com.google.ortools.pdlp.RestartChoice Enum Reference

Inheritance diagram for com.google.ortools.pdlp.RestartChoice:

Public Member Functions
final int	getNumber ()
final com.google.protobuf.Descriptors.EnumValueDescriptor	getValueDescriptor ()
final com.google.protobuf.Descriptors.EnumDescriptor	getDescriptorForType ()

Static Public Member Functions
	[static initializer]
static RestartChoice	valueOf (int value)
static RestartChoice	forNumber (int value)
static com.google.protobuf.Internal.EnumLiteMap< RestartChoice >	internalGetValueMap ()
static final com.google.protobuf.Descriptors.EnumDescriptor	getDescriptor ()
static RestartChoice	valueOf (com.google.protobuf.Descriptors.EnumValueDescriptor desc)

Public Attributes
	RESTART_CHOICE_UNSPECIFIED =(0)
	RESTART_CHOICE_NO_RESTART =(1)
	RESTART_CHOICE_WEIGHTED_AVERAGE_RESET =(2)
	RESTART_CHOICE_RESTART_TO_AVERAGE =(3)

Static Public Attributes
static final int	RESTART_CHOICE_UNSPECIFIED_VALUE = 0
static final int	RESTART_CHOICE_NO_RESTART_VALUE = 1
static final int	RESTART_CHOICE_WEIGHTED_AVERAGE_RESET_VALUE = 2
static final int	RESTART_CHOICE_RESTART_TO_AVERAGE_VALUE = 3

Detailed Description

Specifies whether a restart was performed on a given iteration.

Protobuf enum operations_research.pdlp.RestartChoice

Definition at line 15 of file RestartChoice.java.

Member Function Documentation

[static initializer]()

com.google.ortools.pdlp.RestartChoice.[static initializer]

static

forNumber()

static RestartChoice com.google.ortools.pdlp.RestartChoice.forNumber ( int value )

static

Parameters

value

The numeric wire value of the corresponding enum entry.

Returns

The enum associated with the given numeric wire value.

Definition at line 112 of file RestartChoice.java.

getDescriptor()

static final com.google.protobuf.Descriptors.EnumDescriptor com.google.ortools.pdlp.RestartChoice.getDescriptor ( )

static

Definition at line 143 of file RestartChoice.java.

getDescriptorForType()

final com.google.protobuf.Descriptors.EnumDescriptor com.google.ortools.pdlp.RestartChoice.getDescriptorForType

(

)

Definition at line 139 of file RestartChoice.java.

getNumber()

final int com.google.ortools.pdlp.RestartChoice.getNumber

(

)

Definition at line 94 of file RestartChoice.java.

getValueDescriptor()

final com.google.protobuf.Descriptors.EnumValueDescriptor com.google.ortools.pdlp.RestartChoice.getValueDescriptor

(

)

Definition at line 135 of file RestartChoice.java.

internalGetValueMap()

static com.google.protobuf.Internal.EnumLiteMap< RestartChoice > com.google.ortools.pdlp.RestartChoice.internalGetValueMap ( )

static

Definition at line 123 of file RestartChoice.java.

valueOf() [1/2]

static RestartChoice com.google.ortools.pdlp.RestartChoice.valueOf ( com.google.protobuf.Descriptors.EnumValueDescriptor desc )

static

Definition at line 149 of file RestartChoice.java.

valueOf() [2/2]

static RestartChoice com.google.ortools.pdlp.RestartChoice.valueOf ( int value )

static

Parameters

value

The numeric wire value of the corresponding enum entry.

Returns

The enum associated with the given numeric wire value.

Deprecated

Use forNumber(int) instead.

Definition at line 104 of file RestartChoice.java.

Member Data Documentation

RESTART_CHOICE_NO_RESTART

com.google.ortools.pdlp.RestartChoice.RESTART_CHOICE_NO_RESTART =(1)

No restart on this iteration.

RESTART_CHOICE_NO_RESTART = 1;

Definition at line 28 of file RestartChoice.java.

RESTART_CHOICE_NO_RESTART_VALUE

final int com.google.ortools.pdlp.RestartChoice.RESTART_CHOICE_NO_RESTART_VALUE = 1

static

No restart on this iteration.

RESTART_CHOICE_NO_RESTART = 1;

Definition at line 71 of file RestartChoice.java.

RESTART_CHOICE_RESTART_TO_AVERAGE

com.google.ortools.pdlp.RestartChoice.RESTART_CHOICE_RESTART_TO_AVERAGE =(3)

The algorithm is restarted at the average of iterates since the last
restart.

RESTART_CHOICE_RESTART_TO_AVERAGE = 3;

Definition at line 48 of file RestartChoice.java.

RESTART_CHOICE_RESTART_TO_AVERAGE_VALUE

final int com.google.ortools.pdlp.RestartChoice.RESTART_CHOICE_RESTART_TO_AVERAGE_VALUE = 3

static

The algorithm is restarted at the average of iterates since the last
restart.

RESTART_CHOICE_RESTART_TO_AVERAGE = 3;

Definition at line 91 of file RestartChoice.java.

RESTART_CHOICE_UNSPECIFIED

com.google.ortools.pdlp.RestartChoice.RESTART_CHOICE_UNSPECIFIED =(0)

RESTART_CHOICE_UNSPECIFIED = 0;

Definition at line 20 of file RestartChoice.java.

RESTART_CHOICE_UNSPECIFIED_VALUE

final int com.google.ortools.pdlp.RestartChoice.RESTART_CHOICE_UNSPECIFIED_VALUE = 0

static

RESTART_CHOICE_UNSPECIFIED = 0;

Definition at line 63 of file RestartChoice.java.

RESTART_CHOICE_WEIGHTED_AVERAGE_RESET

com.google.ortools.pdlp.RestartChoice.RESTART_CHOICE_WEIGHTED_AVERAGE_RESET =(2)

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;

Definition at line 39 of file RestartChoice.java.

RESTART_CHOICE_WEIGHTED_AVERAGE_RESET_VALUE

final int com.google.ortools.pdlp.RestartChoice.RESTART_CHOICE_WEIGHTED_AVERAGE_RESET_VALUE = 2

static

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;

Definition at line 82 of file RestartChoice.java.

---

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

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