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

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 18 of file AdaptiveLinesearchParams.java.

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

Classes

class  Builder

Public Member Functions

boolean hasStepSizeReductionExponent ()
double getStepSizeReductionExponent ()
boolean hasStepSizeGrowthExponent ()
double getStepSizeGrowthExponent ()
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< AdaptiveLinesearchParams > getParserForType ()
com.google.ortools.pdlp.AdaptiveLinesearchParams getDefaultInstanceForType ()

Static Public Member Functions

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

Static Public Attributes

static final int STEP_SIZE_REDUCTION_EXPONENT_FIELD_NUMBER = 1
static final int STEP_SIZE_GROWTH_EXPONENT_FIELD_NUMBER = 2

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

Definition at line 162 of file AdaptiveLinesearchParams.java.

◆ getDefaultInstance()

com.google.ortools.pdlp.AdaptiveLinesearchParams com.google.ortools.pdlp.AdaptiveLinesearchParams.getDefaultInstance ( )
static

Definition at line 600 of file AdaptiveLinesearchParams.java.

◆ getDefaultInstanceForType()

com.google.ortools.pdlp.AdaptiveLinesearchParams com.google.ortools.pdlp.AdaptiveLinesearchParams.getDefaultInstanceForType ( )

Definition at line 636 of file AdaptiveLinesearchParams.java.

◆ getDescriptor()

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

Definition at line 42 of file AdaptiveLinesearchParams.java.

◆ getParserForType()

com.google.protobuf.Parser< AdaptiveLinesearchParams > com.google.ortools.pdlp.AdaptiveLinesearchParams.getParserForType ( )

Definition at line 631 of file AdaptiveLinesearchParams.java.

◆ getSerializedSize()

int com.google.ortools.pdlp.AdaptiveLinesearchParams.getSerializedSize ( )

Definition at line 143 of file AdaptiveLinesearchParams.java.

◆ getStepSizeGrowthExponent()

double com.google.ortools.pdlp.AdaptiveLinesearchParams.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 115 of file AdaptiveLinesearchParams.java.

◆ getStepSizeReductionExponent()

double com.google.ortools.pdlp.AdaptiveLinesearchParams.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 84 of file AdaptiveLinesearchParams.java.

◆ hashCode()

int com.google.ortools.pdlp.AdaptiveLinesearchParams.hashCode ( )

Definition at line 188 of file AdaptiveLinesearchParams.java.

◆ hasStepSizeGrowthExponent()

boolean com.google.ortools.pdlp.AdaptiveLinesearchParams.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 101 of file AdaptiveLinesearchParams.java.

◆ hasStepSizeReductionExponent()

boolean com.google.ortools.pdlp.AdaptiveLinesearchParams.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 69 of file AdaptiveLinesearchParams.java.

◆ internalGetFieldAccessorTable()

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

Definition at line 48 of file AdaptiveLinesearchParams.java.

◆ isInitialized()

final boolean com.google.ortools.pdlp.AdaptiveLinesearchParams.isInitialized ( )

Definition at line 121 of file AdaptiveLinesearchParams.java.

◆ newBuilder() [1/2]

Builder com.google.ortools.pdlp.AdaptiveLinesearchParams.newBuilder ( )
static

Definition at line 283 of file AdaptiveLinesearchParams.java.

◆ newBuilder() [2/2]

Builder com.google.ortools.pdlp.AdaptiveLinesearchParams.newBuilder ( com.google.ortools.pdlp.AdaptiveLinesearchParams prototype)
static

Definition at line 286 of file AdaptiveLinesearchParams.java.

◆ newBuilderForType() [1/2]

Builder com.google.ortools.pdlp.AdaptiveLinesearchParams.newBuilderForType ( )

Definition at line 282 of file AdaptiveLinesearchParams.java.

◆ newBuilderForType() [2/2]

Builder com.google.ortools.pdlp.AdaptiveLinesearchParams.newBuilderForType ( com.google.protobuf.GeneratedMessage.BuilderParent parent)
protected

Definition at line 296 of file AdaptiveLinesearchParams.java.

◆ parseDelimitedFrom() [1/2]

com.google.ortools.pdlp.AdaptiveLinesearchParams com.google.ortools.pdlp.AdaptiveLinesearchParams.parseDelimitedFrom ( java.io.InputStream input) throws java.io.IOException
static

Definition at line 254 of file AdaptiveLinesearchParams.java.

◆ parseDelimitedFrom() [2/2]

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

Definition at line 260 of file AdaptiveLinesearchParams.java.

◆ parseFrom() [1/10]

com.google.ortools.pdlp.AdaptiveLinesearchParams com.google.ortools.pdlp.AdaptiveLinesearchParams.parseFrom ( byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
static

Definition at line 231 of file AdaptiveLinesearchParams.java.

◆ parseFrom() [2/10]

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

Definition at line 235 of file AdaptiveLinesearchParams.java.

◆ parseFrom() [3/10]

com.google.ortools.pdlp.AdaptiveLinesearchParams com.google.ortools.pdlp.AdaptiveLinesearchParams.parseFrom ( com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
static

Definition at line 220 of file AdaptiveLinesearchParams.java.

◆ parseFrom() [4/10]

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

Definition at line 225 of file AdaptiveLinesearchParams.java.

◆ parseFrom() [5/10]

com.google.ortools.pdlp.AdaptiveLinesearchParams com.google.ortools.pdlp.AdaptiveLinesearchParams.parseFrom ( com.google.protobuf.CodedInputStream input) throws java.io.IOException
static

Definition at line 267 of file AdaptiveLinesearchParams.java.

◆ parseFrom() [6/10]

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

Definition at line 273 of file AdaptiveLinesearchParams.java.

◆ parseFrom() [7/10]

com.google.ortools.pdlp.AdaptiveLinesearchParams com.google.ortools.pdlp.AdaptiveLinesearchParams.parseFrom ( java.io.InputStream input) throws java.io.IOException
static

Definition at line 241 of file AdaptiveLinesearchParams.java.

◆ parseFrom() [8/10]

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

Definition at line 246 of file AdaptiveLinesearchParams.java.

◆ parseFrom() [9/10]

com.google.ortools.pdlp.AdaptiveLinesearchParams com.google.ortools.pdlp.AdaptiveLinesearchParams.parseFrom ( java.nio.ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
static

Definition at line 209 of file AdaptiveLinesearchParams.java.

◆ parseFrom() [10/10]

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

Definition at line 214 of file AdaptiveLinesearchParams.java.

◆ parser()

com.google.protobuf.Parser< AdaptiveLinesearchParams > com.google.ortools.pdlp.AdaptiveLinesearchParams.parser ( )
static

Definition at line 626 of file AdaptiveLinesearchParams.java.

◆ toBuilder()

Builder com.google.ortools.pdlp.AdaptiveLinesearchParams.toBuilder ( )

Definition at line 290 of file AdaptiveLinesearchParams.java.

◆ writeTo()

void com.google.ortools.pdlp.AdaptiveLinesearchParams.writeTo ( com.google.protobuf.CodedOutputStream output) throws java.io.IOException

Definition at line 131 of file AdaptiveLinesearchParams.java.

Member Data Documentation

◆ STEP_SIZE_GROWTH_EXPONENT_FIELD_NUMBER

final int com.google.ortools.pdlp.AdaptiveLinesearchParams.STEP_SIZE_GROWTH_EXPONENT_FIELD_NUMBER = 2
static

Definition at line 88 of file AdaptiveLinesearchParams.java.

◆ STEP_SIZE_REDUCTION_EXPONENT_FIELD_NUMBER

final int com.google.ortools.pdlp.AdaptiveLinesearchParams.STEP_SIZE_REDUCTION_EXPONENT_FIELD_NUMBER = 1
static

Definition at line 55 of file AdaptiveLinesearchParams.java.

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