Google OR-Tools v9.14
a fast and portable software suite for combinatorial optimization
Loading...
Searching...
No Matches
com.google.ortools.pdlp.InfeasibilityInformation Class Reference

Detailed Description

Information measuring how close a point is to establishing primal or dual
infeasibility (i.e. has no solution); see also TerminationCriteria.

Protobuf type operations_research.pdlp.InfeasibilityInformation

Definition at line 17 of file InfeasibilityInformation.java.

Inheritance diagram for com.google.ortools.pdlp.InfeasibilityInformation:
com.google.ortools.pdlp.InfeasibilityInformationOrBuilder

Classes

class  Builder

Public Member Functions

boolean hasMaxPrimalRayInfeasibility ()
double getMaxPrimalRayInfeasibility ()
boolean hasPrimalRayLinearObjective ()
double getPrimalRayLinearObjective ()
boolean hasPrimalRayQuadraticNorm ()
double getPrimalRayQuadraticNorm ()
boolean hasMaxDualRayInfeasibility ()
double getMaxDualRayInfeasibility ()
boolean hasDualRayObjective ()
double getDualRayObjective ()
boolean hasCandidateType ()
com.google.ortools.pdlp.PointType getCandidateType ()
final boolean isInitialized ()
void writeTo (com.google.protobuf.CodedOutputStream output) throws java.io.IOException
int getSerializedSize ()
boolean equals (final java.lang.Object obj)
int hashCode ()
Builder newBuilderForType ()
Builder toBuilder ()
com.google.protobuf.Parser< InfeasibilityInformation > getParserForType ()
com.google.ortools.pdlp.InfeasibilityInformation getDefaultInstanceForType ()

Static Public Member Functions

static final com.google.protobuf.Descriptors.Descriptor getDescriptor ()
static com.google.ortools.pdlp.InfeasibilityInformation parseFrom (java.nio.ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
static com.google.ortools.pdlp.InfeasibilityInformation parseFrom (java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
static com.google.ortools.pdlp.InfeasibilityInformation parseFrom (com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
static com.google.ortools.pdlp.InfeasibilityInformation parseFrom (com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
static com.google.ortools.pdlp.InfeasibilityInformation parseFrom (byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
static com.google.ortools.pdlp.InfeasibilityInformation parseFrom (byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
static com.google.ortools.pdlp.InfeasibilityInformation parseFrom (java.io.InputStream input) throws java.io.IOException
static com.google.ortools.pdlp.InfeasibilityInformation parseFrom (java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
static com.google.ortools.pdlp.InfeasibilityInformation parseDelimitedFrom (java.io.InputStream input) throws java.io.IOException
static com.google.ortools.pdlp.InfeasibilityInformation parseDelimitedFrom (java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
static com.google.ortools.pdlp.InfeasibilityInformation parseFrom (com.google.protobuf.CodedInputStream input) throws java.io.IOException
static com.google.ortools.pdlp.InfeasibilityInformation parseFrom (com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
static Builder newBuilder ()
static Builder newBuilder (com.google.ortools.pdlp.InfeasibilityInformation prototype)
static com.google.ortools.pdlp.InfeasibilityInformation getDefaultInstance ()
static com.google.protobuf.Parser< InfeasibilityInformation > parser ()

Static Public Attributes

static final int MAX_PRIMAL_RAY_INFEASIBILITY_FIELD_NUMBER = 1
static final int PRIMAL_RAY_LINEAR_OBJECTIVE_FIELD_NUMBER = 2
static final int PRIMAL_RAY_QUADRATIC_NORM_FIELD_NUMBER = 3
static final int MAX_DUAL_RAY_INFEASIBILITY_FIELD_NUMBER = 4
static final int DUAL_RAY_OBJECTIVE_FIELD_NUMBER = 5
static final int CANDIDATE_TYPE_FIELD_NUMBER = 6

Protected Member Functions

com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable ()
Builder newBuilderForType (com.google.protobuf.GeneratedMessage.BuilderParent parent)

Member Function Documentation

◆ equals()

boolean com.google.ortools.pdlp.InfeasibilityInformation.equals ( final java.lang.Object obj)

Definition at line 325 of file InfeasibilityInformation.java.

◆ getCandidateType()

com.google.ortools.pdlp.PointType com.google.ortools.pdlp.InfeasibilityInformation.getCandidateType ( ) 
Type of the point used to compute the InfeasibilityInformation.

optional .operations_research.pdlp.PointType candidate_type = 6;

Returns
The candidateType.

Implements com.google.ortools.pdlp.InfeasibilityInformationOrBuilder.

Definition at line 249 of file InfeasibilityInformation.java.

◆ getDefaultInstance()

com.google.ortools.pdlp.InfeasibilityInformation com.google.ortools.pdlp.InfeasibilityInformation.getDefaultInstance ( )
static

Definition at line 1146 of file InfeasibilityInformation.java.

◆ getDefaultInstanceForType()

com.google.ortools.pdlp.InfeasibilityInformation com.google.ortools.pdlp.InfeasibilityInformation.getDefaultInstanceForType ( )

Definition at line 1182 of file InfeasibilityInformation.java.

◆ getDescriptor()

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

Definition at line 40 of file InfeasibilityInformation.java.

◆ getDualRayObjective()

double com.google.ortools.pdlp.InfeasibilityInformation.getDualRayObjective ( ) 
The objective of the linear program labeled (1) in the previous paragraph.

optional double dual_ray_objective = 5;

Returns
The dualRayObjective.

Implements com.google.ortools.pdlp.InfeasibilityInformationOrBuilder.

Definition at line 224 of file InfeasibilityInformation.java.

◆ getMaxDualRayInfeasibility()

double com.google.ortools.pdlp.InfeasibilityInformation.getMaxDualRayInfeasibility ( ) 
Let (y_ray, r_ray) be the algorithm's estimate of the dual and reduced cost
extreme ray where (y_ray, r_ray) is a vector (satisfying the dual variable
constraints) scaled such that its infinity norm is one. A simple and
typical choice of y_ray is (y_ray, r_ray) = (y, r) / max(| y |_∞, | r |_∞)
where y is the current dual iterate and r is the current dual reduced
costs. Consider the quadratic program we are solving but with the objective
(both quadratic and linear terms) set to zero. This forms a linear program
(label this linear program (1)) with no objective. Take the dual of (1) and
compute the maximum absolute value of the constraint error for
(y_ray, r_ray) to obtain the value of max_dual_ray_infeasibility.

optional double max_dual_ray_infeasibility = 4;

Returns
The maxDualRayInfeasibility.

Implements com.google.ortools.pdlp.InfeasibilityInformationOrBuilder.

Definition at line 197 of file InfeasibilityInformation.java.

◆ getMaxPrimalRayInfeasibility()

double com.google.ortools.pdlp.InfeasibilityInformation.getMaxPrimalRayInfeasibility ( ) 
Let x_ray be the algorithm's estimate of the primal extreme ray where x_ray
is a vector that satisfies the sign constraints for a ray, scaled such that
its infinity norm is one (the sign constraints are the variable bound
constraints, with all finite bounds mapped to zero). A simple and typical
choice of x_ray is x_ray = x / | x |_∞ where x is the current primal
iterate projected onto the primal ray sign constraints. For this value
compute the maximum absolute error in the primal linear program with the
right hand side set to zero.

optional double max_primal_ray_infeasibility = 1;

Returns
The maxPrimalRayInfeasibility.

Implements com.google.ortools.pdlp.InfeasibilityInformationOrBuilder.

Definition at line 90 of file InfeasibilityInformation.java.

◆ getParserForType()

com.google.protobuf.Parser< InfeasibilityInformation > com.google.ortools.pdlp.InfeasibilityInformation.getParserForType ( )

Definition at line 1177 of file InfeasibilityInformation.java.

◆ getPrimalRayLinearObjective()

double com.google.ortools.pdlp.InfeasibilityInformation.getPrimalRayLinearObjective ( ) 
The value of the linear part of the primal objective (ignoring additive
constants) evaluated at x_ray, i.e., c' * x_ray where c is the objective
coefficient vector.

optional double primal_ray_linear_objective = 2;

Returns
The primalRayLinearObjective.

Implements com.google.ortools.pdlp.InfeasibilityInformationOrBuilder.

Definition at line 121 of file InfeasibilityInformation.java.

◆ getPrimalRayQuadraticNorm()

double com.google.ortools.pdlp.InfeasibilityInformation.getPrimalRayQuadraticNorm ( ) 
The l_∞ norm of the vector resulting from taking the quadratic matrix from
primal objective and multiplying it by the primal variables. For linear
programming problems this is zero.

optional double primal_ray_quadratic_norm = 3;

Returns
The primalRayQuadraticNorm.

Implements com.google.ortools.pdlp.InfeasibilityInformationOrBuilder.

Definition at line 152 of file InfeasibilityInformation.java.

◆ getSerializedSize()

int com.google.ortools.pdlp.InfeasibilityInformation.getSerializedSize ( )

Definition at line 290 of file InfeasibilityInformation.java.

◆ hasCandidateType()

boolean com.google.ortools.pdlp.InfeasibilityInformation.hasCandidateType ( ) 
Type of the point used to compute the InfeasibilityInformation.

optional .operations_research.pdlp.PointType candidate_type = 6;

Returns
Whether the candidateType field is set.

Implements com.google.ortools.pdlp.InfeasibilityInformationOrBuilder.

Definition at line 238 of file InfeasibilityInformation.java.

◆ hasDualRayObjective()

boolean com.google.ortools.pdlp.InfeasibilityInformation.hasDualRayObjective ( ) 
The objective of the linear program labeled (1) in the previous paragraph.

optional double dual_ray_objective = 5;

Returns
Whether the dualRayObjective field is set.

Implements com.google.ortools.pdlp.InfeasibilityInformationOrBuilder.

Definition at line 212 of file InfeasibilityInformation.java.

◆ hashCode()

int com.google.ortools.pdlp.InfeasibilityInformation.hashCode ( )

Definition at line 373 of file InfeasibilityInformation.java.

◆ hasMaxDualRayInfeasibility()

boolean com.google.ortools.pdlp.InfeasibilityInformation.hasMaxDualRayInfeasibility ( ) 
Let (y_ray, r_ray) be the algorithm's estimate of the dual and reduced cost
extreme ray where (y_ray, r_ray) is a vector (satisfying the dual variable
constraints) scaled such that its infinity norm is one. A simple and
typical choice of y_ray is (y_ray, r_ray) = (y, r) / max(| y |_∞, | r |_∞)
where y is the current dual iterate and r is the current dual reduced
costs. Consider the quadratic program we are solving but with the objective
(both quadratic and linear terms) set to zero. This forms a linear program
(label this linear program (1)) with no objective. Take the dual of (1) and
compute the maximum absolute value of the constraint error for
(y_ray, r_ray) to obtain the value of max_dual_ray_infeasibility.

optional double max_dual_ray_infeasibility = 4;

Returns
Whether the maxDualRayInfeasibility field is set.

Implements com.google.ortools.pdlp.InfeasibilityInformationOrBuilder.

Definition at line 176 of file InfeasibilityInformation.java.

◆ hasMaxPrimalRayInfeasibility()

boolean com.google.ortools.pdlp.InfeasibilityInformation.hasMaxPrimalRayInfeasibility ( ) 
Let x_ray be the algorithm's estimate of the primal extreme ray where x_ray
is a vector that satisfies the sign constraints for a ray, scaled such that
its infinity norm is one (the sign constraints are the variable bound
constraints, with all finite bounds mapped to zero). A simple and typical
choice of x_ray is x_ray = x / | x |_∞ where x is the current primal
iterate projected onto the primal ray sign constraints. For this value
compute the maximum absolute error in the primal linear program with the
right hand side set to zero.

optional double max_primal_ray_infeasibility = 1;

Returns
Whether the maxPrimalRayInfeasibility field is set.

Implements com.google.ortools.pdlp.InfeasibilityInformationOrBuilder.

Definition at line 71 of file InfeasibilityInformation.java.

◆ hasPrimalRayLinearObjective()

boolean com.google.ortools.pdlp.InfeasibilityInformation.hasPrimalRayLinearObjective ( ) 
The value of the linear part of the primal objective (ignoring additive
constants) evaluated at x_ray, i.e., c' * x_ray where c is the objective
coefficient vector.

optional double primal_ray_linear_objective = 2;

Returns
Whether the primalRayLinearObjective field is set.

Implements com.google.ortools.pdlp.InfeasibilityInformationOrBuilder.

Definition at line 107 of file InfeasibilityInformation.java.

◆ hasPrimalRayQuadraticNorm()

boolean com.google.ortools.pdlp.InfeasibilityInformation.hasPrimalRayQuadraticNorm ( ) 
The l_∞ norm of the vector resulting from taking the quadratic matrix from
primal objective and multiplying it by the primal variables. For linear
programming problems this is zero.

optional double primal_ray_quadratic_norm = 3;

Returns
Whether the primalRayQuadraticNorm field is set.

Implements com.google.ortools.pdlp.InfeasibilityInformationOrBuilder.

Definition at line 138 of file InfeasibilityInformation.java.

◆ internalGetFieldAccessorTable()

com.google.protobuf.GeneratedMessage.FieldAccessorTable com.google.ortools.pdlp.InfeasibilityInformation.internalGetFieldAccessorTable ( )
protected

Definition at line 46 of file InfeasibilityInformation.java.

◆ isInitialized()

final boolean com.google.ortools.pdlp.InfeasibilityInformation.isInitialized ( )

Definition at line 256 of file InfeasibilityInformation.java.

◆ newBuilder() [1/2]

Builder com.google.ortools.pdlp.InfeasibilityInformation.newBuilder ( )
static

Definition at line 487 of file InfeasibilityInformation.java.

◆ newBuilder() [2/2]

Builder com.google.ortools.pdlp.InfeasibilityInformation.newBuilder ( com.google.ortools.pdlp.InfeasibilityInformation prototype)
static

Definition at line 490 of file InfeasibilityInformation.java.

◆ newBuilderForType() [1/2]

Builder com.google.ortools.pdlp.InfeasibilityInformation.newBuilderForType ( )

Definition at line 486 of file InfeasibilityInformation.java.

◆ newBuilderForType() [2/2]

Builder com.google.ortools.pdlp.InfeasibilityInformation.newBuilderForType ( com.google.protobuf.GeneratedMessage.BuilderParent parent)
protected

Definition at line 500 of file InfeasibilityInformation.java.

◆ parseDelimitedFrom() [1/2]

com.google.ortools.pdlp.InfeasibilityInformation com.google.ortools.pdlp.InfeasibilityInformation.parseDelimitedFrom ( java.io.InputStream input) throws java.io.IOException
static

Definition at line 458 of file InfeasibilityInformation.java.

◆ parseDelimitedFrom() [2/2]

com.google.ortools.pdlp.InfeasibilityInformation com.google.ortools.pdlp.InfeasibilityInformation.parseDelimitedFrom ( java.io.InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry ) throws java.io.IOException
static

Definition at line 464 of file InfeasibilityInformation.java.

◆ parseFrom() [1/10]

com.google.ortools.pdlp.InfeasibilityInformation com.google.ortools.pdlp.InfeasibilityInformation.parseFrom ( byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
static

Definition at line 435 of file InfeasibilityInformation.java.

◆ parseFrom() [2/10]

com.google.ortools.pdlp.InfeasibilityInformation com.google.ortools.pdlp.InfeasibilityInformation.parseFrom ( byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry ) throws com.google.protobuf.InvalidProtocolBufferException
static

Definition at line 439 of file InfeasibilityInformation.java.

◆ parseFrom() [3/10]

com.google.ortools.pdlp.InfeasibilityInformation com.google.ortools.pdlp.InfeasibilityInformation.parseFrom ( com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
static

Definition at line 424 of file InfeasibilityInformation.java.

◆ parseFrom() [4/10]

com.google.ortools.pdlp.InfeasibilityInformation com.google.ortools.pdlp.InfeasibilityInformation.parseFrom ( com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry ) throws com.google.protobuf.InvalidProtocolBufferException
static

Definition at line 429 of file InfeasibilityInformation.java.

◆ parseFrom() [5/10]

com.google.ortools.pdlp.InfeasibilityInformation com.google.ortools.pdlp.InfeasibilityInformation.parseFrom ( com.google.protobuf.CodedInputStream input) throws java.io.IOException
static

Definition at line 471 of file InfeasibilityInformation.java.

◆ parseFrom() [6/10]

com.google.ortools.pdlp.InfeasibilityInformation com.google.ortools.pdlp.InfeasibilityInformation.parseFrom ( com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry ) throws java.io.IOException
static

Definition at line 477 of file InfeasibilityInformation.java.

◆ parseFrom() [7/10]

com.google.ortools.pdlp.InfeasibilityInformation com.google.ortools.pdlp.InfeasibilityInformation.parseFrom ( java.io.InputStream input) throws java.io.IOException
static

Definition at line 445 of file InfeasibilityInformation.java.

◆ parseFrom() [8/10]

com.google.ortools.pdlp.InfeasibilityInformation com.google.ortools.pdlp.InfeasibilityInformation.parseFrom ( java.io.InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry ) throws java.io.IOException
static

Definition at line 450 of file InfeasibilityInformation.java.

◆ parseFrom() [9/10]

com.google.ortools.pdlp.InfeasibilityInformation com.google.ortools.pdlp.InfeasibilityInformation.parseFrom ( java.nio.ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
static

Definition at line 413 of file InfeasibilityInformation.java.

◆ parseFrom() [10/10]

com.google.ortools.pdlp.InfeasibilityInformation com.google.ortools.pdlp.InfeasibilityInformation.parseFrom ( java.nio.ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry ) throws com.google.protobuf.InvalidProtocolBufferException
static

Definition at line 418 of file InfeasibilityInformation.java.

◆ parser()

com.google.protobuf.Parser< InfeasibilityInformation > com.google.ortools.pdlp.InfeasibilityInformation.parser ( )
static

Definition at line 1172 of file InfeasibilityInformation.java.

◆ toBuilder()

Builder com.google.ortools.pdlp.InfeasibilityInformation.toBuilder ( )

Definition at line 494 of file InfeasibilityInformation.java.

◆ writeTo()

void com.google.ortools.pdlp.InfeasibilityInformation.writeTo ( com.google.protobuf.CodedOutputStream output) throws java.io.IOException

Definition at line 266 of file InfeasibilityInformation.java.

Member Data Documentation

◆ CANDIDATE_TYPE_FIELD_NUMBER

final int com.google.ortools.pdlp.InfeasibilityInformation.CANDIDATE_TYPE_FIELD_NUMBER = 6
static

Definition at line 228 of file InfeasibilityInformation.java.

◆ DUAL_RAY_OBJECTIVE_FIELD_NUMBER

final int com.google.ortools.pdlp.InfeasibilityInformation.DUAL_RAY_OBJECTIVE_FIELD_NUMBER = 5
static

Definition at line 201 of file InfeasibilityInformation.java.

◆ MAX_DUAL_RAY_INFEASIBILITY_FIELD_NUMBER

final int com.google.ortools.pdlp.InfeasibilityInformation.MAX_DUAL_RAY_INFEASIBILITY_FIELD_NUMBER = 4
static

Definition at line 156 of file InfeasibilityInformation.java.

◆ MAX_PRIMAL_RAY_INFEASIBILITY_FIELD_NUMBER

final int com.google.ortools.pdlp.InfeasibilityInformation.MAX_PRIMAL_RAY_INFEASIBILITY_FIELD_NUMBER = 1
static

Definition at line 53 of file InfeasibilityInformation.java.

◆ PRIMAL_RAY_LINEAR_OBJECTIVE_FIELD_NUMBER

final int com.google.ortools.pdlp.InfeasibilityInformation.PRIMAL_RAY_LINEAR_OBJECTIVE_FIELD_NUMBER = 2
static

Definition at line 94 of file InfeasibilityInformation.java.

◆ PRIMAL_RAY_QUADRATIC_NORM_FIELD_NUMBER

final int com.google.ortools.pdlp.InfeasibilityInformation.PRIMAL_RAY_QUADRATIC_NORM_FIELD_NUMBER = 3
static

Definition at line 125 of file InfeasibilityInformation.java.

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