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.MalitskyPockParams Class Reference
Inheritance diagram for operations_research.pdlp.Solvers.MalitskyPockParams:
operations_research.pdlp.Solvers.MalitskyPockParamsOrBuilder

Classes

class  Builder
 

Public Member Functions

boolean hasStepSizeDownscalingFactor ()
 
double getStepSizeDownscalingFactor ()
 
boolean hasLinesearchContractionFactor ()
 
double getLinesearchContractionFactor ()
 
boolean hasStepSizeInterpolation ()
 
double getStepSizeInterpolation ()
 
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< MalitskyPockParams > getParserForType ()
 
operations_research.pdlp.Solvers.MalitskyPockParams getDefaultInstanceForType ()
 

Static Public Member Functions

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

Static Public Attributes

static final int STEP_SIZE_DOWNSCALING_FACTOR_FIELD_NUMBER = 1
 
static final int LINESEARCH_CONTRACTION_FACTOR_FIELD_NUMBER = 2
 
static final int STEP_SIZE_INTERPOLATION_FIELD_NUMBER = 3
 
static final com.google.protobuf.Parser< MalitskyPockParams > 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

Protobuf type operations_research.pdlp.MalitskyPockParams

Definition at line 5122 of file Solvers.java.

Member Function Documentation

◆ equals()

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

Definition at line 5311 of file Solvers.java.

◆ getDefaultInstance()

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

Definition at line 5891 of file Solvers.java.

◆ getDefaultInstanceForType()

operations_research.pdlp.Solvers.MalitskyPockParams operations_research.pdlp.Solvers.MalitskyPockParams.getDefaultInstanceForType ( )

Definition at line 5927 of file Solvers.java.

◆ getDescriptor()

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

Definition at line 5145 of file Solvers.java.

◆ getLinesearchContractionFactor()

double operations_research.pdlp.Solvers.MalitskyPockParams.getLinesearchContractionFactor ( ) 
Contraction factor used in the linesearch condition of Malitsky and Pock.
A step size is accepted if primal_weight * primal_stepsize *
norm(constraint_matrix' * (next_dual - current_dual)) is less
than linesearch_contraction_factor * norm(next_dual - current_dual).
The default is the value used in Malitsky and Pock (2016).

optional double linesearch_contraction_factor = 2 [default = 0.99];

Returns
The linesearchContractionFactor.

Implements operations_research.pdlp.Solvers.MalitskyPockParamsOrBuilder.

Definition at line 5222 of file Solvers.java.

◆ getParserForType()

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

Definition at line 5922 of file Solvers.java.

◆ getSerializedSize()

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

Definition at line 5288 of file Solvers.java.

◆ getStepSizeDownscalingFactor()

double operations_research.pdlp.Solvers.MalitskyPockParams.getStepSizeDownscalingFactor ( ) 
At every inner iteration the algorithm can decide to accept the step size
or to update it to step_size = step_size_downscaling_factor * step_size.
This parameter should lie between 0 and 1. The default is the value used in
Malitsky and Pock (2016).

optional double step_size_downscaling_factor = 1 [default = 0.7];

Returns
The stepSizeDownscalingFactor.

Implements operations_research.pdlp.Solvers.MalitskyPockParamsOrBuilder.

Definition at line 5187 of file Solvers.java.

◆ getStepSizeInterpolation()

double operations_research.pdlp.Solvers.MalitskyPockParams.getStepSizeInterpolation ( ) 
Malitsky and Pock linesearch rule permits an arbitrary choice of the first
step size guess within an interval [m, M]. This parameter determines where
in that interval to pick the step size. In particular, the next stepsize is
given by m + step_size_interpolation*(M - m). The default is the value used
in Malitsky and Pock (2016).

optional double step_size_interpolation = 3 [default = 1];

Returns
The stepSizeInterpolation.

Implements operations_research.pdlp.Solvers.MalitskyPockParamsOrBuilder.

Definition at line 5257 of file Solvers.java.

◆ hashCode()

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

Definition at line 5343 of file Solvers.java.

◆ hasLinesearchContractionFactor()

boolean operations_research.pdlp.Solvers.MalitskyPockParams.hasLinesearchContractionFactor ( ) 
Contraction factor used in the linesearch condition of Malitsky and Pock.
A step size is accepted if primal_weight * primal_stepsize *
norm(constraint_matrix' * (next_dual - current_dual)) is less
than linesearch_contraction_factor * norm(next_dual - current_dual).
The default is the value used in Malitsky and Pock (2016).

optional double linesearch_contraction_factor = 2 [default = 0.99];

Returns
Whether the linesearchContractionFactor field is set.

Implements operations_research.pdlp.Solvers.MalitskyPockParamsOrBuilder.

Definition at line 5206 of file Solvers.java.

◆ hasStepSizeDownscalingFactor()

boolean operations_research.pdlp.Solvers.MalitskyPockParams.hasStepSizeDownscalingFactor ( ) 
At every inner iteration the algorithm can decide to accept the step size
or to update it to step_size = step_size_downscaling_factor * step_size.
This parameter should lie between 0 and 1. The default is the value used in
Malitsky and Pock (2016).

optional double step_size_downscaling_factor = 1 [default = 0.7];

Returns
Whether the stepSizeDownscalingFactor field is set.

Implements operations_research.pdlp.Solvers.MalitskyPockParamsOrBuilder.

Definition at line 5172 of file Solvers.java.

◆ hasStepSizeInterpolation()

boolean operations_research.pdlp.Solvers.MalitskyPockParams.hasStepSizeInterpolation ( ) 
Malitsky and Pock linesearch rule permits an arbitrary choice of the first
step size guess within an interval [m, M]. This parameter determines where
in that interval to pick the step size. In particular, the next stepsize is
given by m + step_size_interpolation*(M - m). The default is the value used
in Malitsky and Pock (2016).

optional double step_size_interpolation = 3 [default = 1];

Returns
Whether the stepSizeInterpolation field is set.

Implements operations_research.pdlp.Solvers.MalitskyPockParamsOrBuilder.

Definition at line 5241 of file Solvers.java.

◆ internalGetFieldAccessorTable()

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

Definition at line 5151 of file Solvers.java.

◆ isInitialized()

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

Definition at line 5263 of file Solvers.java.

◆ newBuilder() [1/2]

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

Definition at line 5443 of file Solvers.java.

◆ newBuilder() [2/2]

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

Definition at line 5446 of file Solvers.java.

◆ newBuilderForType() [1/2]

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

Definition at line 5442 of file Solvers.java.

◆ newBuilderForType() [2/2]

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

Definition at line 5456 of file Solvers.java.

◆ newInstance()

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

Definition at line 5139 of file Solvers.java.

◆ parseDelimitedFrom() [1/2]

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

Definition at line 5414 of file Solvers.java.

◆ parseDelimitedFrom() [2/2]

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

Definition at line 5420 of file Solvers.java.

◆ parseFrom() [1/10]

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

Definition at line 5391 of file Solvers.java.

◆ parseFrom() [2/10]

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

Definition at line 5395 of file Solvers.java.

◆ parseFrom() [3/10]

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

Definition at line 5380 of file Solvers.java.

◆ parseFrom() [4/10]

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

Definition at line 5385 of file Solvers.java.

◆ parseFrom() [5/10]

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

Definition at line 5427 of file Solvers.java.

◆ parseFrom() [6/10]

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

Definition at line 5433 of file Solvers.java.

◆ parseFrom() [7/10]

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

Definition at line 5401 of file Solvers.java.

◆ parseFrom() [8/10]

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

Definition at line 5406 of file Solvers.java.

◆ parseFrom() [9/10]

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

Definition at line 5369 of file Solvers.java.

◆ parseFrom() [10/10]

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

Definition at line 5374 of file Solvers.java.

◆ parser()

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

Definition at line 5917 of file Solvers.java.

◆ toBuilder()

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

Definition at line 5450 of file Solvers.java.

◆ writeTo()

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

Definition at line 5273 of file Solvers.java.

Member Data Documentation

◆ LINESEARCH_CONTRACTION_FACTOR_FIELD_NUMBER

final int operations_research.pdlp.Solvers.MalitskyPockParams.LINESEARCH_CONTRACTION_FACTOR_FIELD_NUMBER = 2
static

Definition at line 5191 of file Solvers.java.

◆ PARSER

final com.google.protobuf.Parser<MalitskyPockParams> operations_research.pdlp.Solvers.MalitskyPockParams.PARSER
static
Initial value:
= new com.google.protobuf.AbstractParser<MalitskyPockParams>() {
@java.lang.Override
public MalitskyPockParams 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.MalitskyPockParams.newBuilder
static Builder newBuilder()
Definition Solvers.java:5443

Definition at line 5896 of file Solvers.java.

◆ STEP_SIZE_DOWNSCALING_FACTOR_FIELD_NUMBER

final int operations_research.pdlp.Solvers.MalitskyPockParams.STEP_SIZE_DOWNSCALING_FACTOR_FIELD_NUMBER = 1
static

Definition at line 5158 of file Solvers.java.

◆ STEP_SIZE_INTERPOLATION_FIELD_NUMBER

final int operations_research.pdlp.Solvers.MalitskyPockParams.STEP_SIZE_INTERPOLATION_FIELD_NUMBER = 3
static

Definition at line 5226 of file Solvers.java.

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