org.cpsolver.exam.criteria

Class PeriodSizePenalty

java.lang.Object

org.cpsolver.ifs.criteria.AbstractCriterion<Exam,ExamPlacement>

org.cpsolver.exam.criteria.ExamCriterion

org.cpsolver.exam.criteria.PeriodSizePenalty

All Implemented Interfaces:

CanHoldContext, HasAssignmentContext<Exam,ExamPlacement,AbstractCriterion.ValueContext>, Criterion<Exam,ExamPlacement>, ExtendedInfoProvider<Exam,ExamPlacement>, InfoProvider<Exam,ExamPlacement>, ModelListener<Exam,ExamPlacement>

public class PeriodSizePenalty
extends ExamCriterion

A weight for period penalty (used in ExamPeriodPlacement.getPenalty() multiplied by examination size Exam.getSize(). Can be set by problem property Exams.PeriodSizeWeight, or in the input xml file, property periodSizeWeight).

Version:

ExamTT 1.3 (Examination Timetabling)
Copyright (C) 2008 - 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.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
PeriodSizePenalty()

Method Summary

Modifier and Type	Method and Description
double[]	getBounds(Assignment<Exam,ExamPlacement> assignment, Collection<Exam> variables) Value bounds (minimum and maximum) of the criterion on a part of the problem
void	getInfo(Assignment<Exam,ExamPlacement> assignment, Map<String,String> info) Adds some information into the table with information about the solution
String	getName() Criterion name
double	getValue(Assignment<Exam,ExamPlacement> assignment, 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.
String	toString(Assignment<Exam,ExamPlacement> assignment) Simple text representation of the criterion and its value.

Methods inherited from class org.cpsolver.exam.criteria.ExamCriterion

getPeriodValue, getRoomValue, getXmlParameters, isPeriodCriterion, isRoomCriterion, setWeight, setXmlParameters

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

PeriodSizePenalty

public PeriodSizePenalty()

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

Returns:

name of the weight associated with this criterion

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

Returns:

name of the weight parameter in the XML

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>

Parameters:

config - solver configuration

Returns:

default criterion weight value

getValue

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

Description copied from interface: Criterion

Value of a proposed assignment (including hard conflicts)

Parameters:

assignment - current assignment

value - given value

conflicts - values conflicting with the given value

Returns:

change in this criterion value when assigned

getName

public String getName()

Description copied from interface: Criterion

Criterion name

Specified by:

getName in interface Criterion<Exam,ExamPlacement>

Overrides:

getName in class AbstractCriterion<Exam,ExamPlacement>

Returns:

name

getBounds

public double[] getBounds(Assignment<Exam,ExamPlacement> assignment,
                          Collection<Exam> 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<Exam,ExamPlacement>

Overrides:

getBounds in class ExamCriterion

Parameters:

assignment - current assignment

variables - list of problem variables

Returns:

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

getInfo

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

Overrides:

getInfo in class ExamCriterion

Parameters:

assignment - current assignment

info - info table

toString

public String toString(Assignment<Exam,ExamPlacement> assignment)

Description copied from class: AbstractCriterion

Simple text representation of the criterion and its value. E.g., X:x where X is the AbstractCriterion.getAbbreviation() and x is the current value AbstractCriterion.getValue(Assignment).

Specified by:

toString in interface Criterion<Exam,ExamPlacement>

Overrides:

toString in class AbstractCriterion<Exam,ExamPlacement>

Parameters:

assignment - current assignment

Returns:

short string representation (e.g., PP:95% for period preference)