operations_research.pdlp.Solvers.TerminationCriteria.Builder Class Reference

Inheritance diagram for operations_research.pdlp.Solvers.TerminationCriteria.Builder:

Public Member Functions
Builder	clear ()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType ()
operations_research.pdlp.Solvers.TerminationCriteria	getDefaultInstanceForType ()
operations_research.pdlp.Solvers.TerminationCriteria	build ()
operations_research.pdlp.Solvers.TerminationCriteria	buildPartial ()
Builder	clone ()
Builder	setField (com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)
Builder	clearField (com.google.protobuf.Descriptors.FieldDescriptor field)
Builder	clearOneof (com.google.protobuf.Descriptors.OneofDescriptor oneof)
Builder	setRepeatedField (com.google.protobuf.Descriptors.FieldDescriptor field, int index, java.lang.Object value)
Builder	addRepeatedField (com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)
Builder	mergeFrom (com.google.protobuf.Message other)
Builder	mergeFrom (operations_research.pdlp.Solvers.TerminationCriteria other)
final boolean	isInitialized ()
Builder	mergeFrom (com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
OptimalityCriteriaCase	getOptimalityCriteriaCase ()
Builder	clearOptimalityCriteria ()
boolean	hasOptimalityNorm ()
operations_research.pdlp.Solvers.OptimalityNorm	getOptimalityNorm ()
Builder	setOptimalityNorm (operations_research.pdlp.Solvers.OptimalityNorm value)
Builder	clearOptimalityNorm ()
boolean	hasSimpleOptimalityCriteria ()
operations_research.pdlp.Solvers.TerminationCriteria.SimpleOptimalityCriteria	getSimpleOptimalityCriteria ()
Builder	setSimpleOptimalityCriteria (operations_research.pdlp.Solvers.TerminationCriteria.SimpleOptimalityCriteria value)
Builder	setSimpleOptimalityCriteria (operations_research.pdlp.Solvers.TerminationCriteria.SimpleOptimalityCriteria.Builder builderForValue)
Builder	mergeSimpleOptimalityCriteria (operations_research.pdlp.Solvers.TerminationCriteria.SimpleOptimalityCriteria value)
Builder	clearSimpleOptimalityCriteria ()
operations_research.pdlp.Solvers.TerminationCriteria.SimpleOptimalityCriteria.Builder	getSimpleOptimalityCriteriaBuilder ()
operations_research.pdlp.Solvers.TerminationCriteria.SimpleOptimalityCriteriaOrBuilder	getSimpleOptimalityCriteriaOrBuilder ()
boolean	hasDetailedOptimalityCriteria ()
operations_research.pdlp.Solvers.TerminationCriteria.DetailedOptimalityCriteria	getDetailedOptimalityCriteria ()
Builder	setDetailedOptimalityCriteria (operations_research.pdlp.Solvers.TerminationCriteria.DetailedOptimalityCriteria value)
Builder	setDetailedOptimalityCriteria (operations_research.pdlp.Solvers.TerminationCriteria.DetailedOptimalityCriteria.Builder builderForValue)
Builder	mergeDetailedOptimalityCriteria (operations_research.pdlp.Solvers.TerminationCriteria.DetailedOptimalityCriteria value)
Builder	clearDetailedOptimalityCriteria ()
operations_research.pdlp.Solvers.TerminationCriteria.DetailedOptimalityCriteria.Builder	getDetailedOptimalityCriteriaBuilder ()
operations_research.pdlp.Solvers.TerminationCriteria.DetailedOptimalityCriteriaOrBuilder	getDetailedOptimalityCriteriaOrBuilder ()
boolean	hasEpsOptimalAbsolute ()
double	getEpsOptimalAbsolute ()
Builder	setEpsOptimalAbsolute (double value)
Builder	clearEpsOptimalAbsolute ()
boolean	hasEpsOptimalRelative ()
double	getEpsOptimalRelative ()
Builder	setEpsOptimalRelative (double value)
Builder	clearEpsOptimalRelative ()
boolean	hasEpsPrimalInfeasible ()
double	getEpsPrimalInfeasible ()
Builder	setEpsPrimalInfeasible (double value)
Builder	clearEpsPrimalInfeasible ()
boolean	hasEpsDualInfeasible ()
double	getEpsDualInfeasible ()
Builder	setEpsDualInfeasible (double value)
Builder	clearEpsDualInfeasible ()
boolean	hasTimeSecLimit ()
double	getTimeSecLimit ()
Builder	setTimeSecLimit (double value)
Builder	clearTimeSecLimit ()
boolean	hasIterationLimit ()
int	getIterationLimit ()
Builder	setIterationLimit (int value)
Builder	clearIterationLimit ()
boolean	hasKktMatrixPassLimit ()
double	getKktMatrixPassLimit ()
Builder	setKktMatrixPassLimit (double value)
Builder	clearKktMatrixPassLimit ()
final Builder	setUnknownFields (final com.google.protobuf.UnknownFieldSet unknownFields)
final Builder	mergeUnknownFields (final com.google.protobuf.UnknownFieldSet unknownFields)

Static Public Member Functions
static final com.google.protobuf.Descriptors.Descriptor	getDescriptor ()

Protected Member Functions
com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable ()

Detailed Description

Relevant readings on infeasibility certificates:
(1) https://docs.mosek.com/modeling-cookbook/qcqo.html provides references
explaining why the primal rays imply dual infeasibility and dual rays imply
primal infeasibility.
(2) The termination criteria for Mosek's linear programming optimizer
https://docs.mosek.com/9.0/pythonfusion/solving-linear.html.
(3) The termination criteria for OSQP is in section 3.3 of
https://web.stanford.edu/~boyd/papers/pdf/osqp.pdf.
(4) The termination criteria for SCS is in section 3.5 of
https://arxiv.org/pdf/1312.3039.pdf.

Protobuf type operations_research.pdlp.TerminationCriteria

Definition at line 3082 of file Solvers.java.

Member Function Documentation

addRepeatedField()

Builder operations_research.pdlp.Solvers.TerminationCriteria.Builder.addRepeatedField	(	com.google.protobuf.Descriptors.FieldDescriptor	field,
		java.lang.Object	value )

Definition at line 3239 of file Solvers.java.

build()

operations_research.pdlp.Solvers.TerminationCriteria operations_research.pdlp.Solvers.TerminationCriteria.Builder.build

(

)

Definition at line 3144 of file Solvers.java.

buildPartial()

operations_research.pdlp.Solvers.TerminationCriteria operations_research.pdlp.Solvers.TerminationCriteria.Builder.buildPartial

(

)

Definition at line 3153 of file Solvers.java.

clear()

Builder operations_research.pdlp.Solvers.TerminationCriteria.Builder.clear

(

)

Definition at line 3110 of file Solvers.java.

clearDetailedOptimalityCriteria()

Builder operations_research.pdlp.Solvers.TerminationCriteria.Builder.clearDetailedOptimalityCriteria

(

)

.operations_research.pdlp.TerminationCriteria.DetailedOptimalityCriteria detailed_optimality_criteria = 10;

Definition at line 3696 of file Solvers.java.

clearEpsDualInfeasible()

Builder operations_research.pdlp.Solvers.TerminationCriteria.Builder.clearEpsDualInfeasible

(

)

If the following three conditions hold we say we have obtained an
approximate primal ray, which is an approximate certificate of dual
infeasibility.
(1) primal_ray_linear_objective < 0,
(2) max_primal_ray_infeasibility / (-primal_ray_linear_objective) <=
eps_dual_infeasible
(3) primal_ray_quadratic_norm / (-primal_ray_linear_objective) <=
eps_dual_infeasible.

optional double eps_dual_infeasible = 5 [default = 1e-08];

Returns

This builder for chaining.

Definition at line 4059 of file Solvers.java.

clearEpsOptimalAbsolute()

Builder operations_research.pdlp.Solvers.TerminationCriteria.Builder.clearEpsOptimalAbsolute

(

)

Absolute tolerance on primal residual, dual residual, and the objective
gap.
Deprecated, use simple_optimality_criteria instead.
TODO(b/241462829) delete this deprecated field.

optional double eps_optimal_absolute = 2 [default = 1e-06, deprecated = true];

Deprecated

operations_research.pdlp.TerminationCriteria.eps_optimal_absolute is deprecated. See ortools/pdlp/solvers.proto;l=133

Returns

This builder for chaining.

Definition at line 3823 of file Solvers.java.

clearEpsOptimalRelative()

Builder operations_research.pdlp.Solvers.TerminationCriteria.Builder.clearEpsOptimalRelative

(

)

Relative tolerance on primal residual, dual residual, and the objective
gap.
Deprecated, use simple_optimality_criteria instead.
TODO(b/241462829) delete this deprecated field.

optional double eps_optimal_relative = 3 [default = 1e-06, deprecated = true];

Deprecated

operations_research.pdlp.TerminationCriteria.eps_optimal_relative is deprecated. See ortools/pdlp/solvers.proto;l=140

Returns

This builder for chaining.

Definition at line 3899 of file Solvers.java.

clearEpsPrimalInfeasible()

Builder operations_research.pdlp.Solvers.TerminationCriteria.Builder.clearEpsPrimalInfeasible

(

)

If the following two conditions hold we say that we have obtained an
approximate dual ray, which is an approximate certificate of primal
infeasibility.
(1) dual_ray_objective > 0,
(2) max_dual_ray_infeasibility / dual_ray_objective <=
eps_primal_infeasible.

optional double eps_primal_infeasible = 4 [default = 1e-08];

Returns

This builder for chaining.

Definition at line 3975 of file Solvers.java.

clearField()

Builder operations_research.pdlp.Solvers.TerminationCriteria.Builder.clearField

(

com.google.protobuf.Descriptors.FieldDescriptor

field

)

Definition at line 3223 of file Solvers.java.

clearIterationLimit()

Builder operations_research.pdlp.Solvers.TerminationCriteria.Builder.clearIterationLimit

(

)

If termination_reason = TERMINATION_REASON_ITERATION_LIMIT then the solver
has taken at least iterations_limit iterations.

optional int32 iteration_limit = 7 [default = 2147483647];

Returns

This builder for chaining.

Definition at line 4179 of file Solvers.java.

clearKktMatrixPassLimit()

Builder operations_research.pdlp.Solvers.TerminationCriteria.Builder.clearKktMatrixPassLimit

(

)

If termination_reason = TERMINATION_REASON_KKT_MATRIX_PASS_LIMIT then
cumulative_kkt_matrix_passes is at least kkt_pass_limit.

optional double kkt_matrix_pass_limit = 8 [default = inf];

Returns

This builder for chaining.

Definition at line 4239 of file Solvers.java.

clearOneof()

Builder operations_research.pdlp.Solvers.TerminationCriteria.Builder.clearOneof

(

com.google.protobuf.Descriptors.OneofDescriptor

oneof

)

Definition at line 3228 of file Solvers.java.

clearOptimalityCriteria()

Builder operations_research.pdlp.Solvers.TerminationCriteria.Builder.clearOptimalityCriteria

(

)

Definition at line 3403 of file Solvers.java.

clearOptimalityNorm()

Builder operations_research.pdlp.Solvers.TerminationCriteria.Builder.clearOptimalityNorm

(

)

The norm that we are measuring the optimality criteria in.

optional .operations_research.pdlp.OptimalityNorm optimality_norm = 1 [default = OPTIMALITY_NORM_L2];

Returns

This builder for chaining.

Definition at line 3463 of file Solvers.java.

clearSimpleOptimalityCriteria()

Builder operations_research.pdlp.Solvers.TerminationCriteria.Builder.clearSimpleOptimalityCriteria

(

)

.operations_research.pdlp.TerminationCriteria.SimpleOptimalityCriteria simple_optimality_criteria = 9;

Definition at line 3554 of file Solvers.java.

clearTimeSecLimit()

Builder operations_research.pdlp.Solvers.TerminationCriteria.Builder.clearTimeSecLimit

(

)

If termination_reason = TERMINATION_REASON_TIME_LIMIT then the solver has
taken at least time_sec_limit time.

optional double time_sec_limit = 6 [default = inf];

Returns

This builder for chaining.

Definition at line 4119 of file Solvers.java.

clone()

Builder operations_research.pdlp.Solvers.TerminationCriteria.Builder.clone

(

)

Definition at line 3213 of file Solvers.java.

getDefaultInstanceForType()

operations_research.pdlp.Solvers.TerminationCriteria operations_research.pdlp.Solvers.TerminationCriteria.Builder.getDefaultInstanceForType

(

)

Definition at line 3139 of file Solvers.java.

getDescriptor()

static final com.google.protobuf.Descriptors.Descriptor operations_research.pdlp.Solvers.TerminationCriteria.Builder.getDescriptor ( )

static

Definition at line 3087 of file Solvers.java.

getDescriptorForType()

com.google.protobuf.Descriptors.Descriptor operations_research.pdlp.Solvers.TerminationCriteria.Builder.getDescriptorForType

(

)

Definition at line 3134 of file Solvers.java.

getDetailedOptimalityCriteria()

operations_research.pdlp.Solvers.TerminationCriteria.DetailedOptimalityCriteria operations_research.pdlp.Solvers.TerminationCriteria.Builder.getDetailedOptimalityCriteria

(

)

.operations_research.pdlp.TerminationCriteria.DetailedOptimalityCriteria detailed_optimality_criteria = 10;

Returns

The detailedOptimalityCriteria.

Implements operations_research.pdlp.Solvers.TerminationCriteriaOrBuilder.

Definition at line 3627 of file Solvers.java.

getDetailedOptimalityCriteriaBuilder()

operations_research.pdlp.Solvers.TerminationCriteria.DetailedOptimalityCriteria.Builder operations_research.pdlp.Solvers.TerminationCriteria.Builder.getDetailedOptimalityCriteriaBuilder

(

)

.operations_research.pdlp.TerminationCriteria.DetailedOptimalityCriteria detailed_optimality_criteria = 10;

Definition at line 3715 of file Solvers.java.

getDetailedOptimalityCriteriaOrBuilder()

operations_research.pdlp.Solvers.TerminationCriteria.DetailedOptimalityCriteriaOrBuilder operations_research.pdlp.Solvers.TerminationCriteria.Builder.getDetailedOptimalityCriteriaOrBuilder

(

)

.operations_research.pdlp.TerminationCriteria.DetailedOptimalityCriteria detailed_optimality_criteria = 10;

Implements operations_research.pdlp.Solvers.TerminationCriteriaOrBuilder.

Definition at line 3722 of file Solvers.java.

getEpsDualInfeasible()

double operations_research.pdlp.Solvers.TerminationCriteria.Builder.getEpsDualInfeasible

(

)

If the following three conditions hold we say we have obtained an
approximate primal ray, which is an approximate certificate of dual
infeasibility.
(1) primal_ray_linear_objective < 0,
(2) max_primal_ray_infeasibility / (-primal_ray_linear_objective) <=
eps_dual_infeasible
(3) primal_ray_quadratic_norm / (-primal_ray_linear_objective) <=
eps_dual_infeasible.

optional double eps_dual_infeasible = 5 [default = 1e-08];

Returns

The epsDualInfeasible.

Implements operations_research.pdlp.Solvers.TerminationCriteriaOrBuilder.

Definition at line 4018 of file Solvers.java.

getEpsOptimalAbsolute()

double operations_research.pdlp.Solvers.TerminationCriteria.Builder.getEpsOptimalAbsolute

(

)

Absolute tolerance on primal residual, dual residual, and the objective
gap.
Deprecated, use simple_optimality_criteria instead.
TODO(b/241462829) delete this deprecated field.

optional double eps_optimal_absolute = 2 [default = 1e-06, deprecated = true];

Deprecated

operations_research.pdlp.TerminationCriteria.eps_optimal_absolute is deprecated. See ortools/pdlp/solvers.proto;l=133

Returns

The epsOptimalAbsolute.

Implements operations_research.pdlp.Solvers.TerminationCriteriaOrBuilder.

Definition at line 3786 of file Solvers.java.

getEpsOptimalRelative()

double operations_research.pdlp.Solvers.TerminationCriteria.Builder.getEpsOptimalRelative

(

)

Relative tolerance on primal residual, dual residual, and the objective
gap.
Deprecated, use simple_optimality_criteria instead.
TODO(b/241462829) delete this deprecated field.

optional double eps_optimal_relative = 3 [default = 1e-06, deprecated = true];

Deprecated

operations_research.pdlp.TerminationCriteria.eps_optimal_relative is deprecated. See ortools/pdlp/solvers.proto;l=140

Returns

The epsOptimalRelative.

Implements operations_research.pdlp.Solvers.TerminationCriteriaOrBuilder.

Definition at line 3862 of file Solvers.java.

getEpsPrimalInfeasible()

double operations_research.pdlp.Solvers.TerminationCriteria.Builder.getEpsPrimalInfeasible

(

)

If the following two conditions hold we say that we have obtained an
approximate dual ray, which is an approximate certificate of primal
infeasibility.
(1) dual_ray_objective > 0,
(2) max_dual_ray_infeasibility / dual_ray_objective <=
eps_primal_infeasible.

optional double eps_primal_infeasible = 4 [default = 1e-08];

Returns

The epsPrimalInfeasible.

Implements operations_research.pdlp.Solvers.TerminationCriteriaOrBuilder.

Definition at line 3938 of file Solvers.java.

getIterationLimit()

int operations_research.pdlp.Solvers.TerminationCriteria.Builder.getIterationLimit

(

)

If termination_reason = TERMINATION_REASON_ITERATION_LIMIT then the solver
has taken at least iterations_limit iterations.

optional int32 iteration_limit = 7 [default = 2147483647];

Returns

The iterationLimit.

Implements operations_research.pdlp.Solvers.TerminationCriteriaOrBuilder.

Definition at line 4150 of file Solvers.java.

getKktMatrixPassLimit()

double operations_research.pdlp.Solvers.TerminationCriteria.Builder.getKktMatrixPassLimit

(

)

If termination_reason = TERMINATION_REASON_KKT_MATRIX_PASS_LIMIT then
cumulative_kkt_matrix_passes is at least kkt_pass_limit.

optional double kkt_matrix_pass_limit = 8 [default = inf];

Returns

The kktMatrixPassLimit.

Implements operations_research.pdlp.Solvers.TerminationCriteriaOrBuilder.

Definition at line 4210 of file Solvers.java.

getOptimalityCriteriaCase()

OptimalityCriteriaCase operations_research.pdlp.Solvers.TerminationCriteria.Builder.getOptimalityCriteriaCase

(

)

Implements operations_research.pdlp.Solvers.TerminationCriteriaOrBuilder.

Definition at line 3398 of file Solvers.java.

getOptimalityNorm()

operations_research.pdlp.Solvers.OptimalityNorm operations_research.pdlp.Solvers.TerminationCriteria.Builder.getOptimalityNorm

(

)

The norm that we are measuring the optimality criteria in.

optional .operations_research.pdlp.OptimalityNorm optimality_norm = 1 [default = OPTIMALITY_NORM_L2];

Returns

The optimalityNorm.

Implements operations_research.pdlp.Solvers.TerminationCriteriaOrBuilder.

Definition at line 3433 of file Solvers.java.

getSimpleOptimalityCriteria()

operations_research.pdlp.Solvers.TerminationCriteria.SimpleOptimalityCriteria operations_research.pdlp.Solvers.TerminationCriteria.Builder.getSimpleOptimalityCriteria

(

)

.operations_research.pdlp.TerminationCriteria.SimpleOptimalityCriteria simple_optimality_criteria = 9;

Returns

The simpleOptimalityCriteria.

Implements operations_research.pdlp.Solvers.TerminationCriteriaOrBuilder.

Definition at line 3485 of file Solvers.java.

getSimpleOptimalityCriteriaBuilder()

operations_research.pdlp.Solvers.TerminationCriteria.SimpleOptimalityCriteria.Builder operations_research.pdlp.Solvers.TerminationCriteria.Builder.getSimpleOptimalityCriteriaBuilder

(

)

.operations_research.pdlp.TerminationCriteria.SimpleOptimalityCriteria simple_optimality_criteria = 9;

Definition at line 3573 of file Solvers.java.

getSimpleOptimalityCriteriaOrBuilder()

operations_research.pdlp.Solvers.TerminationCriteria.SimpleOptimalityCriteriaOrBuilder operations_research.pdlp.Solvers.TerminationCriteria.Builder.getSimpleOptimalityCriteriaOrBuilder

(

)

.operations_research.pdlp.TerminationCriteria.SimpleOptimalityCriteria simple_optimality_criteria = 9;

Implements operations_research.pdlp.Solvers.TerminationCriteriaOrBuilder.

Definition at line 3580 of file Solvers.java.

getTimeSecLimit()

double operations_research.pdlp.Solvers.TerminationCriteria.Builder.getTimeSecLimit

(

)

If termination_reason = TERMINATION_REASON_TIME_LIMIT then the solver has
taken at least time_sec_limit time.

optional double time_sec_limit = 6 [default = inf];

Returns

The timeSecLimit.

Implements operations_research.pdlp.Solvers.TerminationCriteriaOrBuilder.

Definition at line 4090 of file Solvers.java.

hasDetailedOptimalityCriteria()

boolean operations_research.pdlp.Solvers.TerminationCriteria.Builder.hasDetailedOptimalityCriteria

(

)

.operations_research.pdlp.TerminationCriteria.DetailedOptimalityCriteria detailed_optimality_criteria = 10;

Returns

Whether the detailedOptimalityCriteria field is set.

Implements operations_research.pdlp.Solvers.TerminationCriteriaOrBuilder.

Definition at line 3619 of file Solvers.java.

hasEpsDualInfeasible()

boolean operations_research.pdlp.Solvers.TerminationCriteria.Builder.hasEpsDualInfeasible

(

)

If the following three conditions hold we say we have obtained an
approximate primal ray, which is an approximate certificate of dual
infeasibility.
(1) primal_ray_linear_objective < 0,
(2) max_primal_ray_infeasibility / (-primal_ray_linear_objective) <=
eps_dual_infeasible
(3) primal_ray_quadratic_norm / (-primal_ray_linear_objective) <=
eps_dual_infeasible.

optional double eps_dual_infeasible = 5 [default = 1e-08];

Returns

Whether the epsDualInfeasible field is set.

Implements operations_research.pdlp.Solvers.TerminationCriteriaOrBuilder.

Definition at line 3999 of file Solvers.java.

hasEpsOptimalAbsolute()

boolean operations_research.pdlp.Solvers.TerminationCriteria.Builder.hasEpsOptimalAbsolute

(

)

Absolute tolerance on primal residual, dual residual, and the objective
gap.
Deprecated, use simple_optimality_criteria instead.
TODO(b/241462829) delete this deprecated field.

optional double eps_optimal_absolute = 2 [default = 1e-06, deprecated = true];

Deprecated

operations_research.pdlp.TerminationCriteria.eps_optimal_absolute is deprecated. See ortools/pdlp/solvers.proto;l=133

Returns

Whether the epsOptimalAbsolute field is set.

Implements operations_research.pdlp.Solvers.TerminationCriteriaOrBuilder.

Definition at line 3769 of file Solvers.java.

hasEpsOptimalRelative()

boolean operations_research.pdlp.Solvers.TerminationCriteria.Builder.hasEpsOptimalRelative

(

)

Relative tolerance on primal residual, dual residual, and the objective
gap.
Deprecated, use simple_optimality_criteria instead.
TODO(b/241462829) delete this deprecated field.

optional double eps_optimal_relative = 3 [default = 1e-06, deprecated = true];

Deprecated

operations_research.pdlp.TerminationCriteria.eps_optimal_relative is deprecated. See ortools/pdlp/solvers.proto;l=140

Returns

Whether the epsOptimalRelative field is set.

Implements operations_research.pdlp.Solvers.TerminationCriteriaOrBuilder.

Definition at line 3845 of file Solvers.java.

hasEpsPrimalInfeasible()

boolean operations_research.pdlp.Solvers.TerminationCriteria.Builder.hasEpsPrimalInfeasible

(

)

If the following two conditions hold we say that we have obtained an
approximate dual ray, which is an approximate certificate of primal
infeasibility.
(1) dual_ray_objective > 0,
(2) max_dual_ray_infeasibility / dual_ray_objective <=
eps_primal_infeasible.

optional double eps_primal_infeasible = 4 [default = 1e-08];

Returns

Whether the epsPrimalInfeasible field is set.

Implements operations_research.pdlp.Solvers.TerminationCriteriaOrBuilder.

Definition at line 3921 of file Solvers.java.

hasIterationLimit()

boolean operations_research.pdlp.Solvers.TerminationCriteria.Builder.hasIterationLimit

(

)

If termination_reason = TERMINATION_REASON_ITERATION_LIMIT then the solver
has taken at least iterations_limit iterations.

optional int32 iteration_limit = 7 [default = 2147483647];

Returns

Whether the iterationLimit field is set.

Implements operations_research.pdlp.Solvers.TerminationCriteriaOrBuilder.

Definition at line 4137 of file Solvers.java.

hasKktMatrixPassLimit()

boolean operations_research.pdlp.Solvers.TerminationCriteria.Builder.hasKktMatrixPassLimit

(

)

If termination_reason = TERMINATION_REASON_KKT_MATRIX_PASS_LIMIT then
cumulative_kkt_matrix_passes is at least kkt_pass_limit.

optional double kkt_matrix_pass_limit = 8 [default = inf];

Returns

Whether the kktMatrixPassLimit field is set.

Implements operations_research.pdlp.Solvers.TerminationCriteriaOrBuilder.

Definition at line 4197 of file Solvers.java.

hasOptimalityNorm()

boolean operations_research.pdlp.Solvers.TerminationCriteria.Builder.hasOptimalityNorm

(

)

The norm that we are measuring the optimality criteria in.

optional .operations_research.pdlp.OptimalityNorm optimality_norm = 1 [default = OPTIMALITY_NORM_L2];

Returns

Whether the optimalityNorm field is set.

Implements operations_research.pdlp.Solvers.TerminationCriteriaOrBuilder.

Definition at line 3421 of file Solvers.java.

hasSimpleOptimalityCriteria()

boolean operations_research.pdlp.Solvers.TerminationCriteria.Builder.hasSimpleOptimalityCriteria

(

)

.operations_research.pdlp.TerminationCriteria.SimpleOptimalityCriteria simple_optimality_criteria = 9;

Returns

Whether the simpleOptimalityCriteria field is set.

Implements operations_research.pdlp.Solvers.TerminationCriteriaOrBuilder.

Definition at line 3477 of file Solvers.java.

hasTimeSecLimit()

boolean operations_research.pdlp.Solvers.TerminationCriteria.Builder.hasTimeSecLimit

(

)

If termination_reason = TERMINATION_REASON_TIME_LIMIT then the solver has
taken at least time_sec_limit time.

optional double time_sec_limit = 6 [default = inf];

Returns

Whether the timeSecLimit field is set.

Implements operations_research.pdlp.Solvers.TerminationCriteriaOrBuilder.

Definition at line 4077 of file Solvers.java.

internalGetFieldAccessorTable()

com.google.protobuf.GeneratedMessageV3.FieldAccessorTable operations_research.pdlp.Solvers.TerminationCriteria.Builder.internalGetFieldAccessorTable ( )

protected

Definition at line 3093 of file Solvers.java.

isInitialized()

final boolean operations_research.pdlp.Solvers.TerminationCriteria.Builder.isInitialized

(

)

Definition at line 3299 of file Solvers.java.

mergeDetailedOptimalityCriteria()

Builder operations_research.pdlp.Solvers.TerminationCriteria.Builder.mergeDetailedOptimalityCriteria

(

operations_research.pdlp.Solvers.TerminationCriteria.DetailedOptimalityCriteria

value

)

.operations_research.pdlp.TerminationCriteria.DetailedOptimalityCriteria detailed_optimality_criteria = 10;

Definition at line 3673 of file Solvers.java.

mergeFrom() [1/3]

Builder operations_research.pdlp.Solvers.TerminationCriteria.Builder.mergeFrom	(	com.google.protobuf.CodedInputStream	input,
		com.google.protobuf.ExtensionRegistryLite	extensionRegistry ) throws java.io.IOException

Definition at line 3304 of file Solvers.java.

mergeFrom() [2/3]

Builder operations_research.pdlp.Solvers.TerminationCriteria.Builder.mergeFrom

(

com.google.protobuf.Message

other

)

Definition at line 3245 of file Solvers.java.

mergeFrom() [3/3]

Builder operations_research.pdlp.Solvers.TerminationCriteria.Builder.mergeFrom

(

operations_research.pdlp.Solvers.TerminationCriteria

other

)

Definition at line 3254 of file Solvers.java.

mergeSimpleOptimalityCriteria()

Builder operations_research.pdlp.Solvers.TerminationCriteria.Builder.mergeSimpleOptimalityCriteria

(

operations_research.pdlp.Solvers.TerminationCriteria.SimpleOptimalityCriteria

value

)

.operations_research.pdlp.TerminationCriteria.SimpleOptimalityCriteria simple_optimality_criteria = 9;

Definition at line 3531 of file Solvers.java.

mergeUnknownFields()

final Builder operations_research.pdlp.Solvers.TerminationCriteria.Builder.mergeUnknownFields

(

final com.google.protobuf.UnknownFieldSet

unknownFields

)

Definition at line 4252 of file Solvers.java.

setDetailedOptimalityCriteria() [1/2]

Builder operations_research.pdlp.Solvers.TerminationCriteria.Builder.setDetailedOptimalityCriteria

(

operations_research.pdlp.Solvers.TerminationCriteria.DetailedOptimalityCriteria

value

)

.operations_research.pdlp.TerminationCriteria.DetailedOptimalityCriteria detailed_optimality_criteria = 10;

Definition at line 3643 of file Solvers.java.

setDetailedOptimalityCriteria() [2/2]

Builder operations_research.pdlp.Solvers.TerminationCriteria.Builder.setDetailedOptimalityCriteria

(

operations_research.pdlp.Solvers.TerminationCriteria.DetailedOptimalityCriteria.Builder

builderForValue

)

.operations_research.pdlp.TerminationCriteria.DetailedOptimalityCriteria detailed_optimality_criteria = 10;

Definition at line 3659 of file Solvers.java.

setEpsDualInfeasible()

Builder operations_research.pdlp.Solvers.TerminationCriteria.Builder.setEpsDualInfeasible

(

double

value

)

If the following three conditions hold we say we have obtained an
approximate primal ray, which is an approximate certificate of dual
infeasibility.
(1) primal_ray_linear_objective < 0,
(2) max_primal_ray_infeasibility / (-primal_ray_linear_objective) <=
eps_dual_infeasible
(3) primal_ray_quadratic_norm / (-primal_ray_linear_objective) <=
eps_dual_infeasible.

optional double eps_dual_infeasible = 5 [default = 1e-08];

Parameters

value

The epsDualInfeasible to set.

Returns

This builder for chaining.

Definition at line 4037 of file Solvers.java.

setEpsOptimalAbsolute()

Builder operations_research.pdlp.Solvers.TerminationCriteria.Builder.setEpsOptimalAbsolute

(

double

value

)

Absolute tolerance on primal residual, dual residual, and the objective
gap.
Deprecated, use simple_optimality_criteria instead.
TODO(b/241462829) delete this deprecated field.

optional double eps_optimal_absolute = 2 [default = 1e-06, deprecated = true];

Deprecated

operations_research.pdlp.TerminationCriteria.eps_optimal_absolute is deprecated. See ortools/pdlp/solvers.proto;l=133

Parameters

value

The epsOptimalAbsolute to set.

Returns

This builder for chaining.

Definition at line 3803 of file Solvers.java.

setEpsOptimalRelative()

Builder operations_research.pdlp.Solvers.TerminationCriteria.Builder.setEpsOptimalRelative

(

double

value

)

Relative tolerance on primal residual, dual residual, and the objective
gap.
Deprecated, use simple_optimality_criteria instead.
TODO(b/241462829) delete this deprecated field.

optional double eps_optimal_relative = 3 [default = 1e-06, deprecated = true];

Deprecated

operations_research.pdlp.TerminationCriteria.eps_optimal_relative is deprecated. See ortools/pdlp/solvers.proto;l=140

Parameters

value

The epsOptimalRelative to set.

Returns

This builder for chaining.

Definition at line 3879 of file Solvers.java.

setEpsPrimalInfeasible()

Builder operations_research.pdlp.Solvers.TerminationCriteria.Builder.setEpsPrimalInfeasible

(

double

value

)

If the following two conditions hold we say that we have obtained an
approximate dual ray, which is an approximate certificate of primal
infeasibility.
(1) dual_ray_objective > 0,
(2) max_dual_ray_infeasibility / dual_ray_objective <=
eps_primal_infeasible.

optional double eps_primal_infeasible = 4 [default = 1e-08];

Parameters

value

The epsPrimalInfeasible to set.

Returns

This builder for chaining.

Definition at line 3955 of file Solvers.java.

setField()

Builder operations_research.pdlp.Solvers.TerminationCriteria.Builder.setField	(	com.google.protobuf.Descriptors.FieldDescriptor	field,
		java.lang.Object	value )

Definition at line 3217 of file Solvers.java.

setIterationLimit()

Builder operations_research.pdlp.Solvers.TerminationCriteria.Builder.setIterationLimit

(

int

value

)

If termination_reason = TERMINATION_REASON_ITERATION_LIMIT then the solver
has taken at least iterations_limit iterations.

optional int32 iteration_limit = 7 [default = 2147483647];

Parameters

value

The iterationLimit to set.

Returns

This builder for chaining.

Definition at line 4163 of file Solvers.java.

setKktMatrixPassLimit()

Builder operations_research.pdlp.Solvers.TerminationCriteria.Builder.setKktMatrixPassLimit

(

double

value

)

If termination_reason = TERMINATION_REASON_KKT_MATRIX_PASS_LIMIT then
cumulative_kkt_matrix_passes is at least kkt_pass_limit.

optional double kkt_matrix_pass_limit = 8 [default = inf];

Parameters

value

The kktMatrixPassLimit to set.

Returns

This builder for chaining.

Definition at line 4223 of file Solvers.java.

setOptimalityNorm()

Builder operations_research.pdlp.Solvers.TerminationCriteria.Builder.setOptimalityNorm

(

operations_research.pdlp.Solvers.OptimalityNorm

value

)

The norm that we are measuring the optimality criteria in.

optional .operations_research.pdlp.OptimalityNorm optimality_norm = 1 [default = OPTIMALITY_NORM_L2];

Parameters

value

The optimalityNorm to set.

Returns

This builder for chaining.

Definition at line 3446 of file Solvers.java.

setRepeatedField()

Builder operations_research.pdlp.Solvers.TerminationCriteria.Builder.setRepeatedField	(	com.google.protobuf.Descriptors.FieldDescriptor	field,
		int	index,
		java.lang.Object	value )

Definition at line 3233 of file Solvers.java.

setSimpleOptimalityCriteria() [1/2]

Builder operations_research.pdlp.Solvers.TerminationCriteria.Builder.setSimpleOptimalityCriteria

(

operations_research.pdlp.Solvers.TerminationCriteria.SimpleOptimalityCriteria

value

)

.operations_research.pdlp.TerminationCriteria.SimpleOptimalityCriteria simple_optimality_criteria = 9;

Definition at line 3501 of file Solvers.java.

setSimpleOptimalityCriteria() [2/2]

Builder operations_research.pdlp.Solvers.TerminationCriteria.Builder.setSimpleOptimalityCriteria

(

operations_research.pdlp.Solvers.TerminationCriteria.SimpleOptimalityCriteria.Builder

builderForValue

)

.operations_research.pdlp.TerminationCriteria.SimpleOptimalityCriteria simple_optimality_criteria = 9;

Definition at line 3517 of file Solvers.java.

setTimeSecLimit()

Builder operations_research.pdlp.Solvers.TerminationCriteria.Builder.setTimeSecLimit

(

double

value

)

If termination_reason = TERMINATION_REASON_TIME_LIMIT then the solver has
taken at least time_sec_limit time.

optional double time_sec_limit = 6 [default = inf];

Parameters

value

The timeSecLimit to set.

Returns

This builder for chaining.

Definition at line 4103 of file Solvers.java.

setUnknownFields()

final Builder operations_research.pdlp.Solvers.TerminationCriteria.Builder.setUnknownFields

(

final com.google.protobuf.UnknownFieldSet

unknownFields

)

Definition at line 4246 of file Solvers.java.

---

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

• build/java/ortools-java/src/main/java/operations_research/pdlp/Solvers.java