Java Reference

Java Reference

IntExpr

Detailed Description

The class IntExpr is the base of all integer expressions in constraint programming.

It contains the basic protocol for an expression: - setting and modifying its bound - querying if it is bound - listening to events modifying its bounds - casting it into a variable (instance of IntVar)

Definition at line 14 of file IntExpr.java.

Public Member Functions

synchronized void delete ()
 
long min ()
 
void setMin (long m)
 
long max ()
 
void setMax (long m)
 
void range (int[] l, int[] u)
 By default calls Min() and Max(), but can be redefined when Min and Max code can be factorized. More...
 
void setRange (long l, long u)
 This method sets both the min and the max of the expression. More...
 
void setValue (long v)
 This method sets the value of the expression. More...
 
boolean bound ()
 Returns true if the min and the max of the expression are equal. More...
 
boolean isVar ()
 Returns true if the expression is indeed a variable. More...
 
IntVar var ()
 Creates a variable from the expression. More...
 
IntVar varWithName (String name)
 Creates a variable from the expression and set the name of the resulting var. More...
 
void whenRange (Demon d)
 Attach a demon that will watch the min or the max of the expression. More...
 
void whenRange (Runnable closure)
 Attach a demon that will watch the min or the max of the expression. More...
 
void accept (ModelVisitor visitor)
 Accepts the given visitor. More...
 
String toString ()
 
Solver solver ()
 
void freezeQueue ()
 This method freezes the propagation queue. More...
 
void unfreezeQueue ()
 This method unfreezes the propagation queue. More...
 
void enqueueDelayedDemon (Demon d)
 This method pushes the demon onto the propagation queue. More...
 
void enqueueVar (Demon d)
 
void reset_action_on_fail ()
 This method clears the failure callback. More...
 
void set_variable_to_clean_on_fail (IntVar v)
 Shortcut for variable cleaner. More...
 
String name ()
 Object naming. More...
 
void setName (String name)
 
boolean hasName ()
 Returns whether the object has been named or not. More...
 
String baseName ()
 Returns a base name for automatic naming. More...
 

Protected Member Functions

 IntExpr (long cPtr, boolean cMemoryOwn)
 

Constructor & Destructor Documentation

◆ IntExpr()

IntExpr ( long  cPtr,
boolean  cMemoryOwn 
)
inlineprotected

Definition at line 17 of file IntExpr.java.

Member Function Documentation

◆ accept()

void accept ( ModelVisitor  visitor)
inline

Accepts the given visitor.

Reimplemented in IntVar.

Definition at line 126 of file IntExpr.java.

◆ baseName()

String baseName ( )
inlineinherited

Returns a base name for automatic naming.

Reimplemented in BooleanVar.

Definition at line 115 of file PropagationBaseObject.java.

◆ bound()

boolean bound ( )
inline

Returns true if the min and the max of the expression are equal.

Reimplemented in BooleanVar.

Definition at line 82 of file IntExpr.java.

◆ delete()

synchronized void delete ( )
inline

Reimplemented from PropagationBaseObject.

Reimplemented in BaseIntExpr, IntVar, and BooleanVar.

Definition at line 31 of file IntExpr.java.

◆ enqueueDelayedDemon()

void enqueueDelayedDemon ( Demon  d)
inlineinherited

This method pushes the demon onto the propagation queue.

It will be processed directly if the queue is empty. It will be enqueued according to its priority otherwise.

Definition at line 72 of file PropagationBaseObject.java.

◆ enqueueVar()

void enqueueVar ( Demon  d)
inlineinherited

Definition at line 76 of file PropagationBaseObject.java.

◆ freezeQueue()

void freezeQueue ( )
inlineinherited

This method freezes the propagation queue.

It is useful when you need to apply multiple modifications at once.

Definition at line 58 of file PropagationBaseObject.java.

◆ hasName()

boolean hasName ( )
inlineinherited

Returns whether the object has been named or not.

Definition at line 108 of file PropagationBaseObject.java.

◆ isVar()

boolean isVar ( )
inline

Returns true if the expression is indeed a variable.

Reimplemented in IntVar.

Definition at line 89 of file IntExpr.java.

◆ max()

long max ( )
inline

Reimplemented in BooleanVar.

Definition at line 50 of file IntExpr.java.

◆ min()

long min ( )
inline

Reimplemented in BooleanVar.

Definition at line 42 of file IntExpr.java.

◆ name()

String name ( )
inlineinherited

Object naming.

Definition at line 97 of file PropagationBaseObject.java.

◆ range()

void range ( int[]  l,
int[]  u 
)
inline

By default calls Min() and Max(), but can be redefined when Min and Max code can be factorized.

Definition at line 61 of file IntExpr.java.

◆ reset_action_on_fail()

void reset_action_on_fail ( )
inlineinherited

This method clears the failure callback.

Definition at line 83 of file PropagationBaseObject.java.

◆ set_variable_to_clean_on_fail()

void set_variable_to_clean_on_fail ( IntVar  v)
inlineinherited

Shortcut for variable cleaner.

Definition at line 90 of file PropagationBaseObject.java.

◆ setMax()

void setMax ( long  m)
inline

Reimplemented in BooleanVar.

Definition at line 54 of file IntExpr.java.

◆ setMin()

void setMin ( long  m)
inline

Reimplemented in BooleanVar.

Definition at line 46 of file IntExpr.java.

◆ setName()

void setName ( String  name)
inlineinherited

Definition at line 101 of file PropagationBaseObject.java.

◆ setRange()

void setRange ( long  l,
long  u 
)
inline

This method sets both the min and the max of the expression.

Reimplemented in BooleanVar.

Definition at line 68 of file IntExpr.java.

◆ setValue()

void setValue ( long  v)
inline

This method sets the value of the expression.

Definition at line 75 of file IntExpr.java.

◆ solver()

Solver solver ( )
inlineinherited

Definition at line 50 of file PropagationBaseObject.java.

◆ toString()

String toString ( )
inlineinherited

Reimplemented from BaseObject.

Reimplemented in Assignment, Pack, BooleanVar, Constraint, GlobalVehicleBreaksConstraint, and SequenceVar.

Definition at line 46 of file PropagationBaseObject.java.

◆ unfreezeQueue()

void unfreezeQueue ( )
inlineinherited

This method unfreezes the propagation queue.

All modifications that happened when the queue was frozen will be processed.

Definition at line 65 of file PropagationBaseObject.java.

◆ var()

IntVar var ( )
inline

Creates a variable from the expression.

Reimplemented in IntVar, and BaseIntExpr.

Definition at line 96 of file IntExpr.java.

◆ varWithName()

IntVar varWithName ( String  name)
inline

Creates a variable from the expression and set the name of the resulting var.

If the expression is already a variable, then it will set the name of the expression, possibly overwriting it. This is just a shortcut to Var() followed by set_name().

Definition at line 104 of file IntExpr.java.

◆ whenRange() [1/2]

void whenRange ( Demon  d)
inline

Attach a demon that will watch the min or the max of the expression.

Reimplemented in BooleanVar.

Definition at line 112 of file IntExpr.java.

◆ whenRange() [2/2]

void whenRange ( Runnable  closure)
inline

Attach a demon that will watch the min or the max of the expression.

Definition at line 119 of file IntExpr.java.


The documentation for this class was generated from the following file: