Enum RestartChoice
- All Implemented Interfaces:
com.google.protobuf.Internal.EnumLite,com.google.protobuf.ProtocolMessageEnum,Serializable,Comparable<RestartChoice>,java.lang.constant.Constable
@Generated
public enum RestartChoice
extends Enum<RestartChoice>
implements com.google.protobuf.ProtocolMessageEnum
Specifies whether a restart was performed on a given iteration.Protobuf enum
operations_research.pdlp.RestartChoice-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>> -
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionNo restart on this iteration.The algorithm is restarted at the average of iterates since the last restart.RESTART_CHOICE_UNSPECIFIED = 0;The weighted average of iterates is cleared and reset to the current point. -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intNo restart on this iteration.static final intThe algorithm is restarted at the average of iterates since the last restart.static final intRESTART_CHOICE_UNSPECIFIED = 0;static final intThe weighted average of iterates is cleared and reset to the current point. -
Method Summary
Modifier and TypeMethodDescriptionstatic RestartChoiceforNumber(int value) static com.google.protobuf.Descriptors.EnumDescriptorfinal com.google.protobuf.Descriptors.EnumDescriptorfinal intfinal com.google.protobuf.Descriptors.EnumValueDescriptorstatic com.google.protobuf.Internal.EnumLiteMap<RestartChoice> static RestartChoicevalueOf(int value) Deprecated.static RestartChoicevalueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc) Returns the enum constant of this type with the specified name.static RestartChoiceReturns the enum constant of this type with the specified name.static RestartChoice[]values()Returns an array containing the constants of this enum type, in the order they are declared.
-
Enum Constant Details
-
RESTART_CHOICE_UNSPECIFIED
RESTART_CHOICE_UNSPECIFIED = 0; -
RESTART_CHOICE_NO_RESTART
No restart on this iteration.
RESTART_CHOICE_NO_RESTART = 1; -
RESTART_CHOICE_WEIGHTED_AVERAGE_RESET
The weighted average of iterates is cleared and reset to the current point. Note that from a mathematical perspective this can be equivalently viewed as restarting the algorithm but picking the restart point to be the current iterate.
RESTART_CHOICE_WEIGHTED_AVERAGE_RESET = 2; -
RESTART_CHOICE_RESTART_TO_AVERAGE
The algorithm is restarted at the average of iterates since the last restart.
RESTART_CHOICE_RESTART_TO_AVERAGE = 3;
-
-
Field Details
-
RESTART_CHOICE_UNSPECIFIED_VALUE
public static final int RESTART_CHOICE_UNSPECIFIED_VALUERESTART_CHOICE_UNSPECIFIED = 0;- See Also:
-
RESTART_CHOICE_NO_RESTART_VALUE
public static final int RESTART_CHOICE_NO_RESTART_VALUENo restart on this iteration.
RESTART_CHOICE_NO_RESTART = 1;- See Also:
-
RESTART_CHOICE_WEIGHTED_AVERAGE_RESET_VALUE
public static final int RESTART_CHOICE_WEIGHTED_AVERAGE_RESET_VALUEThe weighted average of iterates is cleared and reset to the current point. Note that from a mathematical perspective this can be equivalently viewed as restarting the algorithm but picking the restart point to be the current iterate.
RESTART_CHOICE_WEIGHTED_AVERAGE_RESET = 2;- See Also:
-
RESTART_CHOICE_RESTART_TO_AVERAGE_VALUE
public static final int RESTART_CHOICE_RESTART_TO_AVERAGE_VALUEThe algorithm is restarted at the average of iterates since the last restart.
RESTART_CHOICE_RESTART_TO_AVERAGE = 3;- See Also:
-
-
Method Details
-
values
Returns an array containing the constants of this enum type, in the order they are declared.- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)- Parameters:
name- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException- if this enum type has no constant with the specified nameNullPointerException- if the argument is null
-
getNumber
public final int getNumber()- Specified by:
getNumberin interfacecom.google.protobuf.Internal.EnumLite- Specified by:
getNumberin interfacecom.google.protobuf.ProtocolMessageEnum
-
valueOf
Deprecated.Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)- Parameters:
value- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException- if this enum type has no constant with the specified nameNullPointerException- if the argument is null
-
forNumber
- Parameters:
value- The numeric wire value of the corresponding enum entry.- Returns:
- The enum associated with the given numeric wire value.
-
internalGetValueMap
-
getValueDescriptor
public final com.google.protobuf.Descriptors.EnumValueDescriptor getValueDescriptor()- Specified by:
getValueDescriptorin interfacecom.google.protobuf.ProtocolMessageEnum
-
getDescriptorForType
public final com.google.protobuf.Descriptors.EnumDescriptor getDescriptorForType()- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.ProtocolMessageEnum
-
getDescriptor
public static com.google.protobuf.Descriptors.EnumDescriptor getDescriptor() -
valueOf
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)- Parameters:
desc- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException- if this enum type has no constant with the specified nameNullPointerException- if the argument is null
-