Google OR-Tools v9.15
a fast and portable software suite for combinatorial optimization
Loading...
Searching...
No Matches
com.google.ortools.constraintsolver.SavingsParameters Class Reference

Detailed Description

Parameters used to configure savings heuristics.

Protobuf type operations_research.SavingsParameters

Definition at line 16 of file SavingsParameters.java.

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

Classes

class  Builder

Public Member Functions

double getNeighborsRatio ()
double getMaxMemoryUsageBytes ()
boolean getAddReverseArcs ()
double getArcCoefficient ()
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< SavingsParameters > getParserForType ()
com.google.ortools.constraintsolver.SavingsParameters getDefaultInstanceForType ()

Static Public Member Functions

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

Static Public Attributes

static final int NEIGHBORS_RATIO_FIELD_NUMBER = 1
static final int MAX_MEMORY_USAGE_BYTES_FIELD_NUMBER = 2
static final int ADD_REVERSE_ARCS_FIELD_NUMBER = 3
static final int ARC_COEFFICIENT_FIELD_NUMBER = 4

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.constraintsolver.SavingsParameters.equals ( final java.lang.Object obj)

Definition at line 178 of file SavingsParameters.java.

◆ getAddReverseArcs()

boolean com.google.ortools.constraintsolver.SavingsParameters.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 98 of file SavingsParameters.java.

◆ getArcCoefficient()

double com.google.ortools.constraintsolver.SavingsParameters.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 117 of file SavingsParameters.java.

◆ getDefaultInstance()

com.google.ortools.constraintsolver.SavingsParameters com.google.ortools.constraintsolver.SavingsParameters.getDefaultInstance ( )
static

Definition at line 712 of file SavingsParameters.java.

◆ getDefaultInstanceForType()

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

Definition at line 748 of file SavingsParameters.java.

◆ getDescriptor()

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

Definition at line 38 of file SavingsParameters.java.

◆ getMaxMemoryUsageBytes()

double com.google.ortools.constraintsolver.SavingsParameters.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 82 of file SavingsParameters.java.

◆ getNeighborsRatio()

double com.google.ortools.constraintsolver.SavingsParameters.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 62 of file SavingsParameters.java.

◆ getParserForType()

com.google.protobuf.Parser< SavingsParameters > com.google.ortools.constraintsolver.SavingsParameters.getParserForType ( )

Definition at line 743 of file SavingsParameters.java.

◆ getSerializedSize()

int com.google.ortools.constraintsolver.SavingsParameters.getSerializedSize ( )

Definition at line 151 of file SavingsParameters.java.

◆ hashCode()

int com.google.ortools.constraintsolver.SavingsParameters.hashCode ( )

Definition at line 203 of file SavingsParameters.java.

◆ internalGetFieldAccessorTable()

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

Definition at line 44 of file SavingsParameters.java.

◆ isInitialized()

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

Definition at line 123 of file SavingsParameters.java.

◆ newBuilder() [1/2]

Builder com.google.ortools.constraintsolver.SavingsParameters.newBuilder ( )
static

Definition at line 300 of file SavingsParameters.java.

◆ newBuilder() [2/2]

Builder com.google.ortools.constraintsolver.SavingsParameters.newBuilder ( com.google.ortools.constraintsolver.SavingsParameters prototype)
static

Definition at line 303 of file SavingsParameters.java.

◆ newBuilderForType() [1/2]

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

Definition at line 299 of file SavingsParameters.java.

◆ newBuilderForType() [2/2]

Builder com.google.ortools.constraintsolver.SavingsParameters.newBuilderForType ( com.google.protobuf.GeneratedMessage.BuilderParent parent)
protected

Definition at line 313 of file SavingsParameters.java.

◆ parseDelimitedFrom() [1/2]

com.google.ortools.constraintsolver.SavingsParameters com.google.ortools.constraintsolver.SavingsParameters.parseDelimitedFrom ( java.io.InputStream input) throws java.io.IOException
static

Definition at line 271 of file SavingsParameters.java.

◆ parseDelimitedFrom() [2/2]

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

Definition at line 277 of file SavingsParameters.java.

◆ parseFrom() [1/10]

com.google.ortools.constraintsolver.SavingsParameters com.google.ortools.constraintsolver.SavingsParameters.parseFrom ( byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
static

Definition at line 248 of file SavingsParameters.java.

◆ parseFrom() [2/10]

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

Definition at line 252 of file SavingsParameters.java.

◆ parseFrom() [3/10]

com.google.ortools.constraintsolver.SavingsParameters com.google.ortools.constraintsolver.SavingsParameters.parseFrom ( com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
static

Definition at line 237 of file SavingsParameters.java.

◆ parseFrom() [4/10]

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

Definition at line 242 of file SavingsParameters.java.

◆ parseFrom() [5/10]

com.google.ortools.constraintsolver.SavingsParameters com.google.ortools.constraintsolver.SavingsParameters.parseFrom ( com.google.protobuf.CodedInputStream input) throws java.io.IOException
static

Definition at line 284 of file SavingsParameters.java.

◆ parseFrom() [6/10]

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

Definition at line 290 of file SavingsParameters.java.

◆ parseFrom() [7/10]

com.google.ortools.constraintsolver.SavingsParameters com.google.ortools.constraintsolver.SavingsParameters.parseFrom ( java.io.InputStream input) throws java.io.IOException
static

Definition at line 258 of file SavingsParameters.java.

◆ parseFrom() [8/10]

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

Definition at line 263 of file SavingsParameters.java.

◆ parseFrom() [9/10]

com.google.ortools.constraintsolver.SavingsParameters com.google.ortools.constraintsolver.SavingsParameters.parseFrom ( java.nio.ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
static

Definition at line 226 of file SavingsParameters.java.

◆ parseFrom() [10/10]

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

Definition at line 231 of file SavingsParameters.java.

◆ parser()

com.google.protobuf.Parser< SavingsParameters > com.google.ortools.constraintsolver.SavingsParameters.parser ( )
static

Definition at line 738 of file SavingsParameters.java.

◆ toBuilder()

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

Definition at line 307 of file SavingsParameters.java.

◆ writeTo()

void com.google.ortools.constraintsolver.SavingsParameters.writeTo ( com.google.protobuf.CodedOutputStream output) throws java.io.IOException

Definition at line 133 of file SavingsParameters.java.

Member Data Documentation

◆ ADD_REVERSE_ARCS_FIELD_NUMBER

final int com.google.ortools.constraintsolver.SavingsParameters.ADD_REVERSE_ARCS_FIELD_NUMBER = 3
static

Definition at line 86 of file SavingsParameters.java.

◆ ARC_COEFFICIENT_FIELD_NUMBER

final int com.google.ortools.constraintsolver.SavingsParameters.ARC_COEFFICIENT_FIELD_NUMBER = 4
static

Definition at line 102 of file SavingsParameters.java.

◆ MAX_MEMORY_USAGE_BYTES_FIELD_NUMBER

final int com.google.ortools.constraintsolver.SavingsParameters.MAX_MEMORY_USAGE_BYTES_FIELD_NUMBER = 2
static

Definition at line 66 of file SavingsParameters.java.

◆ NEIGHBORS_RATIO_FIELD_NUMBER

final int com.google.ortools.constraintsolver.SavingsParameters.NEIGHBORS_RATIO_FIELD_NUMBER = 1
static

Definition at line 50 of file SavingsParameters.java.

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