Files
ortools-clone/ortools/sat/linear_programming_constraint.cc

375 lines
15 KiB
C++

// Copyright 2010-2014 Google
// 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/linear_programming_constraint.h"
#include "ortools/base/commandlineflags.h"
#include "ortools/util/time_limit.h"
// TODO(user): remove the option once we know which algo work best.
DEFINE_bool(lp_constraint_use_dual_ray, true,
"If true, use the dual simplex and exploit the dual ray when the "
"problem is DUAL_UNBOUNDED as a reason rather than "
"solving a custom feasibility LP first.");
namespace operations_research {
namespace sat {
const double LinearProgrammingConstraint::kEpsilon = 1e-6;
LinearProgrammingConstraint::LinearProgrammingConstraint(Model* model)
: integer_trail_(model->GetOrCreate<IntegerTrail>()) {
// TODO(user): Find a way to make GetOrCreate<TimeLimit>() construct it by
// default.
time_limit_ = model->Mutable<TimeLimit>();
if (time_limit_ == nullptr) {
model->SetSingleton(TimeLimit::Infinite());
time_limit_ = model->Mutable<TimeLimit>();
}
if (!FLAGS_lp_constraint_use_dual_ray) {
// The violation_sum_ variable will be the sum of constraints' violation.
violation_sum_constraint_ = lp_data_.CreateNewConstraint();
lp_data_.SetConstraintBounds(violation_sum_constraint_, 0.0, 0.0);
violation_sum_ = lp_data_.CreateNewVariable();
lp_data_.SetVariableBounds(violation_sum_, 0.0,
std::numeric_limits<double>::infinity());
lp_data_.SetCoefficient(violation_sum_constraint_, violation_sum_, -1.0);
}
// Tweak the default parameters to make the solve incremental.
glop::GlopParameters parameters;
parameters.set_use_dual_simplex(true);
simplex_.SetParameters(parameters);
}
LinearProgrammingConstraint::ConstraintIndex
LinearProgrammingConstraint::CreateNewConstraint(double lb, double ub) {
DCHECK(!lp_constraint_is_registered_);
const ConstraintIndex ct = lp_data_.CreateNewConstraint();
lp_data_.SetConstraintBounds(ct, lb, ub);
return ct;
}
glop::ColIndex LinearProgrammingConstraint::GetOrCreateMirrorVariable(
IntegerVariable ivar) {
const auto it = integer_variable_to_index_.find(ivar);
if (it == integer_variable_to_index_.end()) {
integer_variable_to_index_[ivar] = integer_variables_.size();
integer_variables_.push_back(ivar);
mirror_lp_variables_.push_back(lp_data_.CreateNewVariable());
lp_solution_.push_back(std::numeric_limits<double>::infinity());
}
return mirror_lp_variables_[integer_variable_to_index_[ivar]];
}
void LinearProgrammingConstraint::SetCoefficient(ConstraintIndex ct,
IntegerVariable ivar,
double coefficient) {
CHECK(!lp_constraint_is_registered_);
glop::ColIndex cvar = GetOrCreateMirrorVariable(ivar);
lp_data_.SetCoefficient(ct, cvar, coefficient);
}
void LinearProgrammingConstraint::SetObjectiveCoefficient(IntegerVariable ivar,
double coeff) {
CHECK(!lp_constraint_is_registered_);
objective_is_defined_ = true;
objective_lp_.push_back(
std::make_pair(GetOrCreateMirrorVariable(ivar), coeff));
}
void LinearProgrammingConstraint::RegisterWith(GenericLiteralWatcher* watcher) {
DCHECK(!lp_constraint_is_registered_);
lp_constraint_is_registered_ = true;
// Note that the order is important so that the lp objective is exactly
// lp_to_cp_objective_scale_ times the cp one.
if (objective_is_defined_) {
for (const auto& var_coeff : objective_lp_) {
lp_data_.SetObjectiveCoefficient(var_coeff.first, var_coeff.second);
}
}
lp_data_.Scale(&scaler_);
lp_to_cp_objective_scale_ = lp_data_.ScaleObjective();
if (!FLAGS_lp_constraint_use_dual_ray) {
// Add all the individual violation variables. Note that it is important
// to do that AFTER the scaling so that each constraint is considered on the
// same footing regarding a violation.
//
// Note that scaler_.col_scale() will returns a value of 1.0 for these new
// variables.
//
// TODO(user): See if it is possible to reuse the feasibility code of the
// simplex that do not need to create these extra variables.
//
// TODO(user): It might be better (smaller reasons) to to check the maximum
// of the individual constraint violation rather than the sum.
const double infinity = std::numeric_limits<double>::infinity();
for (glop::RowIndex row(0); row < lp_data_.num_constraints(); ++row) {
if (row == violation_sum_constraint_) continue;
const glop::Fractional lb = lp_data_.constraint_lower_bounds()[row];
const glop::Fractional ub = lp_data_.constraint_upper_bounds()[row];
if (lb != -infinity) {
const glop::ColIndex violation_lb = lp_data_.CreateNewVariable();
lp_data_.SetVariableBounds(violation_lb, 0.0, infinity);
lp_data_.SetCoefficient(violation_sum_constraint_, violation_lb, 1.0);
lp_data_.SetCoefficient(row, violation_lb, 1.0);
}
if (ub != infinity) {
const glop::ColIndex violation_ub = lp_data_.CreateNewVariable();
lp_data_.SetVariableBounds(violation_ub, 0.0, infinity);
lp_data_.SetCoefficient(violation_sum_constraint_, violation_ub, 1.0);
lp_data_.SetCoefficient(row, violation_ub, -1.0);
}
}
}
lp_data_.AddSlackVariablesWhereNecessary(false);
const int watcher_id = watcher->Register(this);
const int num_vars = integer_variables_.size();
for (int i = 0; i < num_vars; i++) {
watcher->WatchIntegerVariable(integer_variables_[i], watcher_id, i);
}
watcher->SetPropagatorPriority(watcher_id, 2);
}
// Check whether the change breaks the current LP solution.
// Call Propagate() only if it does.
bool LinearProgrammingConstraint::IncrementalPropagate(
const std::vector<int>& watch_indices) {
for (const int index : watch_indices) {
const double lb = static_cast<double>(
integer_trail_->LowerBound(integer_variables_[index]).value());
const double ub = static_cast<double>(
integer_trail_->UpperBound(integer_variables_[index]).value());
const double value = lp_solution_[index];
if (value < lb - kEpsilon || value > ub + kEpsilon) return Propagate();
}
return true;
}
glop::Fractional LinearProgrammingConstraint::GetVariableValueAtCpScale(
glop::ColIndex var) {
return simplex_.GetVariableValue(var) / scaler_.col_scale(var);
}
bool LinearProgrammingConstraint::Propagate() {
// Copy CP state into LP state.
const int num_vars = integer_variables_.size();
for (int i = 0; i < num_vars; i++) {
const IntegerVariable cp_var = integer_variables_[i];
const double lb =
static_cast<double>(integer_trail_->LowerBound(cp_var).value());
const double ub =
static_cast<double>(integer_trail_->UpperBound(cp_var).value());
const double factor = scaler_.col_scale(mirror_lp_variables_[i]);
lp_data_.SetVariableBounds(mirror_lp_variables_[i], lb * factor,
ub * factor);
}
if (!FLAGS_lp_constraint_use_dual_ray) {
if (objective_is_defined_) {
for (auto& var_coeff : objective_lp_) {
lp_data_.SetObjectiveCoefficient(var_coeff.first, 0.0);
}
}
lp_data_.SetObjectiveCoefficient(violation_sum_, 1.0);
lp_data_.SetObjectiveScalingFactor(1.0);
lp_data_.SetVariableBounds(violation_sum_, 0.0,
std::numeric_limits<double>::infinity());
// Feasibility deductions.
const auto status = simplex_.Solve(lp_data_, time_limit_);
CHECK(status.ok()) << "LinearProgrammingConstraint encountered an error: "
<< status.error_message();
CHECK_EQ(simplex_.GetProblemStatus(), glop::ProblemStatus::OPTIMAL)
<< "simplex Solve() should return optimal, but it returned "
<< simplex_.GetProblemStatus();
if (simplex_.GetVariableValue(violation_sum_) > kEpsilon) { // infeasible.
FillReducedCostsReason();
return integer_trail_->ReportConflict(integer_reason_);
}
// Reduced cost strengthening for feasibility.
ReducedCostStrengtheningDeductions(0.0);
if (!deductions_.empty()) {
FillReducedCostsReason();
for (const IntegerLiteral deduction : deductions_) {
if (!integer_trail_->Enqueue(deduction, {}, integer_reason_)) {
return false;
}
}
}
// Revert to the real problem objective and save current solution.
lp_data_.SetVariableBounds(violation_sum_, 0.0, 0.0);
lp_data_.SetObjectiveCoefficient(violation_sum_, 0.0);
if (objective_is_defined_) {
for (auto& var_coeff : objective_lp_) {
const glop::ColIndex col = var_coeff.first;
lp_data_.SetObjectiveCoefficient(
col, var_coeff.second * scaler_.col_scale(col));
}
lp_to_cp_objective_scale_ = lp_data_.ScaleObjective();
}
for (int i = 0; i < num_vars; i++) {
lp_solution_[i] = GetVariableValueAtCpScale(mirror_lp_variables_[i]);
}
// We currently ignore the objective and return right away when we don't
// use the dual ray as an infeasibility reason.
return true;
}
const auto status = simplex_.Solve(lp_data_, time_limit_);
CHECK(status.ok()) << "LinearProgrammingConstraint encountered an error: "
<< status.error_message();
// A dual-unbounded problem is infeasible. We use the dual ray reason.
if (simplex_.GetProblemStatus() == glop::ProblemStatus::DUAL_UNBOUNDED) {
FillDualRayReason();
return integer_trail_->ReportConflict(integer_reason_);
}
// Optimality deductions if problem has an objective.
if (objective_is_defined_ &&
simplex_.GetProblemStatus() == glop::ProblemStatus::OPTIMAL) {
// Try to filter optimal objective value. Note that GetObjectiveValue()
// already take care of the scaling so that it returns an objective in the
// CP world.
const double relaxed_optimal_objective = simplex_.GetObjectiveValue();
const IntegerValue old_lb = integer_trail_->LowerBound(objective_cp_);
const IntegerValue new_lb(
static_cast<int64>(std::ceil(relaxed_optimal_objective - kEpsilon)));
if (old_lb < new_lb) {
FillReducedCostsReason();
const IntegerLiteral deduction =
IntegerLiteral::GreaterOrEqual(objective_cp_, new_lb);
if (!integer_trail_->Enqueue(deduction, {}, integer_reason_)) {
return false;
}
}
// Reduced cost strengthening.
const double objective_cp_ub =
static_cast<double>(integer_trail_->UpperBound(objective_cp_).value());
ReducedCostStrengtheningDeductions(objective_cp_ub -
relaxed_optimal_objective);
if (!deductions_.empty()) {
FillReducedCostsReason();
integer_reason_.push_back(
integer_trail_->UpperBoundAsLiteral(objective_cp_));
for (const IntegerLiteral deduction : deductions_) {
if (!integer_trail_->Enqueue(deduction, {}, integer_reason_)) {
return false;
}
}
}
}
// Copy current LP solution.
for (int i = 0; i < num_vars; i++) {
lp_solution_[i] = GetVariableValueAtCpScale(mirror_lp_variables_[i]);
}
return true;
}
void LinearProgrammingConstraint::FillReducedCostsReason() {
integer_reason_.clear();
const int num_vars = integer_variables_.size();
for (int i = 0; i < num_vars; i++) {
// TODO(user): try to extend the bounds that are put in the
// explanation of feasibility: can we compute bounds of variables for which
// the objective would still not be low/high enough for the problem to be
// feasible? If the violation minimum is 10 and a variable has rc 1,
// then decreasing it by 9 would still leave the problem infeasible.
// Using this could allow to generalize some explanations.
const double rc = simplex_.GetReducedCost(mirror_lp_variables_[i]);
if (rc > kEpsilon) {
integer_reason_.push_back(
integer_trail_->LowerBoundAsLiteral(integer_variables_[i]));
} else if (rc < -kEpsilon) {
integer_reason_.push_back(
integer_trail_->UpperBoundAsLiteral(integer_variables_[i]));
}
}
}
void LinearProgrammingConstraint::FillDualRayReason() {
integer_reason_.clear();
const int num_vars = integer_variables_.size();
for (int i = 0; i < num_vars; i++) {
// TODO(user): Like for FillReducedCostsReason(), the bounds could be
// extended here. Actually, the "dual ray cost updates" is the reduced cost
// of an optimal solution if we were optimizing one direction of one basic
// variable. The simplex_ interface would need to be slightly extended to
// retrieve the basis column in question and the variable values though.
const double rc =
simplex_.GetDualRayRowCombination()[mirror_lp_variables_[i]];
if (rc > kEpsilon) {
integer_reason_.push_back(
integer_trail_->LowerBoundAsLiteral(integer_variables_[i]));
} else if (rc < -kEpsilon) {
integer_reason_.push_back(
integer_trail_->UpperBoundAsLiteral(integer_variables_[i]));
}
}
}
void LinearProgrammingConstraint::ReducedCostStrengtheningDeductions(
double cp_objective_delta) {
deductions_.clear();
// TRICKY: while simplex_.GetObjectiveValue() use the objective scaling factor
// stored in the lp_data_, all the other functions like GetReducedCost() or
// GetVariableValue() do not.
const double lp_objective_delta =
cp_objective_delta / lp_to_cp_objective_scale_;
const int num_vars = integer_variables_.size();
for (int i = 0; i < num_vars; i++) {
const IntegerVariable cp_var = integer_variables_[i];
const glop::ColIndex lp_var = mirror_lp_variables_[i];
const double rc = simplex_.GetReducedCost(lp_var);
const double value = simplex_.GetVariableValue(lp_var);
const double lp_other_bound = value + lp_objective_delta / rc;
const double cp_other_bound = lp_other_bound / scaler_.col_scale(lp_var);
if (rc > kEpsilon) {
const double ub =
static_cast<double>(integer_trail_->UpperBound(cp_var).value());
const double new_ub = std::floor(cp_other_bound + kEpsilon);
if (new_ub < ub) {
const IntegerValue new_ub_int(static_cast<IntegerValue>(new_ub));
deductions_.push_back(IntegerLiteral::LowerOrEqual(cp_var, new_ub_int));
}
} else if (rc < -kEpsilon) {
const double lb =
static_cast<double>(integer_trail_->LowerBound(cp_var).value());
const double new_lb = std::ceil(cp_other_bound - kEpsilon);
if (new_lb > lb) {
const IntegerValue new_lb_int(static_cast<IntegerValue>(new_lb));
deductions_.push_back(
IntegerLiteral::GreaterOrEqual(cp_var, new_lb_int));
}
}
}
}
} // namespace sat
} // namespace operations_research