indicator_constraint.cc

Go to the documentation of this file.

// Copyright 2010-2025 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/math_opt/constraints/indicator/indicator_constraint.h"
 
#include <optional>
#include <sstream>
#include <string>
#include <utility>
 
#include "ortools/math_opt/constraints/util/model_util.h"
#include "ortools/math_opt/cpp/variable_and_expressions.h"
#include "ortools/math_opt/storage/model_storage.h"
 
namespace operations_research::math_opt {
 
BoundedLinearExpression IndicatorConstraint::ImpliedConstraint() const {
  const IndicatorConstraintData& data = storage()->constraint_data(typed_id());
  // NOTE: The following makes a copy of `data.linear_terms`. This can be made
  // more efficient if the need arises.
  LinearExpression expr = ToLinearExpression(
      *storage(), {.coeffs = data.linear_terms, .offset = 0.0});
  return data.lower_bound <= std::move(expr) <= data.upper_bound;
}
 
std::string IndicatorConstraint::ToString() const {
  if (!storage()->has_constraint(typed_id())) {
    return std::string(kDeletedConstraintDefaultDescription);
  }
  const IndicatorConstraintData& data = storage()->constraint_data(typed_id());
  std::stringstream str;
  if (data.indicator.has_value()) {
    str << Variable(storage(), *data.indicator)
        << (data.activate_on_zero ? " = 0" : " = 1");
  } else {
    str << "[unset indicator variable]";
  }
  str << " ⇒ " << ImpliedConstraint();
  return str.str();
}
 
}  // namespace operations_research::math_opt