net.sf.cpsolver.exam.criteria
Class RoomSizePenalty

java.lang.Object
  extended by net.sf.cpsolver.ifs.criteria.AbstractCriterion<Exam,ExamPlacement>
      extended by net.sf.cpsolver.exam.criteria.ExamCriterion
          extended by net.sf.cpsolver.exam.criteria.RoomSizePenalty
All Implemented Interfaces:
Criterion<Exam,ExamPlacement>, InfoProvider<Exam>, ModelListener<Exam,ExamPlacement>

public class RoomSizePenalty
extends ExamCriterion

Cost for using room(s) that are too big. I.e., a difference between total room size (computed using either ExamRoom.getSize() or ExamRoom.getAltSize() based on Exam.hasAltSeating()) and the number of students Exam.getSize().

A weight for room size penalty can be set by problem property Exams.RoomSizeWeight, or in the input xml file, property roomSizeWeight).

The difference function can be made polynomial by using Exams.RoomSizeFactor parameter (defaults to 1.0). The value of this criteria is then cubed by the power of this room size factor. This is to be able to favor a room swap between two exams at the same period, in which a smaller exam takes a smaller room. To do this, set Exams.RoomSizeFactor to a number bigger than one that is close to one (e.g., 1.05).

Version:
ExamTT 1.2 (Examination Timetabling)
Copyright (C) 2008 - 2012 Tomas Muller
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
RoomSizePenalty()
           
 
Method Summary
 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).
 void getXmlParameters(Map<String,String> params)
          Put all the parameters of this criterion into a map that is used to write parameters section of the examination XML file.
 String getXmlWeightName()
          Name of the weight parameter in the parameters section of the examination XML file.
 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.
 void setXmlParameters(Map<String,String> params)
          Set all the parameters of this criterion from a map that is read from the parameters section the examination XML file.
 String toString()
           
 
Methods inherited from class net.sf.cpsolver.exam.criteria.ExamCriterion
getBounds, getPeriodValue, getRoomValue, isRoomCriterion, setWeight
 
Methods inherited from class net.sf.cpsolver.ifs.criteria.AbstractCriterion
afterAssigned, afterUnassigned, beforeAssigned, beforeUnassigned, bestRestored, bestSaved, clearCache, computeBounds, constraintAdded, constraintRemoved, getBest, getBounds, getInfo, getModel, getName, getPerc, getPercRev, getValue, getValue, getWeight, getWeightedBest, getWeightedValue, getWeightedValue, getWeightedValue, inc, variableAdded, variableRemoved
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

RoomSizePenalty

public RoomSizePenalty()
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>

getXmlParameters

public void getXmlParameters(Map<String,String> params)
Description copied from class: ExamCriterion
Put all the parameters of this criterion into a map that is used to write parameters section of the examination XML file.

Overrides:
getXmlParameters in class ExamCriterion

setXmlParameters

public void setXmlParameters(Map<String,String> params)
Description copied from class: ExamCriterion
Set all the parameters of this criterion from a map that is read from the parameters section the examination XML file.

Overrides:
setXmlParameters 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)


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

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


Copyright © 2014 UniTime LLC. All Rights Reserved.