net.sf.cpsolver.exam.criteria.additional
Class DistanceToStronglyPreferredRoom

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

public class DistanceToStronglyPreferredRoom
extends ExamCriterion

Experimental criterion measuring average distance (in meters) to the strongly preferred room (or rooms) of the examination. The idea is to prefer rooms that are close to the strongly preference room (if there is a strongly preferred room but it is not available).

A weight of the average distance between the assigned room(s) and the strongly preferred room or rooms can be set using Exams.DistanceToStronglyPreferredRoomWeight property.

To enable this criterion add this class name to Exams.AdditionalCriteria parameter. For instance:
Exams.AdditionalCriteria=net.sf.cpsolver.exam.criteria.additional.DistanceToStronglyPreferredRoom

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
DistanceToStronglyPreferredRoom()
           
 
Method Summary
 double[] getBounds()
          Bounds (minimum and maximum) estimate for the value
 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.
 String toString()
           
 
Methods inherited from class net.sf.cpsolver.exam.criteria.ExamCriterion
getBounds, getPeriodValue, getRoomValue, getXmlParameters, isPeriodCriterion, isRoomCriterion, setWeight, setXmlParameters
 
Methods inherited from class net.sf.cpsolver.ifs.criteria.AbstractCriterion
afterAssigned, afterUnassigned, beforeAssigned, beforeUnassigned, bestRestored, bestSaved, clearCache, computeBounds, constraintAdded, constraintRemoved, getBest, 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

DistanceToStronglyPreferredRoom

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


toString

public String toString()
Overrides:
toString in class Object

getBounds

public double[] getBounds()
Description copied from interface: Criterion
Bounds (minimum and maximum) estimate for the value

Specified by:
getBounds in interface Criterion<Exam,ExamPlacement>
Overrides:
getBounds in class AbstractCriterion<Exam,ExamPlacement>

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


Copyright © 2014 UniTime LLC. All Rights Reserved.