com.google.ortools.sat.CpObjectiveProtoOrBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-or-tools Show documentation
Publishing Google OR-Tools as a Maven dependency
The newest version!
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: ortools/sat/cp_model.proto

package com.google.ortools.sat;

public interface CpObjectiveProtoOrBuilder extends
    // @@protoc_insertion_point(interface_extends:operations_research.sat.CpObjectiveProto)
    com.google.protobuf.MessageOrBuilder {

  /**
   *    * The linear terms of the objective to minimize.
   * For a maximization problem, one can negate all coefficients in the
   * objective and set a scaling_factor to -1.
   * 
   *
   * repeated int32 vars = 1;
   * @return A list containing the vars.
   */
  java.util.List getVarsList();
  /**
   *    * The linear terms of the objective to minimize.
   * For a maximization problem, one can negate all coefficients in the
   * objective and set a scaling_factor to -1.
   * 
   *
   * repeated int32 vars = 1;
   * @return The count of vars.
   */
  int getVarsCount();
  /**
   *    * The linear terms of the objective to minimize.
   * For a maximization problem, one can negate all coefficients in the
   * objective and set a scaling_factor to -1.
   * 
   *
   * repeated int32 vars = 1;
   * @param index The index of the element to return.
   * @return The vars at the given index.
   */
  int getVars(int index);

  /**
   * repeated int64 coeffs = 4;
   * @return A list containing the coeffs.
   */
  java.util.List getCoeffsList();
  /**
   * repeated int64 coeffs = 4;
   * @return The count of coeffs.
   */
  int getCoeffsCount();
  /**
   * repeated int64 coeffs = 4;
   * @param index The index of the element to return.
   * @return The coeffs at the given index.
   */
  long getCoeffs(int index);

  /**
   *    * The displayed objective is always:
   *   scaling_factor * (sum(coefficients[i] * objective_vars[i]) + offset).
   * This is needed to have a consistent objective after presolve or when
   * scaling a double problem to express it with integers.
   * Note that if scaling_factor is zero, then it is assumed to be 1, so that by
   * default these fields have no effect.
   * 
   *
   * double offset = 2;
   * @return The offset.
   */
  double getOffset();

  /**
   * double scaling_factor = 3;
   * @return The scalingFactor.
   */
  double getScalingFactor();

  /**
   *    * If non-empty, only look for an objective value in the given domain.
   * Note that this does not depend on the offset or scaling factor, it is a
   * domain on the sum of the objective terms only.
   * 
   *
   * repeated int64 domain = 5;
   * @return A list containing the domain.
   */
  java.util.List getDomainList();
  /**
   *    * If non-empty, only look for an objective value in the given domain.
   * Note that this does not depend on the offset or scaling factor, it is a
   * domain on the sum of the objective terms only.
   * 
   *
   * repeated int64 domain = 5;
   * @return The count of domain.
   */
  int getDomainCount();
  /**
   *    * If non-empty, only look for an objective value in the given domain.
   * Note that this does not depend on the offset or scaling factor, it is a
   * domain on the sum of the objective terms only.
   * 
   *
   * repeated int64 domain = 5;
   * @param index The index of the element to return.
   * @return The domain at the given index.
   */
  long getDomain(int index);
}