com.google.ortools.pdlp

Class AdaptiveLinesearchParams

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessage

com.google.ortools.pdlp.AdaptiveLinesearchParams

All Implemented Interfaces:

AdaptiveLinesearchParamsOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable

public final class AdaptiveLinesearchParams
extends com.google.protobuf.GeneratedMessage
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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AdaptiveLinesearchParams.Builder 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.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

com.google.protobuf.AbstractMessage.BuilderParent

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	STEP_SIZE_GROWTH_EXPONENT_FIELD_NUMBER
static int	STEP_SIZE_REDUCTION_EXPONENT_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessage

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
static AdaptiveLinesearchParams	getDefaultInstance()
AdaptiveLinesearchParams	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Parser<AdaptiveLinesearchParams>	getParserForType()
int	getSerializedSize()
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.
int	hashCode()
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()
static AdaptiveLinesearchParams.Builder	newBuilder()
static AdaptiveLinesearchParams.Builder	newBuilder(AdaptiveLinesearchParams prototype)
AdaptiveLinesearchParams.Builder	newBuilderForType()
protected AdaptiveLinesearchParams.Builder	newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
static AdaptiveLinesearchParams	parseDelimitedFrom(java.io.InputStream input)
static AdaptiveLinesearchParams	parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static AdaptiveLinesearchParams	parseFrom(byte[] data)
static AdaptiveLinesearchParams	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static AdaptiveLinesearchParams	parseFrom(java.nio.ByteBuffer data)
static AdaptiveLinesearchParams	parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static AdaptiveLinesearchParams	parseFrom(com.google.protobuf.ByteString data)
static AdaptiveLinesearchParams	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static AdaptiveLinesearchParams	parseFrom(com.google.protobuf.CodedInputStream input)
static AdaptiveLinesearchParams	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static AdaptiveLinesearchParams	parseFrom(java.io.InputStream input)
static AdaptiveLinesearchParams	parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<AdaptiveLinesearchParams>	parser()
AdaptiveLinesearchParams.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessage

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashFields, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

STEP_SIZE_REDUCTION_EXPONENT_FIELD_NUMBER

public static final int STEP_SIZE_REDUCTION_EXPONENT_FIELD_NUMBER

See Also:

Constant Field Values

STEP_SIZE_GROWTH_EXPONENT_FIELD_NUMBER

public static final int STEP_SIZE_GROWTH_EXPONENT_FIELD_NUMBER

See Also:

Constant Field Values

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

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.

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.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessage

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws java.io.IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessage

Throws:

java.io.IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessage

equals

public boolean equals(java.lang.Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static AdaptiveLinesearchParams parseFrom(java.nio.ByteBuffer data)
                                          throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static AdaptiveLinesearchParams parseFrom(java.nio.ByteBuffer data,
                                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                          throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static AdaptiveLinesearchParams parseFrom(com.google.protobuf.ByteString data)
                                          throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static AdaptiveLinesearchParams parseFrom(com.google.protobuf.ByteString data,
                                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                          throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static AdaptiveLinesearchParams parseFrom(byte[] data)
                                          throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static AdaptiveLinesearchParams parseFrom(byte[] data,
                                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                          throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static AdaptiveLinesearchParams parseFrom(java.io.InputStream input)
                                          throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static AdaptiveLinesearchParams parseFrom(java.io.InputStream input,
                                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                          throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

public static AdaptiveLinesearchParams parseDelimitedFrom(java.io.InputStream input)
                                                   throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

public static AdaptiveLinesearchParams parseDelimitedFrom(java.io.InputStream input,
                                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                   throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static AdaptiveLinesearchParams parseFrom(com.google.protobuf.CodedInputStream input)
                                          throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static AdaptiveLinesearchParams parseFrom(com.google.protobuf.CodedInputStream input,
                                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                          throws java.io.IOException

Throws:

java.io.IOException

newBuilderForType

public AdaptiveLinesearchParams.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static AdaptiveLinesearchParams.Builder newBuilder()

newBuilder

public static AdaptiveLinesearchParams.Builder newBuilder(AdaptiveLinesearchParams prototype)

toBuilder

public AdaptiveLinesearchParams.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected AdaptiveLinesearchParams.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)

Overrides:

newBuilderForType in class com.google.protobuf.AbstractMessage

getDefaultInstance

public static AdaptiveLinesearchParams getDefaultInstance()

parser

public static com.google.protobuf.Parser<AdaptiveLinesearchParams> parser()

getParserForType

public com.google.protobuf.Parser<AdaptiveLinesearchParams> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessage

getDefaultInstanceForType

public AdaptiveLinesearchParams getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder