com.google.ortools.sat.RoutesConstraintProto Class Reference

Inheritance diagram for com.google.ortools.sat.RoutesConstraintProto:

Classes
class	Builder

Public Member Functions
java.util.List< java.lang.Integer >	getTailsList ()
int	getTailsCount ()
int	getTails (int index)
java.util.List< java.lang.Integer >	getHeadsList ()
int	getHeadsCount ()
int	getHeads (int index)
java.util.List< java.lang.Integer >	getLiteralsList ()
int	getLiteralsCount ()
int	getLiterals (int index)
java.util.List< java.lang.Integer >	getDemandsList ()
int	getDemandsCount ()
int	getDemands (int index)
long	getCapacity ()
final boolean	isInitialized ()
void	writeTo (com.google.protobuf.CodedOutputStream output) throws java.io.IOException
int	getSerializedSize ()
boolean	equals (final java.lang.Object obj)
int	hashCode ()
Builder	newBuilderForType ()
Builder	toBuilder ()
com.google.protobuf.Parser< RoutesConstraintProto >	getParserForType ()
com.google.ortools.sat.RoutesConstraintProto	getDefaultInstanceForType ()

Static Public Member Functions
static final com.google.protobuf.Descriptors.Descriptor	getDescriptor ()
static com.google.ortools.sat.RoutesConstraintProto	parseFrom (java.nio.ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
static com.google.ortools.sat.RoutesConstraintProto	parseFrom (java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
static com.google.ortools.sat.RoutesConstraintProto	parseFrom (com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
static com.google.ortools.sat.RoutesConstraintProto	parseFrom (com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
static com.google.ortools.sat.RoutesConstraintProto	parseFrom (byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
static com.google.ortools.sat.RoutesConstraintProto	parseFrom (byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
static com.google.ortools.sat.RoutesConstraintProto	parseFrom (java.io.InputStream input) throws java.io.IOException
static com.google.ortools.sat.RoutesConstraintProto	parseFrom (java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
static com.google.ortools.sat.RoutesConstraintProto	parseDelimitedFrom (java.io.InputStream input) throws java.io.IOException
static com.google.ortools.sat.RoutesConstraintProto	parseDelimitedFrom (java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
static com.google.ortools.sat.RoutesConstraintProto	parseFrom (com.google.protobuf.CodedInputStream input) throws java.io.IOException
static com.google.ortools.sat.RoutesConstraintProto	parseFrom (com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
static Builder	newBuilder ()
static Builder	newBuilder (com.google.ortools.sat.RoutesConstraintProto prototype)
static com.google.ortools.sat.RoutesConstraintProto	getDefaultInstance ()
static com.google.protobuf.Parser< RoutesConstraintProto >	parser ()

Static Public Attributes
static final int	TAILS_FIELD_NUMBER = 1
static final int	HEADS_FIELD_NUMBER = 2
static final int	LITERALS_FIELD_NUMBER = 3
static final int	DEMANDS_FIELD_NUMBER = 4
static final int	CAPACITY_FIELD_NUMBER = 5

Protected Member Functions
com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable ()
Builder	newBuilderForType (com.google.protobuf.GeneratedMessage.BuilderParent parent)

Detailed Description

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

Definition at line 34 of file RoutesConstraintProto.java.

Member Function Documentation

equals()

boolean com.google.ortools.sat.RoutesConstraintProto.equals

(

final java.lang.Object

obj

)

Definition at line 360 of file RoutesConstraintProto.java.

getCapacity()

long com.google.ortools.sat.RoutesConstraintProto.getCapacity

(

)

int64 capacity = 5;

Returns

The capacity.

Implements com.google.ortools.sat.RoutesConstraintProtoOrBuilder.

Definition at line 235 of file RoutesConstraintProto.java.

getDefaultInstance()

static com.google.ortools.sat.RoutesConstraintProto com.google.ortools.sat.RoutesConstraintProto.getDefaultInstance ( )

static

Definition at line 1254 of file RoutesConstraintProto.java.

getDefaultInstanceForType()

com.google.ortools.sat.RoutesConstraintProto com.google.ortools.sat.RoutesConstraintProto.getDefaultInstanceForType

(

)

Definition at line 1290 of file RoutesConstraintProto.java.

getDemands()

int com.google.ortools.sat.RoutesConstraintProto.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;

Parameters

index

The index of the element to return.

Returns

The demands at the given index.

Implements com.google.ortools.sat.RoutesConstraintProtoOrBuilder.

Definition at line 223 of file RoutesConstraintProto.java.

getDemandsCount()

int com.google.ortools.sat.RoutesConstraintProto.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;

Returns

The count of demands.

Implements com.google.ortools.sat.RoutesConstraintProtoOrBuilder.

Definition at line 203 of file RoutesConstraintProto.java.

getDemandsList()

java.util.List< java.lang.Integer > com.google.ortools.sat.RoutesConstraintProto.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;

Returns

A list containing the demands.

Implements com.google.ortools.sat.RoutesConstraintProtoOrBuilder.

Definition at line 184 of file RoutesConstraintProto.java.

getDescriptor()

static final com.google.protobuf.Descriptors.Descriptor com.google.ortools.sat.RoutesConstraintProto.getDescriptor ( )

static

Definition at line 60 of file RoutesConstraintProto.java.

getHeads()

int com.google.ortools.sat.RoutesConstraintProto.getHeads

(

int

index

)

repeated int32 heads = 2;

Parameters

index

The index of the element to return.

Returns

The heads at the given index.

Implements com.google.ortools.sat.RoutesConstraintProtoOrBuilder.

Definition at line 127 of file RoutesConstraintProto.java.

getHeadsCount()

int com.google.ortools.sat.RoutesConstraintProto.getHeadsCount

(

)

repeated int32 heads = 2;

Returns

The count of heads.

Implements com.google.ortools.sat.RoutesConstraintProtoOrBuilder.

Definition at line 119 of file RoutesConstraintProto.java.

getHeadsList()

java.util.List< java.lang.Integer > com.google.ortools.sat.RoutesConstraintProto.getHeadsList

(

)

repeated int32 heads = 2;

Returns

A list containing the heads.

Implements com.google.ortools.sat.RoutesConstraintProtoOrBuilder.

Definition at line 112 of file RoutesConstraintProto.java.

getLiterals()

int com.google.ortools.sat.RoutesConstraintProto.getLiterals

(

int

index

)

repeated int32 literals = 3;

Parameters

index

The index of the element to return.

Returns

The literals at the given index.

Implements com.google.ortools.sat.RoutesConstraintProtoOrBuilder.

Definition at line 157 of file RoutesConstraintProto.java.

getLiteralsCount()

int com.google.ortools.sat.RoutesConstraintProto.getLiteralsCount

(

)

repeated int32 literals = 3;

Returns

The count of literals.

Implements com.google.ortools.sat.RoutesConstraintProtoOrBuilder.

Definition at line 149 of file RoutesConstraintProto.java.

getLiteralsList()

java.util.List< java.lang.Integer > com.google.ortools.sat.RoutesConstraintProto.getLiteralsList

(

)

repeated int32 literals = 3;

Returns

A list containing the literals.

Implements com.google.ortools.sat.RoutesConstraintProtoOrBuilder.

Definition at line 142 of file RoutesConstraintProto.java.

getParserForType()

com.google.protobuf.Parser< RoutesConstraintProto > com.google.ortools.sat.RoutesConstraintProto.getParserForType

(

)

Definition at line 1285 of file RoutesConstraintProto.java.

getSerializedSize()

int com.google.ortools.sat.RoutesConstraintProto.getSerializedSize

(

)

Definition at line 289 of file RoutesConstraintProto.java.

getTails()

int com.google.ortools.sat.RoutesConstraintProto.getTails

(

int

index

)

repeated int32 tails = 1;

Parameters

index

The index of the element to return.

Returns

The tails at the given index.

Implements com.google.ortools.sat.RoutesConstraintProtoOrBuilder.

Definition at line 97 of file RoutesConstraintProto.java.

getTailsCount()

int com.google.ortools.sat.RoutesConstraintProto.getTailsCount

(

)

repeated int32 tails = 1;

Returns

The count of tails.

Implements com.google.ortools.sat.RoutesConstraintProtoOrBuilder.

Definition at line 89 of file RoutesConstraintProto.java.

getTailsList()

java.util.List< java.lang.Integer > com.google.ortools.sat.RoutesConstraintProto.getTailsList

(

)

repeated int32 tails = 1;

Returns

A list containing the tails.

Implements com.google.ortools.sat.RoutesConstraintProtoOrBuilder.

Definition at line 82 of file RoutesConstraintProto.java.

hashCode()

int com.google.ortools.sat.RoutesConstraintProto.hashCode

(

)

Definition at line 384 of file RoutesConstraintProto.java.

internalGetFieldAccessorTable()

com.google.protobuf.GeneratedMessage.FieldAccessorTable com.google.ortools.sat.RoutesConstraintProto.internalGetFieldAccessorTable ( )

protected

Definition at line 66 of file RoutesConstraintProto.java.

isInitialized()

final boolean com.google.ortools.sat.RoutesConstraintProto.isInitialized

(

)

Definition at line 241 of file RoutesConstraintProto.java.

newBuilder() [1/2]

static Builder com.google.ortools.sat.RoutesConstraintProto.newBuilder ( )

static

Definition at line 488 of file RoutesConstraintProto.java.

newBuilder() [2/2]

static Builder com.google.ortools.sat.RoutesConstraintProto.newBuilder ( com.google.ortools.sat.RoutesConstraintProto prototype )

static

Definition at line 491 of file RoutesConstraintProto.java.

newBuilderForType() [1/2]

Builder com.google.ortools.sat.RoutesConstraintProto.newBuilderForType

(

)

Definition at line 487 of file RoutesConstraintProto.java.

newBuilderForType() [2/2]

Builder com.google.ortools.sat.RoutesConstraintProto.newBuilderForType ( com.google.protobuf.GeneratedMessage.BuilderParent parent )

protected

Definition at line 501 of file RoutesConstraintProto.java.

parseDelimitedFrom() [1/2]

static com.google.ortools.sat.RoutesConstraintProto com.google.ortools.sat.RoutesConstraintProto.parseDelimitedFrom ( java.io.InputStream input ) throws java.io.IOException

static

Definition at line 459 of file RoutesConstraintProto.java.

parseDelimitedFrom() [2/2]

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

static

Definition at line 465 of file RoutesConstraintProto.java.

parseFrom() [1/10]

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

static

Definition at line 436 of file RoutesConstraintProto.java.

parseFrom() [2/10]

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

static

Definition at line 440 of file RoutesConstraintProto.java.

parseFrom() [3/10]

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

static

Definition at line 425 of file RoutesConstraintProto.java.

parseFrom() [4/10]

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

static

Definition at line 430 of file RoutesConstraintProto.java.

parseFrom() [5/10]

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

static

Definition at line 472 of file RoutesConstraintProto.java.

parseFrom() [6/10]

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

static

Definition at line 478 of file RoutesConstraintProto.java.

parseFrom() [7/10]

static com.google.ortools.sat.RoutesConstraintProto com.google.ortools.sat.RoutesConstraintProto.parseFrom ( java.io.InputStream input ) throws java.io.IOException

static

Definition at line 446 of file RoutesConstraintProto.java.

parseFrom() [8/10]

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

static

Definition at line 451 of file RoutesConstraintProto.java.

parseFrom() [9/10]

static com.google.ortools.sat.RoutesConstraintProto com.google.ortools.sat.RoutesConstraintProto.parseFrom ( java.nio.ByteBuffer data ) throws com.google.protobuf.InvalidProtocolBufferException

static

Definition at line 414 of file RoutesConstraintProto.java.

parseFrom() [10/10]

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

static

Definition at line 419 of file RoutesConstraintProto.java.

parser()

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

static

Definition at line 1280 of file RoutesConstraintProto.java.

toBuilder()

Builder com.google.ortools.sat.RoutesConstraintProto.toBuilder

(

)

Definition at line 495 of file RoutesConstraintProto.java.

writeTo()

void com.google.ortools.sat.RoutesConstraintProto.writeTo

(

com.google.protobuf.CodedOutputStream

output

)

throws java.io.IOException

Definition at line 251 of file RoutesConstraintProto.java.

Member Data Documentation

CAPACITY_FIELD_NUMBER

final int com.google.ortools.sat.RoutesConstraintProto.CAPACITY_FIELD_NUMBER = 5

static

Definition at line 228 of file RoutesConstraintProto.java.

DEMANDS_FIELD_NUMBER

final int com.google.ortools.sat.RoutesConstraintProto.DEMANDS_FIELD_NUMBER = 4

static

Definition at line 162 of file RoutesConstraintProto.java.

HEADS_FIELD_NUMBER

final int com.google.ortools.sat.RoutesConstraintProto.HEADS_FIELD_NUMBER = 2

static

Definition at line 102 of file RoutesConstraintProto.java.

LITERALS_FIELD_NUMBER

final int com.google.ortools.sat.RoutesConstraintProto.LITERALS_FIELD_NUMBER = 3

static

Definition at line 132 of file RoutesConstraintProto.java.

TAILS_FIELD_NUMBER

final int com.google.ortools.sat.RoutesConstraintProto.TAILS_FIELD_NUMBER = 1

static

Definition at line 72 of file RoutesConstraintProto.java.

---

The documentation for this class was generated from the following file:

• build/java/ortools-java/src/main/java/com/google/ortools/sat/RoutesConstraintProto.java