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 expects 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 35 of file RoutesConstraintProto.java.

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

Classes
class	Builder
class	NodeExpressions
interface	NodeExpressionsOrBuilder

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 ()
java.util.List< com.google.ortools.sat.RoutesConstraintProto.NodeExpressions >	getDimensionsList ()
java.util.List<? extends com.google.ortools.sat.RoutesConstraintProto.NodeExpressionsOrBuilder >	getDimensionsOrBuilderList ()
int	getDimensionsCount ()
com.google.ortools.sat.RoutesConstraintProto.NodeExpressions	getDimensions (int index)
com.google.ortools.sat.RoutesConstraintProto.NodeExpressionsOrBuilder	getDimensionsOrBuilder (int index)
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
static final int	DIMENSIONS_FIELD_NUMBER = 6

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

Member Function Documentation

◆ equals()

boolean com.google.ortools.sat.RoutesConstraintProto.equals ( final java.lang.Object obj )

Definition at line 1334 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 1101 of file RoutesConstraintProto.java.

◆ getDefaultInstance()

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

static

Definition at line 2693 of file RoutesConstraintProto.java.

◆ getDefaultInstanceForType()

com.google.ortools.sat.RoutesConstraintProto com.google.ortools.sat.RoutesConstraintProto.getDefaultInstanceForType ( )

Definition at line 2729 of file RoutesConstraintProto.java.

◆ getDemands()

int com.google.ortools.sat.RoutesConstraintProto.getDemands ( int index )

DEPRECATED. These fields are no longer used. The solver ignores them.

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 1089 of file RoutesConstraintProto.java.

◆ getDemandsCount()

int com.google.ortools.sat.RoutesConstraintProto.getDemandsCount ( )

DEPRECATED. These fields are no longer used. The solver ignores them.

repeated int32 demands = 4;

Returns: The count of demands.

Implements com.google.ortools.sat.RoutesConstraintProtoOrBuilder.

Definition at line 1077 of file RoutesConstraintProto.java.

◆ getDemandsList()

java.util.List< java.lang.Integer > com.google.ortools.sat.RoutesConstraintProto.getDemandsList ( )

DEPRECATED. These fields are no longer used. The solver ignores them.

repeated int32 demands = 4;

Returns: A list containing the demands.

Implements com.google.ortools.sat.RoutesConstraintProtoOrBuilder.

Definition at line 1066 of file RoutesConstraintProto.java.

◆ getDescriptor()

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

static

Definition at line 62 of file RoutesConstraintProto.java.

◆ getDimensions()

com.google.ortools.sat.RoutesConstraintProto.NodeExpressions com.google.ortools.sat.RoutesConstraintProto.getDimensions ( int index )

Expressions associated with the nodes of the graph, such as the load of the
vehicle arriving at a node, or the time at which a vehicle arrives at a
node. Expressions with the same "dimension" (such as "load" or "time") must
be listed together.
This field is optional. If it is set, the linear constraints of size 1 or 2
between the variables in these expressions will be used to derive cuts for
this constraint. If it is not set, the solver will try to automatically
derive it, from the linear constraints of size 1 or 2 in the model (this
can fail in complex cases).