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.MalitskyPockParams Class Reference
Inheritance diagram for com.google.ortools.pdlp.MalitskyPockParams:
com.google.ortools.pdlp.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 ()
 
com.google.ortools.pdlp.MalitskyPockParams getDefaultInstanceForType ()
 

Static Public Member Functions

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

Protected Member Functions

com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable ()
 
Builder newBuilderForType (com.google.protobuf.GeneratedMessage.BuilderParent parent)
 

Detailed Description

Protobuf type operations_research.pdlp.MalitskyPockParams

Definition at line 11 of file MalitskyPockParams.java.

Member Function Documentation

◆ equals()

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

Definition at line 202 of file MalitskyPockParams.java.

◆ getDefaultInstance()

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

Definition at line 738 of file MalitskyPockParams.java.

◆ getDefaultInstanceForType()

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

Definition at line 774 of file MalitskyPockParams.java.

◆ getDescriptor()

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

Definition at line 36 of file MalitskyPockParams.java.

◆ getLinesearchContractionFactor()

double com.google.ortools.pdlp.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 com.google.ortools.pdlp.MalitskyPockParamsOrBuilder.

Definition at line 113 of file MalitskyPockParams.java.

◆ getParserForType()

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

Definition at line 769 of file MalitskyPockParams.java.

◆ getSerializedSize()

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

Definition at line 179 of file MalitskyPockParams.java.

◆ getStepSizeDownscalingFactor()

double com.google.ortools.pdlp.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 com.google.ortools.pdlp.MalitskyPockParamsOrBuilder.

Definition at line 78 of file MalitskyPockParams.java.

◆ getStepSizeInterpolation()

double com.google.ortools.pdlp.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 com.google.ortools.pdlp.MalitskyPockParamsOrBuilder.

Definition at line 148 of file MalitskyPockParams.java.

◆ hashCode()

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

Definition at line 234 of file MalitskyPockParams.java.

◆ hasLinesearchContractionFactor()

boolean com.google.ortools.pdlp.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 com.google.ortools.pdlp.MalitskyPockParamsOrBuilder.

Definition at line 97 of file MalitskyPockParams.java.

◆ hasStepSizeDownscalingFactor()

boolean com.google.ortools.pdlp.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 com.google.ortools.pdlp.MalitskyPockParamsOrBuilder.

Definition at line 63 of file MalitskyPockParams.java.

◆ hasStepSizeInterpolation()

boolean com.google.ortools.pdlp.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 com.google.ortools.pdlp.MalitskyPockParamsOrBuilder.

Definition at line 132 of file MalitskyPockParams.java.

◆ internalGetFieldAccessorTable()

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

Definition at line 42 of file MalitskyPockParams.java.

◆ isInitialized()

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

Definition at line 154 of file MalitskyPockParams.java.

◆ newBuilder() [1/2]

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

Definition at line 334 of file MalitskyPockParams.java.

◆ newBuilder() [2/2]

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

Definition at line 337 of file MalitskyPockParams.java.

◆ newBuilderForType() [1/2]

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

Definition at line 333 of file MalitskyPockParams.java.

◆ newBuilderForType() [2/2]

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

Definition at line 347 of file MalitskyPockParams.java.

◆ parseDelimitedFrom() [1/2]

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

Definition at line 305 of file MalitskyPockParams.java.

◆ parseDelimitedFrom() [2/2]

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

Definition at line 311 of file MalitskyPockParams.java.

◆ parseFrom() [1/10]

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

Definition at line 282 of file MalitskyPockParams.java.

◆ parseFrom() [2/10]

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

Definition at line 286 of file MalitskyPockParams.java.

◆ parseFrom() [3/10]

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

Definition at line 271 of file MalitskyPockParams.java.

◆ parseFrom() [4/10]

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

Definition at line 276 of file MalitskyPockParams.java.

◆ parseFrom() [5/10]

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

Definition at line 318 of file MalitskyPockParams.java.

◆ parseFrom() [6/10]

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

Definition at line 324 of file MalitskyPockParams.java.

◆ parseFrom() [7/10]

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

Definition at line 292 of file MalitskyPockParams.java.

◆ parseFrom() [8/10]

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

Definition at line 297 of file MalitskyPockParams.java.

◆ parseFrom() [9/10]

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

Definition at line 260 of file MalitskyPockParams.java.

◆ parseFrom() [10/10]

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

Definition at line 265 of file MalitskyPockParams.java.

◆ parser()

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

Definition at line 764 of file MalitskyPockParams.java.

◆ toBuilder()

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

Definition at line 341 of file MalitskyPockParams.java.

◆ writeTo()

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

Definition at line 164 of file MalitskyPockParams.java.

Member Data Documentation

◆ LINESEARCH_CONTRACTION_FACTOR_FIELD_NUMBER

final int com.google.ortools.pdlp.MalitskyPockParams.LINESEARCH_CONTRACTION_FACTOR_FIELD_NUMBER = 2
static

Definition at line 82 of file MalitskyPockParams.java.

◆ STEP_SIZE_DOWNSCALING_FACTOR_FIELD_NUMBER

final int com.google.ortools.pdlp.MalitskyPockParams.STEP_SIZE_DOWNSCALING_FACTOR_FIELD_NUMBER = 1
static

Definition at line 49 of file MalitskyPockParams.java.

◆ STEP_SIZE_INTERPOLATION_FIELD_NUMBER

final int com.google.ortools.pdlp.MalitskyPockParams.STEP_SIZE_INTERPOLATION_FIELD_NUMBER = 3
static

Definition at line 117 of file MalitskyPockParams.java.

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