Package org.jacop.floats.constraints.linear

Class Linear

java.lang.Object

org.jacop.constraints.DecomposedConstraint<Constraint>

org.jacop.constraints.Constraint

org.jacop.constraints.PrimitiveConstraint

org.jacop.floats.constraints.linear.Linear

All Implemented Interfaces:

SatisfiedPresent, StoreAware, UsesQueueVariable

Direct Known Subclasses:

LinearFloat

public class Linear
extends PrimitiveConstraint
implements UsesQueueVariable

Linear constraint implements the weighted summation over several Variable's . It provides the weighted sum from all Variable's on the list. The weights must be positive integers.

Version:

4.8

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static class	Linear.VarWeightComparator<T extends VariableNode>

Field Summary

Fields

Modifier and Type	Field	Description
static byte	eq	Defines relations
static byte	ge	Defines relations
static byte	gt	Defines relations
(package private) static java.util.concurrent.atomic.AtomicInteger	idNumber
static byte	le	Defines relations
(package private) BTree	linearTree
FloatVar[]	list	It specifies a list of variables being summed.
static byte	lt	Defines relations
static byte	ne	Defines relations
(package private) static byte[]	negRel	Defines negated relations
(package private) TimeStamp<java.lang.Boolean>	noSat
(package private) boolean	reified
byte	relationType	It specifies what relations is used by this constraint
(package private) Store	store
double	sum	It specifies variable for the overall sum.
(package private) SimpleHashSet<FloatVar>	variableQueue
(package private) java.util.Map<FloatVar,VariableNode>	varMap
double[]	weights	It specifies a list of weights associated with the variables being summed.

Fields inherited from class org.jacop.constraints.PrimitiveConstraint

notConsistencyPruningEvents

Fields inherited from class org.jacop.constraints.Constraint

atomicExecution, consistencyPruningEvents, constraintScope, earlyTerminationOK, increaseWeight, numberId, scope, trace

Fields inherited from class org.jacop.constraints.DecomposedConstraint

queueIndex

Constructor Summary

Constructors

Constructor	Description
Linear(Store store, java.util.List<? extends FloatVar> variables, java.util.List<java.lang.Double> weights, java.lang.String rel, double sum)	It constructs the constraint Linear.
Linear(Store store, FloatVar[] list, double[] weights, java.lang.String rel, double sum)
Linear(Store store, FloatVar[] list, double[] weights, java.lang.String rel, FloatVar sum)

Method Summary

Modifier and Type	Method	Description
(package private) RootBNode	buildBinaryTree(BinaryNode[] nodes)
(package private) void	checkForOverflow()
private void	commonInitialization(Store store, FloatVar[] list, double[] weights, java.lang.String rel, double sum)
void	consistency(Store store)	It is a (most probably incomplete) consistency function which removes the values from variables domains.
private boolean	entailed(byte rel)
int	getDefaultConsistencyPruningEvent()
protected int	getDefaultNestedConsistencyPruningEvent()
protected int	getDefaultNestedNotConsistencyPruningEvent()
protected int	getDefaultNotConsistencyPruningEvent()
void	impose(Store store)	It imposes the constraint in a given store.
void	notConsistency(Store store)	It makes pruning in such a way that constraint is notConsistent.
boolean	notSatisfied()	It checks if constraint would be always not satisfied.
(package private) void	propagate(SimpleHashSet<FloatVar> fdvs)
private void	pruneRelation()
void	queueVariable(int level, Var var)	This is a function called to indicate which variable in a scope of constraint has changed.
java.lang.String	rel2String()
byte	relation(java.lang.String r)
boolean	satisfied()	It checks if the constraint is satisfied.
java.lang.String	toString()	It produces a string representation of a constraint state.

Methods inherited from class org.jacop.constraints.PrimitiveConstraint

getNestedPruningEvent, getNotConsistencyPruningEvent, include, setNotConsistencyPruningEvent

Methods inherited from class org.jacop.constraints.Constraint

afc, arguments, cleanAfterFailure, decompose, getConsistencyPruningEvent, getGuideConstraint, getGuideValue, getGuideVariable, grounded, grounded, id, impose, imposeDecomposition, increaseWeight, intArrayToString, numberArgs, removeConstraint, requiresMonotonicity, setConsistencyPruningEvent, setConstraintScope, setScope, setScope, setScope, setScope, setScope, setWatchedVariableGrounded, supplyGuideFeedback, updateAFC, watchedVariableGrounded

Methods inherited from class org.jacop.constraints.DecomposedConstraint

auxiliaryVariables, checkInput, checkInput, checkInputForDuplication, checkInputForDuplicationSkipSingletons, checkInputForNullness, checkInputForNullness, checkInputForNullness, derivative, getDubletonsSkipSingletons, imposeDecomposition

Methods inherited from class java.lang.Object

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

Field Detail

store

Store store

idNumber

static java.util.concurrent.atomic.AtomicInteger idNumber

eq

public static final byte eq

Defines relations

See Also:

Constant Field Values

lt

public static final byte lt

Defines relations

See Also:

Constant Field Values

le

public static final byte le

Defines relations

See Also:

Constant Field Values

ne

public static final byte ne

Defines relations

See Also:

Constant Field Values

gt

public static final byte gt

Defines relations

See Also:

Constant Field Values

ge

public static final byte ge

Defines relations

See Also:

Constant Field Values

negRel

static final byte[] negRel

Defines negated relations

relationType

public byte relationType

It specifies what relations is used by this constraint

list

public FloatVar[] list

It specifies a list of variables being summed.

weights

public double[] weights

It specifies a list of weights associated with the variables being summed.

sum

public double sum

It specifies variable for the overall sum.

varMap

java.util.Map<FloatVar,VariableNode> varMap

variableQueue

SimpleHashSet<FloatVar> variableQueue

reified

boolean reified

linearTree

BTree linearTree

noSat

TimeStamp<java.lang.Boolean> noSat

Constructor Detail

Linear

public Linear(Store store,
              FloatVar[] list,
              double[] weights,
              java.lang.String rel,
              double sum)

Parameters:

store - current store

list - variables which are being multiplied by weights.

weights - weight for each variable.

rel - the relation, one of "==", "<", ">", "<=", ">=", "!="

sum - the sum of weighted variables.

Linear

public Linear(Store store,
              FloatVar[] list,
              double[] weights,
              java.lang.String rel,
              FloatVar sum)

Parameters:

store - current store

list - variables which are being multiplied by weights.

weights - weight for each variable.

rel - the relation, one of "==", "<", ">", "<=", ">=", "!="

sum - variable containing the sum of weighted variables.

Linear

public Linear(Store store,
              java.util.List<? extends FloatVar> variables,
              java.util.List<java.lang.Double> weights,
              java.lang.String rel,
              double sum)

It constructs the constraint Linear.

Parameters:

store - current store

variables - variables which are being multiplied by weights.

weights - weight for each variable.

rel - the relation, one of "==", "<", ">", "<=", ">="

sum - variable containing the sum of weighted variables.

Method Detail

commonInitialization

private void commonInitialization(Store store,
                                  FloatVar[] list,
                                  double[] weights,
                                  java.lang.String rel,
                                  double sum)

buildBinaryTree

RootBNode buildBinaryTree(BinaryNode[] nodes)

consistency

public void consistency(Store store)

Description copied from class: Constraint

It is a (most probably incomplete) consistency function which removes the values from variables domains. Only values which do not have any support in a solution space are removed.

Specified by:

consistency in class Constraint

Parameters:

store - constraint store within which the constraint consistency is being checked.

notConsistency

public void notConsistency(Store store)

Description copied from class: PrimitiveConstraint

It makes pruning in such a way that constraint is notConsistent. It removes values which always belong to a solution.

Specified by:

notConsistency in class PrimitiveConstraint

Parameters:

store - the constraint store in which context the notConsistency technique is evaluated.

pruneRelation

private void pruneRelation()

propagate

void propagate(SimpleHashSet<FloatVar> fdvs)

getDefaultConsistencyPruningEvent

public int getDefaultConsistencyPruningEvent()

Specified by:

getDefaultConsistencyPruningEvent in class Constraint

getDefaultNestedNotConsistencyPruningEvent

protected int getDefaultNestedNotConsistencyPruningEvent()

Overrides:

getDefaultNestedNotConsistencyPruningEvent in class PrimitiveConstraint

getDefaultNestedConsistencyPruningEvent

protected int getDefaultNestedConsistencyPruningEvent()

Overrides:

getDefaultNestedConsistencyPruningEvent in class PrimitiveConstraint

getDefaultNotConsistencyPruningEvent

protected int getDefaultNotConsistencyPruningEvent()

Specified by:

getDefaultNotConsistencyPruningEvent in class PrimitiveConstraint

impose

public void impose(Store store)

Description copied from class: Constraint

It imposes the constraint in a given store.

Overrides:

impose in class PrimitiveConstraint

Parameters:

store - the constraint store to which the constraint is imposed to.

queueVariable

public void queueVariable(int level,
                          Var var)

Description copied from class: Constraint

This is a function called to indicate which variable in a scope of constraint has changed. It also indicates a store level at which the change has occurred.

Overrides:

queueVariable in class Constraint

Parameters:

level - the level of the store at which the change has occurred.

var - variable which has changed.

satisfied

public boolean satisfied()

Description copied from interface: SatisfiedPresent

It checks if the constraint is satisfied. It can return false even if constraint is satisfied but not all variables in its scope are grounded. It needs to return true if all variables in its scope are grounded and constraint is satisfied.

Implementations of this interface for constraints that are not PrimitiveConstraint may require constraint imposition and consistency check as a requirement to work correctly.

Specified by:

satisfied in interface SatisfiedPresent

Returns:

true if constraint is possible to verify that it is satisfied.

notSatisfied

public boolean notSatisfied()

Description copied from class: PrimitiveConstraint

It checks if constraint would be always not satisfied.

Specified by:

notSatisfied in class PrimitiveConstraint

Returns:

true if constraint must be notSatisfied, false otherwise.

entailed

private boolean entailed(byte rel)

checkForOverflow

void checkForOverflow()

relation

public byte relation(java.lang.String r)

rel2String

public java.lang.String rel2String()

toString

public java.lang.String toString()

Description copied from class: Constraint

It produces a string representation of a constraint state.

Overrides:

toString in class Constraint