com.google.ortools.pdlp.TerminationCriteriaOrBuilder Interface Reference

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

Public Member Functions
boolean	hasOptimalityNorm ()
com.google.ortools.pdlp.OptimalityNorm	getOptimalityNorm ()
boolean	hasSimpleOptimalityCriteria ()
com.google.ortools.pdlp.TerminationCriteria.SimpleOptimalityCriteria	getSimpleOptimalityCriteria ()
com.google.ortools.pdlp.TerminationCriteria.SimpleOptimalityCriteriaOrBuilder	getSimpleOptimalityCriteriaOrBuilder ()
boolean	hasDetailedOptimalityCriteria ()
com.google.ortools.pdlp.TerminationCriteria.DetailedOptimalityCriteria	getDetailedOptimalityCriteria ()
com.google.ortools.pdlp.TerminationCriteria.DetailedOptimalityCriteriaOrBuilder	getDetailedOptimalityCriteriaOrBuilder ()
boolean	hasEpsOptimalAbsolute ()
double	getEpsOptimalAbsolute ()
boolean	hasEpsOptimalRelative ()
double	getEpsOptimalRelative ()
boolean	hasEpsPrimalInfeasible ()
double	getEpsPrimalInfeasible ()
boolean	hasEpsDualInfeasible ()
double	getEpsDualInfeasible ()
boolean	hasTimeSecLimit ()
double	getTimeSecLimit ()
boolean	hasIterationLimit ()
int	getIterationLimit ()
boolean	hasKktMatrixPassLimit ()
double	getKktMatrixPassLimit ()
com.google.ortools.pdlp.TerminationCriteria.OptimalityCriteriaCase	getOptimalityCriteriaCase ()

Detailed Description

Definition at line 7 of file TerminationCriteriaOrBuilder.java.

Member Function Documentation

getDetailedOptimalityCriteria()

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

(

)

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

Returns

The detailedOptimalityCriteria.

Implemented in com.google.ortools.pdlp.TerminationCriteria.Builder, and com.google.ortools.pdlp.TerminationCriteria.

getDetailedOptimalityCriteriaOrBuilder()

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

(

)

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

Implemented in com.google.ortools.pdlp.TerminationCriteria.Builder, and com.google.ortools.pdlp.TerminationCriteria.

getEpsDualInfeasible()

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

Implemented in com.google.ortools.pdlp.TerminationCriteria.Builder, and com.google.ortools.pdlp.TerminationCriteria.

getEpsOptimalAbsolute()

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

Implemented in com.google.ortools.pdlp.TerminationCriteria.Builder, and com.google.ortools.pdlp.TerminationCriteria.

getEpsOptimalRelative()

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

Implemented in com.google.ortools.pdlp.TerminationCriteria.Builder, and com.google.ortools.pdlp.TerminationCriteria.

getEpsPrimalInfeasible()

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

Implemented in com.google.ortools.pdlp.TerminationCriteria.Builder, and com.google.ortools.pdlp.TerminationCriteria.

getIterationLimit()

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

Implemented in com.google.ortools.pdlp.TerminationCriteria.Builder, and com.google.ortools.pdlp.TerminationCriteria.

getKktMatrixPassLimit()

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

Implemented in com.google.ortools.pdlp.TerminationCriteria.Builder, and com.google.ortools.pdlp.TerminationCriteria.

getOptimalityCriteriaCase()

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

(

)

Implemented in com.google.ortools.pdlp.TerminationCriteria.Builder, and com.google.ortools.pdlp.TerminationCriteria.

getOptimalityNorm()

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

Implemented in com.google.ortools.pdlp.TerminationCriteria.Builder, and com.google.ortools.pdlp.TerminationCriteria.

getSimpleOptimalityCriteria()

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

(

)

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

Returns

The simpleOptimalityCriteria.

Implemented in com.google.ortools.pdlp.TerminationCriteria.Builder, and com.google.ortools.pdlp.TerminationCriteria.

getSimpleOptimalityCriteriaOrBuilder()

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

(

)

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

Implemented in com.google.ortools.pdlp.TerminationCriteria.Builder, and com.google.ortools.pdlp.TerminationCriteria.

getTimeSecLimit()

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

Implemented in com.google.ortools.pdlp.TerminationCriteria.Builder, and com.google.ortools.pdlp.TerminationCriteria.

hasDetailedOptimalityCriteria()

boolean com.google.ortools.pdlp.TerminationCriteriaOrBuilder.hasDetailedOptimalityCriteria

(

)

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

Returns

Whether the detailedOptimalityCriteria field is set.

Implemented in com.google.ortools.pdlp.TerminationCriteria.Builder, and com.google.ortools.pdlp.TerminationCriteria.

hasEpsDualInfeasible()

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

Implemented in com.google.ortools.pdlp.TerminationCriteria.Builder, and com.google.ortools.pdlp.TerminationCriteria.

hasEpsOptimalAbsolute()

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

Implemented in com.google.ortools.pdlp.TerminationCriteria.Builder, and com.google.ortools.pdlp.TerminationCriteria.

hasEpsOptimalRelative()

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

Implemented in com.google.ortools.pdlp.TerminationCriteria.Builder, and com.google.ortools.pdlp.TerminationCriteria.

hasEpsPrimalInfeasible()

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

Implemented in com.google.ortools.pdlp.TerminationCriteria.Builder, and com.google.ortools.pdlp.TerminationCriteria.

hasIterationLimit()

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

Implemented in com.google.ortools.pdlp.TerminationCriteria.Builder, and com.google.ortools.pdlp.TerminationCriteria.

hasKktMatrixPassLimit()

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

Implemented in com.google.ortools.pdlp.TerminationCriteria.Builder, and com.google.ortools.pdlp.TerminationCriteria.

hasOptimalityNorm()

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

Implemented in com.google.ortools.pdlp.TerminationCriteria.Builder, and com.google.ortools.pdlp.TerminationCriteria.

hasSimpleOptimalityCriteria()

boolean com.google.ortools.pdlp.TerminationCriteriaOrBuilder.hasSimpleOptimalityCriteria

(

)

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

Returns

Whether the simpleOptimalityCriteria field is set.

Implemented in com.google.ortools.pdlp.TerminationCriteria.Builder, and com.google.ortools.pdlp.TerminationCriteria.

hasTimeSecLimit()

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

Implemented in com.google.ortools.pdlp.TerminationCriteria.Builder, and com.google.ortools.pdlp.TerminationCriteria.

---

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

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