001package org.cpsolver.instructor.criteria;
002
003import java.util.Collection;
004import java.util.Map;
005import java.util.Set;
006
007import org.cpsolver.ifs.assignment.Assignment;
008import org.cpsolver.ifs.util.DataProperties;
009import org.cpsolver.instructor.model.Instructor;
010import org.cpsolver.instructor.model.Section;
011import org.cpsolver.instructor.model.TeachingAssignment;
012import org.cpsolver.instructor.model.TeachingRequest;
013
014/**
015 * Time overlaps. This criterion counts slots during which an instructor has to teach (or attend) two things that are overlapping in time
016 * (using {@link Instructor#share(TeachingRequest)}). The time overlaps must be allowed in this case (see {@link Section#isAllowOverlap()}).
017 * 
018 * @author  Tomáš Müller
019 * @version IFS 1.3 (Instructor Sectioning)<br>
020 *          Copyright (C) 2016 Tomáš Müller<br>
021 *          <a href="mailto:muller@unitime.org">muller@unitime.org</a><br>
022 *          <a href="http://muller.unitime.org">http://muller.unitime.org</a><br>
023 * <br>
024 *          This library is free software; you can redistribute it and/or modify
025 *          it under the terms of the GNU Lesser General Public License as
026 *          published by the Free Software Foundation; either version 3 of the
027 *          License, or (at your option) any later version. <br>
028 * <br>
029 *          This library is distributed in the hope that it will be useful, but
030 *          WITHOUT ANY WARRANTY; without even the implied warranty of
031 *          MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
032 *          Lesser General Public License for more details. <br>
033 * <br>
034 *          You should have received a copy of the GNU Lesser General Public
035 *          License along with this library; if not see
036 *          <a href='http://www.gnu.org/licenses/'>http://www.gnu.org/licenses/</a>.
037 */
038public class TimeOverlaps extends InstructorSchedulingCriterion {
039
040    public TimeOverlaps() {
041        setValueUpdateType(ValueUpdateType.NoUpdate);
042    }
043
044    @Override
045    public double getWeightDefault(DataProperties config) {
046        return 1000.0;
047    }
048
049    @Override
050    public double getValue(Assignment<TeachingRequest.Variable, TeachingAssignment> assignment, TeachingAssignment value, Set<TeachingAssignment> conflicts) {
051        return value.getInstructor().share(assignment, value);
052    }
053
054    @Override
055    public double getValue(Assignment<TeachingRequest.Variable, TeachingAssignment> assignment, Collection<TeachingRequest.Variable> variables) {
056        double value = 0.0;
057        for (Instructor instructor: getAssignedInstructors(assignment, variables)) {
058            value += instructor.getContext(assignment).countTimeOverlaps();
059        }
060        return value;
061    }
062    
063    @Override
064    public String getAbbreviation() {
065        return "Overlaps";
066    }
067    
068    @Override
069    public void getInfo(Assignment<TeachingRequest.Variable, TeachingAssignment> assignment, Map<String, String> info) {
070        double val = getValue(assignment);
071        if (val != 0)
072            info.put(getName(), sDoubleFormat.format(val / 12.0) + " h");
073    }
074
075    @Override
076    public void getInfo(Assignment<TeachingRequest.Variable, TeachingAssignment> assignment, Map<String, String> info, Collection<TeachingRequest.Variable> variables) {
077        double val = getValue(assignment, variables);
078        if (val != 0)
079            info.put(getName(), sDoubleFormat.format(val / 12.0) + " h");
080    }
081}