com.google.ortools.pdlp.AdaptiveLinesearchParams.Builder Class Reference

Inheritance diagram for com.google.ortools.pdlp.AdaptiveLinesearchParams.Builder:

Public Member Functions
Builder	clear ()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType ()
com.google.ortools.pdlp.AdaptiveLinesearchParams	getDefaultInstanceForType ()
com.google.ortools.pdlp.AdaptiveLinesearchParams	build ()
com.google.ortools.pdlp.AdaptiveLinesearchParams	buildPartial ()
Builder	mergeFrom (com.google.protobuf.Message other)
Builder	mergeFrom (com.google.ortools.pdlp.AdaptiveLinesearchParams other)
final boolean	isInitialized ()
Builder	mergeFrom (com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
boolean	hasStepSizeReductionExponent ()
double	getStepSizeReductionExponent ()
Builder	setStepSizeReductionExponent (double value)
Builder	clearStepSizeReductionExponent ()
boolean	hasStepSizeGrowthExponent ()
double	getStepSizeGrowthExponent ()
Builder	setStepSizeGrowthExponent (double value)
Builder	clearStepSizeGrowthExponent ()
Public Member Functions inherited from com.google.ortools.pdlp.AdaptiveLinesearchParamsOrBuilder

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

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

Detailed Description

At the end of each iteration, regardless of whether the step was accepted
or not, the adaptive rule updates the step_size as the minimum of two
potential step sizes defined by the following two exponents.

Protobuf type operations_research.pdlp.AdaptiveLinesearchParams

Definition at line 308 of file AdaptiveLinesearchParams.java.

Member Function Documentation

build()

com.google.ortools.pdlp.AdaptiveLinesearchParams com.google.ortools.pdlp.AdaptiveLinesearchParams.Builder.build

(

)

Definition at line 356 of file AdaptiveLinesearchParams.java.

buildPartial()

com.google.ortools.pdlp.AdaptiveLinesearchParams com.google.ortools.pdlp.AdaptiveLinesearchParams.Builder.buildPartial

(

)

Definition at line 365 of file AdaptiveLinesearchParams.java.

clear()

Builder com.google.ortools.pdlp.AdaptiveLinesearchParams.Builder.clear

(

)

Definition at line 336 of file AdaptiveLinesearchParams.java.

clearStepSizeGrowthExponent()

Builder com.google.ortools.pdlp.AdaptiveLinesearchParams.Builder.clearStepSizeGrowthExponent

(

)

The step size growth exponent defines a step size given by (1 +
(total_steps_attempted + 1)^(-step_size_growth_exponent)) * step_size_.
This should be between 0.1 and 1.

optional double step_size_growth_exponent = 2 [default = 0.6];

Returns

This builder for chaining.

Definition at line 582 of file AdaptiveLinesearchParams.java.

clearStepSizeReductionExponent()

Builder com.google.ortools.pdlp.AdaptiveLinesearchParams.Builder.clearStepSizeReductionExponent

(

)

The step size reduction exponent defines a step size given by
(1 - (total_steps_attempted + 1)^(-step_size_reduction_exponent)) *
step_size_limit where step_size_limit is the maximum allowed step size at
the current iteration. This should be between 0.1 and 1.

optional double step_size_reduction_exponent = 1 [default = 0.3];

Returns

This builder for chaining.

Definition at line 518 of file AdaptiveLinesearchParams.java.

getDefaultInstanceForType()

com.google.ortools.pdlp.AdaptiveLinesearchParams com.google.ortools.pdlp.AdaptiveLinesearchParams.Builder.getDefaultInstanceForType

(

)

Definition at line 351 of file AdaptiveLinesearchParams.java.

getDescriptor()

static final com.google.protobuf.Descriptors.Descriptor com.google.ortools.pdlp.AdaptiveLinesearchParams.Builder.getDescriptor ( )

static

Definition at line 313 of file AdaptiveLinesearchParams.java.

getDescriptorForType()

com.google.protobuf.Descriptors.Descriptor com.google.ortools.pdlp.AdaptiveLinesearchParams.Builder.getDescriptorForType

(

)

Definition at line 346 of file AdaptiveLinesearchParams.java.

getStepSizeGrowthExponent()

double com.google.ortools.pdlp.AdaptiveLinesearchParams.Builder.getStepSizeGrowthExponent

(

)

The step size growth exponent defines a step size given by (1 +
(total_steps_attempted + 1)^(-step_size_growth_exponent)) * step_size_.
This should be between 0.1 and 1.

optional double step_size_growth_exponent = 2 [default = 0.6];

Returns

The stepSizeGrowthExponent.

Implements com.google.ortools.pdlp.AdaptiveLinesearchParamsOrBuilder.

Definition at line 551 of file AdaptiveLinesearchParams.java.

getStepSizeReductionExponent()

double com.google.ortools.pdlp.AdaptiveLinesearchParams.Builder.getStepSizeReductionExponent

(

)

The step size reduction exponent defines a step size given by
(1 - (total_steps_attempted + 1)^(-step_size_reduction_exponent)) *
step_size_limit where step_size_limit is the maximum allowed step size at
the current iteration. This should be between 0.1 and 1.

optional double step_size_reduction_exponent = 1 [default = 0.3];

Returns

The stepSizeReductionExponent.

Implements com.google.ortools.pdlp.AdaptiveLinesearchParamsOrBuilder.

Definition at line 485 of file AdaptiveLinesearchParams.java.

hasStepSizeGrowthExponent()

boolean com.google.ortools.pdlp.AdaptiveLinesearchParams.Builder.hasStepSizeGrowthExponent

(

)

The step size growth exponent defines a step size given by (1 +
(total_steps_attempted + 1)^(-step_size_growth_exponent)) * step_size_.
This should be between 0.1 and 1.

optional double step_size_growth_exponent = 2 [default = 0.6];

Returns

Whether the stepSizeGrowthExponent field is set.

Implements com.google.ortools.pdlp.AdaptiveLinesearchParamsOrBuilder.

Definition at line 537 of file AdaptiveLinesearchParams.java.

hasStepSizeReductionExponent()

boolean com.google.ortools.pdlp.AdaptiveLinesearchParams.Builder.hasStepSizeReductionExponent

(

)

The step size reduction exponent defines a step size given by
(1 - (total_steps_attempted + 1)^(-step_size_reduction_exponent)) *
step_size_limit where step_size_limit is the maximum allowed step size at
the current iteration. This should be between 0.1 and 1.

optional double step_size_reduction_exponent = 1 [default = 0.3];

Returns

Whether the stepSizeReductionExponent field is set.

Implements com.google.ortools.pdlp.AdaptiveLinesearchParamsOrBuilder.

Definition at line 470 of file AdaptiveLinesearchParams.java.

internalGetFieldAccessorTable()

com.google.protobuf.GeneratedMessage.FieldAccessorTable com.google.ortools.pdlp.AdaptiveLinesearchParams.Builder.internalGetFieldAccessorTable ( )

protected

Definition at line 319 of file AdaptiveLinesearchParams.java.

isInitialized()

final boolean com.google.ortools.pdlp.AdaptiveLinesearchParams.Builder.isInitialized

(

)

Definition at line 410 of file AdaptiveLinesearchParams.java.

mergeFrom() [1/3]

Builder com.google.ortools.pdlp.AdaptiveLinesearchParams.Builder.mergeFrom

(

com.google.ortools.pdlp.AdaptiveLinesearchParams

other

)

Definition at line 396 of file AdaptiveLinesearchParams.java.

mergeFrom() [2/3]

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

Definition at line 415 of file AdaptiveLinesearchParams.java.

mergeFrom() [3/3]

Builder com.google.ortools.pdlp.AdaptiveLinesearchParams.Builder.mergeFrom

(

com.google.protobuf.Message

other

)

Definition at line 387 of file AdaptiveLinesearchParams.java.

setStepSizeGrowthExponent()

Builder com.google.ortools.pdlp.AdaptiveLinesearchParams.Builder.setStepSizeGrowthExponent

(

double

value

)

The step size growth exponent defines a step size given by (1 +
(total_steps_attempted + 1)^(-step_size_growth_exponent)) * step_size_.
This should be between 0.1 and 1.

optional double step_size_growth_exponent = 2 [default = 0.6];

Parameters

value

The stepSizeGrowthExponent to set.

Returns

This builder for chaining.

Definition at line 565 of file AdaptiveLinesearchParams.java.

setStepSizeReductionExponent()

Builder com.google.ortools.pdlp.AdaptiveLinesearchParams.Builder.setStepSizeReductionExponent

(

double

value

)

The step size reduction exponent defines a step size given by
(1 - (total_steps_attempted + 1)^(-step_size_reduction_exponent)) *
step_size_limit where step_size_limit is the maximum allowed step size at
the current iteration. This should be between 0.1 and 1.

optional double step_size_reduction_exponent = 1 [default = 0.3];

Parameters

value

The stepSizeReductionExponent to set.

Returns

This builder for chaining.

Definition at line 500 of file AdaptiveLinesearchParams.java.

---

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

• build/java/ortools-java/src/main/java/com/google/ortools/pdlp/AdaptiveLinesearchParams.java