com.google.ortools.pdlp

Class AdaptiveLinesearchParams.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

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

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

com.google.ortools.pdlp.AdaptiveLinesearchParams.Builder

All Implemented Interfaces:

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

Enclosing class:

AdaptiveLinesearchParams

public static final class AdaptiveLinesearchParams.Builder
extends com.google.protobuf.GeneratedMessage.Builder<AdaptiveLinesearchParams.Builder>
implements AdaptiveLinesearchParamsOrBuilder

 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

Method Summary

Modifier and Type	Method and Description
AdaptiveLinesearchParams	build()
AdaptiveLinesearchParams	buildPartial()
AdaptiveLinesearchParams.Builder	clear()
AdaptiveLinesearchParams.Builder	clearStepSizeGrowthExponent() The step size growth exponent defines a step size given by (1 + (total_steps_attempted + 1)^(-step_size_growth_exponent)) * step_size_.
AdaptiveLinesearchParams.Builder	clearStepSizeReductionExponent() 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.
AdaptiveLinesearchParams	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
double	getStepSizeGrowthExponent() The step size growth exponent defines a step size given by (1 + (total_steps_attempted + 1)^(-step_size_growth_exponent)) * step_size_.
double	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.
boolean	hasStepSizeGrowthExponent() The step size growth exponent defines a step size given by (1 + (total_steps_attempted + 1)^(-step_size_growth_exponent)) * step_size_.
boolean	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.
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
AdaptiveLinesearchParams.Builder	mergeFrom(AdaptiveLinesearchParams other)
AdaptiveLinesearchParams.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
AdaptiveLinesearchParams.Builder	mergeFrom(com.google.protobuf.Message other)
AdaptiveLinesearchParams.Builder	setStepSizeGrowthExponent(double value) The step size growth exponent defines a step size given by (1 + (total_steps_attempted + 1)^(-step_size_growth_exponent)) * step_size_.
AdaptiveLinesearchParams.Builder	setStepSizeReductionExponent(double value) 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.

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<AdaptiveLinesearchParams.Builder>

clear

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

getDefaultInstanceForType

public AdaptiveLinesearchParams getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public AdaptiveLinesearchParams build()

Specified by:

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

Specified by:

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

buildPartial

public AdaptiveLinesearchParams buildPartial()

Specified by:

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

Specified by:

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

mergeFrom

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

mergeFrom

public AdaptiveLinesearchParams.Builder mergeFrom(AdaptiveLinesearchParams other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

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

mergeFrom

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

Throws:

java.io.IOException

hasStepSizeReductionExponent

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

Specified by:

hasStepSizeReductionExponent in interface AdaptiveLinesearchParamsOrBuilder

Returns:

Whether the stepSizeReductionExponent field is set.

getStepSizeReductionExponent

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

Specified by:

getStepSizeReductionExponent in interface AdaptiveLinesearchParamsOrBuilder

Returns:

The stepSizeReductionExponent.

setStepSizeReductionExponent

public AdaptiveLinesearchParams.Builder setStepSizeReductionExponent(double value)

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

Parameters:

value - The stepSizeReductionExponent to set.

Returns:

This builder for chaining.

clearStepSizeReductionExponent

public AdaptiveLinesearchParams.Builder clearStepSizeReductionExponent()

 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:

This builder for chaining.

hasStepSizeGrowthExponent

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

Specified by:

hasStepSizeGrowthExponent in interface AdaptiveLinesearchParamsOrBuilder

Returns:

Whether the stepSizeGrowthExponent field is set.

getStepSizeGrowthExponent

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

Specified by:

getStepSizeGrowthExponent in interface AdaptiveLinesearchParamsOrBuilder

Returns:

The stepSizeGrowthExponent.

setStepSizeGrowthExponent

public AdaptiveLinesearchParams.Builder setStepSizeGrowthExponent(double value)

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

Parameters:

value - The stepSizeGrowthExponent to set.

Returns:

This builder for chaining.

clearStepSizeGrowthExponent

public AdaptiveLinesearchParams.Builder clearStepSizeGrowthExponent()

 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:

This builder for chaining.