Package com.google.ortools.sat

Class CpObjectiveProto

  • All Implemented Interfaces:
    CpObjectiveProtoOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable
    public final class CpObjectiveProto
extends com.google.protobuf.GeneratedMessageV3
implements CpObjectiveProtoOrBuilder
     Optimization objective.
    Protobuf type operations_research.sat.CpObjectiveProto
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  CpObjectiveProto.Builder
      Optimization objective.

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object obj)  
      long getCoeffs​(int index)
      repeated int64 coeffs = 4;
      int getCoeffsCount()
      repeated int64 coeffs = 4;
      java.util.List<java.lang.Long> getCoeffsList()
      repeated int64 coeffs = 4;
      static CpObjectiveProto getDefaultInstance()  
      CpObjectiveProto getDefaultInstanceForType()  
      static com.google.protobuf.Descriptors.Descriptor getDescriptor()  
      long getDomain​(int index)
      If non-empty, only look for an objective value in the given domain.
      int getDomainCount()
      If non-empty, only look for an objective value in the given domain.
      java.util.List<java.lang.Long> getDomainList()
      If non-empty, only look for an objective value in the given domain.
      long getIntegerAfterOffset()
      int64 integer_after_offset = 9;
      long getIntegerBeforeOffset()
      Internal fields to recover a bound on the original integer objective from the presolved one.
      long getIntegerScalingFactor()
      int64 integer_scaling_factor = 8;
      double getOffset()
      The displayed objective is always: scaling_factor * (sum(coefficients[i] * objective_vars[i]) + offset).
      com.google.protobuf.Parser<CpObjectiveProto> getParserForType()  
      double getScalingFactor()
      double scaling_factor = 3;
      boolean getScalingWasExact()
      Internal field.
      int getSerializedSize()  
      int getVars​(int index)
      The linear terms of the objective to minimize.
      int getVarsCount()
      The linear terms of the objective to minimize.
      java.util.List<java.lang.Integer> getVarsList()
      The linear terms of the objective to minimize.
      int hashCode()  
      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()  
      boolean isInitialized()  
      static CpObjectiveProto.Builder newBuilder()  
      static CpObjectiveProto.Builder newBuilder​(CpObjectiveProto prototype)  
      CpObjectiveProto.Builder newBuilderForType()  
      protected CpObjectiveProto.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)  
      protected java.lang.Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)  
      static CpObjectiveProto parseDelimitedFrom​(java.io.InputStream input)  
      static CpObjectiveProto parseDelimitedFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static CpObjectiveProto parseFrom​(byte[] data)  
      static CpObjectiveProto parseFrom​(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static CpObjectiveProto parseFrom​(com.google.protobuf.ByteString data)  
      static CpObjectiveProto parseFrom​(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static CpObjectiveProto parseFrom​(com.google.protobuf.CodedInputStream input)  
      static CpObjectiveProto parseFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static CpObjectiveProto parseFrom​(java.io.InputStream input)  
      static CpObjectiveProto parseFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static CpObjectiveProto parseFrom​(java.nio.ByteBuffer data)  
      static CpObjectiveProto parseFrom​(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static com.google.protobuf.Parser<CpObjectiveProto> parser()  
      CpObjectiveProto.Builder toBuilder()  
      void writeTo​(com.google.protobuf.CodedOutputStream output)  

      • Methods inherited from class com.google.protobuf.GeneratedMessageV3

        canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

      • Methods inherited from class com.google.protobuf.AbstractMessage

        findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

      • Methods inherited from class com.google.protobuf.AbstractMessageLite

        addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait

      • Methods inherited from interface com.google.protobuf.MessageLite

        toByteArray, toByteString, writeDelimitedTo, writeTo

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • Field Detail

      • SCALING_FACTOR_FIELD_NUMBER

        public static final int SCALING_FACTOR_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SCALING_WAS_EXACT_FIELD_NUMBER

        public static final int SCALING_WAS_EXACT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • INTEGER_BEFORE_OFFSET_FIELD_NUMBER

        public static final int INTEGER_BEFORE_OFFSET_FIELD_NUMBER
        See Also:
        Constant Field Values

      • INTEGER_AFTER_OFFSET_FIELD_NUMBER

        public static final int INTEGER_AFTER_OFFSET_FIELD_NUMBER
        See Also:
        Constant Field Values

      • INTEGER_SCALING_FACTOR_FIELD_NUMBER

        public static final int INTEGER_SCALING_FACTOR_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected java.lang.Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getVarsList

        public java.util.List<java.lang.Integer> getVarsList()
         The linear terms of the objective to minimize.
 For a maximization problem, one can negate all coefficients in the
 objective and set scaling_factor to -1.
        repeated int32 vars = 1;
        Specified by:
        getVarsList in interface CpObjectiveProtoOrBuilder
        Returns:
        A list containing the vars.

      • getVarsCount

        public int getVarsCount()
         The linear terms of the objective to minimize.
 For a maximization problem, one can negate all coefficients in the
 objective and set scaling_factor to -1.
        repeated int32 vars = 1;
        Specified by:
        getVarsCount in interface CpObjectiveProtoOrBuilder
        Returns:
        The count of vars.

      • getVars

        public int getVars​(int index)
         The linear terms of the objective to minimize.
 For a maximization problem, one can negate all coefficients in the
 objective and set scaling_factor to -1.
        repeated int32 vars = 1;
        Specified by:
        getVars in interface CpObjectiveProtoOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The vars at the given index.

      • getCoeffsList

        public java.util.List<java.lang.Long> getCoeffsList()
        repeated int64 coeffs = 4;
        Specified by:
        getCoeffsList in interface CpObjectiveProtoOrBuilder
        Returns:
        A list containing the coeffs.

      • getCoeffs

        public long getCoeffs​(int index)
        repeated int64 coeffs = 4;
        Specified by:
        getCoeffs in interface CpObjectiveProtoOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The coeffs at the given index.

      • getOffset

        public double getOffset()
         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;
        Specified by:
        getOffset in interface CpObjectiveProtoOrBuilder
        Returns:
        The offset.

      • getDomainList

        public java.util.List<java.lang.Long> 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;
        Specified by:
        getDomainList in interface CpObjectiveProtoOrBuilder
        Returns:
        A list containing the domain.

      • getDomainCount

        public 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;
        Specified by:
        getDomainCount in interface CpObjectiveProtoOrBuilder
        Returns:
        The count of domain.

      • getDomain

        public long getDomain​(int index)
         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;
        Specified by:
        getDomain in interface CpObjectiveProtoOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The domain at the given index.

      • getScalingWasExact

        public boolean getScalingWasExact()
         Internal field. Do not set. When we scale a FloatObjectiveProto to a
 integer version, we set this to true if the scaling was exact (i.e. all
 original coeff were integer for instance).

 TODO(user): Put the error bounds we computed instead?
        bool scaling_was_exact = 6;
        Specified by:
        getScalingWasExact in interface CpObjectiveProtoOrBuilder
        Returns:
        The scalingWasExact.

      • getIntegerBeforeOffset

        public long getIntegerBeforeOffset()
         Internal fields to recover a bound on the original integer objective from
 the presolved one. Basically, initially the integer objective fit on an
 int64 and is in [Initial_lb, Initial_ub]. During presolve, we might change
 the linear expression to have a new domain [Presolved_lb, Presolved_ub]
 that will also always fit on an int64.

 The two domain will always be linked with an affine transformation between
 the two of the form:
   old = (new + before_offset) * integer_scaling_factor + after_offset.
 Note that we use both offsets to always be able to do the computation while
 staying in the int64 domain. In particular, the after_offset will always
 be in (-integer_scaling_factor, integer_scaling_factor).
        int64 integer_before_offset = 7;
        Specified by:
        getIntegerBeforeOffset in interface CpObjectiveProtoOrBuilder
        Returns:
        The integerBeforeOffset.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws java.io.IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        java.io.IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(java.lang.Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static CpObjectiveProto parseFrom​(java.nio.ByteBuffer data)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static CpObjectiveProto parseFrom​(java.nio.ByteBuffer data,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static CpObjectiveProto parseFrom​(com.google.protobuf.ByteString data)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static CpObjectiveProto parseFrom​(com.google.protobuf.ByteString data,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static CpObjectiveProto parseFrom​(byte[] data)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static CpObjectiveProto parseFrom​(byte[] data,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static CpObjectiveProto parseFrom​(java.io.InputStream input)
                                  throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static CpObjectiveProto parseFrom​(java.io.InputStream input,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static CpObjectiveProto parseDelimitedFrom​(java.io.InputStream input)
                                           throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static CpObjectiveProto parseDelimitedFrom​(java.io.InputStream input,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static CpObjectiveProto parseFrom​(com.google.protobuf.CodedInputStream input)
                                  throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static CpObjectiveProto parseFrom​(com.google.protobuf.CodedInputStream input,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws java.io.IOException
        Throws:
        java.io.IOException

      • newBuilderForType

        public CpObjectiveProto.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public CpObjectiveProto.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected CpObjectiveProto.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<CpObjectiveProto> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public CpObjectiveProto getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder