Variable.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 Variable implements LinearArgument {
  Variable(ModelBuilderHelper helper, double lb, double ub, boolean isIntegral, String name) {
    this.helper = helper;
    this.index = helper.addVar();
    this.helper.setVarName(index, name);
    this.helper.setVarIntegrality(index, isIntegral);
    this.helper.setVarLowerBound(index, lb);
    this.helper.setVarUpperBound(index, ub);
  }
 
  Variable(ModelBuilderHelper helper, int index) {
    this.helper = helper;
    this.index = index;
  }

  public int getIndex() {
    return index;
  }
 
  // LinearArgument interface
  @Override
  public LinearExpr build() {
    return new AffineExpression(index, 1.0, 0.0);
  }

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

  public void setLowerBound(double lowerBound) {
    helper.setVarLowerBound(index, lowerBound);
  }

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

  public void setUpperBound(double upperBound) {
    helper.setVarUpperBound(index, upperBound);
  }

  public boolean getIntegrality() {
    return helper.getVarIntegrality(index);
  }

  public void setIntegrality(boolean isIntegral) {
    helper.setVarIntegrality(index, isIntegral);
  }

  public double getObjectiveCoefficient() {
    return helper.getVarObjectiveCoefficient(index);
  }

  public void setObjectiveCoefficient(double objectiveCoefficient) {
    helper.setVarObjectiveCoefficient(index, objectiveCoefficient);
  }

  public String getName() {
    return helper.getVarName(index);
  }
 
  public void setName(String name) {
    helper.setVarName(index, name);
  }
 
  @Override
  public String toString() {
    if (getName().isEmpty()) {
      if (getLowerBound() == getUpperBound()) {
        return String.format("%f", getLowerBound());
      } else {
        return String.format("var_%d(%f, %f)", getIndex(), getLowerBound(), getUpperBound());
      }
    } else {
      return String.format("%s(%f, %f)", getName(), getLowerBound(), getUpperBound());
    }
  }
 
  protected final ModelBuilderHelper helper;
  protected final int index;
}