EnforcedLinearConstraint.java

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.
 
package com.google.ortools.modelbuilder;

public class EnforcedLinearConstraint {
  public EnforcedLinearConstraint(ModelBuilderHelper helper) {
    this.helper = helper;
    this.index = helper.addEnforcedLinearConstraint();
  }
 
  EnforcedLinearConstraint(ModelBuilderHelper helper, int index) {
    if (!helper.isEnforcedConstraint(index)) {
      throw new IllegalArgumentException(
          "the given index does not refer to an enforced linear constraint");
    }
    this.helper = helper;
    this.index = index;
  }

  public int getIndex() {
    return index;
  }

  public ModelBuilderHelper getHelper() {
    return helper;
  }

  public double getLowerBound() {
    return helper.getEnforcedConstraintLowerBound(index);
  }

  public void setLowerBound(double lb) {
    helper.setEnforcedConstraintLowerBound(index, lb);
  }

  public double getUpperBound() {
    return helper.getEnforcedConstraintUpperBound(index);
  }

  public void setUpperBound(double ub) {
    helper.setEnforcedConstraintUpperBound(index, ub);
  }

  public String getName() {
    return helper.getEnforcedConstraintName(index);
  }
 
  // Sets the name of the constraint. */
  public void setName(String name) {
    helper.setEnforcedConstraintName(index, name);
  }

  public void addTerm(Variable v, double coeff) {
    helper.safeAddEnforcedConstraintTerm(index, v.getIndex(), coeff);
  }

  public void setCoefficient(Variable v, double coeff) {
    helper.setEnforcedConstraintCoefficient(index, v.getIndex(), coeff);
  }

  public void clearTerms() {
    helper.clearEnforcedConstraintTerms(index);
  }

  public Variable getIndicatorVariable() {
    return new Variable(helper, helper.getEnforcedIndicatorVariableIndex(index));
  }

  public void setIndicatorVariable(Variable v) {
    helper.setEnforcedIndicatorVariableIndex(index, v.index);
  }

  public boolean getIndicatorValue() {
    return helper.getEnforcedIndicatorValue(index);
  }

  public void setIndicatorValue(boolean b) {
    helper.setEnforcedIndicatorValue(index, b);
  }

  public EnforcedLinearConstraint withName(String name) {
    setName(name);
    return this;
  }
 
  private final ModelBuilderHelper helper;
  private final int index;
}