com.google.ortools.sat

Class LinearObjective

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessage

com.google.ortools.sat.LinearObjective

All Implemented Interfaces:

LinearObjectiveOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable

public final class LinearObjective
extends com.google.protobuf.GeneratedMessage
implements LinearObjectiveOrBuilder

 The objective of an optimization problem.
 

Protobuf type operations_research.sat.LinearObjective

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LinearObjective.Builder The objective of an optimization problem.

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 and Description
static int	COEFFICIENTS_FIELD_NUMBER
static int	LITERALS_FIELD_NUMBER
static int	OFFSET_FIELD_NUMBER
static int	SCALING_FACTOR_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 and Description
boolean	equals(java.lang.Object obj)
long	getCoefficients(int index) repeated int64 coefficients = 2;
int	getCoefficientsCount() repeated int64 coefficients = 2;
java.util.List<java.lang.Long>	getCoefficientsList() repeated int64 coefficients = 2;
static LinearObjective	getDefaultInstance()
LinearObjective	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
int	getLiterals(int index) The goal is always to minimize the linear Boolean formula defined by these two fields: sum_i literal_i * coefficient_i where literal_i is 1 iff literal_i is true in a given assignment.
int	getLiteralsCount() The goal is always to minimize the linear Boolean formula defined by these two fields: sum_i literal_i * coefficient_i where literal_i is 1 iff literal_i is true in a given assignment.
java.util.List<java.lang.Integer>	getLiteralsList() The goal is always to minimize the linear Boolean formula defined by these two fields: sum_i literal_i * coefficient_i where literal_i is 1 iff literal_i is true in a given assignment.
double	getOffset() For a given variable assignment, the "real" problem objective value is 'scaling_factor * (minimization_objective + offset)' where 'minimization_objective is the one defined just above.
com.google.protobuf.Parser<LinearObjective>	getParserForType()
double	getScalingFactor() optional double scaling_factor = 4 [default = 1];
int	getSerializedSize()
int	hashCode()
boolean	hasOffset() For a given variable assignment, the "real" problem objective value is 'scaling_factor * (minimization_objective + offset)' where 'minimization_objective is the one defined just above.
boolean	hasScalingFactor() optional double scaling_factor = 4 [default = 1];
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static LinearObjective.Builder	newBuilder()
static LinearObjective.Builder	newBuilder(LinearObjective prototype)
LinearObjective.Builder	newBuilderForType()
protected LinearObjective.Builder	newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
static LinearObjective	parseDelimitedFrom(java.io.InputStream input)
static LinearObjective	parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static LinearObjective	parseFrom(byte[] data)
static LinearObjective	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static LinearObjective	parseFrom(java.nio.ByteBuffer data)
static LinearObjective	parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static LinearObjective	parseFrom(com.google.protobuf.ByteString data)
static LinearObjective	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static LinearObjective	parseFrom(com.google.protobuf.CodedInputStream input)
static LinearObjective	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static LinearObjective	parseFrom(java.io.InputStream input)
static LinearObjective	parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<LinearObjective>	parser()
LinearObjective.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.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

LITERALS_FIELD_NUMBER

public static final int LITERALS_FIELD_NUMBER

See Also:

Constant Field Values

COEFFICIENTS_FIELD_NUMBER

public static final int COEFFICIENTS_FIELD_NUMBER

See Also:

Constant Field Values

OFFSET_FIELD_NUMBER

public static final int OFFSET_FIELD_NUMBER

See Also:

Constant Field Values

SCALING_FACTOR_FIELD_NUMBER

public static final int SCALING_FACTOR_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

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

getLiteralsList

public java.util.List<java.lang.Integer> getLiteralsList()

 The goal is always to minimize the linear Boolean formula defined by these
 two fields: sum_i literal_i * coefficient_i where literal_i is 1 iff
 literal_i is true in a given assignment.

 Note that the same variable shouldn't appear twice and that zero
 coefficients are not allowed.
 

repeated int32 literals = 1;

Specified by:

getLiteralsList in interface LinearObjectiveOrBuilder

Returns:

A list containing the literals.

getLiteralsCount

public int getLiteralsCount()

 The goal is always to minimize the linear Boolean formula defined by these
 two fields: sum_i literal_i * coefficient_i where literal_i is 1 iff
 literal_i is true in a given assignment.

 Note that the same variable shouldn't appear twice and that zero
 coefficients are not allowed.
 

repeated int32 literals = 1;

Specified by:

getLiteralsCount in interface LinearObjectiveOrBuilder

Returns:

The count of literals.

getLiterals

public int getLiterals(int index)

 The goal is always to minimize the linear Boolean formula defined by these
 two fields: sum_i literal_i * coefficient_i where literal_i is 1 iff
 literal_i is true in a given assignment.

 Note that the same variable shouldn't appear twice and that zero
 coefficients are not allowed.
 

repeated int32 literals = 1;

Specified by:

getLiterals in interface LinearObjectiveOrBuilder

Parameters:

index - The index of the element to return.

Returns:

The literals at the given index.

getCoefficientsList

public java.util.List<java.lang.Long> getCoefficientsList()

repeated int64 coefficients = 2;

Specified by:

getCoefficientsList in interface LinearObjectiveOrBuilder

Returns:

A list containing the coefficients.

getCoefficientsCount

public int getCoefficientsCount()

repeated int64 coefficients = 2;

Specified by:

getCoefficientsCount in interface LinearObjectiveOrBuilder

Returns:

The count of coefficients.

getCoefficients

public long getCoefficients(int index)

repeated int64 coefficients = 2;

Specified by:

getCoefficients in interface LinearObjectiveOrBuilder

Parameters:

index - The index of the element to return.

Returns:

The coefficients at the given index.

hasOffset

public boolean hasOffset()

 For a given variable assignment, the "real" problem objective value is
 'scaling_factor * (minimization_objective + offset)' where
 'minimization_objective is the one defined just above.

 Note that this is not what we minimize, but it is what we display.
 In particular if scaling_factor is negative, then the "real" problem is
 a maximization problem, even if the "internal" objective is minimized.
 

optional double offset = 3 [default = 0];

Specified by:

hasOffset in interface LinearObjectiveOrBuilder

Returns:

Whether the offset field is set.

getOffset

public double getOffset()

 For a given variable assignment, the "real" problem objective value is
 'scaling_factor * (minimization_objective + offset)' where
 'minimization_objective is the one defined just above.

 Note that this is not what we minimize, but it is what we display.
 In particular if scaling_factor is negative, then the "real" problem is
 a maximization problem, even if the "internal" objective is minimized.
 

optional double offset = 3 [default = 0];

Specified by:

getOffset in interface LinearObjectiveOrBuilder

Returns:

The offset.

hasScalingFactor

public boolean hasScalingFactor()

optional double scaling_factor = 4 [default = 1];

Specified by:

hasScalingFactor in interface LinearObjectiveOrBuilder

Returns:

Whether the scalingFactor field is set.

getScalingFactor

public double getScalingFactor()

optional double scaling_factor = 4 [default = 1];

Specified by:

getScalingFactor in interface LinearObjectiveOrBuilder

Returns:

The scalingFactor.

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 java.io.IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessage

Throws:

java.io.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(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 LinearObjective parseFrom(java.nio.ByteBuffer data)
                                 throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static LinearObjective parseFrom(java.nio.ByteBuffer data,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static LinearObjective parseFrom(com.google.protobuf.ByteString data)
                                 throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static LinearObjective parseFrom(byte[] data)
                                 throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static LinearObjective parseFrom(java.io.InputStream input)
                                 throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static LinearObjective parseFrom(java.io.InputStream input,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

public static LinearObjective parseDelimitedFrom(java.io.InputStream input)
                                          throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

public static LinearObjective parseDelimitedFrom(java.io.InputStream input,
                                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                          throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static LinearObjective parseFrom(com.google.protobuf.CodedInputStream input)
                                 throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static LinearObjective parseFrom(com.google.protobuf.CodedInputStream input,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws java.io.IOException

Throws:

java.io.IOException

newBuilderForType

public LinearObjective.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static LinearObjective.Builder newBuilder()

newBuilder

public static LinearObjective.Builder newBuilder(LinearObjective prototype)

toBuilder

public LinearObjective.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected LinearObjective.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)

Overrides:

newBuilderForType in class com.google.protobuf.AbstractMessage

getDefaultInstance

public static LinearObjective getDefaultInstance()

parser

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

getParserForType

public com.google.protobuf.Parser<LinearObjective> 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 LinearObjective getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder