com.google.ortools.pdlp

Class MalitskyPockParams.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderT>

com.google.protobuf.GeneratedMessage.Builder<MalitskyPockParams.Builder>

com.google.ortools.pdlp.MalitskyPockParams.Builder

All Implemented Interfaces:

MalitskyPockParamsOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.lang.Cloneable

Enclosing class:

MalitskyPockParams

public static final class MalitskyPockParams.Builder
extends com.google.protobuf.GeneratedMessage.Builder<MalitskyPockParams.Builder>
implements MalitskyPockParamsOrBuilder

Protobuf type operations_research.pdlp.MalitskyPockParams

Method Summary

Modifier and Type	Method and Description
MalitskyPockParams	build()
MalitskyPockParams	buildPartial()
MalitskyPockParams.Builder	clear()
MalitskyPockParams.Builder	clearLinesearchContractionFactor() Contraction factor used in the linesearch condition of Malitsky and Pock.
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.
MalitskyPockParams.Builder	clearStepSizeInterpolation() Malitsky and Pock linesearch rule permits an arbitrary choice of the first step size guess within an interval [m, M].
MalitskyPockParams	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
double	getLinesearchContractionFactor() Contraction factor used in the linesearch condition of Malitsky and Pock.
double	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.
double	getStepSizeInterpolation() Malitsky and Pock linesearch rule permits an arbitrary choice of the first step size guess within an interval [m, M].
boolean	hasLinesearchContractionFactor() Contraction factor used in the linesearch condition of Malitsky and Pock.
boolean	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.
boolean	hasStepSizeInterpolation() Malitsky and Pock linesearch rule permits an arbitrary choice of the first step size guess within an interval [m, M].
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
MalitskyPockParams.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
MalitskyPockParams.Builder	mergeFrom(MalitskyPockParams other)
MalitskyPockParams.Builder	mergeFrom(com.google.protobuf.Message other)
MalitskyPockParams.Builder	setLinesearchContractionFactor(double value) Contraction factor used in the linesearch condition of Malitsky and Pock.
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.
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].

Methods inherited from class com.google.protobuf.GeneratedMessage.Builder

addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

Method Detail

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<MalitskyPockParams.Builder>

clear

public MalitskyPockParams.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessage.Builder<MalitskyPockParams.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<MalitskyPockParams.Builder>

getDefaultInstanceForType

public MalitskyPockParams getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public MalitskyPockParams build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public MalitskyPockParams buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

mergeFrom

public MalitskyPockParams.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<MalitskyPockParams.Builder>

mergeFrom

public MalitskyPockParams.Builder mergeFrom(MalitskyPockParams other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessage.Builder<MalitskyPockParams.Builder>

mergeFrom

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

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<MalitskyPockParams.Builder>

Throws:

java.io.IOException

hasStepSizeDownscalingFactor

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

Specified by:

hasStepSizeDownscalingFactor in interface MalitskyPockParamsOrBuilder

Returns:

Whether the stepSizeDownscalingFactor field is set.

getStepSizeDownscalingFactor

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

Specified by:

getStepSizeDownscalingFactor in interface MalitskyPockParamsOrBuilder

Returns:

The stepSizeDownscalingFactor.

setStepSizeDownscalingFactor

public 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.

clearStepSizeDownscalingFactor

public 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.

hasLinesearchContractionFactor

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

Specified by:

hasLinesearchContractionFactor in interface MalitskyPockParamsOrBuilder

Returns:

Whether the linesearchContractionFactor field is set.

getLinesearchContractionFactor

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

Specified by:

getLinesearchContractionFactor in interface MalitskyPockParamsOrBuilder

Returns:

The linesearchContractionFactor.

setLinesearchContractionFactor

public 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.

clearLinesearchContractionFactor

public 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.

hasStepSizeInterpolation

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

Specified by:

hasStepSizeInterpolation in interface MalitskyPockParamsOrBuilder

Returns:

Whether the stepSizeInterpolation field is set.

getStepSizeInterpolation

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

Specified by:

getStepSizeInterpolation in interface MalitskyPockParamsOrBuilder

Returns:

The stepSizeInterpolation.

setStepSizeInterpolation

public 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.

clearStepSizeInterpolation

public 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.