com.google.ortools.pdlp.TerminationCriteria.Builder Class Reference

Inheritance diagram for com.google.ortools.pdlp.TerminationCriteria.Builder:

Public Member Functions
Builder	clear ()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType ()
com.google.ortools.pdlp.TerminationCriteria	getDefaultInstanceForType ()
com.google.ortools.pdlp.TerminationCriteria	build ()
com.google.ortools.pdlp.TerminationCriteria	buildPartial ()
Builder	mergeFrom (com.google.protobuf.Message other)
Builder	mergeFrom (com.google.ortools.pdlp.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 ()
com.google.ortools.pdlp.OptimalityNorm	getOptimalityNorm ()
Builder	setOptimalityNorm (com.google.ortools.pdlp.OptimalityNorm value)
Builder	clearOptimalityNorm ()
boolean	hasSimpleOptimalityCriteria ()
com.google.ortools.pdlp.TerminationCriteria.SimpleOptimalityCriteria	getSimpleOptimalityCriteria ()
Builder	setSimpleOptimalityCriteria (com.google.ortools.pdlp.TerminationCriteria.SimpleOptimalityCriteria value)
Builder	setSimpleOptimalityCriteria (com.google.ortools.pdlp.TerminationCriteria.SimpleOptimalityCriteria.Builder builderForValue)
Builder	mergeSimpleOptimalityCriteria (com.google.ortools.pdlp.TerminationCriteria.SimpleOptimalityCriteria value)
Builder	clearSimpleOptimalityCriteria ()
com.google.ortools.pdlp.TerminationCriteria.SimpleOptimalityCriteria.Builder	getSimpleOptimalityCriteriaBuilder ()
com.google.ortools.pdlp.TerminationCriteria.SimpleOptimalityCriteriaOrBuilder	getSimpleOptimalityCriteriaOrBuilder ()
boolean	hasDetailedOptimalityCriteria ()
com.google.ortools.pdlp.TerminationCriteria.DetailedOptimalityCriteria	getDetailedOptimalityCriteria ()
Builder	setDetailedOptimalityCriteria (com.google.ortools.pdlp.TerminationCriteria.DetailedOptimalityCriteria value)
Builder	setDetailedOptimalityCriteria (com.google.ortools.pdlp.TerminationCriteria.DetailedOptimalityCriteria.Builder builderForValue)
Builder	mergeDetailedOptimalityCriteria (com.google.ortools.pdlp.TerminationCriteria.DetailedOptimalityCriteria value)
Builder	clearDetailedOptimalityCriteria ()
com.google.ortools.pdlp.TerminationCriteria.DetailedOptimalityCriteria.Builder	getDetailedOptimalityCriteriaBuilder ()
com.google.ortools.pdlp.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 ()
Public Member Functions inherited from com.google.ortools.pdlp.TerminationCriteriaOrBuilder

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

Protected Member Functions
com.google.protobuf.GeneratedMessage.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 2593 of file TerminationCriteria.java.

Member Function Documentation

build()

com.google.ortools.pdlp.TerminationCriteria com.google.ortools.pdlp.TerminationCriteria.Builder.build

(

)

Definition at line 2655 of file TerminationCriteria.java.

buildPartial()

com.google.ortools.pdlp.TerminationCriteria com.google.ortools.pdlp.TerminationCriteria.Builder.buildPartial

(

)

Definition at line 2664 of file TerminationCriteria.java.

clear()

Builder com.google.ortools.pdlp.TerminationCriteria.Builder.clear

(

)

Definition at line 2621 of file TerminationCriteria.java.

clearDetailedOptimalityCriteria()

Builder com.google.ortools.pdlp.TerminationCriteria.Builder.clearDetailedOptimalityCriteria

(

)

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

Definition at line 3175 of file TerminationCriteria.java.

clearEpsDualInfeasible()

Builder com.google.ortools.pdlp.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 3538 of file TerminationCriteria.java.

clearEpsOptimalAbsolute()

Builder com.google.ortools.pdlp.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=137

Returns

This builder for chaining.

Definition at line 3302 of file TerminationCriteria.java.

clearEpsOptimalRelative()

Builder com.google.ortools.pdlp.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=144

Returns

This builder for chaining.

Definition at line 3378 of file TerminationCriteria.java.

clearEpsPrimalInfeasible()

Builder com.google.ortools.pdlp.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 3454 of file TerminationCriteria.java.

clearIterationLimit()

Builder com.google.ortools.pdlp.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 3658 of file TerminationCriteria.java.

clearKktMatrixPassLimit()

Builder com.google.ortools.pdlp.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 3718 of file TerminationCriteria.java.

clearOptimalityCriteria()

Builder com.google.ortools.pdlp.TerminationCriteria.Builder.clearOptimalityCriteria

(

)

Definition at line 2882 of file TerminationCriteria.java.

clearOptimalityNorm()

Builder com.google.ortools.pdlp.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 2942 of file TerminationCriteria.java.

clearSimpleOptimalityCriteria()

Builder com.google.ortools.pdlp.TerminationCriteria.Builder.clearSimpleOptimalityCriteria

(

)

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

Definition at line 3033 of file TerminationCriteria.java.

clearTimeSecLimit()

Builder com.google.ortools.pdlp.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 3598 of file TerminationCriteria.java.

getDefaultInstanceForType()

com.google.ortools.pdlp.TerminationCriteria com.google.ortools.pdlp.TerminationCriteria.Builder.getDefaultInstanceForType

(

)

Definition at line 2650 of file TerminationCriteria.java.

getDescriptor()

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

static

Definition at line 2598 of file TerminationCriteria.java.

getDescriptorForType()

com.google.protobuf.Descriptors.Descriptor com.google.ortools.pdlp.TerminationCriteria.Builder.getDescriptorForType

(

)

Definition at line 2645 of file TerminationCriteria.java.

getDetailedOptimalityCriteria()

com.google.ortools.pdlp.TerminationCriteria.DetailedOptimalityCriteria com.google.ortools.pdlp.TerminationCriteria.Builder.getDetailedOptimalityCriteria

(

)

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

Returns

The detailedOptimalityCriteria.

Implements com.google.ortools.pdlp.TerminationCriteriaOrBuilder.

Definition at line 3106 of file TerminationCriteria.java.

getDetailedOptimalityCriteriaBuilder()

com.google.ortools.pdlp.TerminationCriteria.DetailedOptimalityCriteria.Builder com.google.ortools.pdlp.TerminationCriteria.Builder.getDetailedOptimalityCriteriaBuilder

(

)

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

Definition at line 3194 of file TerminationCriteria.java.

getDetailedOptimalityCriteriaOrBuilder()

com.google.ortools.pdlp.TerminationCriteria.DetailedOptimalityCriteriaOrBuilder com.google.ortools.pdlp.TerminationCriteria.Builder.getDetailedOptimalityCriteriaOrBuilder

(

)

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

Implements com.google.ortools.pdlp.TerminationCriteriaOrBuilder.

Definition at line 3201 of file TerminationCriteria.java.

getEpsDualInfeasible()

double com.google.ortools.pdlp.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 com.google.ortools.pdlp.TerminationCriteriaOrBuilder.

Definition at line 3497 of file TerminationCriteria.java.

getEpsOptimalAbsolute()

double com.google.ortools.pdlp.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=137

Returns

The epsOptimalAbsolute.

Implements com.google.ortools.pdlp.TerminationCriteriaOrBuilder.

Definition at line 3265 of file TerminationCriteria.java.

getEpsOptimalRelative()

double com.google.ortools.pdlp.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=144

Returns

The epsOptimalRelative.

Implements com.google.ortools.pdlp.TerminationCriteriaOrBuilder.

Definition at line 3341 of file TerminationCriteria.java.

getEpsPrimalInfeasible()

double com.google.ortools.pdlp.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 com.google.ortools.pdlp.TerminationCriteriaOrBuilder.

Definition at line 3417 of file TerminationCriteria.java.

getIterationLimit()

int com.google.ortools.pdlp.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 com.google.ortools.pdlp.TerminationCriteriaOrBuilder.

Definition at line 3629 of file TerminationCriteria.java.

getKktMatrixPassLimit()

double com.google.ortools.pdlp.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 com.google.ortools.pdlp.TerminationCriteriaOrBuilder.

Definition at line 3689 of file TerminationCriteria.java.

getOptimalityCriteriaCase()

OptimalityCriteriaCase com.google.ortools.pdlp.TerminationCriteria.Builder.getOptimalityCriteriaCase

(

)

Implements com.google.ortools.pdlp.TerminationCriteriaOrBuilder.

Definition at line 2877 of file TerminationCriteria.java.

getOptimalityNorm()

com.google.ortools.pdlp.OptimalityNorm com.google.ortools.pdlp.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 com.google.ortools.pdlp.TerminationCriteriaOrBuilder.

Definition at line 2912 of file TerminationCriteria.java.

getSimpleOptimalityCriteria()

com.google.ortools.pdlp.TerminationCriteria.SimpleOptimalityCriteria com.google.ortools.pdlp.TerminationCriteria.Builder.getSimpleOptimalityCriteria

(

)

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

Returns

The simpleOptimalityCriteria.

Implements com.google.ortools.pdlp.TerminationCriteriaOrBuilder.

Definition at line 2964 of file TerminationCriteria.java.

getSimpleOptimalityCriteriaBuilder()

com.google.ortools.pdlp.TerminationCriteria.SimpleOptimalityCriteria.Builder com.google.ortools.pdlp.TerminationCriteria.Builder.getSimpleOptimalityCriteriaBuilder

(

)

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

Definition at line 3052 of file TerminationCriteria.java.

getSimpleOptimalityCriteriaOrBuilder()

com.google.ortools.pdlp.TerminationCriteria.SimpleOptimalityCriteriaOrBuilder com.google.ortools.pdlp.TerminationCriteria.Builder.getSimpleOptimalityCriteriaOrBuilder

(

)

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

Implements com.google.ortools.pdlp.TerminationCriteriaOrBuilder.

Definition at line 3059 of file TerminationCriteria.java.

getTimeSecLimit()

double com.google.ortools.pdlp.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 com.google.ortools.pdlp.TerminationCriteriaOrBuilder.

Definition at line 3569 of file TerminationCriteria.java.

hasDetailedOptimalityCriteria()

boolean com.google.ortools.pdlp.TerminationCriteria.Builder.hasDetailedOptimalityCriteria

(

)

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

Returns

Whether the detailedOptimalityCriteria field is set.

Implements com.google.ortools.pdlp.TerminationCriteriaOrBuilder.

Definition at line 3098 of file TerminationCriteria.java.

hasEpsDualInfeasible()

boolean com.google.ortools.pdlp.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 com.google.ortools.pdlp.TerminationCriteriaOrBuilder.

Definition at line 3478 of file TerminationCriteria.java.

hasEpsOptimalAbsolute()

boolean com.google.ortools.pdlp.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=137

Returns

Whether the epsOptimalAbsolute field is set.

Implements com.google.ortools.pdlp.TerminationCriteriaOrBuilder.

Definition at line 3248 of file TerminationCriteria.java.

hasEpsOptimalRelative()

boolean com.google.ortools.pdlp.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=144

Returns

Whether the epsOptimalRelative field is set.

Implements com.google.ortools.pdlp.TerminationCriteriaOrBuilder.

Definition at line 3324 of file TerminationCriteria.java.

hasEpsPrimalInfeasible()

boolean com.google.ortools.pdlp.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 com.google.ortools.pdlp.TerminationCriteriaOrBuilder.

Definition at line 3400 of file TerminationCriteria.java.

hasIterationLimit()

boolean com.google.ortools.pdlp.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 com.google.ortools.pdlp.TerminationCriteriaOrBuilder.

Definition at line 3616 of file TerminationCriteria.java.

hasKktMatrixPassLimit()

boolean com.google.ortools.pdlp.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 com.google.ortools.pdlp.TerminationCriteriaOrBuilder.

Definition at line 3676 of file TerminationCriteria.java.

hasOptimalityNorm()

boolean com.google.ortools.pdlp.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 com.google.ortools.pdlp.TerminationCriteriaOrBuilder.

Definition at line 2900 of file TerminationCriteria.java.

hasSimpleOptimalityCriteria()

boolean com.google.ortools.pdlp.TerminationCriteria.Builder.hasSimpleOptimalityCriteria

(

)

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

Returns

Whether the simpleOptimalityCriteria field is set.

Implements com.google.ortools.pdlp.TerminationCriteriaOrBuilder.

Definition at line 2956 of file TerminationCriteria.java.

hasTimeSecLimit()

boolean com.google.ortools.pdlp.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 com.google.ortools.pdlp.TerminationCriteriaOrBuilder.

Definition at line 3556 of file TerminationCriteria.java.

internalGetFieldAccessorTable()

com.google.protobuf.GeneratedMessage.FieldAccessorTable com.google.ortools.pdlp.TerminationCriteria.Builder.internalGetFieldAccessorTable ( )

protected

Definition at line 2604 of file TerminationCriteria.java.

isInitialized()

final boolean com.google.ortools.pdlp.TerminationCriteria.Builder.isInitialized

(

)

Definition at line 2778 of file TerminationCriteria.java.

mergeDetailedOptimalityCriteria()

Builder com.google.ortools.pdlp.TerminationCriteria.Builder.mergeDetailedOptimalityCriteria

(

com.google.ortools.pdlp.TerminationCriteria.DetailedOptimalityCriteria

value

)

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

Definition at line 3152 of file TerminationCriteria.java.

mergeFrom() [1/3]

Builder com.google.ortools.pdlp.TerminationCriteria.Builder.mergeFrom

(

com.google.ortools.pdlp.TerminationCriteria

other

)

Definition at line 2733 of file TerminationCriteria.java.

mergeFrom() [2/3]

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

Definition at line 2783 of file TerminationCriteria.java.

mergeFrom() [3/3]

Builder com.google.ortools.pdlp.TerminationCriteria.Builder.mergeFrom

(

com.google.protobuf.Message

other

)

Definition at line 2724 of file TerminationCriteria.java.

mergeSimpleOptimalityCriteria()

Builder com.google.ortools.pdlp.TerminationCriteria.Builder.mergeSimpleOptimalityCriteria

(

com.google.ortools.pdlp.TerminationCriteria.SimpleOptimalityCriteria

value

)

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

Definition at line 3010 of file TerminationCriteria.java.

setDetailedOptimalityCriteria() [1/2]

Builder com.google.ortools.pdlp.TerminationCriteria.Builder.setDetailedOptimalityCriteria

(

com.google.ortools.pdlp.TerminationCriteria.DetailedOptimalityCriteria

value

)

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

Definition at line 3122 of file TerminationCriteria.java.

setDetailedOptimalityCriteria() [2/2]

Builder com.google.ortools.pdlp.TerminationCriteria.Builder.setDetailedOptimalityCriteria

(

com.google.ortools.pdlp.TerminationCriteria.DetailedOptimalityCriteria.Builder

builderForValue

)

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

Definition at line 3138 of file TerminationCriteria.java.

setEpsDualInfeasible()

Builder com.google.ortools.pdlp.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 3516 of file TerminationCriteria.java.

setEpsOptimalAbsolute()

Builder com.google.ortools.pdlp.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=137

Parameters

value

The epsOptimalAbsolute to set.

Returns

This builder for chaining.

Definition at line 3282 of file TerminationCriteria.java.

setEpsOptimalRelative()

Builder com.google.ortools.pdlp.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=144

Parameters

value

The epsOptimalRelative to set.

Returns

This builder for chaining.

Definition at line 3358 of file TerminationCriteria.java.

setEpsPrimalInfeasible()

Builder com.google.ortools.pdlp.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 3434 of file TerminationCriteria.java.

setIterationLimit()

Builder com.google.ortools.pdlp.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 3642 of file TerminationCriteria.java.

setKktMatrixPassLimit()

Builder com.google.ortools.pdlp.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 3702 of file TerminationCriteria.java.

setOptimalityNorm()

Builder com.google.ortools.pdlp.TerminationCriteria.Builder.setOptimalityNorm

(

com.google.ortools.pdlp.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 2925 of file TerminationCriteria.java.

setSimpleOptimalityCriteria() [1/2]

Builder com.google.ortools.pdlp.TerminationCriteria.Builder.setSimpleOptimalityCriteria

(

com.google.ortools.pdlp.TerminationCriteria.SimpleOptimalityCriteria

value

)

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

Definition at line 2980 of file TerminationCriteria.java.

setSimpleOptimalityCriteria() [2/2]

Builder com.google.ortools.pdlp.TerminationCriteria.Builder.setSimpleOptimalityCriteria

(

com.google.ortools.pdlp.TerminationCriteria.SimpleOptimalityCriteria.Builder

builderForValue

)

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

Definition at line 2996 of file TerminationCriteria.java.

setTimeSecLimit()

Builder com.google.ortools.pdlp.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 3582 of file TerminationCriteria.java.

---

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

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