38 #ifndef OR_TOOLS_SAT_CP_MODEL_H_
39 #define OR_TOOLS_SAT_CP_MODEL_H_
43 #include "absl/container/flat_hash_map.h"
44 #include "absl/types/span.h"
45 #include "ortools/sat/cp_model.pb.h"
49 #include "ortools/sat/sat_parameters.pb.h"
75 const std::string&
Name()
const {
return Proto().name(); }
82 return other.cp_model_ == cp_model_ && other.index_ == index_;
87 return other.cp_model_ != cp_model_ || other.index_ != index_;
94 const IntegerVariableProto&
Proto()
const {
95 return cp_model_->variables(index_);
100 return cp_model_->mutable_variables(index_);
109 int index()
const {
return index_; }
124 CpModelProto* cp_model_ =
nullptr;
161 const std::string&
Name()
const {
return Proto().name(); }
169 return other.cp_model_ == cp_model_ && other.index_ == index_;
174 return other.cp_model_ != cp_model_ || other.index_ != index_;
181 const IntegerVariableProto&
Proto()
const {
182 return cp_model_->variables(index_);
187 return cp_model_->mutable_variables(index_);
191 int index()
const {
return index_; }
207 CpModelProto* cp_model_ =
nullptr;
279 absl::Span<const int64> coeffs);
286 absl::Span<const int64> coeffs);
291 const std::vector<IntVar>&
variables()
const {
return variables_; }
294 const std::vector<int64>&
coefficients()
const {
return coefficients_; }
302 std::vector<IntVar> variables_;
303 std::vector<int64> coefficients_;
335 std::string
Name()
const;
355 return other.cp_model_ == cp_model_ && other.index_ == index_;
360 return other.cp_model_ != cp_model_ || other.index_ != index_;
367 const IntervalConstraintProto&
Proto()
const {
368 return cp_model_->constraints(index_).interval();
373 return cp_model_->mutable_constraints(index_)->mutable_interval();
377 int index()
const {
return index_; }
387 CpModelProto* cp_model_ =
nullptr;
430 const std::string&
Name()
const;
500 void AddTuple(absl::Span<const int64> tuple);
663 absl::Span<const IntVar> variables,
734 absl::Span<const IntVar> inverse_variables);
784 absl::Span<const IntVar> transition_variables,
int starting_state,
785 absl::Span<const int> final_states);
792 absl::Span<const LinearExpr> exprs);
799 absl::Span<const LinearExpr> exprs);
849 absl::Span<const IntVar> variables,
850 DecisionStrategyProto::VariableSelectionStrategy var_strategy,
851 DecisionStrategyProto::DomainReductionStrategy domain_strategy);
855 absl::Span<const BoolVar> variables,
856 DecisionStrategyProto::VariableSelectionStrategy var_strategy,
857 DecisionStrategyProto::DomainReductionStrategy domain_strategy);
878 const CpModelProto&
Proto()
const {
return cp_model_; }
898 void LinearExprToProto(
const LinearExpr& expr,
899 LinearExpressionProto* expr_proto);
909 int GetOrCreateIntegerIndex(
int index);
912 LinearConstraintProto*
proto);
914 CpModelProto cp_model_;
915 absl::flat_hash_map<int64, int> constant_to_index_map_;
916 absl::flat_hash_map<int, int> bool_to_integer_index_map_;
We call domain any subset of Int64 = [kint64min, kint64max].
Specialized automaton constraint.
void AddTransition(int tail, int head, int64 transition_label)
Adds a transitions to the automaton.
IntegerVariableProto * MutableProto() const
Returns the mutable underlying protobuf object (useful for model edition).
const std::string & Name() const
Returns the name of the variable.
BoolVar WithName(const std::string &name)
Sets the name of the variable.
std::string DebugString() const
Debug string.
friend bool SolutionBooleanValue(const CpSolverResponse &r, BoolVar x)
Evaluates the value of a Boolean literal in a solver response.
bool operator!=(const BoolVar &other) const
Dis-Equality test.
bool operator==(const BoolVar &other) const
Equality test with another boolvar.
int index() const
Returns the index of the variable in the model.
BoolVar Not() const
Returns the logical negation of the current Boolean variable.
const IntegerVariableProto & Proto() const
Returns the underlying protobuf object (useful for testing).
Specialized circuit constraint.
void AddArc(int tail, int head, BoolVar literal)
Add an arc to the circuit.
Constraint OnlyEnforceIf(absl::Span< const BoolVar > literals)
The constraint will be enforced iff all literals listed here are true.
Constraint WithName(const std::string &name)
Sets the name of the constraint.
const ConstraintProto & Proto() const
Returns the underlying protobuf object (useful for testing).
const std::string & Name() const
Returns the name of the constraint (or the empty string if not set).
ConstraintProto * MutableProto() const
Returns the mutable underlying protobuf object (useful for model edition).
Constraint(ConstraintProto *proto)
Wrapper class around the cp_model proto.
IntVar NewConstant(int64 value)
Creates a constant variable.
TableConstraint AddForbiddenAssignments(absl::Span< const IntVar > vars)
Adds an forbidden assignments constraint.
Constraint AddLinearConstraint(const LinearExpr &expr, const Domain &domain)
Adds expr in domain.
void ClearAssumptions()
Remove all assumptions from the model.
Constraint AddAbsEquality(IntVar target, IntVar var)
Adds target == abs(var).
void AddAssumptions(absl::Span< const BoolVar > literals)
Adds multiple literals to the model as assumptions.
ReservoirConstraint AddReservoirConstraint(int64 min_level, int64 max_level)
Adds a reservoir constraint with optional refill/emptying events.
MultipleCircuitConstraint AddMultipleCircuitConstraint()
Adds a multiple circuit constraint, aka the "VRP" (Vehicle Routing Problem) constraint.
Constraint AddMinEquality(IntVar target, absl::Span< const IntVar > vars)
Adds target == min(vars).
BoolVar TrueVar()
Creates an always true Boolean variable.
IntVar NewIntVar(const Domain &domain)
Creates an integer variable with the given domain.
Constraint AddMaxEquality(IntVar target, absl::Span< const IntVar > vars)
Adds target == max(vars).
Constraint AddDivisionEquality(IntVar target, IntVar numerator, IntVar denominator)
Adds target = num / denom (integer division rounded towards 0).
void ClearHints()
Remove all hints.
void Maximize(const LinearExpr &expr)
Adds a linear maximization objective.
IntervalVar NewOptionalIntervalVar(IntVar start, IntVar size, IntVar end, BoolVar presence)
Creates an optional interval variable.
BoolVar NewBoolVar()
Creates a Boolean variable.
void AddDecisionStrategy(absl::Span< const IntVar > variables, DecisionStrategyProto::VariableSelectionStrategy var_strategy, DecisionStrategyProto::DomainReductionStrategy domain_strategy)
Adds a decision strategy on a list of integer variables.
void ScaleObjectiveBy(double scaling)
Sets scaling of the objective.
CircuitConstraint AddCircuitConstraint()
Adds a circuit constraint.
Constraint AddVariableElement(IntVar index, absl::Span< const IntVar > variables, IntVar target)
Adds the element constraint: variables[index] == target.
const CpModelProto & Proto() const
CumulativeConstraint AddCumulative(IntVar capacity)
The cumulative constraint.
const CpModelProto & Build() const
Constraint AddGreaterThan(const LinearExpr &left, const LinearExpr &right)
Adds left > right.
void CopyFrom(const CpModelProto &model_proto)
Replace the current model with the one from the given proto.
Constraint AddLessThan(const LinearExpr &left, const LinearExpr &right)
Adds left < right.
Constraint AddBoolXor(absl::Span< const BoolVar > literals)
Adds the constraint that a odd number of literal is true.
void AddAssumption(BoolVar lit)
Adds a literal to the model as assumptions.
void Minimize(const LinearExpr &expr)
Adds a linear minimization objective.
BoolVar FalseVar()
Creates an always false Boolean variable.
Constraint AddImplication(BoolVar a, BoolVar b)
Adds a => b.
Constraint AddBoolAnd(absl::Span< const BoolVar > literals)
Adds the constraint that all literals must be true.
IntervalVar GetIntervalVarFromProtoIndex(int index)
Returns the interval variable from its index in the proto.
Constraint AddLessOrEqual(const LinearExpr &left, const LinearExpr &right)
Adds left <= right.
Constraint AddModuloEquality(IntVar target, IntVar var, IntVar mod)
Adds target = var % mod.
Constraint AddEquality(const LinearExpr &left, const LinearExpr &right)
Adds left == right.
NoOverlap2DConstraint AddNoOverlap2D()
The no_overlap_2d constraint prevents a set of boxes from overlapping.
Constraint AddElement(IntVar index, absl::Span< const int64 > values, IntVar target)
Adds the element constraint: values[index] == target.
Constraint AddGreaterOrEqual(const LinearExpr &left, const LinearExpr &right)
Adds left >= right.
Constraint AddBoolOr(absl::Span< const BoolVar > literals)
Adds the constraint that at least one of the literals must be true.
IntVar GetIntVarFromProtoIndex(int index)
Returns the integer variable from its index in the proto.
AutomatonConstraint AddAutomaton(absl::Span< const IntVar > transition_variables, int starting_state, absl::Span< const int > final_states)
An automaton constraint/.
void AddHint(IntVar var, int64 value)
Adds hinting to a variable.
Constraint AddLinMinEquality(const LinearExpr &target, absl::Span< const LinearExpr > exprs)
Adds target == min(exprs).
Constraint AddProductEquality(IntVar target, absl::Span< const IntVar > vars)
Adds target == prod(vars).
Constraint AddLinMaxEquality(const LinearExpr &target, absl::Span< const LinearExpr > exprs)
Adds target == max(exprs).
BoolVar GetBoolVarFromProtoIndex(int index)
Returns the Boolean variable from its index in the proto.
Constraint AddNotEqual(const LinearExpr &left, const LinearExpr &right)
Adds left != right.
CpModelProto * MutableProto()
Constraint AddAllDifferent(absl::Span< const IntVar > vars)
this constraint forces all variables to have different values.
TableConstraint AddAllowedAssignments(absl::Span< const IntVar > vars)
Adds an allowed assignments constraint.
Constraint AddInverseConstraint(absl::Span< const IntVar > variables, absl::Span< const IntVar > inverse_variables)
An inverse constraint.
IntervalVar NewIntervalVar(IntVar start, IntVar size, IntVar end)
Creates an interval variable.
Constraint AddNoOverlap(absl::Span< const IntervalVar > vars)
Adds a no-overlap constraint that ensures that all present intervals do not overlap in time.
Specialized cumulative constraint.
void AddDemand(IntervalVar interval, IntVar demand)
Adds a pair (interval, demand) to the constraint.
IntegerVariableProto * MutableProto() const
Returns the mutable underlying protobuf object (useful for model edition).
const std::string & Name() const
Returns the name of the variable (or the empty string if not set).
BoolVar ToBoolVar() const
Cast IntVar -> BoolVar.
LinearExpr AddConstant(int64 value) const
Adds a constant value to an integer variable and returns a linear expression.
bool operator==(const IntVar &other) const
Equality test with another IntVar.
friend int64 SolutionIntegerValue(const CpSolverResponse &r, const LinearExpr &expr)
Evaluates the value of an linear expression in a solver response.
std::string DebugString() const
Returns a debug string.
friend int64 SolutionIntegerMax(const CpSolverResponse &r, IntVar x)
Returns the max of an integer variable in a solution.
bool operator!=(const IntVar &other) const
Difference test with anpther IntVar.
IntVar WithName(const std::string &name)
Sets the name of the variable.
friend int64 SolutionIntegerMin(const CpSolverResponse &r, IntVar x)
Returns the min of an integer variable in a solution.
int index() const
Returns the index of the variable in the model.
const IntegerVariableProto & Proto() const
Returns the underlying protobuf object (useful for testing).
Represents a Interval variable.
BoolVar PresenceBoolVar() const
Returns a BoolVar indicating the presence of this interval.
std::string Name() const
Returns the name of the interval (or the empty string if not set).
IntVar SizeVar() const
Returns the size variable.
std::string DebugString() const
Returns a debug string.
bool operator!=(const IntervalVar &other) const
Difference test with another interval variable.
bool operator==(const IntervalVar &other) const
Equality test with another interval variable.
IntervalVar WithName(const std::string &name)
Sets the name of the variable.
IntVar EndVar() const
Returns the end variable.
const IntervalConstraintProto & Proto() const
Returns the underlying protobuf object (useful for testing).
IntervalConstraintProto * MutableProto() const
Returns the mutable underlying protobuf object (useful for model edition).
IntervalVar()
Default ctor.
int index() const
Returns the index of the interval constraint in the model.
friend std::ostream & operator<<(std::ostream &os, const IntervalVar &var)
IntVar StartVar() const
Returns the start variable.
A dedicated container for linear expressions.
static LinearExpr Term(IntVar var, int64 coefficient)
Construncts var * coefficient.
static LinearExpr ScalProd(absl::Span< const IntVar > vars, absl::Span< const int64 > coeffs)
Constructs the scalar product of variables and coefficients.
LinearExpr & AddConstant(int64 value)
Adds a constant value to the linear expression.
static LinearExpr BooleanScalProd(absl::Span< const BoolVar > vars, absl::Span< const int64 > coeffs)
Constructs the scalar product of Booleans and coefficients.
static LinearExpr Sum(absl::Span< const IntVar > vars)
Constructs the sum of a list of variables.
static LinearExpr BooleanSum(absl::Span< const BoolVar > vars)
Constructs the sum of a list of Booleans.
const std::vector< IntVar > & variables() const
Returns the vector of variables.
void AddTerm(IntVar var, int64 coeff)
Adds a term (var * coeff) to the linear expression.
void AddVar(IntVar var)
Adds a single integer variable to the linear expression.
const std::vector< int64 > & coefficients() const
Returns the vector of coefficients.
int64 constant() const
Returns the constant term.
Specialized circuit constraint.
void AddArc(int tail, int head, BoolVar literal)
Add an arc to the circuit.
Specialized no_overlap2D constraint.
void AddRectangle(IntervalVar x_coordinate, IntervalVar y_coordinate)
Adds a rectangle (parallel to the axis) to the constraint.
Specialized reservoir constraint.
void AddEvent(IntVar time, int64 demand)
Adds a mandatory event.
void AddOptionalEvent(IntVar time, int64 demand, BoolVar is_active)
Adds a optional event.
Specialized assignment constraint.
void AddTuple(absl::Span< const int64 > tuple)
Adds a tuple of possible values to the constraint.
CpModelProto const * model_proto
static const int32 kint32min
std::ostream & operator<<(std::ostream &os, const BoolVar &var)
int64 SolutionIntegerValue(const CpSolverResponse &r, const LinearExpr &expr)
Evaluates the value of an linear expression in a solver response.
int64 SolutionIntegerMax(const CpSolverResponse &r, IntVar x)
Returns the max of an integer variable in a solution.
BoolVar Not(BoolVar x)
A convenient wrapper so we can write Not(x) instead of x.Not() which is sometimes clearer.
bool SolutionBooleanValue(const CpSolverResponse &r, BoolVar x)
Evaluates the value of a Boolean literal in a solver response.
int64 SolutionIntegerMin(const CpSolverResponse &r, IntVar x)
Returns the min of an integer variable in a solution.
The vehicle routing library lets one model and solve generic vehicle routing problems ranging from th...