Package org.projog.clp

Class Variable

java.lang.Object

org.projog.clp.Variable

All Implemented Interfaces:

Constraint, Expression, LeafExpression

public final class Variable
extends java.lang.Object
implements LeafExpression

An expression that can have one or more possible numeric values.

Field Summary

Fields

Modifier and Type	Field	Description
private static int	FALSE
private int	id
private static int	TRUE

Constructor Summary

Constructors

Constructor	Description
Variable(int id)

Method Summary

Modifier and Type	Method	Description
ConstraintResult	enforce(ConstraintStore s)	Attempts to enforce this constraint using the given ConstraintStore.
(package private) int	getId()
long	getMax(ReadConstraintStore s)
long	getMin(ReadConstraintStore s)
ConstraintResult	prevent(ConstraintStore s)	Attempts to prevent this constraint using the given ConstraintStore.
ConstraintResult	reify(ReadConstraintStore s)
LeafExpression	replace(java.util.function.Function<LeafExpression,LeafExpression> function)	Returns new Constraint with LeafExpressions in this Constraint replaced with values returned from the given function.
ExpressionResult	setMax(ConstraintStore s, long max)
ExpressionResult	setMin(ConstraintStore s, long min)
ExpressionResult	setNot(ConstraintStore s, long not)
ExpressionResult	setValue(ConstraintStore s, long value)
java.lang.String	toString()
void	walk(java.util.function.Consumer<Expression> r)	Traverse this constraint.

Methods inherited from class java.lang.Object

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

Field Detail

TRUE

private static final int TRUE

See Also:

Constant Field Values

FALSE

private static final int FALSE

See Also:

Constant Field Values

id

private final int id

Constructor Detail

Variable

Variable(int id)

See Also:

ClpConstraintStore.Builder.createVariable()

Method Detail

getId

int getId()

getMin

public long getMin(ReadConstraintStore s)

Specified by:

getMin in interface Constraint

Specified by:

getMin in interface Expression

getMax

public long getMax(ReadConstraintStore s)

Specified by:

getMax in interface Constraint

Specified by:

getMax in interface Expression

setValue

public ExpressionResult setValue(ConstraintStore s,
                                 long value)

setNot

public ExpressionResult setNot(ConstraintStore s,
                               long not)

Specified by:

setNot in interface Expression

setMin

public ExpressionResult setMin(ConstraintStore s,
                               long min)

Specified by:

setMin in interface Constraint

Specified by:

setMin in interface Expression

setMax

public ExpressionResult setMax(ConstraintStore s,
                               long max)

Specified by:

setMax in interface Constraint

Specified by:

setMax in interface Expression

enforce

public ConstraintResult enforce(ConstraintStore s)

Description copied from interface: Constraint

Attempts to enforce this constraint using the given ConstraintStore.

Specified by:

enforce in interface Constraint

prevent

public ConstraintResult prevent(ConstraintStore s)

Description copied from interface: Constraint

Attempts to prevent this constraint using the given ConstraintStore.

Specified by:

prevent in interface Constraint

reify

public ConstraintResult reify(ReadConstraintStore s)

Specified by:

reify in interface Constraint

walk

public void walk(java.util.function.Consumer<Expression> r)

Description copied from interface: Constraint

Traverse this constraint.

Specified by:

walk in interface Constraint

Specified by:

walk in interface Expression

Parameters:

r - will be called for each Expression contained within this Constraint.

replace

public LeafExpression replace(java.util.function.Function<LeafExpression,LeafExpression> function)

Description copied from interface: Constraint

Returns new Constraint with LeafExpressions in this Constraint replaced with values returned from the given function.

Specified by:

replace in interface Constraint

Specified by:

replace in interface Expression

Specified by:

replace in interface LeafExpression

Parameters:

function - returns the LeafExpression to use as a replacement for the LeafExpression it is called with, or null if the original LeafExpression should continue to be used.

Returns:

a new Constraint with LeafExpressions in this Constraint replaced with versions returned from function.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object