Google OR-Tools v9.12
a fast and portable software suite for combinatorial optimization
Loading...
Searching...
No Matches
Classes | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | List of all members
com.google.ortools.pdlp.AdaptiveLinesearchParams Class Reference
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)
 

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

Member Function Documentation

◆ equals()

boolean com.google.ortools.pdlp.AdaptiveLinesearchParams.equals ( final java.lang.Object obj)

Definition at line 161 of file AdaptiveLinesearchParams.java.

◆ getDefaultInstance()

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

Definition at line 599 of file AdaptiveLinesearchParams.java.

◆ getDefaultInstanceForType()

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

Definition at line 635 of file AdaptiveLinesearchParams.java.

◆ getDescriptor()

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

Definition at line 41 of file AdaptiveLinesearchParams.java.

◆ getParserForType()

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

Definition at line 630 of file AdaptiveLinesearchParams.java.

◆ getSerializedSize()

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

Definition at line 142 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 114 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 83 of file AdaptiveLinesearchParams.java.

◆ hashCode()

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

Definition at line 187 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 100 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 68 of file AdaptiveLinesearchParams.java.

◆ internalGetFieldAccessorTable()

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

Definition at line 47 of file AdaptiveLinesearchParams.java.

◆ isInitialized()

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

Definition at line 120 of file AdaptiveLinesearchParams.java.

◆ newBuilder() [1/2]

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

Definition at line 282 of file AdaptiveLinesearchParams.java.

◆ newBuilder() [2/2]

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

Definition at line 285 of file AdaptiveLinesearchParams.java.

◆ newBuilderForType() [1/2]

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

Definition at line 281 of file AdaptiveLinesearchParams.java.

◆ newBuilderForType() [2/2]

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

Definition at line 295 of file AdaptiveLinesearchParams.java.

◆ parseDelimitedFrom() [1/2]

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

Definition at line 253 of file AdaptiveLinesearchParams.java.

◆ parseDelimitedFrom() [2/2]

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

◆ parseFrom() [1/10]

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

Definition at line 230 of file AdaptiveLinesearchParams.java.

◆ parseFrom() [2/10]

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

◆ parseFrom() [3/10]

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

◆ parseFrom() [4/10]

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

◆ parseFrom() [5/10]

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

Definition at line 266 of file AdaptiveLinesearchParams.java.

◆ parseFrom() [6/10]

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

◆ parseFrom() [7/10]

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

Definition at line 240 of file AdaptiveLinesearchParams.java.

◆ parseFrom() [8/10]

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

◆ parseFrom() [9/10]

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

Definition at line 208 of file AdaptiveLinesearchParams.java.

◆ parseFrom() [10/10]

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

◆ parser()

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

Definition at line 625 of file AdaptiveLinesearchParams.java.

◆ toBuilder()

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

Definition at line 289 of file AdaptiveLinesearchParams.java.

◆ writeTo()

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

Definition at line 130 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 87 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 54 of file AdaptiveLinesearchParams.java.

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