com.google.ortools.constraintsolver.SimulatedAnnealingParameters.Builder Class Reference

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

Public Member Functions
Builder	clear ()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType ()
com.google.ortools.constraintsolver.SimulatedAnnealingParameters	getDefaultInstanceForType ()
com.google.ortools.constraintsolver.SimulatedAnnealingParameters	build ()
com.google.ortools.constraintsolver.SimulatedAnnealingParameters	buildPartial ()
Builder	mergeFrom (com.google.protobuf.Message other)
Builder	mergeFrom (com.google.ortools.constraintsolver.SimulatedAnnealingParameters other)
final boolean	isInitialized ()
Builder	mergeFrom (com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
int	getCoolingScheduleStrategyValue ()
Builder	setCoolingScheduleStrategyValue (int value)
com.google.ortools.constraintsolver.CoolingScheduleStrategy.Value	getCoolingScheduleStrategy ()
Builder	setCoolingScheduleStrategy (com.google.ortools.constraintsolver.CoolingScheduleStrategy.Value value)
Builder	clearCoolingScheduleStrategy ()
boolean	hasInitialTemperature ()
double	getInitialTemperature ()
Builder	setInitialTemperature (double value)
Builder	clearInitialTemperature ()
boolean	hasFinalTemperature ()
double	getFinalTemperature ()
Builder	setFinalTemperature (double value)
Builder	clearFinalTemperature ()
boolean	hasAutomaticTemperatures ()
boolean	getAutomaticTemperatures ()
Builder	setAutomaticTemperatures (boolean value)
Builder	clearAutomaticTemperatures ()

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

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

Detailed Description

Specifies the behavior of a simulated annealing acceptance strategy.

Protobuf type operations_research.SimulatedAnnealingParameters

Definition at line 395 of file SimulatedAnnealingParameters.java.

Member Function Documentation

build()

com.google.ortools.constraintsolver.SimulatedAnnealingParameters com.google.ortools.constraintsolver.SimulatedAnnealingParameters.Builder.build

(

)

Definition at line 445 of file SimulatedAnnealingParameters.java.

buildPartial()

com.google.ortools.constraintsolver.SimulatedAnnealingParameters com.google.ortools.constraintsolver.SimulatedAnnealingParameters.Builder.buildPartial

(

)

Definition at line 454 of file SimulatedAnnealingParameters.java.

clear()

Builder com.google.ortools.constraintsolver.SimulatedAnnealingParameters.Builder.clear

(

)

Definition at line 423 of file SimulatedAnnealingParameters.java.

clearAutomaticTemperatures()

Builder com.google.ortools.constraintsolver.SimulatedAnnealingParameters.Builder.clearAutomaticTemperatures

(

)

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

This builder for chaining.

Definition at line 842 of file SimulatedAnnealingParameters.java.

clearCoolingScheduleStrategy()

Builder com.google.ortools.constraintsolver.SimulatedAnnealingParameters.Builder.clearCoolingScheduleStrategy

(

)

Determines the speed at which the temperature changes from initial to
final.

.operations_research.CoolingScheduleStrategy.Value cooling_schedule_strategy = 1;

Returns

This builder for chaining.

Definition at line 638 of file SimulatedAnnealingParameters.java.

clearFinalTemperature()

Builder com.google.ortools.constraintsolver.SimulatedAnnealingParameters.Builder.clearFinalTemperature

(

)

The final temperature. See CoolingScheduleStrategy for its usage.

optional double final_temperature = 3;

Returns

This builder for chaining.

Definition at line 750 of file SimulatedAnnealingParameters.java.

clearInitialTemperature()

Builder com.google.ortools.constraintsolver.SimulatedAnnealingParameters.Builder.clearInitialTemperature

(

)

The initial temperature. See CoolingScheduleStrategy for its usage.

optional double initial_temperature = 2;

Returns

This builder for chaining.

Definition at line 694 of file SimulatedAnnealingParameters.java.

getAutomaticTemperatures()

boolean com.google.ortools.constraintsolver.SimulatedAnnealingParameters.Builder.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 797 of file SimulatedAnnealingParameters.java.

getCoolingScheduleStrategy()

com.google.ortools.constraintsolver.CoolingScheduleStrategy.Value com.google.ortools.constraintsolver.SimulatedAnnealingParameters.Builder.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 608 of file SimulatedAnnealingParameters.java.

getCoolingScheduleStrategyValue()

int com.google.ortools.constraintsolver.SimulatedAnnealingParameters.Builder.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 579 of file SimulatedAnnealingParameters.java.

getDefaultInstanceForType()

com.google.ortools.constraintsolver.SimulatedAnnealingParameters com.google.ortools.constraintsolver.SimulatedAnnealingParameters.Builder.getDefaultInstanceForType

(

)

Definition at line 440 of file SimulatedAnnealingParameters.java.

getDescriptor()

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

static

Definition at line 400 of file SimulatedAnnealingParameters.java.

getDescriptorForType()

com.google.protobuf.Descriptors.Descriptor com.google.ortools.constraintsolver.SimulatedAnnealingParameters.Builder.getDescriptorForType

(

)

Definition at line 435 of file SimulatedAnnealingParameters.java.

getFinalTemperature()

double com.google.ortools.constraintsolver.SimulatedAnnealingParameters.Builder.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 723 of file SimulatedAnnealingParameters.java.

getInitialTemperature()

double com.google.ortools.constraintsolver.SimulatedAnnealingParameters.Builder.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 667 of file SimulatedAnnealingParameters.java.

hasAutomaticTemperatures()

boolean com.google.ortools.constraintsolver.SimulatedAnnealingParameters.Builder.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 776 of file SimulatedAnnealingParameters.java.

hasFinalTemperature()

boolean com.google.ortools.constraintsolver.SimulatedAnnealingParameters.Builder.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 711 of file SimulatedAnnealingParameters.java.

hasInitialTemperature()

boolean com.google.ortools.constraintsolver.SimulatedAnnealingParameters.Builder.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 655 of file SimulatedAnnealingParameters.java.

internalGetFieldAccessorTable()

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

protected

Definition at line 406 of file SimulatedAnnealingParameters.java.

isInitialized()

final boolean com.google.ortools.constraintsolver.SimulatedAnnealingParameters.Builder.isInitialized

(

)

Definition at line 512 of file SimulatedAnnealingParameters.java.

mergeFrom() [1/3]

Builder com.google.ortools.constraintsolver.SimulatedAnnealingParameters.Builder.mergeFrom

(

com.google.ortools.constraintsolver.SimulatedAnnealingParameters

other

)

Definition at line 492 of file SimulatedAnnealingParameters.java.

mergeFrom() [2/3]

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

Definition at line 517 of file SimulatedAnnealingParameters.java.

mergeFrom() [3/3]

Builder com.google.ortools.constraintsolver.SimulatedAnnealingParameters.Builder.mergeFrom

(

com.google.protobuf.Message

other

)

Definition at line 483 of file SimulatedAnnealingParameters.java.

setAutomaticTemperatures()

Builder com.google.ortools.constraintsolver.SimulatedAnnealingParameters.Builder.setAutomaticTemperatures

(

boolean

value

)

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;

Parameters

value

The automaticTemperatures to set.

Returns

This builder for chaining.

Definition at line 818 of file SimulatedAnnealingParameters.java.

setCoolingScheduleStrategy()

Builder com.google.ortools.constraintsolver.SimulatedAnnealingParameters.Builder.setCoolingScheduleStrategy

(

com.google.ortools.constraintsolver.CoolingScheduleStrategy.Value

value

)

Determines the speed at which the temperature changes from initial to
final.

.operations_research.CoolingScheduleStrategy.Value cooling_schedule_strategy = 1;

Parameters

value

The coolingScheduleStrategy to set.

Returns

This builder for chaining.

Definition at line 622 of file SimulatedAnnealingParameters.java.

setCoolingScheduleStrategyValue()

Builder com.google.ortools.constraintsolver.SimulatedAnnealingParameters.Builder.setCoolingScheduleStrategyValue

(

int

value

)

Determines the speed at which the temperature changes from initial to
final.

.operations_research.CoolingScheduleStrategy.Value cooling_schedule_strategy = 1;

Parameters

value

The enum numeric value on the wire for coolingScheduleStrategy to set.

Returns

This builder for chaining.

Definition at line 592 of file SimulatedAnnealingParameters.java.

setFinalTemperature()

Builder com.google.ortools.constraintsolver.SimulatedAnnealingParameters.Builder.setFinalTemperature

(

double

value

)

The final temperature. See CoolingScheduleStrategy for its usage.

optional double final_temperature = 3;

Parameters

value

The finalTemperature to set.

Returns

This builder for chaining.

Definition at line 735 of file SimulatedAnnealingParameters.java.

setInitialTemperature()

Builder com.google.ortools.constraintsolver.SimulatedAnnealingParameters.Builder.setInitialTemperature

(

double

value

)

The initial temperature. See CoolingScheduleStrategy for its usage.

optional double initial_temperature = 2;

Parameters

value

The initialTemperature to set.

Returns

This builder for chaining.

Definition at line 679 of file SimulatedAnnealingParameters.java.

---

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

• build/java/ortools-java/src/main/java/com/google/ortools/constraintsolver/SimulatedAnnealingParameters.java