ReservoirConstraint.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.sat;
 
import com.google.ortools.sat.ReservoirConstraintProto;

public class ReservoirConstraint extends Constraint {
  public ReservoirConstraint(CpModel model) {
    super(model.getBuilder());
    this.model = model;
  }

  public ReservoirConstraint addEvent(LinearArgument time, long levelChange) {
    ReservoirConstraintProto.Builder reservoir = getBuilder().getReservoirBuilder();
    reservoir.addTimeExprs(
        model.getLinearExpressionProtoBuilderFromLinearArgument(time, /*negate=*/false));
    reservoir.addLevelChanges(model.getLinearExpressionProtoBuilderFromLong(levelChange));
    reservoir.addActiveLiterals(model.trueLiteral().getIndex());
    return this;
  }

  public ReservoirConstraint addEvent(long time, long levelChange) {
    ReservoirConstraintProto.Builder reservoir = getBuilder().getReservoirBuilder();
    reservoir.addTimeExprs(model.getLinearExpressionProtoBuilderFromLong(time));
    reservoir.addLevelChanges(model.getLinearExpressionProtoBuilderFromLong(levelChange));
    reservoir.addActiveLiterals(model.trueLiteral().getIndex());
    return this;
  }

  public ReservoirConstraint addOptionalEvent(LinearExpr time, long levelChange, Literal isActive) {
    ReservoirConstraintProto.Builder reservoir = getBuilder().getReservoirBuilder();
    reservoir.addTimeExprs(
        model.getLinearExpressionProtoBuilderFromLinearArgument(time, /*negate=*/false));
    reservoir.addLevelChanges(model.getLinearExpressionProtoBuilderFromLong(levelChange));
    reservoir.addActiveLiterals(isActive.getIndex());
    return this;
  }

  public ReservoirConstraint addOptionalEvent(long time, long levelChange, Literal isActive) {
    ReservoirConstraintProto.Builder reservoir = getBuilder().getReservoirBuilder();
    reservoir.addTimeExprs(model.getLinearExpressionProtoBuilderFromLong(time));
    reservoir.addLevelChanges(model.getLinearExpressionProtoBuilderFromLong(levelChange));
    reservoir.addActiveLiterals(isActive.getIndex());
    return this;
  }
 
  private final CpModel model;
}