com.google.ortools.sat

Class RoutesConstraintProto

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessage

com.google.ortools.sat.RoutesConstraintProto

All Implemented Interfaces:

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

public final class RoutesConstraintProto
extends com.google.protobuf.GeneratedMessage
implements RoutesConstraintProtoOrBuilder

 The "VRP" (Vehicle Routing Problem) constraint.

 The direct graph where arc #i (from tails[i] to head[i]) is present iff
 literals[i] is true must satisfy this set of properties:
 - #incoming arcs == 1 except for node 0.
 - #outgoing arcs == 1 except for node 0.
 - for node zero, #incoming arcs == #outgoing arcs.
 - There are no duplicate arcs.
 - Self-arcs are allowed except for node 0.
 - There is no cycle in this graph, except through node 0.

 Note: Currently this constraint expect all the nodes in [0, num_nodes) to
 have at least one incident arc. The model will be considered invalid if it
 is not the case. You can add self-arc fixed to one to ignore some nodes if
 needed.

 TODO(user): It is probably possible to generalize this constraint to a
 no-cycle in a general graph, or a no-cycle with sum incoming <= 1 and sum
 outgoing <= 1 (more efficient implementation). On the other hand, having this
 specific constraint allow us to add specific "cuts" to a VRP problem.
 

Protobuf type operations_research.sat.RoutesConstraintProto

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RoutesConstraintProto.Builder The "VRP" (Vehicle Routing Problem) constraint.

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	CAPACITY_FIELD_NUMBER
static int	DEMANDS_FIELD_NUMBER
static int	HEADS_FIELD_NUMBER
static int	LITERALS_FIELD_NUMBER
static int	TAILS_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	getCapacity() int64 capacity = 5;
static RoutesConstraintProto	getDefaultInstance()
RoutesConstraintProto	getDefaultInstanceForType()
int	getDemands(int index) EXPERIMENTAL.
int	getDemandsCount() EXPERIMENTAL.
java.util.List<java.lang.Integer>	getDemandsList() EXPERIMENTAL.
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
int	getHeads(int index) repeated int32 heads = 2;
int	getHeadsCount() repeated int32 heads = 2;
java.util.List<java.lang.Integer>	getHeadsList() repeated int32 heads = 2;
int	getLiterals(int index) repeated int32 literals = 3;
int	getLiteralsCount() repeated int32 literals = 3;
java.util.List<java.lang.Integer>	getLiteralsList() repeated int32 literals = 3;
com.google.protobuf.Parser<RoutesConstraintProto>	getParserForType()
int	getSerializedSize()
int	getTails(int index) repeated int32 tails = 1;
int	getTailsCount() repeated int32 tails = 1;
java.util.List<java.lang.Integer>	getTailsList() repeated int32 tails = 1;
int	hashCode()
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static RoutesConstraintProto.Builder	newBuilder()
static RoutesConstraintProto.Builder	newBuilder(RoutesConstraintProto prototype)
RoutesConstraintProto.Builder	newBuilderForType()
protected RoutesConstraintProto.Builder	newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
static RoutesConstraintProto	parseDelimitedFrom(java.io.InputStream input)
static RoutesConstraintProto	parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RoutesConstraintProto	parseFrom(byte[] data)
static RoutesConstraintProto	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RoutesConstraintProto	parseFrom(java.nio.ByteBuffer data)
static RoutesConstraintProto	parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RoutesConstraintProto	parseFrom(com.google.protobuf.ByteString data)
static RoutesConstraintProto	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RoutesConstraintProto	parseFrom(com.google.protobuf.CodedInputStream input)
static RoutesConstraintProto	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RoutesConstraintProto	parseFrom(java.io.InputStream input)
static RoutesConstraintProto	parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<RoutesConstraintProto>	parser()
RoutesConstraintProto.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

TAILS_FIELD_NUMBER

public static final int TAILS_FIELD_NUMBER

See Also:

Constant Field Values

HEADS_FIELD_NUMBER

public static final int HEADS_FIELD_NUMBER

See Also:

Constant Field Values

LITERALS_FIELD_NUMBER

public static final int LITERALS_FIELD_NUMBER

See Also:

Constant Field Values

DEMANDS_FIELD_NUMBER

public static final int DEMANDS_FIELD_NUMBER

See Also:

Constant Field Values

CAPACITY_FIELD_NUMBER

public static final int CAPACITY_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

getTailsList

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

repeated int32 tails = 1;

Specified by:

getTailsList in interface RoutesConstraintProtoOrBuilder

Returns:

A list containing the tails.

getTailsCount

public int getTailsCount()

repeated int32 tails = 1;

Specified by:

getTailsCount in interface RoutesConstraintProtoOrBuilder

Returns:

The count of tails.

getTails

public int getTails(int index)

repeated int32 tails = 1;

Specified by:

getTails in interface RoutesConstraintProtoOrBuilder

Parameters:

index - The index of the element to return.

Returns:

The tails at the given index.

getHeadsList

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

repeated int32 heads = 2;

Specified by:

getHeadsList in interface RoutesConstraintProtoOrBuilder

Returns:

A list containing the heads.

getHeadsCount

public int getHeadsCount()

repeated int32 heads = 2;

Specified by:

getHeadsCount in interface RoutesConstraintProtoOrBuilder

Returns:

The count of heads.

getHeads

public int getHeads(int index)

repeated int32 heads = 2;

Specified by:

getHeads in interface RoutesConstraintProtoOrBuilder

Parameters:

index - The index of the element to return.

Returns:

The heads at the given index.

getLiteralsList

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

repeated int32 literals = 3;

Specified by:

getLiteralsList in interface RoutesConstraintProtoOrBuilder

Returns:

A list containing the literals.

getLiteralsCount

public int getLiteralsCount()

repeated int32 literals = 3;

Specified by:

getLiteralsCount in interface RoutesConstraintProtoOrBuilder

Returns:

The count of literals.

getLiterals

public int getLiterals(int index)

repeated int32 literals = 3;

Specified by:

getLiterals in interface RoutesConstraintProtoOrBuilder

Parameters:

index - The index of the element to return.

Returns:

The literals at the given index.

getDemandsList

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

 EXPERIMENTAL. The demands for each node, and the maximum capacity for each
 route. Note that this is currently only used for the LP relaxation and one
 need to add the corresponding constraint to enforce this outside of the LP.

 TODO(user): Ideally, we should be able to extract any dimension like these
 (i.e. capacity, route_length, etc..) automatically from the encoding. The
 classical way to encode that is to have "current_capacity" variables along
 the route and linear equations of the form:
 arc_literal => (current_capacity_tail + demand <= current_capacity_head)
 

repeated int32 demands = 4;

Specified by:

getDemandsList in interface RoutesConstraintProtoOrBuilder

Returns:

A list containing the demands.

getDemandsCount

public int getDemandsCount()

 EXPERIMENTAL. The demands for each node, and the maximum capacity for each
 route. Note that this is currently only used for the LP relaxation and one
 need to add the corresponding constraint to enforce this outside of the LP.

 TODO(user): Ideally, we should be able to extract any dimension like these
 (i.e. capacity, route_length, etc..) automatically from the encoding. The
 classical way to encode that is to have "current_capacity" variables along
 the route and linear equations of the form:
 arc_literal => (current_capacity_tail + demand <= current_capacity_head)
 

repeated int32 demands = 4;

Specified by:

getDemandsCount in interface RoutesConstraintProtoOrBuilder

Returns:

The count of demands.

getDemands

public int getDemands(int index)

 EXPERIMENTAL. The demands for each node, and the maximum capacity for each
 route. Note that this is currently only used for the LP relaxation and one
 need to add the corresponding constraint to enforce this outside of the LP.

 TODO(user): Ideally, we should be able to extract any dimension like these
 (i.e. capacity, route_length, etc..) automatically from the encoding. The
 classical way to encode that is to have "current_capacity" variables along
 the route and linear equations of the form:
 arc_literal => (current_capacity_tail + demand <= current_capacity_head)
 

repeated int32 demands = 4;

Specified by:

getDemands in interface RoutesConstraintProtoOrBuilder

Parameters:

index - The index of the element to return.

Returns:

The demands at the given index.

getCapacity

public long getCapacity()

int64 capacity = 5;

Specified by:

getCapacity in interface RoutesConstraintProtoOrBuilder

Returns:

The capacity.

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

java.io.IOException

parseFrom

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

Throws:

java.io.IOException

parseDelimitedFrom

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

Throws:

java.io.IOException

parseDelimitedFrom

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

Throws:

java.io.IOException

parseFrom

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

Throws:

java.io.IOException

parseFrom

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

Throws:

java.io.IOException

newBuilderForType

public RoutesConstraintProto.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static RoutesConstraintProto.Builder newBuilder()

newBuilder

public static RoutesConstraintProto.Builder newBuilder(RoutesConstraintProto prototype)

toBuilder

public RoutesConstraintProto.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

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

Overrides:

newBuilderForType in class com.google.protobuf.AbstractMessage

getDefaultInstance

public static RoutesConstraintProto getDefaultInstance()

parser

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

getParserForType

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

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder