Google OR-Tools v9.9
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
operations_research.pdlp.Solvers.AdaptiveLinesearchParams Class Reference
Inheritance diagram for operations_research.pdlp.Solvers.AdaptiveLinesearchParams:
operations_research.pdlp.Solvers.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 ()
 
operations_research.pdlp.Solvers.AdaptiveLinesearchParams getDefaultInstanceForType ()
 

Static Public Member Functions

static final com.google.protobuf.Descriptors.Descriptor getDescriptor ()
 
static operations_research.pdlp.Solvers.AdaptiveLinesearchParams parseFrom (java.nio.ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
 
static operations_research.pdlp.Solvers.AdaptiveLinesearchParams parseFrom (java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
 
static operations_research.pdlp.Solvers.AdaptiveLinesearchParams parseFrom (com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
 
static operations_research.pdlp.Solvers.AdaptiveLinesearchParams parseFrom (com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
 
static operations_research.pdlp.Solvers.AdaptiveLinesearchParams parseFrom (byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
 
static operations_research.pdlp.Solvers.AdaptiveLinesearchParams parseFrom (byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
 
static operations_research.pdlp.Solvers.AdaptiveLinesearchParams parseFrom (java.io.InputStream input) throws java.io.IOException
 
static operations_research.pdlp.Solvers.AdaptiveLinesearchParams parseFrom (java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
 
static operations_research.pdlp.Solvers.AdaptiveLinesearchParams parseDelimitedFrom (java.io.InputStream input) throws java.io.IOException
 
static operations_research.pdlp.Solvers.AdaptiveLinesearchParams parseDelimitedFrom (java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
 
static operations_research.pdlp.Solvers.AdaptiveLinesearchParams parseFrom (com.google.protobuf.CodedInputStream input) throws java.io.IOException
 
static operations_research.pdlp.Solvers.AdaptiveLinesearchParams parseFrom (com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
 
static Builder newBuilder ()
 
static Builder newBuilder (operations_research.pdlp.Solvers.AdaptiveLinesearchParams prototype)
 
static operations_research.pdlp.Solvers.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
 
static final com.google.protobuf.Parser< AdaptiveLinesearchParams > PARSER
 

Protected Member Functions

java.lang.Object newInstance (UnusedPrivateParameter unused)
 
com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable ()
 
Builder newBuilderForType (com.google.protobuf.GeneratedMessageV3.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 4370 of file Solvers.java.

Member Function Documentation

◆ equals()

boolean operations_research.pdlp.Solvers.AdaptiveLinesearchParams.equals ( final java.lang.Object obj)

Definition at line 4512 of file Solvers.java.

◆ getDefaultInstance()

static operations_research.pdlp.Solvers.AdaptiveLinesearchParams operations_research.pdlp.Solvers.AdaptiveLinesearchParams.getDefaultInstance ( )
static

Definition at line 4994 of file Solvers.java.

◆ getDefaultInstanceForType()

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

Definition at line 5030 of file Solvers.java.

◆ getDescriptor()

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

Definition at line 4392 of file Solvers.java.

◆ getParserForType()

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

Definition at line 5025 of file Solvers.java.

◆ getSerializedSize()

int operations_research.pdlp.Solvers.AdaptiveLinesearchParams.getSerializedSize ( )

Definition at line 4493 of file Solvers.java.

◆ getStepSizeGrowthExponent()

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

Definition at line 4465 of file Solvers.java.

◆ getStepSizeReductionExponent()

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

Definition at line 4434 of file Solvers.java.

◆ hashCode()

int operations_research.pdlp.Solvers.AdaptiveLinesearchParams.hashCode ( )

Definition at line 4538 of file Solvers.java.

◆ hasStepSizeGrowthExponent()

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

Definition at line 4451 of file Solvers.java.

◆ hasStepSizeReductionExponent()

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

Definition at line 4419 of file Solvers.java.

◆ internalGetFieldAccessorTable()

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

Definition at line 4398 of file Solvers.java.

◆ isInitialized()

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

Definition at line 4471 of file Solvers.java.

◆ newBuilder() [1/2]

static Builder operations_research.pdlp.Solvers.AdaptiveLinesearchParams.newBuilder ( )
static

Definition at line 4633 of file Solvers.java.

◆ newBuilder() [2/2]

static Builder operations_research.pdlp.Solvers.AdaptiveLinesearchParams.newBuilder ( operations_research.pdlp.Solvers.AdaptiveLinesearchParams prototype)
static

Definition at line 4636 of file Solvers.java.

◆ newBuilderForType() [1/2]

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

Definition at line 4632 of file Solvers.java.

◆ newBuilderForType() [2/2]

Builder operations_research.pdlp.Solvers.AdaptiveLinesearchParams.newBuilderForType ( com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected

Definition at line 4646 of file Solvers.java.

◆ newInstance()

java.lang.Object operations_research.pdlp.Solvers.AdaptiveLinesearchParams.newInstance ( UnusedPrivateParameter unused)
protected

Definition at line 4386 of file Solvers.java.

◆ parseDelimitedFrom() [1/2]

static operations_research.pdlp.Solvers.AdaptiveLinesearchParams operations_research.pdlp.Solvers.AdaptiveLinesearchParams.parseDelimitedFrom ( java.io.InputStream input) throws java.io.IOException
static

Definition at line 4604 of file Solvers.java.

◆ parseDelimitedFrom() [2/2]

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

Definition at line 4610 of file Solvers.java.

◆ parseFrom() [1/10]

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

Definition at line 4581 of file Solvers.java.

◆ parseFrom() [2/10]

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

Definition at line 4585 of file Solvers.java.

◆ parseFrom() [3/10]

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

Definition at line 4570 of file Solvers.java.

◆ parseFrom() [4/10]

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

Definition at line 4575 of file Solvers.java.

◆ parseFrom() [5/10]

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

Definition at line 4617 of file Solvers.java.

◆ parseFrom() [6/10]

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

Definition at line 4623 of file Solvers.java.

◆ parseFrom() [7/10]

static operations_research.pdlp.Solvers.AdaptiveLinesearchParams operations_research.pdlp.Solvers.AdaptiveLinesearchParams.parseFrom ( java.io.InputStream input) throws java.io.IOException
static

Definition at line 4591 of file Solvers.java.

◆ parseFrom() [8/10]

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

Definition at line 4596 of file Solvers.java.

◆ parseFrom() [9/10]

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

Definition at line 4559 of file Solvers.java.

◆ parseFrom() [10/10]

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

Definition at line 4564 of file Solvers.java.

◆ parser()

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

Definition at line 5020 of file Solvers.java.

◆ toBuilder()

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

Definition at line 4640 of file Solvers.java.

◆ writeTo()

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

Definition at line 4481 of file Solvers.java.

Member Data Documentation

◆ PARSER

final com.google.protobuf.Parser<AdaptiveLinesearchParams> operations_research.pdlp.Solvers.AdaptiveLinesearchParams.PARSER
static
Initial value:
= new com.google.protobuf.AbstractParser<AdaptiveLinesearchParams>() {
@java.lang.Override
public AdaptiveLinesearchParams parsePartialFrom(
com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry)
throws com.google.protobuf.InvalidProtocolBufferException {
Builder builder = newBuilder();
try {
builder.mergeFrom(input, extensionRegistry);
} catch (com.google.protobuf.InvalidProtocolBufferException e) {
throw e.setUnfinishedMessage(builder.buildPartial());
} catch (com.google.protobuf.UninitializedMessageException e) {
throw e.asInvalidProtocolBufferException().setUnfinishedMessage(builder.buildPartial());
} catch (java.io.IOException e) {
throw new com.google.protobuf.InvalidProtocolBufferException(e)
.setUnfinishedMessage(builder.buildPartial());
}
return builder.buildPartial();
}
}
operations_research.pdlp.Solvers.AdaptiveLinesearchParams.newBuilder
static Builder newBuilder()
Definition Solvers.java:4633

Definition at line 4999 of file Solvers.java.

◆ STEP_SIZE_GROWTH_EXPONENT_FIELD_NUMBER

final int operations_research.pdlp.Solvers.AdaptiveLinesearchParams.STEP_SIZE_GROWTH_EXPONENT_FIELD_NUMBER = 2
static

Definition at line 4438 of file Solvers.java.

◆ STEP_SIZE_REDUCTION_EXPONENT_FIELD_NUMBER

final int operations_research.pdlp.Solvers.AdaptiveLinesearchParams.STEP_SIZE_REDUCTION_EXPONENT_FIELD_NUMBER = 1
static

Definition at line 4405 of file Solvers.java.

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