org.cpsolver.coursett.criteria

Class StudentCommittedConflict

java.lang.Object

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

org.cpsolver.coursett.criteria.TimetablingCriterion

org.cpsolver.coursett.criteria.StudentConflict

org.cpsolver.coursett.criteria.StudentCommittedConflict

All Implemented Interfaces:

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

public class StudentCommittedConflict
extends StudentConflict

Student committed conflicts. This criterion counts student conflicts between pairs of classes where one the classes is committed (i.e., fixed in time and room, belonging to another problem).

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
StudentCommittedConflict()

Method Summary

Modifier and Type	Method and Description
double[]	getBounds(Assignment<Lecture,Placement> assignment, Collection<Lecture> variables) Value bounds (minimum and maximum) of the criterion on a part of the problem
String	getPlacementSelectionWeightName()
double	getValue(Assignment<Lecture,Placement> assignment, Collection<Lecture> variables) Value of a part of the problem (given by the collection of variables)
double	getValue(Assignment<Lecture,Placement> assignment, Placement value, Set<Placement> conflicts) Value of a proposed assignment (including hard conflicts)
double	getWeightDefault(DataProperties config) Defines default weight (when AbstractCriterion.getWeightName() parameter is not present in the criterion).
boolean	isApplicable(Lecture l1, Lecture l2)

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

applicable, bestRestored, committed, configure, distance, getBounds, getMetrics, hard, ignore, incJenrl, inConflict, isApplicable, jointEnrollment, 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, getInfo, getInfo, 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

StudentCommittedConflict

public StudentCommittedConflict()

Method Detail

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 AbstractCriterion<Lecture,Placement>

Parameters:

config - solver configuration

Returns:

default criterion weight value

getPlacementSelectionWeightName

public String getPlacementSelectionWeightName()

Overrides:

getPlacementSelectionWeightName in class StudentConflict

isApplicable

public boolean isApplicable(Lecture l1,
                            Lecture l2)

Overrides:

isApplicable in class StudentConflict

getBounds

public double[] getBounds(Assignment<Lecture,Placement> assignment,
                          Collection<Lecture> variables)

Description copied from interface: Criterion

Value bounds (minimum and maximum) of the criterion on a part of the problem

Specified by:

getBounds in interface Criterion<Lecture,Placement>

Overrides:

getBounds in class StudentConflict

Parameters:

assignment - current assignment

variables - list of problem variables

Returns:

minimum and maximum of this criterion for the given sub-problem

getValue

public double getValue(Assignment<Lecture,Placement> assignment,
                       Placement value,
                       Set<Placement> conflicts)

Description copied from interface: Criterion

Value of a proposed assignment (including hard conflicts)

Specified by:

getValue in interface Criterion<Lecture,Placement>

Overrides:

getValue in class StudentConflict

Parameters:

assignment - current assignment

value - given value

conflicts - values conflicting with the given value

Returns:

change in this criterion value when assigned

getValue

public double getValue(Assignment<Lecture,Placement> assignment,
                       Collection<Lecture> variables)

Description copied from interface: Criterion

Value of a part of the problem (given by the collection of variables)

Specified by:

getValue in interface Criterion<Lecture,Placement>

Overrides:

getValue in class StudentConflict

Parameters:

assignment - current assignment

variables - list of problem variables

Returns:

value of the given variables