LinearExprBuilder.java

Go to the documentation of this file.

// Copyright 2010-2024 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;
 
import java.util.Map;
import java.util.TreeMap;
 
public final class LinearExprBuilder implements LinearArgument {
  private final TreeMap<Integer, Double> coefficients;
  private double offset;
 
  LinearExprBuilder() {
    this.coefficients = new TreeMap<>();
    this.offset = 0;
  }
 
  public LinearExprBuilder add(LinearArgument expr) {
    addTerm(expr, 1);
    return this;
  }
 
  public LinearExprBuilder add(double constant) {
    offset = offset + constant;
    return this;
  }
 
  public LinearExprBuilder addTerm(LinearArgument expr, double coeff) {
    final LinearExpr e = expr.build();
    final int numElements = e.numElements();
    for (int i = 0; i < numElements; ++i) {
      coefficients.merge(e.getVariableIndex(i), e.getCoefficient(i) * coeff, Double::sum);
    }
    offset = offset + e.getOffset() * coeff;
    return this;
  }
 
  public LinearExprBuilder addSum(LinearArgument[] exprs) {
    for (final LinearArgument expr : exprs) {
      addTerm(expr, 1);
    }
    return this;
  }
 
  public LinearExprBuilder addWeightedSum(LinearArgument[] exprs, double[] coeffs) {
    for (int i = 0; i < exprs.length; ++i) {
      addTerm(exprs[i], coeffs[i]);
    }
    return this;
  }
 
  public LinearExprBuilder addWeightedSum(LinearArgument[] exprs, int[] coeffs) {
    for (int i = 0; i < exprs.length; ++i) {
      addTerm(exprs[i], coeffs[i]);
    }
    return this;
  }
 
  public LinearExprBuilder addWeightedSum(LinearArgument[] exprs, long[] coeffs) {
    for (int i = 0; i < exprs.length; ++i) {
      addTerm(exprs[i], (double) coeffs[i]);
    }
    return this;
  }
 
  @Override
  public LinearExpr build() {
    int numElements = 0;
    int lastVarIndex = -1;
    double lastCoeff = 0;
    for (Map.Entry<Integer, Double> entry : coefficients.entrySet()) {
      if (entry.getValue() != 0) {
        numElements++;
        lastVarIndex = entry.getKey();
        lastCoeff = entry.getValue();
      }
    }
    if (numElements == 0) {
      return new ConstantExpression(offset);
    } else if (numElements == 1) {
      return new AffineExpression(lastVarIndex, lastCoeff, offset);
    } else {
      int[] varIndices = new int[numElements];
      double[] coeffs = new double[numElements];
      int index = 0;
      for (Map.Entry<Integer, Double> entry : coefficients.entrySet()) {
        if (entry.getValue() != 0) {
          varIndices[index] = entry.getKey();
          coeffs[index] = entry.getValue();
          index++;
        }
      }
      return new WeightedSumExpression(varIndices, coeffs, offset);
    }
  }
}