Detailed Description

Parameters used to configure savings heuristics.

Protobuf type operations_research.SavingsParameters

Definition at line 325 of file SavingsParameters.java.

Inheritance diagram for com.google.ortools.constraintsolver.SavingsParameters.Builder:

Public Member Functions
Builder	clear ()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType ()
com.google.ortools.constraintsolver.SavingsParameters	getDefaultInstanceForType ()
com.google.ortools.constraintsolver.SavingsParameters	build ()
com.google.ortools.constraintsolver.SavingsParameters	buildPartial ()
Builder	mergeFrom (com.google.protobuf.Message other)
Builder	mergeFrom (com.google.ortools.constraintsolver.SavingsParameters other)
final boolean	isInitialized ()
Builder	mergeFrom (com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
double	getNeighborsRatio ()
Builder	setNeighborsRatio (double value)
Builder	clearNeighborsRatio ()
double	getMaxMemoryUsageBytes ()
Builder	setMaxMemoryUsageBytes (double value)
Builder	clearMaxMemoryUsageBytes ()
boolean	getAddReverseArcs ()
Builder	setAddReverseArcs (boolean value)
Builder	clearAddReverseArcs ()
double	getArcCoefficient ()
Builder	setArcCoefficient (double value)
Builder	clearArcCoefficient ()

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

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

Member Function Documentation

◆ build()

com.google.ortools.constraintsolver.SavingsParameters com.google.ortools.constraintsolver.SavingsParameters.Builder.build ( )

Definition at line 375 of file SavingsParameters.java.

◆ buildPartial()

com.google.ortools.constraintsolver.SavingsParameters com.google.ortools.constraintsolver.SavingsParameters.Builder.buildPartial ( )

Definition at line 384 of file SavingsParameters.java.

◆ clear()

Builder com.google.ortools.constraintsolver.SavingsParameters.Builder.clear ( )

Definition at line 353 of file SavingsParameters.java.

◆ clearAddReverseArcs()

Builder com.google.ortools.constraintsolver.SavingsParameters.Builder.clearAddReverseArcs ( )

Add savings related to reverse arcs when finding the nearest neighbors
of the nodes.

bool add_reverse_arcs = 3;

Returns: This builder for chaining.

Definition at line 640 of file SavingsParameters.java.

◆ clearArcCoefficient()

Builder com.google.ortools.constraintsolver.SavingsParameters.Builder.clearArcCoefficient ( )

Coefficient of the cost of the arc for which the saving value is being
computed:
Saving(a-->b) = Cost(a-->end) + Cost(start-->b)
- arc_coefficient * Cost(a-->b)
This parameter must be greater than 0, and its default value is 1.

double arc_coefficient = 4;

Returns: This builder for chaining.

Definition at line 696 of file SavingsParameters.java.

◆ clearMaxMemoryUsageBytes()

Builder com.google.ortools.constraintsolver.SavingsParameters.Builder.clearMaxMemoryUsageBytes ( )

The number of neighbors considered for each node in the Savings heuristic
is chosen so that the space used to store the savings doesn't exceed
max_memory_usage_bytes, which must be in ]0, 1e10].
NOTE: If both neighbors_ratio and max_memory_usage_bytes
are specified, the number of neighbors considered for each node will be the
minimum of the two numbers determined by these parameters.

double max_memory_usage_bytes = 2;

Returns: This builder for chaining.

Definition at line 593 of file SavingsParameters.java.

◆ clearNeighborsRatio()

Builder com.google.ortools.constraintsolver.SavingsParameters.Builder.clearNeighborsRatio ( )

Ratio (in ]0, 1]) of neighbors to consider for each node when constructing
the savings. If unspecified, its value is considered to be 1.0.

double neighbors_ratio = 1;

Returns: This builder for chaining.

Definition at line 534 of file SavingsParameters.java.

◆ getAddReverseArcs()

boolean com.google.ortools.constraintsolver.SavingsParameters.Builder.getAddReverseArcs ( )

Add savings related to reverse arcs when finding the nearest neighbors
of the nodes.

bool add_reverse_arcs = 3;

Returns: The addReverseArcs.

Implements com.google.ortools.constraintsolver.SavingsParametersOrBuilder.

Definition at line 611 of file SavingsParameters.java.

◆ getArcCoefficient()

double com.google.ortools.constraintsolver.SavingsParameters.Builder.getArcCoefficient ( )

Coefficient of the cost of the arc for which the saving value is being
computed:
Saving(a-->b) = Cost(a-->end) + Cost(start-->b)
- arc_coefficient * Cost(a-->b)
This parameter must be greater than 0, and its default value is 1.

double arc_coefficient = 4;

Returns: The arcCoefficient.

Implements com.google.ortools.constraintsolver.SavingsParametersOrBuilder.

Definition at line 661 of file SavingsParameters.java.

◆ getDefaultInstanceForType()

com.google.ortools.constraintsolver.SavingsParameters com.google.ortools.constraintsolver.SavingsParameters.Builder.getDefaultInstanceForType ( )

Definition at line 370 of file SavingsParameters.java.

◆ getDescriptor()

final com.google.protobuf.Descriptors.Descriptor com.google.ortools.constraintsolver.SavingsParameters.Builder.getDescriptor ( )

static

Definition at line 330 of file SavingsParameters.java.

◆ getDescriptorForType()

com.google.protobuf.Descriptors.Descriptor com.google.ortools.constraintsolver.SavingsParameters.Builder.getDescriptorForType ( )

Definition at line 365 of file SavingsParameters.java.

◆ getMaxMemoryUsageBytes()

double com.google.ortools.constraintsolver.SavingsParameters.Builder.getMaxMemoryUsageBytes ( )

The number of neighbors considered for each node in the Savings heuristic
is chosen so that the space used to store the savings doesn't exceed
max_memory_usage_bytes, which must be in ]0, 1e10].
NOTE: If both neighbors_ratio and max_memory_usage_bytes
are specified, the number of neighbors considered for each node will be the
minimum of the two numbers determined by these parameters.

double max_memory_usage_bytes = 2;

Returns: The maxMemoryUsageBytes.

Implements com.google.ortools.constraintsolver.SavingsParametersOrBuilder.

Definition at line 556 of file SavingsParameters.java.

◆ getNeighborsRatio()

double com.google.ortools.constraintsolver.SavingsParameters.Builder.getNeighborsRatio ( )

Ratio (in ]0, 1]) of neighbors to consider for each node when constructing
the savings. If unspecified, its value is considered to be 1.0.

double neighbors_ratio = 1;

Returns: The neighborsRatio.

Implements com.google.ortools.constraintsolver.SavingsParametersOrBuilder.

Definition at line 505 of file SavingsParameters.java.

◆ internalGetFieldAccessorTable()

com.google.protobuf.GeneratedMessage.FieldAccessorTable com.google.ortools.constraintsolver.SavingsParameters.Builder.internalGetFieldAccessorTable ( )

protected

Definition at line 336 of file SavingsParameters.java.

◆ isInitialized()

final boolean com.google.ortools.constraintsolver.SavingsParameters.Builder.isInitialized ( )

Definition at line 437 of file SavingsParameters.java.

◆ mergeFrom() [1/3]

Builder com.google.ortools.constraintsolver.SavingsParameters.Builder.mergeFrom ( com.google.ortools.constraintsolver.SavingsParameters other )

Definition at line 417 of file SavingsParameters.java.

◆ mergeFrom() [2/3]

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

Definition at line 442 of file SavingsParameters.java.

◆ mergeFrom() [3/3]

Builder com.google.ortools.constraintsolver.SavingsParameters.Builder.mergeFrom ( com.google.protobuf.Message other )

Definition at line 408 of file SavingsParameters.java.

◆ setAddReverseArcs()

Builder com.google.ortools.constraintsolver.SavingsParameters.Builder.setAddReverseArcs ( boolean value )

Add savings related to reverse arcs when finding the nearest neighbors
of the nodes.

bool add_reverse_arcs = 3;

Parameters

value The addReverseArcs to set.

Returns: This builder for chaining.

Definition at line 624 of file SavingsParameters.java.

◆ setArcCoefficient()

Builder com.google.ortools.constraintsolver.SavingsParameters.Builder.setArcCoefficient ( double value )

Coefficient of the cost of the arc for which the saving value is being
computed:
Saving(a-->b) = Cost(a-->end) + Cost(start-->b)
- arc_coefficient * Cost(a-->b)
This parameter must be greater than 0, and its default value is 1.

double arc_coefficient = 4;

Parameters

value The arcCoefficient to set.

Returns: This builder for chaining.

Definition at line 677 of file SavingsParameters.java.

◆ setMaxMemoryUsageBytes()

Builder com.google.ortools.constraintsolver.SavingsParameters.Builder.setMaxMemoryUsageBytes ( double value )

The number of neighbors considered for each node in the Savings heuristic
is chosen so that the space used to store the savings doesn't exceed
max_memory_usage_bytes, which must be in ]0, 1e10].
NOTE: If both neighbors_ratio and max_memory_usage_bytes
are specified, the number of neighbors considered for each node will be the
minimum of the two numbers determined by these parameters.

double max_memory_usage_bytes = 2;

Parameters

value The maxMemoryUsageBytes to set.

Returns: This builder for chaining.

Definition at line 573 of file SavingsParameters.java.

◆ setNeighborsRatio()

Builder com.google.ortools.constraintsolver.SavingsParameters.Builder.setNeighborsRatio ( double value )

Ratio (in ]0, 1]) of neighbors to consider for each node when constructing
the savings. If unspecified, its value is considered to be 1.0.

double neighbors_ratio = 1;

Parameters

value The neighborsRatio to set.

Returns: This builder for chaining.

Definition at line 518 of file SavingsParameters.java.

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

build/java/ortools-java/src/main/java/com/google/ortools/constraintsolver/SavingsParameters.java

Detailed Description

Public Member Functions

Static Public Member Functions

Protected Member Functions

Member Function Documentation

◆ build()

◆ buildPartial()

◆ clear()

◆ clearAddReverseArcs()

◆ clearArcCoefficient()

◆ clearMaxMemoryUsageBytes()

◆ clearNeighborsRatio()

◆ getAddReverseArcs()

◆ getArcCoefficient()

◆ getDefaultInstanceForType()

◆ getDescriptor()

◆ getDescriptorForType()

◆ getMaxMemoryUsageBytes()

◆ getNeighborsRatio()

◆ internalGetFieldAccessorTable()

◆ isInitialized()

◆ mergeFrom() [1/3]

◆ mergeFrom() [2/3]

◆ mergeFrom() [3/3]

◆ setAddReverseArcs()

◆ setArcCoefficient()

◆ setMaxMemoryUsageBytes()

◆ setNeighborsRatio()