net.sf.cpsolver.exam.criteria.additional

Class DistributionViolation

java.lang.Object

net.sf.cpsolver.ifs.criteria.AbstractCriterion<Exam,ExamPlacement>

net.sf.cpsolver.exam.criteria.ExamCriterion

net.sf.cpsolver.exam.criteria.additional.DistributionViolation

All Implemented Interfaces:

Criterion<Exam,ExamPlacement>, InfoProvider<Exam>, ModelListener<Exam,ExamPlacement>

public class DistributionViolation
extends ExamCriterion

Experimental criterion counting violations of hard distribution constraints.

To enable breaking of hard distribution constraints, set parameter Exam.SoftDistributions to a weight that should be inferred by a hard distribution constraint being broken.

Version:

ExamTT 1.2 (Examination Timetabling)
Copyright (C) 2008 - 2012 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/.

Nested Class Summary

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

AbstractCriterion.ValueUpdateType

Field Summary

Fields inherited from class net.sf.cpsolver.ifs.criteria.AbstractCriterion

iBest, iDebug, iValue, iValueUpdateType, iWeight, sDoubleFormat, sPercentFormat

Constructor Summary

Constructors

Constructor and Description
DistributionViolation()

Method Summary

Modifier and Type	Method and Description
protected double[]	computeBounds() Compute bounds (bounds are being cached by default).
double	getPeriodValue(ExamPlacement value) Return impact of this criterion on period assignment (if this criterion is based on period assignment).
double	getRoomValue(ExamPlacement value) Return impact of this criterion on room assignment (if this criterion is based on room assignment).
double	getValue(ExamPlacement value, Set<ExamPlacement> conflicts) Value of a proposed assignment (including hard conflicts)
String	getWeightName() Defines weight name (to be used to get the criterion weight from the configuration).
String	getXmlWeightName() Name of the weight parameter in the parameters section of the examination XML file.
boolean	isPeriodCriterion() True if this criterion is based on period assignment.
boolean	isRoomCriterion() True if this criterion is based on room assignment.
String	toString()

Methods inherited from class net.sf.cpsolver.exam.criteria.ExamCriterion

getBounds, getInfo, getXmlParameters, setWeight, setXmlParameters

Methods inherited from class net.sf.cpsolver.ifs.criteria.AbstractCriterion

afterAssigned, afterUnassigned, beforeAssigned, beforeUnassigned, bestRestored, bestSaved, clearCache, constraintAdded, constraintRemoved, getBest, getBounds, getInfo, getModel, getName, getPerc, getPercRev, getValue, getValue, getWeight, getWeightDefault, getWeightedBest, getWeightedValue, getWeightedValue, getWeightedValue, inc, init, variableAdded, variableRemoved

Methods inherited from class java.lang.Object

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

Constructor Detail

DistributionViolation

public DistributionViolation()

Method Detail

getWeightName

public String getWeightName()

Description copied from class: AbstractCriterion

Defines weight name (to be used to get the criterion weight from the configuration).

Overrides:

getWeightName in class ExamCriterion

getXmlWeightName

public String getXmlWeightName()

Description copied from class: ExamCriterion

Name of the weight parameter in the parameters section of the examination XML file.

Overrides:

getXmlWeightName in class ExamCriterion

getValue

public double getValue(ExamPlacement value,
                       Set<ExamPlacement> conflicts)

Description copied from interface: Criterion

Value of a proposed assignment (including hard conflicts)

computeBounds

protected double[] computeBounds()

Description copied from class: AbstractCriterion

Compute bounds (bounds are being cached by default).

Overrides:

computeBounds in class AbstractCriterion<Exam,ExamPlacement>

isRoomCriterion

public boolean isRoomCriterion()

Description copied from class: ExamCriterion

True if this criterion is based on room assignment. Used by ExamPlacement.getRoomCost().

Overrides:

isRoomCriterion in class ExamCriterion

getRoomValue

public double getRoomValue(ExamPlacement value)

Description copied from class: ExamCriterion

Return impact of this criterion on room assignment (if this criterion is based on room assignment). Used by ExamPlacement.getRoomCost().

Overrides:

getRoomValue in class ExamCriterion

isPeriodCriterion

public boolean isPeriodCriterion()

Description copied from class: ExamCriterion

True if this criterion is based on period assignment. Used by ExamPlacement.getTimeCost().

Overrides:

isPeriodCriterion in class ExamCriterion

getPeriodValue

public double getPeriodValue(ExamPlacement value)

Description copied from class: ExamCriterion

Return impact of this criterion on period assignment (if this criterion is based on period assignment). Used by ExamPlacement.getTimeCost().

Overrides:

getPeriodValue in class ExamCriterion

toString

public String toString()

Overrides:

toString in class Object