org.cpsolver.coursett.criteria.additional

Class InstructorStudentHardConflict

java.lang.Object

org.cpsolver.ifs.criteria.AbstractCriterion<Lecture,Placement>

org.cpsolver.coursett.criteria.TimetablingCriterion

org.cpsolver.coursett.criteria.StudentConflict

org.cpsolver.coursett.criteria.additional.InstructorStudentConflict

org.cpsolver.coursett.criteria.additional.InstructorStudentHardConflict

All Implemented Interfaces:

CanHoldContext, HasAssignmentContext<Lecture,Placement,AbstractCriterion.ValueContext>, Criterion<Lecture,Placement>, ExtendedInfoProvider<Lecture,Placement>, InfoProvider<Lecture,Placement>, ModelListener<Lecture,Placement>

public class InstructorStudentHardConflict
extends InstructorStudentConflict

Instructor student conflicts. This criterion penalizes cases when an instructor (of a class) is attending some other class as a student and there is a conflict between the two classes. Also, there is no alternative for the student class (the conflict cannot be sectioned away).
To enable instructor student conflicts, set solver parameter Global.LoadStudentInstructorConflicts to true. Also student course requests should be used in this case (to be able to match an instructor external id to a student external id).
Hard instructor student conflicts are weighted by Comparator.InstructorHardStudentConflictWeight.

Version:

CourseTT 1.3 (University Course Timetabling)
Copyright (C) 2006 - 2014 Tomáš Müller
muller@unitime.org
http://muller.unitime.org

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this library; if not see http://www.gnu.org/licenses/.

Author:

Tomáš Müller

Nested Class Summary

Nested classes/interfaces inherited from class org.cpsolver.ifs.criteria.AbstractCriterion

AbstractCriterion.ValueContext, AbstractCriterion.ValueUpdateType

Field Summary

Fields inherited from class org.cpsolver.coursett.criteria.StudentConflict

iIncludeConflicts

Fields inherited from class org.cpsolver.ifs.criteria.AbstractCriterion

iBest, iDebug, iWeight, sDoubleFormat, sPercentFormat

Fields inherited from interface org.cpsolver.ifs.assignment.context.CanHoldContext

sMaxSize

Constructor Summary

Constructors

Constructor and Description
InstructorStudentHardConflict()

Method Summary

Modifier and Type	Method and Description
void	getInfo(Assignment<Lecture,Placement> assignment, Map<String,String> info) Adds some information into the table with information about the solution
void	getInfo(Assignment<Lecture,Placement> assignment, Map<String,String> info, Collection<Lecture> variables) Adds some information into the table with information about the solution, only consider variables from the given set
String	getPlacementSelectionWeightName()
double	getWeightDefault(DataProperties config) Defines default weight (when AbstractCriterion.getWeightName() parameter is not present in the criterion).
boolean	isApplicable(Lecture l1, Lecture l2)
static boolean	oneInstructorOtherHard(Lecture l1, Lecture l2) One of the lectures is hard, there is a joint enrollment constraint between them, and there is at least one student that is instructor for one lecture and the other lecture is singleton.

Methods inherited from class org.cpsolver.coursett.criteria.additional.InstructorStudentConflict

incJenrl, instructor, jointEnrollment

Methods inherited from class org.cpsolver.coursett.criteria.StudentConflict

applicable, bestRestored, committed, configure, distance, getBounds, getBounds, getMetrics, getValue, getValue, hard, ignore, inConflict, isApplicable, jointEnrollment, overlaps, slots, uncommitted, workday

Methods inherited from class org.cpsolver.coursett.criteria.TimetablingCriterion

getPlacementSelectionAdjustmentsName, getPlacementSelectionWeight, getPlacementSelectionWeightDefault

Methods inherited from class org.cpsolver.ifs.criteria.AbstractCriterion

afterAssigned, afterUnassigned, beforeAssigned, beforeUnassigned, bestSaved, clearCache, computeBounds, constraintAdded, constraintRemoved, createAssignmentContext, getAbbreviation, getAssignmentContextReference, getBest, getBounds, getBounds, getContext, getContext, getExtendedInfo, getModel, getName, getPerc, getPercentage, getPercRev, getValue, getValue, getValue, getValueUpdateType, getWeight, getWeightedBest, getWeightedValue, getWeightedValue, getWeightedValue, getWeightedValue, getWeightedValue, getWeightedValue, getWeightName, inc, inc, init, setAssignmentContextReference, setModel, setValueUpdateType, toString, variableAdded, variableRemoved

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

InstructorStudentHardConflict

public InstructorStudentHardConflict()

Method Detail

isApplicable

public boolean isApplicable(Lecture l1,
                            Lecture l2)

Overrides:

isApplicable in class InstructorStudentConflict

oneInstructorOtherHard

public static boolean oneInstructorOtherHard(Lecture l1,
                                             Lecture l2)

One of the lectures is hard, there is a joint enrollment constraint between them, and there is at least one student that is instructor for one lecture and the other lecture is singleton.

Parameters:

l1 - first placement

l2 - second placement

Returns:

true if there is at least one student of one class teaching the other class, and there are no possibility to move the student into an alternative class

getWeightDefault

public double getWeightDefault(DataProperties config)

Description copied from class: AbstractCriterion

Defines default weight (when AbstractCriterion.getWeightName() parameter is not present in the criterion).

Overrides:

getWeightDefault in class InstructorStudentConflict

Parameters:

config - solver configuration

Returns:

default criterion weight value

getPlacementSelectionWeightName

public String getPlacementSelectionWeightName()

Overrides:

getPlacementSelectionWeightName in class InstructorStudentConflict

getInfo

public void getInfo(Assignment<Lecture,Placement> assignment,
                    Map<String,String> info)

Description copied from interface: InfoProvider

Adds some information into the table with information about the solution

Specified by:

getInfo in interface InfoProvider<Lecture,Placement>

Overrides:

getInfo in class InstructorStudentConflict

Parameters:

assignment - current assignment

info - info table

getInfo

public void getInfo(Assignment<Lecture,Placement> assignment,
                    Map<String,String> info,
                    Collection<Lecture> variables)

Description copied from interface: InfoProvider

Adds some information into the table with information about the solution, only consider variables from the given set

Specified by:

getInfo in interface InfoProvider<Lecture,Placement>

Overrides:

getInfo in class InstructorStudentConflict

Parameters:

assignment - current assignment

info - info table

variables - sub-problem