ReservoirConstraint

Detailed Description

Specialized reservoir constraint.

This constraint allows adding emptying/refilling events to the reservoir constraint incrementally.

Definition at line 640 of file cp_model.h.

Public Member Functions
void	AddEvent (LinearExpr time, int64_t level_change)
	Adds a mandatory event. More...
void	AddOptionalEvent (LinearExpr time, int64_t level_change, BoolVar is_active)
	Adds an optional event. More...
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 Attributes
ConstraintProto *	proto_ = nullptr

Member Function Documentation

AddEvent()

void AddEvent	(	LinearExpr	time,
		int64_t	level_change
	)

Adds a mandatory event.

It will increase the used capacity by level_change at time time. time must be an affine expression.

Definition at line 536 of file cp_model.cc.

AddOptionalEvent()

void AddOptionalEvent	(	LinearExpr	time,
		int64_t	level_change,
		BoolVar	is_active
	)

Adds an optional event.

If is_active is true, It will increase the used capacity by level_change at time time.time` must be an affine expression.

Definition at line 544 of file cp_model.cc.

MutableProto()

ConstraintProto* MutableProto ( ) const

inlineinherited

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

Definition at line 562 of file cp_model.h.

Name()

const std::string & Name ( ) const

inherited

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

Definition at line 499 of file cp_model.cc.

OnlyEnforceIf() [1/2]

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

inherited

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] currently, only a few constraints 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).

Definition at line 501 of file cp_model.cc.

OnlyEnforceIf() [2/2]

Constraint OnlyEnforceIf ( BoolVar  literal )

inherited

See OnlyEnforceIf(absl::Span<const BoolVar> literals).

Definition at line 508 of file cp_model.cc.

Proto()

const ConstraintProto& Proto ( ) const

inlineinherited

Returns the underlying protobuf object (useful for testing).

Definition at line 559 of file cp_model.h.

WithName()

Constraint WithName ( const std::string &  name )

inherited

Sets the name of the constraint.

Definition at line 494 of file cp_model.cc.

Member Data Documentation

proto_

ConstraintProto* proto_ = nullptr

protectedinherited

Definition at line 569 of file cp_model.h.

---

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

• cp_model.h
• cp_model.cc