net.sf.cpsolver.exam.criteria

Class DistributionPenalty

java.lang.Object

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

net.sf.cpsolver.exam.criteria.ExamCriterion

net.sf.cpsolver.exam.criteria.DistributionPenalty

All Implemented Interfaces:

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

public class DistributionPenalty
extends ExamCriterion

Distribution penalty. I.e., sum weights of violated distribution constraints.

A weight of violated distribution soft constraints (see ExamDistributionConstraint) can be set by problem property Exams.RoomDistributionWeight, or in the input xml file, property roomDistributionWeight.

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

Modifier and Type	Field and Description
protected Integer	iSoftDistributions

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

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

Constructor Summary

Constructors

Constructor and Description
DistributionPenalty()

Method Summary

Modifier and Type	Method and Description
protected double[]	computeBounds() Compute bounds (bounds are being cached by default).
double	getPeriodValue(ExamPlacement value) Period related distribution penalty, i.e., sum weights of violated distribution constraints
double	getRoomValue(ExamPlacement value) Room related distribution penalty, i.e., sum weights of violated distribution constraints
double	getValue(ExamPlacement value, Set<ExamPlacement> 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).
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.
void	inc(double value) Outside update of the criterion (usefull when the criterion is driven by a set of constraints).
boolean	init(Solver<Exam,ExamPlacement> solver) Notification that the model was initialized by the solver.
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, getWeightedBest, getWeightedValue, getWeightedValue, getWeightedValue, variableAdded, variableRemoved

Methods inherited from class java.lang.Object

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

Field Detail

iSoftDistributions

protected Integer iSoftDistributions

Constructor Detail

DistributionPenalty

public DistributionPenalty()

Method Detail

init

public boolean init(Solver<Exam,ExamPlacement> solver)

Description copied from interface: ModelListener

Notification that the model was initialized by the solver.

Specified by:

init in interface ModelListener<Exam,ExamPlacement>

Overrides:

init in class AbstractCriterion<Exam,ExamPlacement>

Parameters:

solver - IFS solver

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

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<Exam,ExamPlacement>

getValue

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

Description copied from interface: Criterion

Value of a proposed assignment (including hard conflicts)

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)

Room related distribution penalty, i.e., sum weights of violated distribution constraints

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

inc

public void inc(double value)

Description copied from interface: Criterion

Outside update of the criterion (usefull when the criterion is driven by a set of constraints).

Specified by:

inc in interface Criterion<Exam,ExamPlacement>

Overrides:

inc in class AbstractCriterion<Exam,ExamPlacement>

getPeriodValue

public double getPeriodValue(ExamPlacement value)

Period related distribution penalty, i.e., sum weights of violated distribution constraints

Overrides:

getPeriodValue in class ExamCriterion

computeBounds

protected double[] computeBounds()

Description copied from class: AbstractCriterion

Compute bounds (bounds are being cached by default).

Overrides:

computeBounds in class AbstractCriterion<Exam,ExamPlacement>

toString

public String toString()

Overrides:

toString in class Object