com.google.ortools.pdlp.MalitskyPockParams.Builder Class Reference

Inheritance diagram for com.google.ortools.pdlp.MalitskyPockParams.Builder:

Public Member Functions
Builder	clear ()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType ()
com.google.ortools.pdlp.MalitskyPockParams	getDefaultInstanceForType ()
com.google.ortools.pdlp.MalitskyPockParams	build ()
com.google.ortools.pdlp.MalitskyPockParams	buildPartial ()
Builder	mergeFrom (com.google.protobuf.Message other)
Builder	mergeFrom (com.google.ortools.pdlp.MalitskyPockParams other)
final boolean	isInitialized ()
Builder	mergeFrom (com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
boolean	hasStepSizeDownscalingFactor ()
double	getStepSizeDownscalingFactor ()
Builder	setStepSizeDownscalingFactor (double value)
Builder	clearStepSizeDownscalingFactor ()
boolean	hasLinesearchContractionFactor ()
double	getLinesearchContractionFactor ()
Builder	setLinesearchContractionFactor (double value)
Builder	clearLinesearchContractionFactor ()
boolean	hasStepSizeInterpolation ()
double	getStepSizeInterpolation ()
Builder	setStepSizeInterpolation (double value)
Builder	clearStepSizeInterpolation ()

Static Public Member Functions
static final com.google.protobuf.Descriptors.Descriptor	getDescriptor ()

Protected Member Functions
com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable ()

Detailed Description

Protobuf type operations_research.pdlp.MalitskyPockParams

Definition at line 355 of file MalitskyPockParams.java.

Member Function Documentation

build()

com.google.ortools.pdlp.MalitskyPockParams com.google.ortools.pdlp.MalitskyPockParams.Builder.build

(

)

Definition at line 404 of file MalitskyPockParams.java.

buildPartial()

com.google.ortools.pdlp.MalitskyPockParams com.google.ortools.pdlp.MalitskyPockParams.Builder.buildPartial

(

)

Definition at line 413 of file MalitskyPockParams.java.

clear()

Builder com.google.ortools.pdlp.MalitskyPockParams.Builder.clear

(

)

Definition at line 383 of file MalitskyPockParams.java.

clearLinesearchContractionFactor()

Builder com.google.ortools.pdlp.MalitskyPockParams.Builder.clearLinesearchContractionFactor

(

)

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

This builder for chaining.

Definition at line 650 of file MalitskyPockParams.java.

clearStepSizeDownscalingFactor()

Builder com.google.ortools.pdlp.MalitskyPockParams.Builder.clearStepSizeDownscalingFactor

(

)

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

This builder for chaining.

Definition at line 578 of file MalitskyPockParams.java.

clearStepSizeInterpolation()

Builder com.google.ortools.pdlp.MalitskyPockParams.Builder.clearStepSizeInterpolation

(

)

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

This builder for chaining.

Definition at line 722 of file MalitskyPockParams.java.

getDefaultInstanceForType()

com.google.ortools.pdlp.MalitskyPockParams com.google.ortools.pdlp.MalitskyPockParams.Builder.getDefaultInstanceForType

(

)

Definition at line 399 of file MalitskyPockParams.java.

getDescriptor()

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

static

Definition at line 360 of file MalitskyPockParams.java.

getDescriptorForType()

com.google.protobuf.Descriptors.Descriptor com.google.ortools.pdlp.MalitskyPockParams.Builder.getDescriptorForType

(

)

Definition at line 394 of file MalitskyPockParams.java.

getLinesearchContractionFactor()

double com.google.ortools.pdlp.MalitskyPockParams.Builder.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 615 of file MalitskyPockParams.java.

getStepSizeDownscalingFactor()

double com.google.ortools.pdlp.MalitskyPockParams.Builder.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 545 of file MalitskyPockParams.java.

getStepSizeInterpolation()

double com.google.ortools.pdlp.MalitskyPockParams.Builder.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 687 of file MalitskyPockParams.java.

hasLinesearchContractionFactor()

boolean com.google.ortools.pdlp.MalitskyPockParams.Builder.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 599 of file MalitskyPockParams.java.

hasStepSizeDownscalingFactor()

boolean com.google.ortools.pdlp.MalitskyPockParams.Builder.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 530 of file MalitskyPockParams.java.

hasStepSizeInterpolation()

boolean com.google.ortools.pdlp.MalitskyPockParams.Builder.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 671 of file MalitskyPockParams.java.

internalGetFieldAccessorTable()

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

protected

Definition at line 366 of file MalitskyPockParams.java.

isInitialized()

final boolean com.google.ortools.pdlp.MalitskyPockParams.Builder.isInitialized

(

)

Definition at line 465 of file MalitskyPockParams.java.

mergeFrom() [1/3]

Builder com.google.ortools.pdlp.MalitskyPockParams.Builder.mergeFrom

(

com.google.ortools.pdlp.MalitskyPockParams

other

)

Definition at line 448 of file MalitskyPockParams.java.

mergeFrom() [2/3]

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

Definition at line 470 of file MalitskyPockParams.java.

mergeFrom() [3/3]

Builder com.google.ortools.pdlp.MalitskyPockParams.Builder.mergeFrom

(

com.google.protobuf.Message

other

)

Definition at line 439 of file MalitskyPockParams.java.

setLinesearchContractionFactor()

Builder com.google.ortools.pdlp.MalitskyPockParams.Builder.setLinesearchContractionFactor

(

double

value

)

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];

Parameters

value

The linesearchContractionFactor to set.

Returns

This builder for chaining.

Definition at line 631 of file MalitskyPockParams.java.

setStepSizeDownscalingFactor()

Builder com.google.ortools.pdlp.MalitskyPockParams.Builder.setStepSizeDownscalingFactor

(

double

value

)

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];

Parameters

value

The stepSizeDownscalingFactor to set.

Returns

This builder for chaining.

Definition at line 560 of file MalitskyPockParams.java.

setStepSizeInterpolation()

Builder com.google.ortools.pdlp.MalitskyPockParams.Builder.setStepSizeInterpolation

(

double

value

)

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];

Parameters

value

The stepSizeInterpolation to set.

Returns

This builder for chaining.

Definition at line 703 of file MalitskyPockParams.java.

---

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

• build/java/ortools-java/src/main/java/com/google/ortools/pdlp/MalitskyPockParams.java