net.sf.cpsolver.exam.criteria

Class RoomSplitDistancePenalty

java.lang.Object

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

net.sf.cpsolver.exam.criteria.ExamCriterion

net.sf.cpsolver.exam.criteria.RoomSplitDistancePenalty

All Implemented Interfaces:

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

public class RoomSplitDistancePenalty
extends ExamCriterion

Room split distance penalty. I.e., average distance between two rooms of a placement.

A weight for room split penalty can be set by problem property Exams.RoomSplitWeight, or in the input xml file, property roomSplitDistanceWeight).

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

Method Summary

Modifier and Type	Method and Description
void	afterAssigned(long iteration, ExamPlacement value) Called after a value is assigned to its variable ( Value.variable()).
void	beforeUnassigned(long iteration, ExamPlacement value) Called before a value is unassigned from its variable ( Value.variable()).
void	getInfo(Map<String,String> info) Adds some information into the table with information about the solution
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.
boolean	isPeriodCriterion() True if this criterion is based on period assignment.
int	nrRoomSplits()
String	toString()

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

getBounds, getPeriodValue, getRoomValue, getXmlParameters, isRoomCriterion, setWeight, setXmlParameters

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

afterUnassigned, beforeAssigned, bestRestored, bestSaved, clearCache, computeBounds, constraintAdded, constraintRemoved, getBest, getBounds, getInfo, getModel, getName, getPerc, getPercRev, getValue, getValue, getWeight, 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

RoomSplitDistancePenalty

public RoomSplitDistancePenalty()

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

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)

beforeUnassigned

public void beforeUnassigned(long iteration,
                             ExamPlacement value)

Description copied from interface: ModelListener

Called before a value is unassigned from its variable ( Value.variable()).

Specified by:

beforeUnassigned in interface ModelListener<Exam,ExamPlacement>

Overrides:

beforeUnassigned in class AbstractCriterion<Exam,ExamPlacement>

Parameters:

iteration - current iteration

value - value to be unassigned

afterAssigned

public void afterAssigned(long iteration,
                          ExamPlacement value)

Description copied from interface: ModelListener

Called after a value is assigned to its variable ( Value.variable()).

Specified by:

afterAssigned in interface ModelListener<Exam,ExamPlacement>

Overrides:

afterAssigned in class AbstractCriterion<Exam,ExamPlacement>

Parameters:

iteration - current iteration

value - value to be assigned

getInfo

public void getInfo(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<Exam>

Overrides:

getInfo in class ExamCriterion

nrRoomSplits

public int nrRoomSplits()

toString

public String toString()

Overrides:

toString in class Object

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