Java Reference
Java Reference
Detailed Description
A constraint is the main modeling object.
It provides two methods: - Post() is responsible for creating the demons and attaching them to immediate demons(). - InitialPropagate() is called once just after Post and performs the initial propagation. The subsequent propagations will be performed by the demons Posted during the post() method.
Definition at line 14 of file gen/java/com/google/ortools/constraintsolver/Constraint.java.
Public Member Functions | |
| synchronized void | delete () |
| void | post () |
| This method is called when the constraint is processed by the solver. More... | |
| void | initialPropagate () |
| This method performs the initial propagation of the constraint. More... | |
| String | toString () |
| void | postAndPropagate () |
| Calls Post and then Propagate to initialize the constraints. More... | |
| void | accept (ModelVisitor visitor) |
| Accepts the given visitor. More... | |
| boolean | isCastConstraint () |
| Is the constraint created by a cast from expression to integer variable? More... | |
| IntVar | var () |
| Creates a Boolean variable representing the status of the constraint (false = constraint is violated, true = constraint is satisfied). More... | |
| 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 | |
| Constraint (long cPtr, boolean cMemoryOwn) | |
Constructor & Destructor Documentation
◆ Constraint()
|
inlineprotected |
Definition at line 17 of file gen/java/com/google/ortools/constraintsolver/Constraint.java.
Member Function Documentation
◆ accept()
|
inline |
Accepts the given visitor.
Reimplemented in Pack.
Definition at line 70 of file gen/java/com/google/ortools/constraintsolver/Constraint.java.
◆ baseName()
|
inlineinherited |
Returns a base name for automatic naming.
Reimplemented in BooleanVar.
Definition at line 115 of file PropagationBaseObject.java.
◆ delete()
|
inline |
Reimplemented from PropagationBaseObject.
Reimplemented in Pack, DisjunctiveConstraint, CastConstraint, GlobalVehicleBreaksConstraint, and TypeRegulationsConstraint.
Definition at line 31 of file gen/java/com/google/ortools/constraintsolver/Constraint.java.
◆ enqueueDelayedDemon()
|
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()
|
inlineinherited |
Definition at line 76 of file PropagationBaseObject.java.
◆ 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()
|
inlineinherited |
Returns whether the object has been named or not.
Definition at line 108 of file PropagationBaseObject.java.
◆ initialPropagate()
|
inline |
This method performs the initial propagation of the constraint.
It is called just after the post.
Reimplemented in Pack, GlobalVehicleBreaksConstraint, and TypeRegulationsConstraint.
Definition at line 52 of file gen/java/com/google/ortools/constraintsolver/Constraint.java.
◆ isCastConstraint()
|
inline |
Is the constraint created by a cast from expression to integer variable?
Definition at line 77 of file gen/java/com/google/ortools/constraintsolver/Constraint.java.
◆ name()
|
inlineinherited |
Object naming.
Definition at line 97 of file PropagationBaseObject.java.
◆ post()
|
inline |
This method is called when the constraint is processed by the solver.
Its main usage is to attach demons to variables.
Reimplemented in Pack, GlobalVehicleBreaksConstraint, and TypeRegulationsConstraint.
Definition at line 45 of file gen/java/com/google/ortools/constraintsolver/Constraint.java.
◆ postAndPropagate()
|
inline |
Calls Post and then Propagate to initialize the constraints.
This is usually done in the root node.
Definition at line 63 of file gen/java/com/google/ortools/constraintsolver/Constraint.java.
◆ 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()
|
inlineinherited |
Shortcut for variable cleaner.
Definition at line 90 of file PropagationBaseObject.java.
◆ setName()
|
inlineinherited |
Definition at line 101 of file PropagationBaseObject.java.
◆ solver()
|
inlineinherited |
Definition at line 50 of file PropagationBaseObject.java.
◆ toString()
|
inline |
Reimplemented from PropagationBaseObject.
Reimplemented in Pack, and GlobalVehicleBreaksConstraint.
Definition at line 56 of file gen/java/com/google/ortools/constraintsolver/Constraint.java.
◆ 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()
|
inline |
Creates a Boolean variable representing the status of the constraint (false = constraint is violated, true = constraint is satisfied).
It returns nullptr if the constraint does not support this API.
Definition at line 84 of file gen/java/com/google/ortools/constraintsolver/Constraint.java.
The documentation for this class was generated from the following file: