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

Detailed Description

Specifies the behavior of a simulated annealing acceptance strategy.

Protobuf type operations_research.SimulatedAnnealingParameters

Definition at line 16 of file SimulatedAnnealingParameters.java.

Inheritance diagram for com.google.ortools.constraintsolver.SimulatedAnnealingParameters:
com.google.ortools.constraintsolver.SimulatedAnnealingParametersOrBuilder

Classes

class  Builder

Public Member Functions

int getCoolingScheduleStrategyValue ()
com.google.ortools.constraintsolver.CoolingScheduleStrategy.Value getCoolingScheduleStrategy ()
boolean hasInitialTemperature ()
double getInitialTemperature ()
boolean hasFinalTemperature ()
double getFinalTemperature ()
boolean hasAutomaticTemperatures ()
boolean getAutomaticTemperatures ()
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< SimulatedAnnealingParameters > getParserForType ()
com.google.ortools.constraintsolver.SimulatedAnnealingParameters getDefaultInstanceForType ()

Static Public Member Functions

static final com.google.protobuf.Descriptors.Descriptor getDescriptor ()
static com.google.ortools.constraintsolver.SimulatedAnnealingParameters parseFrom (java.nio.ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
static com.google.ortools.constraintsolver.SimulatedAnnealingParameters parseFrom (java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
static com.google.ortools.constraintsolver.SimulatedAnnealingParameters parseFrom (com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
static com.google.ortools.constraintsolver.SimulatedAnnealingParameters parseFrom (com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
static com.google.ortools.constraintsolver.SimulatedAnnealingParameters parseFrom (byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
static com.google.ortools.constraintsolver.SimulatedAnnealingParameters parseFrom (byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
static com.google.ortools.constraintsolver.SimulatedAnnealingParameters parseFrom (java.io.InputStream input) throws java.io.IOException
static com.google.ortools.constraintsolver.SimulatedAnnealingParameters parseFrom (java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
static com.google.ortools.constraintsolver.SimulatedAnnealingParameters parseDelimitedFrom (java.io.InputStream input) throws java.io.IOException
static com.google.ortools.constraintsolver.SimulatedAnnealingParameters parseDelimitedFrom (java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
static com.google.ortools.constraintsolver.SimulatedAnnealingParameters parseFrom (com.google.protobuf.CodedInputStream input) throws java.io.IOException
static com.google.ortools.constraintsolver.SimulatedAnnealingParameters 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.SimulatedAnnealingParameters prototype)
static com.google.ortools.constraintsolver.SimulatedAnnealingParameters getDefaultInstance ()
static com.google.protobuf.Parser< SimulatedAnnealingParameters > parser ()

Static Public Attributes

static final int COOLING_SCHEDULE_STRATEGY_FIELD_NUMBER = 1
static final int INITIAL_TEMPERATURE_FIELD_NUMBER = 2
static final int FINAL_TEMPERATURE_FIELD_NUMBER = 3
static final int AUTOMATIC_TEMPERATURES_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.SimulatedAnnealingParameters.equals ( final java.lang.Object obj)

Definition at line 236 of file SimulatedAnnealingParameters.java.

◆ getAutomaticTemperatures()

boolean com.google.ortools.constraintsolver.SimulatedAnnealingParameters.getAutomaticTemperatures ( ) 
Automatically define the value for the temperatures as follows.
First, a  reference temperature t is defined as
w1 * c1 + w2 * c2 + ... + wK * cK
where 0 < wJ <= 1 is the fraction of vehicles of cost class J and cJ is the
average arc cost for the cost class J.
The value of cJ is identified by randomly sampling N arc costs for the cost
class J, where N is equal to the number of instance nodes.
The initial and final temperatures are then defined as
- initial_temperature: 0.1 * t
- final_temperature: 0.001 * t

optional bool automatic_temperatures = 4;

Returns
The automaticTemperatures.

Implements com.google.ortools.constraintsolver.SimulatedAnnealingParametersOrBuilder.

Definition at line 175 of file SimulatedAnnealingParameters.java.

◆ getCoolingScheduleStrategy()

com.google.ortools.constraintsolver.CoolingScheduleStrategy.Value com.google.ortools.constraintsolver.SimulatedAnnealingParameters.getCoolingScheduleStrategy ( ) 
Determines the speed at which the temperature changes from initial to
final.

.operations_research.CoolingScheduleStrategy.Value cooling_schedule_strategy = 1;

Returns
The coolingScheduleStrategy.

Implements com.google.ortools.constraintsolver.SimulatedAnnealingParametersOrBuilder.

Definition at line 75 of file SimulatedAnnealingParameters.java.

◆ getCoolingScheduleStrategyValue()

int com.google.ortools.constraintsolver.SimulatedAnnealingParameters.getCoolingScheduleStrategyValue ( ) 
Determines the speed at which the temperature changes from initial to
final.

.operations_research.CoolingScheduleStrategy.Value cooling_schedule_strategy = 1;

Returns
The enum numeric value on the wire for coolingScheduleStrategy.

Implements com.google.ortools.constraintsolver.SimulatedAnnealingParametersOrBuilder.

Definition at line 63 of file SimulatedAnnealingParameters.java.

◆ getDefaultInstance()

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

Definition at line 858 of file SimulatedAnnealingParameters.java.

◆ getDefaultInstanceForType()

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

Definition at line 894 of file SimulatedAnnealingParameters.java.

◆ getDescriptor()

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

Definition at line 39 of file SimulatedAnnealingParameters.java.

◆ getFinalTemperature()

double com.google.ortools.constraintsolver.SimulatedAnnealingParameters.getFinalTemperature ( ) 
The final temperature. See CoolingScheduleStrategy for its usage.

optional double final_temperature = 3;

Returns
The finalTemperature.

Implements com.google.ortools.constraintsolver.SimulatedAnnealingParametersOrBuilder.

Definition at line 130 of file SimulatedAnnealingParameters.java.

◆ getInitialTemperature()

double com.google.ortools.constraintsolver.SimulatedAnnealingParameters.getInitialTemperature ( ) 
The initial temperature. See CoolingScheduleStrategy for its usage.

optional double initial_temperature = 2;

Returns
The initialTemperature.

Implements com.google.ortools.constraintsolver.SimulatedAnnealingParametersOrBuilder.

Definition at line 103 of file SimulatedAnnealingParameters.java.

◆ getParserForType()

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

Definition at line 889 of file SimulatedAnnealingParameters.java.

◆ getSerializedSize()

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

Definition at line 209 of file SimulatedAnnealingParameters.java.

◆ hasAutomaticTemperatures()

boolean com.google.ortools.constraintsolver.SimulatedAnnealingParameters.hasAutomaticTemperatures ( ) 
Automatically define the value for the temperatures as follows.
First, a  reference temperature t is defined as
w1 * c1 + w2 * c2 + ... + wK * cK
where 0 < wJ <= 1 is the fraction of vehicles of cost class J and cJ is the
average arc cost for the cost class J.
The value of cJ is identified by randomly sampling N arc costs for the cost
class J, where N is equal to the number of instance nodes.
The initial and final temperatures are then defined as
- initial_temperature: 0.1 * t
- final_temperature: 0.001 * t

optional bool automatic_temperatures = 4;

Returns
Whether the automaticTemperatures field is set.

Implements com.google.ortools.constraintsolver.SimulatedAnnealingParametersOrBuilder.

Definition at line 154 of file SimulatedAnnealingParameters.java.

◆ hasFinalTemperature()

boolean com.google.ortools.constraintsolver.SimulatedAnnealingParameters.hasFinalTemperature ( ) 
The final temperature. See CoolingScheduleStrategy for its usage.

optional double final_temperature = 3;

Returns
Whether the finalTemperature field is set.

Implements com.google.ortools.constraintsolver.SimulatedAnnealingParametersOrBuilder.

Definition at line 118 of file SimulatedAnnealingParameters.java.

◆ hashCode()

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

Definition at line 268 of file SimulatedAnnealingParameters.java.

◆ hasInitialTemperature()

boolean com.google.ortools.constraintsolver.SimulatedAnnealingParameters.hasInitialTemperature ( ) 
The initial temperature. See CoolingScheduleStrategy for its usage.

optional double initial_temperature = 2;

Returns
Whether the initialTemperature field is set.

Implements com.google.ortools.constraintsolver.SimulatedAnnealingParametersOrBuilder.

Definition at line 91 of file SimulatedAnnealingParameters.java.

◆ internalGetFieldAccessorTable()

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

Definition at line 45 of file SimulatedAnnealingParameters.java.

◆ isInitialized()

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

Definition at line 181 of file SimulatedAnnealingParameters.java.

◆ newBuilder() [1/2]

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

Definition at line 370 of file SimulatedAnnealingParameters.java.

◆ newBuilder() [2/2]

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

Definition at line 373 of file SimulatedAnnealingParameters.java.

◆ newBuilderForType() [1/2]

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

Definition at line 369 of file SimulatedAnnealingParameters.java.

◆ newBuilderForType() [2/2]

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

Definition at line 383 of file SimulatedAnnealingParameters.java.

◆ parseDelimitedFrom() [1/2]

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

Definition at line 341 of file SimulatedAnnealingParameters.java.

◆ parseDelimitedFrom() [2/2]

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

Definition at line 347 of file SimulatedAnnealingParameters.java.

◆ parseFrom() [1/10]

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

Definition at line 318 of file SimulatedAnnealingParameters.java.

◆ parseFrom() [2/10]

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

Definition at line 322 of file SimulatedAnnealingParameters.java.

◆ parseFrom() [3/10]

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

Definition at line 307 of file SimulatedAnnealingParameters.java.

◆ parseFrom() [4/10]

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

Definition at line 312 of file SimulatedAnnealingParameters.java.

◆ parseFrom() [5/10]

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

Definition at line 354 of file SimulatedAnnealingParameters.java.

◆ parseFrom() [6/10]

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

Definition at line 360 of file SimulatedAnnealingParameters.java.

◆ parseFrom() [7/10]

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

Definition at line 328 of file SimulatedAnnealingParameters.java.

◆ parseFrom() [8/10]

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

Definition at line 333 of file SimulatedAnnealingParameters.java.

◆ parseFrom() [9/10]

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

Definition at line 296 of file SimulatedAnnealingParameters.java.

◆ parseFrom() [10/10]

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

Definition at line 301 of file SimulatedAnnealingParameters.java.

◆ parser()

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

Definition at line 884 of file SimulatedAnnealingParameters.java.

◆ toBuilder()

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

Definition at line 377 of file SimulatedAnnealingParameters.java.

◆ writeTo()

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

Definition at line 191 of file SimulatedAnnealingParameters.java.

Member Data Documentation

◆ AUTOMATIC_TEMPERATURES_FIELD_NUMBER

final int com.google.ortools.constraintsolver.SimulatedAnnealingParameters.AUTOMATIC_TEMPERATURES_FIELD_NUMBER = 4
static

Definition at line 134 of file SimulatedAnnealingParameters.java.

◆ COOLING_SCHEDULE_STRATEGY_FIELD_NUMBER

final int com.google.ortools.constraintsolver.SimulatedAnnealingParameters.COOLING_SCHEDULE_STRATEGY_FIELD_NUMBER = 1
static

Definition at line 52 of file SimulatedAnnealingParameters.java.

◆ FINAL_TEMPERATURE_FIELD_NUMBER

final int com.google.ortools.constraintsolver.SimulatedAnnealingParameters.FINAL_TEMPERATURE_FIELD_NUMBER = 3
static

Definition at line 107 of file SimulatedAnnealingParameters.java.

◆ INITIAL_TEMPERATURE_FIELD_NUMBER

final int com.google.ortools.constraintsolver.SimulatedAnnealingParameters.INITIAL_TEMPERATURE_FIELD_NUMBER = 2
static

Definition at line 80 of file SimulatedAnnealingParameters.java.

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