OR-Tools  8.2
CastConstraintabstract

Detailed Description

Cast constraints are special channeling constraints designed to keep a variable in sync with an expression.

They are created internally when Var() is called on a subclass of IntExpr.

Definition at line 3620 of file constraint_solver.h.

Public Member Functions

 CastConstraint (Solver *const solver, IntVar *const target_var)
 
 ~CastConstraint () override
 
IntVartarget_var () const
 
virtual void Post ()=0
 This method is called when the constraint is processed by the solver. More...
 
virtual void InitialPropagate ()=0
 This method performs the initial propagation of the constraint. More...
 
std::string DebugString () const override
 
void PostAndPropagate ()
 Calls Post and then Propagate to initialize the constraints. More...
 
virtual void Accept (ModelVisitor *const visitor) const
 Accepts the given visitor. More...
 
bool IsCastConstraint () const
 Is the constraint created by a cast from expression to integer variable? More...
 
virtual IntVarVar ()
 Creates a Boolean variable representing the status of the constraint (false = constraint is violated, true = constraint is satisfied). More...
 
Solversolver () const
 
void FreezeQueue ()
 This method freezes the propagation queue. More...
 
void UnfreezeQueue ()
 This method unfreezes the propagation queue. More...
 
void EnqueueDelayedDemon (Demon *const d)
 This method pushes the demon onto the propagation queue. More...
 
void EnqueueVar (Demon *const d)
 
void ExecuteAll (const SimpleRevFIFO< Demon * > &demons)
 
void EnqueueAll (const SimpleRevFIFO< Demon * > &demons)
 
void set_action_on_fail (Solver::Action a)
 
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...
 
virtual std::string name () const
 Object naming. More...
 
void set_name (const std::string &name)
 
bool HasName () const
 Returns whether the object has been named or not. More...
 
virtual std::string BaseName () const
 Returns a base name for automatic naming. More...
 

Protected Attributes

IntVar *const target_var_
 

Constructor & Destructor Documentation

◆ CastConstraint()

CastConstraint ( Solver *const  solver,
IntVar *const  target_var 
)
inline

Definition at line 3622 of file constraint_solver.h.

◆ ~CastConstraint()

~CastConstraint ( )
inlineoverride

Definition at line 3626 of file constraint_solver.h.

Member Function Documentation

◆ Accept()

void Accept ( ModelVisitor *const  visitor) const
virtualinherited

Accepts the given visitor.

Reimplemented in IfThenElseCt, and Pack.

Definition at line 3247 of file constraint_solver.cc.

◆ BaseName()

std::string BaseName ( ) const
virtualinherited

Returns a base name for automatic naming.

Reimplemented in BooleanVar.

Definition at line 2515 of file constraint_solver.cc.

◆ DebugString()

std::string DebugString ( ) const
overridevirtualinherited

Reimplemented from PropagationBaseObject.

Reimplemented in GlobalVehicleBreaksConstraint, IfThenElseCt, and Pack.

Definition at line 3237 of file constraint_solver.cc.

◆ EnqueueAll()

void EnqueueAll ( const SimpleRevFIFO< Demon * > &  demons)
inherited

Definition at line 2521 of file constraint_solver.cc.

◆ EnqueueDelayedDemon()

void EnqueueDelayedDemon ( Demon *const  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 3192 of file constraint_solver.h.

◆ EnqueueVar()

void EnqueueVar ( Demon *const  d)
inlineinherited

Definition at line 3193 of file constraint_solver.h.

◆ ExecuteAll()

void ExecuteAll ( const SimpleRevFIFO< Demon * > &  demons)
inherited

Definition at line 2517 of file constraint_solver.cc.

◆ 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 3183 of file constraint_solver.h.

◆ HasName()

bool HasName ( ) const
inherited

Returns whether the object has been named or not.

Definition at line 2513 of file constraint_solver.cc.

◆ InitialPropagate()

virtual void InitialPropagate ( )
pure virtualinherited

This method performs the initial propagation of the constraint.

It is called just after the post.

Implemented in TypeRegulationsConstraint, GlobalVehicleBreaksConstraint, IfThenElseCt, and Pack.

◆ IsCastConstraint()

bool IsCastConstraint ( ) const
inherited

Is the constraint created by a cast from expression to integer variable?

Definition at line 3253 of file constraint_solver.cc.

◆ name()

std::string name ( ) const
virtualinherited

Object naming.

Reimplemented in PiecewiseLinearExpr.

Definition at line 2505 of file constraint_solver.cc.

◆ Post()

virtual void Post ( )
pure virtualinherited

This method is called when the constraint is processed by the solver.

Its main usage is to attach demons to variables.

Implemented in TypeRegulationsConstraint, GlobalVehicleBreaksConstraint, IfThenElseCt, and Pack.

◆ PostAndPropagate()

void PostAndPropagate ( )
inherited

Calls Post and then Propagate to initialize the constraints.

This is usually done in the root node.

Definition at line 3239 of file constraint_solver.cc.

◆ reset_action_on_fail()

void reset_action_on_fail ( )
inlineinherited

This method clears the failure callback.

Definition at line 3206 of file constraint_solver.h.

◆ set_action_on_fail()

void set_action_on_fail ( Solver::Action  a)
inlineinherited

Definition at line 3200 of file constraint_solver.h.

◆ set_name()

void set_name ( const std::string &  name)
inherited

Definition at line 2509 of file constraint_solver.cc.

◆ set_variable_to_clean_on_fail()

void set_variable_to_clean_on_fail ( IntVar v)
inlineinherited

Shortcut for variable cleaner.

Definition at line 3209 of file constraint_solver.h.

◆ solver()

Solver* solver ( ) const
inlineinherited

Definition at line 3179 of file constraint_solver.h.

◆ target_var()

IntVar* target_var ( ) const
inline

Definition at line 3628 of file constraint_solver.h.

◆ 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 3187 of file constraint_solver.h.

◆ Var()

IntVar * Var ( )
virtualinherited

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 3257 of file constraint_solver.cc.

Member Data Documentation

◆ target_var_

IntVar* const target_var_
protected

Definition at line 3631 of file constraint_solver.h.


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