org.cpsolver.coursett.criteria.placement

Class WeightedHardConflicts

java.lang.Object

org.cpsolver.ifs.criteria.AbstractCriterion<Lecture,Placement>

org.cpsolver.coursett.criteria.TimetablingCriterion

org.cpsolver.coursett.criteria.placement.PlacementSelectionCriterion

org.cpsolver.coursett.criteria.placement.WeightedHardConflicts

All Implemented Interfaces:

CanHoldContext, HasAssignmentContext<Lecture,Placement,AbstractCriterion.ValueContext>, Criterion<Lecture,Placement>, ExtendedInfoProvider<Lecture,Placement>, InfoProvider<Lecture,Placement>, ModelListener<Lecture,Placement>, SolutionListener<Lecture,Placement>

Direct Known Subclasses:

PotentialHardConflicts

public class WeightedHardConflicts
extends PlacementSelectionCriterion
implements SolutionListener<Lecture,Placement>

Hard conflicts weighted by the conflict-based statistics (past occurrences).

Version:

CourseTT 1.3 (University Course Timetabling)
Copyright (C) 2006 - 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

Modifier and Type	Class and Description
class	WeightedHardConflicts.IterationContext

Nested classes/interfaces inherited from class org.cpsolver.ifs.criteria.AbstractCriterion

AbstractCriterion.ValueContext, AbstractCriterion.ValueUpdateType

Field Summary

Fields

Modifier and Type	Field and Description
protected ConflictStatistics<Lecture,Placement>	iStat

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

Method Summary

Modifier and Type	Method and Description
void	bestCleared(Solution<Lecture,Placement> solution) Called by the solution when method Solution.clearBest() is called.
void	bestRestored(Solution<Lecture,Placement> solution) Called by the solution when method Solution.restoreBest() is called.
void	bestSaved(Solution<Lecture,Placement> solution) Called by the solution when method Solution.saveBest() is called.
AbstractCriterion.ValueContext	createAssignmentContext(Assignment<Lecture,Placement> assignment) Create a new assignment context for the given assignment.
void	getInfo(Solution<Lecture,Placement> solution, Map<String,String> info) Called by the solution when it is asked to produce info table, see Solution.getInfo().
void	getInfo(Solution<Lecture,Placement> solution, Map<String,String> info, Collection<Lecture> variables) Called by the solution when it is asked to produce info table, see Solution.getInfo().
double	getPlacementSelectionWeightDefault(int level)
String	getPlacementSelectionWeightName()
double	getValue(Assignment<Lecture,Placement> assignment, Placement value, Set<Placement> conflicts) Value of a proposed assignment (including hard conflicts)
boolean	init(Solver<Lecture,Placement> solver) Notification that the model was initialized by the solver.
void	solutionUpdated(Solution<Lecture,Placement> solution) Called by the solution when it is updated, see Solution.update(double).

Methods inherited from class org.cpsolver.coursett.criteria.placement.PlacementSelectionCriterion

getInfo, getInfo, getWeightDefault

Methods inherited from class org.cpsolver.coursett.criteria.TimetablingCriterion

configure, getPlacementSelectionAdjustmentsName, getPlacementSelectionWeight

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

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

Methods inherited from class java.lang.Object

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

Field Detail

iStat

protected ConflictStatistics<Lecture,Placement> iStat

Constructor Detail

WeightedHardConflicts

public WeightedHardConflicts()

Method Detail

init

public boolean init(Solver<Lecture,Placement> solver)

Description copied from interface: ModelListener

Notification that the model was initialized by the solver.

Specified by:

init in interface ModelListener<Lecture,Placement>

Overrides:

init in class AbstractCriterion<Lecture,Placement>

Parameters:

solver - IFS solver

Returns:

true if successfully initialized

getPlacementSelectionWeightName

public String getPlacementSelectionWeightName()

Overrides:

getPlacementSelectionWeightName in class TimetablingCriterion

getValue

public double getValue(Assignment<Lecture,Placement> assignment,
                       Placement value,
                       Set<Placement> conflicts)

Description copied from interface: Criterion

Value of a proposed assignment (including hard conflicts)

Specified by:

getValue in interface Criterion<Lecture,Placement>

Parameters:

assignment - current assignment

value - given value

conflicts - values conflicting with the given value

Returns:

change in this criterion value when assigned

getPlacementSelectionWeightDefault

public double getPlacementSelectionWeightDefault(int level)

Overrides:

getPlacementSelectionWeightDefault in class TimetablingCriterion

solutionUpdated

public void solutionUpdated(Solution<Lecture,Placement> solution)

Description copied from interface: SolutionListener

Called by the solution when it is updated, see Solution.update(double).

Specified by:

solutionUpdated in interface SolutionListener<Lecture,Placement>

Parameters:

solution - source solution

getInfo

public void getInfo(Solution<Lecture,Placement> solution,
                    Map<String,String> info)

Description copied from interface: SolutionListener

Called by the solution when it is asked to produce info table, see Solution.getInfo(). A listener can also add some its info into this table.

Specified by:

getInfo in interface SolutionListener<Lecture,Placement>

Parameters:

solution - source solution

info - produced info table

getInfo

public void getInfo(Solution<Lecture,Placement> solution,
                    Map<String,String> info,
                    Collection<Lecture> variables)

Description copied from interface: SolutionListener

Called by the solution when it is asked to produce info table, see Solution.getInfo(). A listener can also add some its info into this table.

Specified by:

getInfo in interface SolutionListener<Lecture,Placement>

Parameters:

solution - source solution

info - produced info table

variables - only variables from this set are included

bestCleared

public void bestCleared(Solution<Lecture,Placement> solution)

Description copied from interface: SolutionListener

Called by the solution when method Solution.clearBest() is called.

Specified by:

bestCleared in interface SolutionListener<Lecture,Placement>

Parameters:

solution - source solution

bestSaved

public void bestSaved(Solution<Lecture,Placement> solution)

Description copied from interface: SolutionListener

Called by the solution when method Solution.saveBest() is called.

Specified by:

bestSaved in interface SolutionListener<Lecture,Placement>

Parameters:

solution - source solution

bestRestored

public void bestRestored(Solution<Lecture,Placement> solution)

Description copied from interface: SolutionListener

Called by the solution when method Solution.restoreBest() is called.

Specified by:

bestRestored in interface SolutionListener<Lecture,Placement>

Parameters:

solution - source solution

createAssignmentContext

public AbstractCriterion.ValueContext createAssignmentContext(Assignment<Lecture,Placement> assignment)

Description copied from interface: HasAssignmentContext

Create a new assignment context for the given assignment. If there are already some variables assigned in the value, the method should make sure that the context is appropriately initialized.

Specified by:

createAssignmentContext in interface HasAssignmentContext<Lecture,Placement,AbstractCriterion.ValueContext>

Overrides:

createAssignmentContext in class AbstractCriterion<Lecture,Placement>

Parameters:

assignment - an assignment for which there needs to be an assignment context

Returns:

a new instance of the assignment context, filled according to the given assignment