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

Public Member Functions
Builder	clear ()

com.google.protobuf.Descriptors.Descriptor	getDescriptorForType ()

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

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

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

Builder	mergeFrom (com.google.protobuf.Message other)

Builder	mergeFrom (com.google.ortools.sat.RoutesConstraintProto other)

final boolean	isInitialized ()

Builder	mergeFrom (com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException

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

int	getTailsCount ()

int	getTails (int index)

Builder	setTails (int index, int value)

Builder	addTails (int value)

Builder	addAllTails (java.lang.Iterable<? extends java.lang.Integer > values)

Builder	clearTails ()

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

int	getHeadsCount ()

int	getHeads (int index)

Builder	setHeads (int index, int value)

Builder	addHeads (int value)

Builder	addAllHeads (java.lang.Iterable<? extends java.lang.Integer > values)

Builder	clearHeads ()

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

int	getLiteralsCount ()

int	getLiterals (int index)

Builder	setLiterals (int index, int value)

Builder	addLiterals (int value)

Builder	addAllLiterals (java.lang.Iterable<? extends java.lang.Integer > values)

Builder	clearLiterals ()

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

int	getDemandsCount ()

int	getDemands (int index)

Builder	setDemands (int index, int value)

Builder	addDemands (int value)

Builder	addAllDemands (java.lang.Iterable<? extends java.lang.Integer > values)

Builder	clearDemands ()

long	getCapacity ()

Builder	setCapacity (long value)

Builder	clearCapacity ()

Static Public Member Functions
static final com.google.protobuf.Descriptors.Descriptor	getDescriptor ()

Protected Member Functions
com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable ()

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

Member Function Documentation

◆ addAllDemands()

Builder com.google.ortools.sat.RoutesConstraintProto.Builder.addAllDemands ( java.lang.Iterable<? extends java.lang.Integer > values )

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

values The demands to add.

Returns: This builder for chaining.

Definition at line 1181 of file RoutesConstraintProto.java.

◆ addAllHeads()

Builder com.google.ortools.sat.RoutesConstraintProto.Builder.addAllHeads ( java.lang.Iterable<? extends java.lang.Integer > values )

repeated int32 heads = 2;

Parameters

values The heads to add.

Returns: This builder for chaining.

Definition at line 941 of file RoutesConstraintProto.java.

◆ addAllLiterals()

Builder com.google.ortools.sat.RoutesConstraintProto.Builder.addAllLiterals ( java.lang.Iterable<? extends java.lang.Integer > values )

repeated int32 literals = 3;

Parameters

values The literals to add.

Returns: This builder for chaining.

Definition at line 1025 of file RoutesConstraintProto.java.

◆ addAllTails()

Builder com.google.ortools.sat.RoutesConstraintProto.Builder.addAllTails ( java.lang.Iterable<? extends java.lang.Integer > values )

repeated int32 tails = 1;

Parameters

values The tails to add.

Returns: This builder for chaining.

Definition at line 857 of file RoutesConstraintProto.java.

◆ addDemands()

Builder com.google.ortools.sat.RoutesConstraintProto.Builder.addDemands ( int value )

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

value The demands to add.

Returns: This builder for chaining.

Definition at line 1156 of file RoutesConstraintProto.java.

◆ addHeads()

Builder com.google.ortools.sat.RoutesConstraintProto.Builder.addHeads ( int value )

repeated int32 heads = 2;

Parameters

value The heads to add.

Returns: This builder for chaining.

Definition at line 928 of file RoutesConstraintProto.java.

◆ addLiterals()

Builder com.google.ortools.sat.RoutesConstraintProto.Builder.addLiterals ( int value )

repeated int32 literals = 3;

Parameters

value The literals to add.

Returns: This builder for chaining.

Definition at line 1012 of file RoutesConstraintProto.java.

◆ addTails()

Builder com.google.ortools.sat.RoutesConstraintProto.Builder.addTails ( int value )

repeated int32 tails = 1;

Parameters

value The tails to add.

Returns: This builder for chaining.

Definition at line 844 of file RoutesConstraintProto.java.

◆ build()

com.google.ortools.sat.RoutesConstraintProto com.google.ortools.sat.RoutesConstraintProto.Builder.build ( )

Definition at line 583 of file RoutesConstraintProto.java.

◆ buildPartial()

com.google.ortools.sat.RoutesConstraintProto com.google.ortools.sat.RoutesConstraintProto.Builder.buildPartial ( )

Definition at line 592 of file RoutesConstraintProto.java.

◆ clear()

Builder com.google.ortools.sat.RoutesConstraintProto.Builder.clear ( )

Definition at line 560 of file RoutesConstraintProto.java.

◆ clearCapacity()

Builder com.google.ortools.sat.RoutesConstraintProto.Builder.clearCapacity ( )

int64 capacity = 5;

Returns: This builder for chaining.

Definition at line 1238 of file RoutesConstraintProto.java.

◆ clearDemands()

Builder com.google.ortools.sat.RoutesConstraintProto.Builder.clearDemands ( )

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: This builder for chaining.

Definition at line 1206 of file RoutesConstraintProto.java.

◆ clearHeads()

Builder com.google.ortools.sat.RoutesConstraintProto.Builder.clearHeads ( )

repeated int32 heads = 2;

Returns: This builder for chaining.

Definition at line 954 of file RoutesConstraintProto.java.

◆ clearLiterals()

Builder com.google.ortools.sat.RoutesConstraintProto.Builder.clearLiterals ( )

repeated int32 literals = 3;

Returns: This builder for chaining.

Definition at line 1038 of file RoutesConstraintProto.java.

◆ clearTails()

Builder com.google.ortools.sat.RoutesConstraintProto.Builder.clearTails ( )

repeated int32 tails = 1;

Returns: This builder for chaining.

Definition at line 870 of file RoutesConstraintProto.java.

◆ getCapacity()

long com.google.ortools.sat.RoutesConstraintProto.Builder.getCapacity ( )

int64 capacity = 5;

Returns: The capacity.

Implements com.google.ortools.sat.RoutesConstraintProtoOrBuilder.

Definition at line 1219 of file RoutesConstraintProto.java.

◆ getDefaultInstanceForType()

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

Definition at line 578 of file RoutesConstraintProto.java.

◆ getDemands()

int com.google.ortools.sat.RoutesConstraintProto.Builder.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 1109 of file RoutesConstraintProto.java.

◆ getDemandsCount()

int com.google.ortools.sat.RoutesConstraintProto.Builder.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 1089 of file RoutesConstraintProto.java.

◆ getDemandsList()

java.util.List< java.lang.Integer > com.google.ortools.sat.RoutesConstraintProto.Builder.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 1069 of file RoutesConstraintProto.java.

◆ getDescriptor()

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

static

Definition at line 537 of file RoutesConstraintProto.java.

◆ getDescriptorForType()

com.google.protobuf.Descriptors.Descriptor com.google.ortools.sat.RoutesConstraintProto.Builder.getDescriptorForType ( )

Definition at line 573 of file RoutesConstraintProto.java.

◆ getHeads()

int com.google.ortools.sat.RoutesConstraintProto.Builder.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 905 of file RoutesConstraintProto.java.

◆ getHeadsCount()

int com.google.ortools.sat.RoutesConstraintProto.Builder.getHeadsCount ( )

repeated int32 heads = 2;

Returns: The count of heads.

Implements com.google.ortools.sat.RoutesConstraintProtoOrBuilder.

Definition at line 897 of file RoutesConstraintProto.java.

◆ getHeadsList()

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

repeated int32 heads = 2;

Returns: A list containing the heads.

Implements com.google.ortools.sat.RoutesConstraintProtoOrBuilder.

Definition at line 889 of file RoutesConstraintProto.java.

◆ getLiterals()

int com.google.ortools.sat.RoutesConstraintProto.Builder.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 989 of file RoutesConstraintProto.java.

◆ getLiteralsCount()

int com.google.ortools.sat.RoutesConstraintProto.Builder.getLiteralsCount ( )

repeated int32 literals = 3;

Returns: The count of literals.

Implements com.google.ortools.sat.RoutesConstraintProtoOrBuilder.

Definition at line 981 of file RoutesConstraintProto.java.

◆ getLiteralsList()

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

repeated int32 literals = 3;

Returns: A list containing the literals.

Implements com.google.ortools.sat.RoutesConstraintProtoOrBuilder.

Definition at line 973 of file RoutesConstraintProto.java.

◆ getTails()

int com.google.ortools.sat.RoutesConstraintProto.Builder.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 821 of file RoutesConstraintProto.java.

◆ getTailsCount()

int com.google.ortools.sat.RoutesConstraintProto.Builder.getTailsCount ( )

repeated int32 tails = 1;

Returns: The count of tails.

Implements com.google.ortools.sat.RoutesConstraintProtoOrBuilder.

Definition at line 813 of file RoutesConstraintProto.java.

◆ getTailsList()

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

repeated int32 tails = 1;

Returns: A list containing the tails.

Implements com.google.ortools.sat.RoutesConstraintProtoOrBuilder.

Definition at line 805 of file RoutesConstraintProto.java.

◆ internalGetFieldAccessorTable()

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

protected

Definition at line 543 of file RoutesConstraintProto.java.

◆ isInitialized()

final boolean com.google.ortools.sat.RoutesConstraintProto.Builder.isInitialized ( )

Definition at line 687 of file RoutesConstraintProto.java.

◆ mergeFrom() [1/3]

Builder com.google.ortools.sat.RoutesConstraintProto.Builder.mergeFrom ( com.google.ortools.sat.RoutesConstraintProto other )

Definition at line 632 of file RoutesConstraintProto.java.

◆ mergeFrom() [2/3]

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

Definition at line 692 of file RoutesConstraintProto.java.

◆ mergeFrom() [3/3]

Builder com.google.ortools.sat.RoutesConstraintProto.Builder.mergeFrom ( com.google.protobuf.Message other )

Definition at line 623 of file RoutesConstraintProto.java.

◆ setCapacity()

Builder com.google.ortools.sat.RoutesConstraintProto.Builder.setCapacity ( long value )

int64 capacity = 5;

Parameters

value The capacity to set.

Returns: This builder for chaining.

Definition at line 1227 of file RoutesConstraintProto.java.

◆ setDemands()

Builder com.google.ortools.sat.RoutesConstraintProto.Builder.setDemands	(	int	index,
		int	value )

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 to set the value at.
value	The demands to set.

Returns: This builder for chaining.

Definition at line 1130 of file RoutesConstraintProto.java.

◆ setHeads()

Builder com.google.ortools.sat.RoutesConstraintProto.Builder.setHeads	(	int	index,
		int	value )

repeated int32 heads = 2;

Parameters

index	The index to set the value at.
value	The heads to set.

Returns: This builder for chaining.

Definition at line 914 of file RoutesConstraintProto.java.

◆ setLiterals()

Builder com.google.ortools.sat.RoutesConstraintProto.Builder.setLiterals	(	int	index,
		int	value )

repeated int32 literals = 3;

Parameters

index	The index to set the value at.
value	The literals to set.

Returns: This builder for chaining.

Definition at line 998 of file RoutesConstraintProto.java.

◆ setTails()

Builder com.google.ortools.sat.RoutesConstraintProto.Builder.setTails	(	int	index,
		int	value )

repeated int32 tails = 1;

Parameters

index	The index to set the value at.
value	The tails to set.

Returns: This builder for chaining.

Definition at line 830 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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Member Function Documentation

◆ addAllDemands()

◆ addAllHeads()

◆ addAllLiterals()

◆ addAllTails()

◆ addDemands()

◆ addHeads()

◆ addLiterals()

◆ addTails()

◆ build()

◆ buildPartial()

◆ clear()

◆ clearCapacity()

◆ clearDemands()

◆ clearHeads()

◆ clearLiterals()

◆ clearTails()

◆ getCapacity()

◆ getDefaultInstanceForType()

◆ getDemands()

◆ getDemandsCount()

◆ getDemandsList()

◆ getDescriptor()

◆ getDescriptorForType()

◆ getHeads()

◆ getHeadsCount()

◆ getHeadsList()

◆ getLiterals()

◆ getLiteralsCount()

◆ getLiteralsList()

◆ getTails()

◆ getTailsCount()

◆ getTailsList()

◆ internalGetFieldAccessorTable()

◆ isInitialized()

◆ mergeFrom() [1/3]

◆ mergeFrom() [2/3]

◆ mergeFrom() [3/3]

◆ setCapacity()

◆ setDemands()

◆ setHeads()

◆ setLiterals()

◆ setTails()