C++ Reference

C++ Reference: CP-SAT

Detailed Description

A constraint.

This class enables you to modify the constraint that was previously added to the model.

The constraint must be built using the different CpModelBuilder::AddXXX methods.

Definition at line 402 of file cp_model.h.

Public Member Functions

Constraint OnlyEnforceIf (absl::Span< const BoolVar > literals)
 The constraint will be enforced iff all literals listed here are true. More...
 
Constraint OnlyEnforceIf (BoolVar literal)
 See OnlyEnforceIf(absl::Span<const BoolVar> literals). More...
 
Constraint WithName (const std::string &name)
 Sets the name of the constraint. More...
 
const std::string & Name () const
 Returns the name of the constraint (or the empty string if not set). More...
 
const ConstraintProto & Proto () const
 Returns the underlying protobuf object (useful for testing). More...
 
ConstraintProto * MutableProto () const
 Returns the mutable underlying protobuf object (useful for model edition). More...
 

Protected Member Functions

 Constraint (ConstraintProto *proto)
 

Protected Attributes

ConstraintProto * proto_ = nullptr
 

Constructor & Destructor Documentation

◆ Constraint()

Constraint ( ConstraintProto *  proto)
explicitprotected

Member Function Documentation

◆ MutableProto()

ConstraintProto* MutableProto ( ) const
inline

Returns the mutable underlying protobuf object (useful for model edition).

Definition at line 436 of file cp_model.h.

◆ Name()

const std::string& Name ( ) const

Returns the name of the constraint (or the empty string if not set).

◆ OnlyEnforceIf() [1/2]

Constraint OnlyEnforceIf ( absl::Span< const BoolVar literals)

The constraint will be enforced iff all literals listed here are true.

If this is empty, then the constraint will always be enforced. An enforced constraint must be satisfied, and an un-enforced one will simply be ignored.

This is also called half-reification. To have an equivalence between a literal and a constraint (full reification), one must add both a constraint (controlled by a literal l) and its negation (controlled by the negation of l).

Important: as of September 2018, only a few constraint support enforcement:

  • bool_or, bool_and, linear: fully supported.
  • interval: only support a single enforcement literal.
  • other: no support (but can be added on a per-demand basis).

◆ OnlyEnforceIf() [2/2]

◆ Proto()

const ConstraintProto& Proto ( ) const
inline

Returns the underlying protobuf object (useful for testing).

Definition at line 433 of file cp_model.h.

◆ WithName()

Constraint WithName ( const std::string &  name)

Sets the name of the constraint.

Member Data Documentation

◆ proto_

ConstraintProto* proto_ = nullptr
protected

Definition at line 443 of file cp_model.h.


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