org.cpsolver.ifs.criteria

Class AssignedValue<V extends Variable<V,T>,T extends Value<V,T>>

java.lang.Object

org.cpsolver.ifs.criteria.AbstractCriterion<V,T>

org.cpsolver.ifs.criteria.AssignedValue<V,T>

Type Parameters:

V - Variable

T - Value

All Implemented Interfaces:

CanHoldContext, HasAssignmentContext<V,T,AbstractCriterion.ValueContext>, Criterion<V,T>, ExtendedInfoProvider<V,T>, InfoProvider<V,T>, ModelListener<V,T>

public class AssignedValue<V extends Variable<V,T>,T extends Value<V,T>>
extends AbstractCriterion<V,T>

Simple Criterion: Sum of Value.toDouble(Assignment).

This criterion only counts a sum of values (see Value.toDouble(Assignment)) of the assigned variables. It is an alternative to the default Model.getTotalValue(Assignment).

Version:

IFS 1.3 (Iterative Forward Search)
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/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
AssignedValue()

Method Summary

Modifier and Type	Method and Description
double	getValue(Assignment<V,T> assignment, T value, Set<T> 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).

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, getBounds, getContext, getContext, getExtendedInfo, getInfo, getInfo, getModel, getName, getPerc, getPercentage, getPercRev, getValue, getValue, getValue, getValue, getValueUpdateType, getWeight, getWeightedBest, getWeightedValue, getWeightedValue, getWeightedValue, getWeightedValue, getWeightedValue, getWeightedValue, getWeightName, inc, inc, init, setAssignmentContextReference, setModel, setValueUpdateType, toString, variableAdded, variableRemoved

Methods inherited from class java.lang.Object

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

Constructor Detail

AssignedValue

public AssignedValue()

Method Detail

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<V extends Variable<V,T>,T extends Value<V,T>>

Parameters:

config - solver configuration

Returns:

default criterion weight value

getValue

public double getValue(Assignment<V,T> assignment,
                       T value,
                       Set<T> 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