always-cautious/ortools-clone
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
8fe2df9a185c810d3be6c8294114b1b4e0d5ee6a
ortools-clone/ortools/sat/cp_model_utils.cc

575 lines
21 KiB
C++
Raw Blame History

// Copyright 2010-2021 Google LLC
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
#include "ortools/sat/cp_model_utils.h"
#include <cstdint>
#include <cstdlib>
#include <functional>
#include <string>
#include <vector>
#include "absl/container/flat_hash_map.h"
#include "ortools/base/logging.h"
#include "ortools/base/stl_util.h"
#include "ortools/sat/cp_model.pb.h"
#include "ortools/util/sorted_interval_list.h"
namespace operations_research {
namespace sat {
namespace {
template <typename IntList>
void AddIndices(const IntList& indices, std::vector<int>* output) {
output->insert(output->end(), indices.begin(), indices.end());
}
} // namespace
void SetToNegatedLinearExpression(const LinearExpressionProto& input_expr,
LinearExpressionProto* output_negated_expr) {
output_negated_expr->Clear();
for (int i = 0; i < input_expr.vars_size(); ++i) {
output_negated_expr->add_vars(NegatedRef(input_expr.vars(i)));
output_negated_expr->add_coeffs(input_expr.coeffs(i));
}
output_negated_expr->set_offset(-input_expr.offset());
}
IndexReferences GetReferencesUsedByConstraint(const ConstraintProto& ct) {
IndexReferences output;
switch (ct.constraint_case()) {
case ConstraintProto::ConstraintCase::kBoolOr:
AddIndices(ct.bool_or().literals(), &output.literals);
break;
case ConstraintProto::ConstraintCase::kBoolAnd:
AddIndices(ct.bool_and().literals(), &output.literals);
break;
case ConstraintProto::ConstraintCase::kAtMostOne:
AddIndices(ct.at_most_one().literals(), &output.literals);
break;
case ConstraintProto::ConstraintCase::kExactlyOne:
AddIndices(ct.exactly_one().literals(), &output.literals);
break;
case ConstraintProto::ConstraintCase::kBoolXor:
AddIndices(ct.bool_xor().literals(), &output.literals);
break;
case ConstraintProto::ConstraintCase::kIntDiv:
AddIndices(ct.int_div().target().vars(), &output.variables);
for (const LinearExpressionProto& expr : ct.int_div().exprs()) {
AddIndices(expr.vars(), &output.variables);
}
break;
case ConstraintProto::ConstraintCase::kIntMod:
AddIndices(ct.int_mod().target().vars(), &output.variables);
for (const LinearExpressionProto& expr : ct.int_mod().exprs()) {
AddIndices(expr.vars(), &output.variables);
}
break;
case ConstraintProto::ConstraintCase::kLinMax: {
AddIndices(ct.lin_max().target().vars(), &output.variables);
for (const LinearExpressionProto& expr : ct.lin_max().exprs()) {
AddIndices(expr.vars(), &output.variables);
}
break;
}
case ConstraintProto::ConstraintCase::kIntProd:
AddIndices(ct.int_prod().target().vars(), &output.variables);
for (const LinearExpressionProto& expr : ct.int_prod().exprs()) {
AddIndices(expr.vars(), &output.variables);
}
break;
case ConstraintProto::ConstraintCase::kLinear:
AddIndices(ct.linear().vars(), &output.variables);
break;
case ConstraintProto::ConstraintCase::kAllDiff:
for (const LinearExpressionProto& expr : ct.all_diff().exprs()) {
AddIndices(expr.vars(), &output.variables);
}
break;
case ConstraintProto::ConstraintCase::kDummyConstraint:
AddIndices(ct.dummy_constraint().vars(), &output.variables);
break;
case ConstraintProto::ConstraintCase::kElement:
output.variables.push_back(ct.element().index());
output.variables.push_back(ct.element().target());
AddIndices(ct.element().vars(), &output.variables);
break;
case ConstraintProto::ConstraintCase::kCircuit:
AddIndices(ct.circuit().literals(), &output.literals);
break;
case ConstraintProto::ConstraintCase::kRoutes:
AddIndices(ct.routes().literals(), &output.literals);
break;
case ConstraintProto::ConstraintCase::kInverse:
AddIndices(ct.inverse().f_direct(), &output.variables);
AddIndices(ct.inverse().f_inverse(), &output.variables);
break;
case ConstraintProto::ConstraintCase::kReservoir:
for (const LinearExpressionProto& time : ct.reservoir().time_exprs()) {
AddIndices(time.vars(), &output.variables);
}
AddIndices(ct.reservoir().active_literals(), &output.literals);
break;
case ConstraintProto::ConstraintCase::kTable:
AddIndices(ct.table().vars(), &output.variables);
break;
case ConstraintProto::ConstraintCase::kAutomaton:
AddIndices(ct.automaton().vars(), &output.variables);
break;
case ConstraintProto::ConstraintCase::kInterval:
AddIndices(ct.interval().start().vars(), &output.variables);
AddIndices(ct.interval().size().vars(), &output.variables);
AddIndices(ct.interval().end().vars(), &output.variables);
break;
case ConstraintProto::ConstraintCase::kNoOverlap:
break;
case ConstraintProto::ConstraintCase::kNoOverlap2D:
break;
case ConstraintProto::ConstraintCase::kCumulative:
AddIndices(ct.cumulative().capacity().vars(), &output.variables);
for (const LinearExpressionProto& demand : ct.cumulative().demands()) {
AddIndices(demand.vars(), &output.variables);
}
break;
case ConstraintProto::ConstraintCase::CONSTRAINT_NOT_SET:
break;
}
return output;
}
#define APPLY_TO_SINGULAR_FIELD(ct_name, field_name) \
{ \
int temp = ct->mutable_##ct_name()->field_name(); \
f(&temp); \
ct->mutable_##ct_name()->set_##field_name(temp); \
}
#define APPLY_TO_REPEATED_FIELD(ct_name, field_name) \
{ \
for (int& r : *ct->mutable_##ct_name()->mutable_##field_name()) f(&r); \
}
void ApplyToAllLiteralIndices(const std::function<void(int*)>& f,
ConstraintProto* ct) {
for (int& r : *ct->mutable_enforcement_literal()) f(&r);
switch (ct->constraint_case()) {
case ConstraintProto::ConstraintCase::kBoolOr:
APPLY_TO_REPEATED_FIELD(bool_or, literals);
break;
case ConstraintProto::ConstraintCase::kBoolAnd:
APPLY_TO_REPEATED_FIELD(bool_and, literals);
break;
case ConstraintProto::ConstraintCase::kAtMostOne:
APPLY_TO_REPEATED_FIELD(at_most_one, literals);
break;
case ConstraintProto::ConstraintCase::kExactlyOne:
APPLY_TO_REPEATED_FIELD(exactly_one, literals);
break;
case ConstraintProto::ConstraintCase::kBoolXor:
APPLY_TO_REPEATED_FIELD(bool_xor, literals);
break;
case ConstraintProto::ConstraintCase::kIntDiv:
break;
case ConstraintProto::ConstraintCase::kIntMod:
break;
case ConstraintProto::ConstraintCase::kLinMax:
break;
case ConstraintProto::ConstraintCase::kIntProd:
break;
case ConstraintProto::ConstraintCase::kLinear:
break;
case ConstraintProto::ConstraintCase::kAllDiff:
break;
case ConstraintProto::ConstraintCase::kDummyConstraint:
break;
case ConstraintProto::ConstraintCase::kElement:
break;
case ConstraintProto::ConstraintCase::kCircuit:
APPLY_TO_REPEATED_FIELD(circuit, literals);
break;
case ConstraintProto::ConstraintCase::kRoutes:
APPLY_TO_REPEATED_FIELD(routes, literals);
break;
case ConstraintProto::ConstraintCase::kInverse:
break;
case ConstraintProto::ConstraintCase::kReservoir:
APPLY_TO_REPEATED_FIELD(reservoir, active_literals);
break;
case ConstraintProto::ConstraintCase::kTable:
break;
case ConstraintProto::ConstraintCase::kAutomaton:
break;
case ConstraintProto::ConstraintCase::kInterval:
break;
case ConstraintProto::ConstraintCase::kNoOverlap:
break;
case ConstraintProto::ConstraintCase::kNoOverlap2D:
break;
case ConstraintProto::ConstraintCase::kCumulative:
break;
case ConstraintProto::ConstraintCase::CONSTRAINT_NOT_SET:
break;
}
}
void ApplyToAllVariableIndices(const std::function<void(int*)>& f,
ConstraintProto* ct) {
switch (ct->constraint_case()) {
case ConstraintProto::ConstraintCase::kBoolOr:
break;
case ConstraintProto::ConstraintCase::kBoolAnd:
break;
case ConstraintProto::ConstraintCase::kAtMostOne:
break;
case ConstraintProto::ConstraintCase::kExactlyOne:
break;
case ConstraintProto::ConstraintCase::kBoolXor:
break;
case ConstraintProto::ConstraintCase::kIntDiv:
APPLY_TO_REPEATED_FIELD(int_div, target()->mutable_vars);
for (int i = 0; i < ct->int_div().exprs_size(); ++i) {
APPLY_TO_REPEATED_FIELD(int_div, exprs(i)->mutable_vars);
}
break;
case ConstraintProto::ConstraintCase::kIntMod:
APPLY_TO_REPEATED_FIELD(int_mod, target()->mutable_vars);
for (int i = 0; i < ct->int_mod().exprs_size(); ++i) {
APPLY_TO_REPEATED_FIELD(int_mod, exprs(i)->mutable_vars);
}
break;
case ConstraintProto::ConstraintCase::kLinMax:
APPLY_TO_REPEATED_FIELD(lin_max, target()->mutable_vars);
for (int i = 0; i < ct->lin_max().exprs_size(); ++i) {
APPLY_TO_REPEATED_FIELD(lin_max, exprs(i)->mutable_vars);
}
break;
case ConstraintProto::ConstraintCase::kIntProd:
APPLY_TO_REPEATED_FIELD(int_prod, target()->mutable_vars);
for (int i = 0; i < ct->int_prod().exprs_size(); ++i) {
APPLY_TO_REPEATED_FIELD(int_prod, exprs(i)->mutable_vars);
}
break;
case ConstraintProto::ConstraintCase::kLinear:
APPLY_TO_REPEATED_FIELD(linear, vars);
break;
case ConstraintProto::ConstraintCase::kAllDiff:
for (int i = 0; i < ct->all_diff().exprs_size(); ++i) {
APPLY_TO_REPEATED_FIELD(all_diff, exprs(i)->mutable_vars);
}
break;
case ConstraintProto::ConstraintCase::kDummyConstraint:
APPLY_TO_REPEATED_FIELD(dummy_constraint, vars);
break;
case ConstraintProto::ConstraintCase::kElement:
APPLY_TO_SINGULAR_FIELD(element, index);
APPLY_TO_SINGULAR_FIELD(element, target);
APPLY_TO_REPEATED_FIELD(element, vars);
break;
case ConstraintProto::ConstraintCase::kCircuit:
break;
case ConstraintProto::ConstraintCase::kRoutes:
break;
case ConstraintProto::ConstraintCase::kInverse:
APPLY_TO_REPEATED_FIELD(inverse, f_direct);
APPLY_TO_REPEATED_FIELD(inverse, f_inverse);
break;
case ConstraintProto::ConstraintCase::kReservoir:
for (int i = 0; i < ct->reservoir().time_exprs_size(); ++i) {
APPLY_TO_REPEATED_FIELD(reservoir, time_exprs(i)->mutable_vars);
}
break;
case ConstraintProto::ConstraintCase::kTable:
APPLY_TO_REPEATED_FIELD(table, vars);
break;
case ConstraintProto::ConstraintCase::kAutomaton:
APPLY_TO_REPEATED_FIELD(automaton, vars);
break;
case ConstraintProto::ConstraintCase::kInterval:
APPLY_TO_REPEATED_FIELD(interval, start()->mutable_vars);
APPLY_TO_REPEATED_FIELD(interval, size()->mutable_vars);
APPLY_TO_REPEATED_FIELD(interval, end()->mutable_vars);
break;
case ConstraintProto::ConstraintCase::kNoOverlap:
break;
case ConstraintProto::ConstraintCase::kNoOverlap2D:
break;
case ConstraintProto::ConstraintCase::kCumulative:
APPLY_TO_REPEATED_FIELD(cumulative, capacity()->mutable_vars);
for (int i = 0; i < ct->cumulative().demands_size(); ++i) {
for (int& r :
*ct->mutable_cumulative()->mutable_demands(i)->mutable_vars()) {
f(&r);
}
}
break;
case ConstraintProto::ConstraintCase::CONSTRAINT_NOT_SET:
break;
}
}
void ApplyToAllIntervalIndices(const std::function<void(int*)>& f,
ConstraintProto* ct) {
switch (ct->constraint_case()) {
case ConstraintProto::ConstraintCase::kBoolOr:
break;
case ConstraintProto::ConstraintCase::kBoolAnd:
break;
case ConstraintProto::ConstraintCase::kAtMostOne:
break;
case ConstraintProto::ConstraintCase::kExactlyOne:
break;
case ConstraintProto::ConstraintCase::kBoolXor:
break;
case ConstraintProto::ConstraintCase::kIntDiv:
break;
case ConstraintProto::ConstraintCase::kIntMod:
break;
case ConstraintProto::ConstraintCase::kLinMax:
break;
case ConstraintProto::ConstraintCase::kIntProd:
break;
case ConstraintProto::ConstraintCase::kLinear:
break;
case ConstraintProto::ConstraintCase::kAllDiff:
break;
case ConstraintProto::ConstraintCase::kDummyConstraint:
break;
case ConstraintProto::ConstraintCase::kElement:
break;
case ConstraintProto::ConstraintCase::kCircuit:
break;
case ConstraintProto::ConstraintCase::kRoutes:
break;
case ConstraintProto::ConstraintCase::kInverse:
break;
case ConstraintProto::ConstraintCase::kReservoir:
break;
case ConstraintProto::ConstraintCase::kTable:
break;
case ConstraintProto::ConstraintCase::kAutomaton:
break;
case ConstraintProto::ConstraintCase::kInterval:
break;
case ConstraintProto::ConstraintCase::kNoOverlap:
APPLY_TO_REPEATED_FIELD(no_overlap, intervals);
break;
case ConstraintProto::ConstraintCase::kNoOverlap2D:
APPLY_TO_REPEATED_FIELD(no_overlap_2d, x_intervals);
APPLY_TO_REPEATED_FIELD(no_overlap_2d, y_intervals);
break;
case ConstraintProto::ConstraintCase::kCumulative:
APPLY_TO_REPEATED_FIELD(cumulative, intervals);
break;
case ConstraintProto::ConstraintCase::CONSTRAINT_NOT_SET:
break;
}
}
#undef APPLY_TO_SINGULAR_FIELD
#undef APPLY_TO_REPEATED_FIELD
std::string ConstraintCaseName(
ConstraintProto::ConstraintCase constraint_case) {
switch (constraint_case) {
case ConstraintProto::ConstraintCase::kBoolOr:
return "kBoolOr";
case ConstraintProto::ConstraintCase::kBoolAnd:
return "kBoolAnd";
case ConstraintProto::ConstraintCase::kAtMostOne:
return "kAtMostOne";
case ConstraintProto::ConstraintCase::kExactlyOne:
return "kExactlyOne";
case ConstraintProto::ConstraintCase::kBoolXor:
return "kBoolXor";
case ConstraintProto::ConstraintCase::kIntDiv:
return "kIntDiv";
case ConstraintProto::ConstraintCase::kIntMod:
return "kIntMod";
case ConstraintProto::ConstraintCase::kLinMax:
return "kLinMax";
case ConstraintProto::ConstraintCase::kIntProd:
return "kIntProd";
case ConstraintProto::ConstraintCase::kLinear:
return "kLinear";
case ConstraintProto::ConstraintCase::kAllDiff:
return "kAllDiff";
case ConstraintProto::ConstraintCase::kDummyConstraint:
return "kDummyConstraint";
case ConstraintProto::ConstraintCase::kElement:
return "kElement";
case ConstraintProto::ConstraintCase::kCircuit:
return "kCircuit";
case ConstraintProto::ConstraintCase::kRoutes:
return "kRoutes";
case ConstraintProto::ConstraintCase::kInverse:
return "kInverse";
case ConstraintProto::ConstraintCase::kReservoir:
return "kReservoir";
case ConstraintProto::ConstraintCase::kTable:
return "kTable";
case ConstraintProto::ConstraintCase::kAutomaton:
return "kAutomaton";
case ConstraintProto::ConstraintCase::kInterval:
return "kInterval";
case ConstraintProto::ConstraintCase::kNoOverlap:
return "kNoOverlap";
case ConstraintProto::ConstraintCase::kNoOverlap2D:
return "kNoOverlap2D";
case ConstraintProto::ConstraintCase::kCumulative:
return "kCumulative";
case ConstraintProto::ConstraintCase::CONSTRAINT_NOT_SET:
return "kEmpty";
}
}
std::vector<int> UsedVariables(const ConstraintProto& ct) {
IndexReferences references = GetReferencesUsedByConstraint(ct);
for (int& ref : references.variables) {
ref = PositiveRef(ref);
}
for (const int lit : references.literals) {
references.variables.push_back(PositiveRef(lit));
}
for (const int lit : ct.enforcement_literal()) {
references.variables.push_back(PositiveRef(lit));
}
gtl::STLSortAndRemoveDuplicates(&references.variables);
return references.variables;
}
std::vector<int> UsedIntervals(const ConstraintProto& ct) {
std::vector<int> used_intervals;
switch (ct.constraint_case()) {
case ConstraintProto::ConstraintCase::kBoolOr:
break;
case ConstraintProto::ConstraintCase::kBoolAnd:
break;
case ConstraintProto::ConstraintCase::kAtMostOne:
break;
case ConstraintProto::ConstraintCase::kExactlyOne:
break;
case ConstraintProto::ConstraintCase::kBoolXor:
break;
case ConstraintProto::ConstraintCase::kIntDiv:
break;
case ConstraintProto::ConstraintCase::kIntMod:
break;
case ConstraintProto::ConstraintCase::kLinMax:
break;
case ConstraintProto::ConstraintCase::kIntProd:
break;
case ConstraintProto::ConstraintCase::kLinear:
break;
case ConstraintProto::ConstraintCase::kAllDiff:
break;
case ConstraintProto::ConstraintCase::kDummyConstraint:
break;
case ConstraintProto::ConstraintCase::kElement:
break;
case ConstraintProto::ConstraintCase::kCircuit:
break;
case ConstraintProto::ConstraintCase::kRoutes:
break;
case ConstraintProto::ConstraintCase::kInverse:
break;
case ConstraintProto::ConstraintCase::kReservoir:
break;
case ConstraintProto::ConstraintCase::kTable:
break;
case ConstraintProto::ConstraintCase::kAutomaton:
break;
case ConstraintProto::ConstraintCase::kInterval:
break;
case ConstraintProto::ConstraintCase::kNoOverlap:
AddIndices(ct.no_overlap().intervals(), &used_intervals);
break;
case ConstraintProto::ConstraintCase::kNoOverlap2D:
AddIndices(ct.no_overlap_2d().x_intervals(), &used_intervals);
AddIndices(ct.no_overlap_2d().y_intervals(), &used_intervals);
break;
case ConstraintProto::ConstraintCase::kCumulative:
AddIndices(ct.cumulative().intervals(), &used_intervals);
break;
case ConstraintProto::ConstraintCase::CONSTRAINT_NOT_SET:
break;
}
gtl::STLSortAndRemoveDuplicates(&used_intervals);
return used_intervals;
}
int64_t ComputeInnerObjective(const CpObjectiveProto& objective,
const CpSolverResponse& response) {
int64_t objective_value = 0;
for (int i = 0; i < objective.vars_size(); ++i) {
int64_t coeff = objective.coeffs(i);
const int ref = objective.vars(i);
const int var = PositiveRef(ref);
if (!RefIsPositive(ref)) coeff = -coeff;
objective_value += coeff * response.solution()[var];
}
return objective_value;
}
bool ExpressionContainsSingleRef(const LinearExpressionProto& expr) {
return expr.offset() == 0 && expr.vars_size() == 1 &&
std::abs(expr.coeffs(0)) == 1;
}
bool ExpressionIsAffine(const LinearExpressionProto& expr) {
return expr.vars_size() <= 1;
}
// Returns the reference the expression can be reduced to. It will DCHECK that
// ExpressionContainsSingleRef(expr) is true.
int GetSingleRefFromExpression(const LinearExpressionProto& expr) {
DCHECK(ExpressionContainsSingleRef(expr));
return expr.coeffs(0) == 1 ? expr.vars(0) : NegatedRef(expr.vars(0));
}
void AddLinearExpressionToLinearConstraint(const LinearExpressionProto& expr,
int64_t coefficient,
LinearConstraintProto* linear) {
for (int i = 0; i < expr.vars_size(); ++i) {
linear->add_vars(expr.vars(i));
linear->add_coeffs(expr.coeffs(i) * coefficient);
}
DCHECK(!linear->domain().empty());
const int64_t shift = coefficient * expr.offset();
if (shift != 0) {
FillDomainInProto(ReadDomainFromProto(*linear).AdditionWith(Domain(-shift)),
linear);
}
}
bool LinearExpressionProtosAreEqual(const LinearExpressionProto& a,
const LinearExpressionProto& b,
int64_t b_scaling) {
if (a.vars_size() != b.vars_size()) return false;
if (a.offset() != b.offset() * b_scaling) return false;
absl::flat_hash_map<int, int64_t> coeffs;
for (int i = 0; i < a.vars_size(); ++i) {
coeffs[a.vars(i)] += a.coeffs(i);
coeffs[b.vars(i)] += -b.coeffs(i) * b_scaling;
}
for (const auto [var, coeff] : coeffs) {
if (coeff != 0) return false;
}
return true;
}
} // namespace sat
} // namespace operations_research
Reference in New Issue View Git Blame Copy Permalink