Google OR-Tools v9.9
a fast and portable software suite for combinatorial optimization
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
operations_research.pdlp.Solvers.AdaptiveLinesearchParams.Builder Class Reference
Inheritance diagram for operations_research.pdlp.Solvers.AdaptiveLinesearchParams.Builder:
operations_research.pdlp.Solvers.AdaptiveLinesearchParamsOrBuilder

Public Member Functions

Builder clear ()
 
com.google.protobuf.Descriptors.Descriptor getDescriptorForType ()
 
operations_research.pdlp.Solvers.AdaptiveLinesearchParams getDefaultInstanceForType ()
 
operations_research.pdlp.Solvers.AdaptiveLinesearchParams build ()
 
operations_research.pdlp.Solvers.AdaptiveLinesearchParams buildPartial ()
 
Builder clone ()
 
Builder setField (com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)
 
Builder clearField (com.google.protobuf.Descriptors.FieldDescriptor field)
 
Builder clearOneof (com.google.protobuf.Descriptors.OneofDescriptor oneof)
 
Builder setRepeatedField (com.google.protobuf.Descriptors.FieldDescriptor field, int index, java.lang.Object value)
 
Builder addRepeatedField (com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)
 
Builder mergeFrom (com.google.protobuf.Message other)
 
Builder mergeFrom (operations_research.pdlp.Solvers.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 ()
 
final Builder setUnknownFields (final com.google.protobuf.UnknownFieldSet unknownFields)
 
final Builder mergeUnknownFields (final com.google.protobuf.UnknownFieldSet unknownFields)
 

Static Public Member Functions

static final com.google.protobuf.Descriptors.Descriptor getDescriptor ()
 

Protected Member Functions

com.google.protobuf.GeneratedMessageV3.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 4660 of file Solvers.java.

Member Function Documentation

◆ addRepeatedField()

Builder operations_research.pdlp.Solvers.AdaptiveLinesearchParams.Builder.addRepeatedField ( com.google.protobuf.Descriptors.FieldDescriptor field,
java.lang.Object value )

Definition at line 4765 of file Solvers.java.

◆ build()

operations_research.pdlp.Solvers.AdaptiveLinesearchParams operations_research.pdlp.Solvers.AdaptiveLinesearchParams.Builder.build ( )

Definition at line 4708 of file Solvers.java.

◆ buildPartial()

operations_research.pdlp.Solvers.AdaptiveLinesearchParams operations_research.pdlp.Solvers.AdaptiveLinesearchParams.Builder.buildPartial ( )

Definition at line 4717 of file Solvers.java.

◆ clear()

Builder operations_research.pdlp.Solvers.AdaptiveLinesearchParams.Builder.clear ( )

Definition at line 4688 of file Solvers.java.

◆ clearField()

Builder operations_research.pdlp.Solvers.AdaptiveLinesearchParams.Builder.clearField ( com.google.protobuf.Descriptors.FieldDescriptor field)

Definition at line 4749 of file Solvers.java.

◆ clearOneof()

Builder operations_research.pdlp.Solvers.AdaptiveLinesearchParams.Builder.clearOneof ( com.google.protobuf.Descriptors.OneofDescriptor oneof)

Definition at line 4754 of file Solvers.java.

◆ clearStepSizeGrowthExponent()

Builder operations_research.pdlp.Solvers.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 4966 of file Solvers.java.

◆ clearStepSizeReductionExponent()

Builder operations_research.pdlp.Solvers.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 4902 of file Solvers.java.

◆ clone()

Builder operations_research.pdlp.Solvers.AdaptiveLinesearchParams.Builder.clone ( )

Definition at line 4739 of file Solvers.java.

◆ getDefaultInstanceForType()

operations_research.pdlp.Solvers.AdaptiveLinesearchParams operations_research.pdlp.Solvers.AdaptiveLinesearchParams.Builder.getDefaultInstanceForType ( )

Definition at line 4703 of file Solvers.java.

◆ getDescriptor()

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

Definition at line 4665 of file Solvers.java.

◆ getDescriptorForType()

com.google.protobuf.Descriptors.Descriptor operations_research.pdlp.Solvers.AdaptiveLinesearchParams.Builder.getDescriptorForType ( )

Definition at line 4698 of file Solvers.java.

◆ getStepSizeGrowthExponent()

double operations_research.pdlp.Solvers.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 operations_research.pdlp.Solvers.AdaptiveLinesearchParamsOrBuilder.

Definition at line 4935 of file Solvers.java.

◆ getStepSizeReductionExponent()

double operations_research.pdlp.Solvers.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 operations_research.pdlp.Solvers.AdaptiveLinesearchParamsOrBuilder.

Definition at line 4869 of file Solvers.java.

◆ hasStepSizeGrowthExponent()

boolean operations_research.pdlp.Solvers.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 operations_research.pdlp.Solvers.AdaptiveLinesearchParamsOrBuilder.

Definition at line 4921 of file Solvers.java.

◆ hasStepSizeReductionExponent()

boolean operations_research.pdlp.Solvers.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 operations_research.pdlp.Solvers.AdaptiveLinesearchParamsOrBuilder.

Definition at line 4854 of file Solvers.java.

◆ internalGetFieldAccessorTable()

com.google.protobuf.GeneratedMessageV3.FieldAccessorTable operations_research.pdlp.Solvers.AdaptiveLinesearchParams.Builder.internalGetFieldAccessorTable ( )
protected

Definition at line 4671 of file Solvers.java.

◆ isInitialized()

final boolean operations_research.pdlp.Solvers.AdaptiveLinesearchParams.Builder.isInitialized ( )

Definition at line 4794 of file Solvers.java.

◆ mergeFrom() [1/3]

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

Definition at line 4799 of file Solvers.java.

◆ mergeFrom() [2/3]

Builder operations_research.pdlp.Solvers.AdaptiveLinesearchParams.Builder.mergeFrom ( com.google.protobuf.Message other)

Definition at line 4771 of file Solvers.java.

◆ mergeFrom() [3/3]

Builder operations_research.pdlp.Solvers.AdaptiveLinesearchParams.Builder.mergeFrom ( operations_research.pdlp.Solvers.AdaptiveLinesearchParams other)

Definition at line 4780 of file Solvers.java.

◆ mergeUnknownFields()

final Builder operations_research.pdlp.Solvers.AdaptiveLinesearchParams.Builder.mergeUnknownFields ( final com.google.protobuf.UnknownFieldSet unknownFields)

Definition at line 4979 of file Solvers.java.

◆ setField()

Builder operations_research.pdlp.Solvers.AdaptiveLinesearchParams.Builder.setField ( com.google.protobuf.Descriptors.FieldDescriptor field,
java.lang.Object value )

Definition at line 4743 of file Solvers.java.

◆ setRepeatedField()

Builder operations_research.pdlp.Solvers.AdaptiveLinesearchParams.Builder.setRepeatedField ( com.google.protobuf.Descriptors.FieldDescriptor field,
int index,
java.lang.Object value )

Definition at line 4759 of file Solvers.java.

◆ setStepSizeGrowthExponent()

Builder operations_research.pdlp.Solvers.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
valueThe stepSizeGrowthExponent to set.
Returns
This builder for chaining.

Definition at line 4949 of file Solvers.java.

◆ setStepSizeReductionExponent()

Builder operations_research.pdlp.Solvers.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
valueThe stepSizeReductionExponent to set.
Returns
This builder for chaining.

Definition at line 4884 of file Solvers.java.

◆ setUnknownFields()

final Builder operations_research.pdlp.Solvers.AdaptiveLinesearchParams.Builder.setUnknownFields ( final com.google.protobuf.UnknownFieldSet unknownFields)

Definition at line 4973 of file Solvers.java.

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