net.sf.cpsolver.exam.criteria
Class LargeExamsPenalty

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.LargeExamsPenalty
All Implemented Interfaces:
Criterion<Exam,ExamPlacement>, InfoProvider<Exam>, ModelListener<Exam,ExamPlacement>

public class LargeExamsPenalty
extends ExamCriterion

Front load penalty. I.e., large exam is discouraged to be placed on or after a certain period.

largeSize: An exam is considered large, if its size is greater or equal to this number. Value -1 means all exams are small. It can be set by problem property Exams.LargeSize, or in the input xml file, property largeSize.

largePeriod: Period index (number of periods multiplied by this number) for front load criteria for large exams. Can be set by problem property Exams.LargePeriod, or in the input xml file, property largePeriod.

Weight of the front load criterion, i.e., a weight for assigning a large exam after large period can be set by problem property Exams.LargeWeight, or in the input xml file, property largeWeight.

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
LargeExamsPenalty()
           
 
Method Summary
 double[] getBounds(Collection<Exam> variables)
          Value bounds (minimum and maximum) of the criterion on a part of the problem
 double getLargePeriod()
          Period index (number of periods multiplied by this number) for front load criteria for large exams.
 int getLargePeriodIndex()
           
 int getLargeSize()
          An exam is considered large, if its size is greater or equal to this large size.
 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.
 void setLargePeriod(double largePeriod)
          Period index (number of periods multiplied by this number) for front load criteria for large exams.
 void setLargeSize(int largeSize)
          An exam is considered large, if its size is greater or equal to this large size.
 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
getInfo, getPeriodValue, getRoomValue, isPeriodCriterion, 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

LargeExamsPenalty

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

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

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>

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

getLargeSize

public int getLargeSize()
An exam is considered large, if its size is greater or equal to this large size. Value -1 means all exams are small. Can be set by problem property Exams.LargeSize, or in the input xml file, property largeSize)


setLargeSize

public void setLargeSize(int largeSize)
An exam is considered large, if its size is greater or equal to this large size. Value -1 means all exams are small. Can be set by problem property Exams.LargeSize, or in the input xml file, property largeSize)


getLargePeriod

public double getLargePeriod()
Period index (number of periods multiplied by this number) for front load criteria for large exams. Can be set by problem property Exams.LargePeriod, or in the input xml file, property largePeriod)


setLargePeriod

public void setLargePeriod(double largePeriod)
Period index (number of periods multiplied by this number) for front load criteria for large exams. Can be set by problem property Exams.LargePeriod, or in the input xml file, property largePeriod)


getLargePeriodIndex

public int getLargePeriodIndex()

getValue

public double getValue(ExamPlacement value,
                       Set<ExamPlacement> conflicts)
Description copied from interface: Criterion
Value of a proposed assignment (including hard conflicts)


getBounds

public double[] getBounds(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

toString

public String toString()
Overrides:
toString in class Object


Copyright © 2014 UniTime LLC. All Rights Reserved.