com.google.ortools.sat.RoutesConstraintProtoOrBuilder Interface Reference

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

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 ()

Detailed Description

Definition at line 7 of file RoutesConstraintProtoOrBuilder.java.

Member Function Documentation

getCapacity()

long com.google.ortools.sat.RoutesConstraintProtoOrBuilder.getCapacity

(

)

int64 capacity = 5;

Returns

The capacity.

Implemented in com.google.ortools.sat.RoutesConstraintProto, and com.google.ortools.sat.RoutesConstraintProto.Builder.

getDemands()

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

Implemented in com.google.ortools.sat.RoutesConstraintProto, and com.google.ortools.sat.RoutesConstraintProto.Builder.

getDemandsCount()

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

Implemented in com.google.ortools.sat.RoutesConstraintProto, and com.google.ortools.sat.RoutesConstraintProto.Builder.

getDemandsList()

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

Implemented in com.google.ortools.sat.RoutesConstraintProto, and com.google.ortools.sat.RoutesConstraintProto.Builder.

getHeads()

int com.google.ortools.sat.RoutesConstraintProtoOrBuilder.getHeads

(

int

index

)

repeated int32 heads = 2;

Parameters

index

The index of the element to return.

Returns

The heads at the given index.

Implemented in com.google.ortools.sat.RoutesConstraintProto, and com.google.ortools.sat.RoutesConstraintProto.Builder.

getHeadsCount()

int com.google.ortools.sat.RoutesConstraintProtoOrBuilder.getHeadsCount

(

)

repeated int32 heads = 2;

Returns

The count of heads.

Implemented in com.google.ortools.sat.RoutesConstraintProto, and com.google.ortools.sat.RoutesConstraintProto.Builder.

getHeadsList()

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

(

)

repeated int32 heads = 2;

Returns

A list containing the heads.

Implemented in com.google.ortools.sat.RoutesConstraintProto, and com.google.ortools.sat.RoutesConstraintProto.Builder.

getLiterals()

int com.google.ortools.sat.RoutesConstraintProtoOrBuilder.getLiterals

(

int

index

)

repeated int32 literals = 3;

Parameters

index

The index of the element to return.

Returns

The literals at the given index.

Implemented in com.google.ortools.sat.RoutesConstraintProto, and com.google.ortools.sat.RoutesConstraintProto.Builder.

getLiteralsCount()

int com.google.ortools.sat.RoutesConstraintProtoOrBuilder.getLiteralsCount

(

)

repeated int32 literals = 3;

Returns

The count of literals.

Implemented in com.google.ortools.sat.RoutesConstraintProto, and com.google.ortools.sat.RoutesConstraintProto.Builder.

getLiteralsList()

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

(

)

repeated int32 literals = 3;

Returns

A list containing the literals.

Implemented in com.google.ortools.sat.RoutesConstraintProto, and com.google.ortools.sat.RoutesConstraintProto.Builder.

getTails()

int com.google.ortools.sat.RoutesConstraintProtoOrBuilder.getTails

(

int

index

)

repeated int32 tails = 1;

Parameters

index

The index of the element to return.

Returns

The tails at the given index.

Implemented in com.google.ortools.sat.RoutesConstraintProto, and com.google.ortools.sat.RoutesConstraintProto.Builder.

getTailsCount()

int com.google.ortools.sat.RoutesConstraintProtoOrBuilder.getTailsCount

(

)

repeated int32 tails = 1;

Returns

The count of tails.

Implemented in com.google.ortools.sat.RoutesConstraintProto, and com.google.ortools.sat.RoutesConstraintProto.Builder.

getTailsList()

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

(

)

repeated int32 tails = 1;

Returns

A list containing the tails.

Implemented in com.google.ortools.sat.RoutesConstraintProto, and com.google.ortools.sat.RoutesConstraintProto.Builder.

---

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

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