Class MPQuadraticObjective

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.ortools.linearsolver.MPQuadraticObjective
All Implemented Interfaces:
MPQuadraticObjectiveOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class MPQuadraticObjective extends com.google.protobuf.GeneratedMessage implements MPQuadraticObjectiveOrBuilder
 Quadratic part of a model's objective. Added with other objectives (such as
 linear), this creates the model's objective function to be optimized.
 Note: the linear part of the objective currently needs to be specified in the
 MPVariableProto.objective_coefficient fields. If you'd rather have a
 dedicated linear array here, talk to or-core-team@
Protobuf type operations_research.MPQuadraticObjective
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    MPQuadraticObjective.Builder
    Quadratic part of a model's objective.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>, BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message, T>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

    com.google.protobuf.AbstractMessage.BuilderParent

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

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    COEFFICIENT_FIELD_NUMBER
     
    static final int
    QVAR1_INDEX_FIELD_NUMBER
     
    static final int
    QVAR2_INDEX_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    double
    getCoefficient(int index)
    Must be finite.
    int
    getCoefficientCount()
    Must be finite.
    List<Double>
    getCoefficientList()
    Must be finite.
    static MPQuadraticObjective
    getDefaultInstance()
     
    MPQuadraticObjective
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Parser<MPQuadraticObjective>
    getParserForType()
     
    int
    getQvar1Index(int index)
    Sparse representation of quadratic terms in the objective function, where term i is qvar1_index[i] * qvar2_index[i] * coefficient[i].
    int
    getQvar1IndexCount()
    Sparse representation of quadratic terms in the objective function, where term i is qvar1_index[i] * qvar2_index[i] * coefficient[i].
    List<Integer>
    getQvar1IndexList()
    Sparse representation of quadratic terms in the objective function, where term i is qvar1_index[i] * qvar2_index[i] * coefficient[i].
    int
    getQvar2Index(int index)
    repeated int32 qvar2_index = 2;
    int
    getQvar2IndexCount()
    repeated int32 qvar2_index = 2;
    List<Integer>
    getQvar2IndexList()
    repeated int32 qvar2_index = 2;
    int
    getSerializedSize()
     
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static MPQuadraticObjective.Builder
    newBuilder()
     
    static MPQuadraticObjective.Builder
    newBuilder(MPQuadraticObjective prototype)
     
    MPQuadraticObjective.Builder
    newBuilderForType()
     
    protected MPQuadraticObjective.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static MPQuadraticObjective
    parseDelimitedFrom(InputStream input)
     
    static MPQuadraticObjective
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static MPQuadraticObjective
    parseFrom(byte[] data)
     
    static MPQuadraticObjective
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static MPQuadraticObjective
    parseFrom(com.google.protobuf.ByteString data)
     
    static MPQuadraticObjective
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static MPQuadraticObjective
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static MPQuadraticObjective
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static MPQuadraticObjective
    parseFrom(InputStream input)
     
    static MPQuadraticObjective
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static MPQuadraticObjective
    parseFrom(ByteBuffer data)
     
    static MPQuadraticObjective
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<MPQuadraticObjective>
    parser()
     
    MPQuadraticObjective.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, 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, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    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 Details

    • QVAR1_INDEX_FIELD_NUMBER

      public static final int QVAR1_INDEX_FIELD_NUMBER
      See Also:

    • QVAR2_INDEX_FIELD_NUMBER

      public static final int QVAR2_INDEX_FIELD_NUMBER
      See Also:

    • COEFFICIENT_FIELD_NUMBER

      public static final int COEFFICIENT_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

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

    • getQvar1IndexList

      public List<Integer> getQvar1IndexList()
       Sparse representation of quadratic terms in the objective function, where
 term i is qvar1_index[i] * qvar2_index[i] * coefficient[i].
 `qvar1_index` and `qvar2_index` are variable indices w.r.t the "variable"
 field in MPModelProto.
 `qvar1_index`, `qvar2_index` and `coefficients` must have the same size.
 If the same unordered pair (qvar1_index, qvar2_index) appears several
 times, the sum of all of the associated coefficients will be applied.
      repeated int32 qvar1_index = 1;
      Specified by:
      getQvar1IndexList in interface MPQuadraticObjectiveOrBuilder
      Returns:
      A list containing the qvar1Index.

    • getQvar1IndexCount

      public int getQvar1IndexCount()
       Sparse representation of quadratic terms in the objective function, where
 term i is qvar1_index[i] * qvar2_index[i] * coefficient[i].
 `qvar1_index` and `qvar2_index` are variable indices w.r.t the "variable"
 field in MPModelProto.
 `qvar1_index`, `qvar2_index` and `coefficients` must have the same size.
 If the same unordered pair (qvar1_index, qvar2_index) appears several
 times, the sum of all of the associated coefficients will be applied.
      repeated int32 qvar1_index = 1;
      Specified by:
      getQvar1IndexCount in interface MPQuadraticObjectiveOrBuilder
      Returns:
      The count of qvar1Index.

    • getQvar1Index

      public int getQvar1Index(int index)
       Sparse representation of quadratic terms in the objective function, where
 term i is qvar1_index[i] * qvar2_index[i] * coefficient[i].
 `qvar1_index` and `qvar2_index` are variable indices w.r.t the "variable"
 field in MPModelProto.
 `qvar1_index`, `qvar2_index` and `coefficients` must have the same size.
 If the same unordered pair (qvar1_index, qvar2_index) appears several
 times, the sum of all of the associated coefficients will be applied.
      repeated int32 qvar1_index = 1;
      Specified by:
      getQvar1Index in interface MPQuadraticObjectiveOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The qvar1Index at the given index.

    • getQvar2IndexList

      public List<Integer> getQvar2IndexList()
      repeated int32 qvar2_index = 2;
      Specified by:
      getQvar2IndexList in interface MPQuadraticObjectiveOrBuilder
      Returns:
      A list containing the qvar2Index.

    • getQvar2IndexCount

      public int getQvar2IndexCount()
      repeated int32 qvar2_index = 2;
      Specified by:
      getQvar2IndexCount in interface MPQuadraticObjectiveOrBuilder
      Returns:
      The count of qvar2Index.

    • getQvar2Index

      public int getQvar2Index(int index)
      repeated int32 qvar2_index = 2;
      Specified by:
      getQvar2Index in interface MPQuadraticObjectiveOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The qvar2Index at the given index.

    • getCoefficientList

      public List<Double> getCoefficientList()
       Must be finite.
      repeated double coefficient = 3;
      Specified by:
      getCoefficientList in interface MPQuadraticObjectiveOrBuilder
      Returns:
      A list containing the coefficient.

    • getCoefficientCount

      public int getCoefficientCount()
       Must be finite.
      repeated double coefficient = 3;
      Specified by:
      getCoefficientCount in interface MPQuadraticObjectiveOrBuilder
      Returns:
      The count of coefficient.

    • getCoefficient

      public double getCoefficient(int index)
       Must be finite.
      repeated double coefficient = 3;
      Specified by:
      getCoefficient in interface MPQuadraticObjectiveOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The coefficient at the given index.

    • isInitialized

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

    • writeTo

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

    • getSerializedSize

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

    • equals

      public boolean equals(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 MPQuadraticObjective parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static MPQuadraticObjective parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static MPQuadraticObjective parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static MPQuadraticObjective parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static MPQuadraticObjective parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static MPQuadraticObjective parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static MPQuadraticObjective parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static MPQuadraticObjective parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

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

    • newBuilder

      public static MPQuadraticObjective.Builder newBuilder()

    • newBuilder

      public static MPQuadraticObjective.Builder newBuilder(MPQuadraticObjective prototype)

    • toBuilder

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

    • newBuilderForType

      protected MPQuadraticObjective.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static MPQuadraticObjective getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<MPQuadraticObjective> parser()

    • getParserForType

      public com.google.protobuf.Parser<MPQuadraticObjective> 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.GeneratedMessage

    • getDefaultInstanceForType

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