Generated on: Thu Mar 29 07:46:58 PDT 2012 for custom file set
// doxy/ or-tools/ src/ constraint_solver/

operations_research::Constraint Class Reference

A constraint is the main modeling object. More...

#include <constraint_solver.h>

Inheritance diagram for operations_research::Constraint:

operations_research::PropagationBaseObject operations_research::BaseObject operations_research::CastConstraint operations_research::Pack

List of all members.

Public Member Functions

 Constraint (Solver *const solver)
virtual ~Constraint ()
virtual void Post ()=0
 This method is called when the constraint is processed by the solver.
virtual void InitialPropagate ()=0
 This method performs the initial propagation of the constraint.
virtual string DebugString () const
 Constraint class.
void PostAndPropagate ()
 Calls Post and then Propagate to initialize the constraints.
virtual void Accept (ModelVisitor *const visitor) const
 Accepts the given visitor.
bool IsCastConstraint () const
 Is the constraint created by a cast from expression to integer variable?
virtual IntVarVar ()
 Creates an boolean variable representing the status of the variable (false = constraint is violated, true constraint is satisfied).


Detailed Description

A constraint is the main modeling object.

It proposes two methods:

Definition at line 3435 of file constraint_solver.h.


Constructor & Destructor Documentation

operations_research::Constraint::Constraint ( Solver *const   solver  )  [inline, explicit]

Definition at line 3437 of file constraint_solver.h.

virtual operations_research::Constraint::~Constraint (  )  [inline, virtual]

Definition at line 3438 of file constraint_solver.h.


Member Function Documentation

virtual void operations_research::Constraint::Post (  )  [pure virtual]

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

Its main usage is to attach demons to variables.

Implemented in operations_research::Pack.

virtual void operations_research::Constraint::InitialPropagate (  )  [pure virtual]

This method performs the initial propagation of the constraint.

It is called just after the post.

Implemented in operations_research::Pack.

string operations_research::Constraint::DebugString (  )  const [virtual]

Constraint class.

Reimplemented from operations_research::PropagationBaseObject.

Reimplemented in operations_research::Pack.

Definition at line 3233 of file constraint_solver.cc.

void operations_research::Constraint::PostAndPropagate (  ) 

Calls Post and then Propagate to initialize the constraints.

This is usually done in the root node.

Definition at line 3237 of file constraint_solver.cc.

void operations_research::Constraint::Accept ( ModelVisitor *const   visitor  )  const [virtual]

Accepts the given visitor.

Reimplemented in operations_research::Pack.

Definition at line 3244 of file constraint_solver.cc.

bool operations_research::Constraint::IsCastConstraint (  )  const

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

Definition at line 3249 of file constraint_solver.cc.

IntVar * operations_research::Constraint::Var (  )  [virtual]

Creates an boolean variable representing the status of the variable (false = constraint is violated, true constraint is satisfied).

It returns NULL if the constraint does not support his API.

Definition at line 3253 of file constraint_solver.cc.


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