public final class ConvergenceInformation extends com.google.protobuf.GeneratedMessage implements ConvergenceInformationOrBuilder
Information measuring how close a candidate is to establishing feasibility and optimality; see also TerminationCriteria.Protobuf type
operations_research.pdlp.ConvergenceInformation| Modifier and Type | Class and Description |
|---|---|
static class |
ConvergenceInformation.Builder
Information measuring how close a candidate is to establishing feasibility
and optimality; see also TerminationCriteria.
|
com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter| Modifier and Type | Field and Description |
|---|---|
static int |
CANDIDATE_TYPE_FIELD_NUMBER |
static int |
CORRECTED_DUAL_OBJECTIVE_FIELD_NUMBER |
static int |
DUAL_OBJECTIVE_FIELD_NUMBER |
static int |
L_INF_COMPONENTWISE_DUAL_RESIDUAL_FIELD_NUMBER |
static int |
L_INF_COMPONENTWISE_PRIMAL_RESIDUAL_FIELD_NUMBER |
static int |
L_INF_DUAL_RESIDUAL_FIELD_NUMBER |
static int |
L_INF_DUAL_VARIABLE_FIELD_NUMBER |
static int |
L_INF_PRIMAL_RESIDUAL_FIELD_NUMBER |
static int |
L_INF_PRIMAL_VARIABLE_FIELD_NUMBER |
static int |
L2_DUAL_RESIDUAL_FIELD_NUMBER |
static int |
L2_DUAL_VARIABLE_FIELD_NUMBER |
static int |
L2_PRIMAL_RESIDUAL_FIELD_NUMBER |
static int |
L2_PRIMAL_VARIABLE_FIELD_NUMBER |
static int |
PRIMAL_OBJECTIVE_FIELD_NUMBER |
| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(java.lang.Object obj) |
PointType |
getCandidateType()
Type of the candidate point described by this ConvergenceInformation.
|
double |
getCorrectedDualObjective()
If possible (e.g., when all primal variables have lower and upper bounds),
a correct dual bound.
|
static ConvergenceInformation |
getDefaultInstance() |
ConvergenceInformation |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
double |
getDualObjective()
The dual objective.
|
double |
getL2DualResidual()
The l_2 norm of the violations of dual constraints.
|
double |
getL2DualVariable()
The l_2 norm of the dual variables.
|
double |
getL2PrimalResidual()
The l_2 norm of the violations of primal constraints.
|
double |
getL2PrimalVariable()
The l_2 norm of the primal variables.
|
double |
getLInfComponentwiseDualResidual()
The maximum relative violation of any dual constraint, with an absolute
offset, i.e., the l_∞ norm of [violation / (eps_ratio + |objective|)] where
eps_ratio = eps_optimal_dual_residual_absolute
/ eps_optimal_dual_residual_relative
|
double |
getLInfComponentwisePrimalResidual()
The maximum relative violation of any primal constraint, with an absolute
offset, i.e., the l_∞ norm of [violation / (eps_ratio + |bound|)] where
eps_ratio = eps_optimal_primal_residual_absolute
/ eps_optimal_primal_residual_relative
and bound is the violated bound.
|
double |
getLInfDualResidual()
The maximum violation of any dual constraint, i.e., the l_∞ norm of the
violations.
|
double |
getLInfDualVariable()
The maximum absolute value of the dual variables, i.e., the l_∞ norm.
|
double |
getLInfPrimalResidual()
The maximum violation of any primal constraint, i.e., the l_∞ norm of the
violations.
|
double |
getLInfPrimalVariable()
The maximum absolute value of the primal variables, i.e., the l_∞ norm.
|
com.google.protobuf.Parser<ConvergenceInformation> |
getParserForType() |
double |
getPrimalObjective()
The primal objective.
|
int |
getSerializedSize() |
boolean |
hasCandidateType()
Type of the candidate point described by this ConvergenceInformation.
|
boolean |
hasCorrectedDualObjective()
If possible (e.g., when all primal variables have lower and upper bounds),
a correct dual bound.
|
boolean |
hasDualObjective()
The dual objective.
|
int |
hashCode() |
boolean |
hasL2DualResidual()
The l_2 norm of the violations of dual constraints.
|
boolean |
hasL2DualVariable()
The l_2 norm of the dual variables.
|
boolean |
hasL2PrimalResidual()
The l_2 norm of the violations of primal constraints.
|
boolean |
hasL2PrimalVariable()
The l_2 norm of the primal variables.
|
boolean |
hasLInfComponentwiseDualResidual()
The maximum relative violation of any dual constraint, with an absolute
offset, i.e., the l_∞ norm of [violation / (eps_ratio + |objective|)] where
eps_ratio = eps_optimal_dual_residual_absolute
/ eps_optimal_dual_residual_relative
|
boolean |
hasLInfComponentwisePrimalResidual()
The maximum relative violation of any primal constraint, with an absolute
offset, i.e., the l_∞ norm of [violation / (eps_ratio + |bound|)] where
eps_ratio = eps_optimal_primal_residual_absolute
/ eps_optimal_primal_residual_relative
and bound is the violated bound.
|
boolean |
hasLInfDualResidual()
The maximum violation of any dual constraint, i.e., the l_∞ norm of the
violations.
|
boolean |
hasLInfDualVariable()
The maximum absolute value of the dual variables, i.e., the l_∞ norm.
|
boolean |
hasLInfPrimalResidual()
The maximum violation of any primal constraint, i.e., the l_∞ norm of the
violations.
|
boolean |
hasLInfPrimalVariable()
The maximum absolute value of the primal variables, i.e., the l_∞ norm.
|
boolean |
hasPrimalObjective()
The primal objective.
|
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
static ConvergenceInformation.Builder |
newBuilder() |
static ConvergenceInformation.Builder |
newBuilder(ConvergenceInformation prototype) |
ConvergenceInformation.Builder |
newBuilderForType() |
protected ConvergenceInformation.Builder |
newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) |
static ConvergenceInformation |
parseDelimitedFrom(java.io.InputStream input) |
static ConvergenceInformation |
parseDelimitedFrom(java.io.InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static ConvergenceInformation |
parseFrom(byte[] data) |
static ConvergenceInformation |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static ConvergenceInformation |
parseFrom(java.nio.ByteBuffer data) |
static ConvergenceInformation |
parseFrom(java.nio.ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static ConvergenceInformation |
parseFrom(com.google.protobuf.ByteString data) |
static ConvergenceInformation |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static ConvergenceInformation |
parseFrom(com.google.protobuf.CodedInputStream input) |
static ConvergenceInformation |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static ConvergenceInformation |
parseFrom(java.io.InputStream input) |
static ConvergenceInformation |
parseFrom(java.io.InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<ConvergenceInformation> |
parser() |
ConvergenceInformation.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashFields, toStringaddAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitpublic static final int CANDIDATE_TYPE_FIELD_NUMBER
public static final int PRIMAL_OBJECTIVE_FIELD_NUMBER
public static final int DUAL_OBJECTIVE_FIELD_NUMBER
public static final int CORRECTED_DUAL_OBJECTIVE_FIELD_NUMBER
public static final int L_INF_PRIMAL_RESIDUAL_FIELD_NUMBER
public static final int L2_PRIMAL_RESIDUAL_FIELD_NUMBER
public static final int L_INF_COMPONENTWISE_PRIMAL_RESIDUAL_FIELD_NUMBER
public static final int L_INF_DUAL_RESIDUAL_FIELD_NUMBER
public static final int L2_DUAL_RESIDUAL_FIELD_NUMBER
public static final int L_INF_COMPONENTWISE_DUAL_RESIDUAL_FIELD_NUMBER
public static final int L_INF_PRIMAL_VARIABLE_FIELD_NUMBER
public static final int L2_PRIMAL_VARIABLE_FIELD_NUMBER
public static final int L_INF_DUAL_VARIABLE_FIELD_NUMBER
public static final int L2_DUAL_VARIABLE_FIELD_NUMBER
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessagepublic boolean hasCandidateType()
Type of the candidate point described by this ConvergenceInformation.
optional .operations_research.pdlp.PointType candidate_type = 1;hasCandidateType in interface ConvergenceInformationOrBuilderpublic PointType getCandidateType()
Type of the candidate point described by this ConvergenceInformation.
optional .operations_research.pdlp.PointType candidate_type = 1;getCandidateType in interface ConvergenceInformationOrBuilderpublic boolean hasPrimalObjective()
The primal objective. The primal need not be feasible.
optional double primal_objective = 2;hasPrimalObjective in interface ConvergenceInformationOrBuilderpublic double getPrimalObjective()
The primal objective. The primal need not be feasible.
optional double primal_objective = 2;getPrimalObjective in interface ConvergenceInformationOrBuilderpublic boolean hasDualObjective()
The dual objective. The dual need not be feasible. The dual objective includes the contributions from reduced costs. NOTE: The definition of dual_objective changed in OR-tools version 9.8. See https://developers.google.com/optimization/lp/pdlp_math#reduced_costs_dual_residuals_and_the_corrected_dual_objective for details.
optional double dual_objective = 3;hasDualObjective in interface ConvergenceInformationOrBuilderpublic double getDualObjective()
The dual objective. The dual need not be feasible. The dual objective includes the contributions from reduced costs. NOTE: The definition of dual_objective changed in OR-tools version 9.8. See https://developers.google.com/optimization/lp/pdlp_math#reduced_costs_dual_residuals_and_the_corrected_dual_objective for details.
optional double dual_objective = 3;getDualObjective in interface ConvergenceInformationOrBuilderpublic boolean hasCorrectedDualObjective()
If possible (e.g., when all primal variables have lower and upper bounds), a correct dual bound. The value is negative infinity if no corrected dual bound is available.
optional double corrected_dual_objective = 4;hasCorrectedDualObjective in interface ConvergenceInformationOrBuilderpublic double getCorrectedDualObjective()
If possible (e.g., when all primal variables have lower and upper bounds), a correct dual bound. The value is negative infinity if no corrected dual bound is available.
optional double corrected_dual_objective = 4;getCorrectedDualObjective in interface ConvergenceInformationOrBuilderpublic boolean hasLInfPrimalResidual()
The maximum violation of any primal constraint, i.e., the l_∞ norm of the violations.
optional double l_inf_primal_residual = 5;hasLInfPrimalResidual in interface ConvergenceInformationOrBuilderpublic double getLInfPrimalResidual()
The maximum violation of any primal constraint, i.e., the l_∞ norm of the violations.
optional double l_inf_primal_residual = 5;getLInfPrimalResidual in interface ConvergenceInformationOrBuilderpublic boolean hasL2PrimalResidual()
The l_2 norm of the violations of primal constraints.
optional double l2_primal_residual = 6;hasL2PrimalResidual in interface ConvergenceInformationOrBuilderpublic double getL2PrimalResidual()
The l_2 norm of the violations of primal constraints.
optional double l2_primal_residual = 6;getL2PrimalResidual in interface ConvergenceInformationOrBuilderpublic boolean hasLInfComponentwisePrimalResidual()
The maximum relative violation of any primal constraint, with an absolute offset, i.e., the l_∞ norm of [violation / (eps_ratio + |bound|)] where eps_ratio = eps_optimal_primal_residual_absolute / eps_optimal_primal_residual_relative and bound is the violated bound.
optional double l_inf_componentwise_primal_residual = 24;hasLInfComponentwisePrimalResidual in interface ConvergenceInformationOrBuilderpublic double getLInfComponentwisePrimalResidual()
The maximum relative violation of any primal constraint, with an absolute offset, i.e., the l_∞ norm of [violation / (eps_ratio + |bound|)] where eps_ratio = eps_optimal_primal_residual_absolute / eps_optimal_primal_residual_relative and bound is the violated bound.
optional double l_inf_componentwise_primal_residual = 24;getLInfComponentwisePrimalResidual in interface ConvergenceInformationOrBuilderpublic boolean hasLInfDualResidual()
The maximum violation of any dual constraint, i.e., the l_∞ norm of the violations.
optional double l_inf_dual_residual = 7;hasLInfDualResidual in interface ConvergenceInformationOrBuilderpublic double getLInfDualResidual()
The maximum violation of any dual constraint, i.e., the l_∞ norm of the violations.
optional double l_inf_dual_residual = 7;getLInfDualResidual in interface ConvergenceInformationOrBuilderpublic boolean hasL2DualResidual()
The l_2 norm of the violations of dual constraints.
optional double l2_dual_residual = 8;hasL2DualResidual in interface ConvergenceInformationOrBuilderpublic double getL2DualResidual()
The l_2 norm of the violations of dual constraints.
optional double l2_dual_residual = 8;getL2DualResidual in interface ConvergenceInformationOrBuilderpublic boolean hasLInfComponentwiseDualResidual()
The maximum relative violation of any dual constraint, with an absolute offset, i.e., the l_∞ norm of [violation / (eps_ratio + |objective|)] where eps_ratio = eps_optimal_dual_residual_absolute / eps_optimal_dual_residual_relative
optional double l_inf_componentwise_dual_residual = 25;hasLInfComponentwiseDualResidual in interface ConvergenceInformationOrBuilderpublic double getLInfComponentwiseDualResidual()
The maximum relative violation of any dual constraint, with an absolute offset, i.e., the l_∞ norm of [violation / (eps_ratio + |objective|)] where eps_ratio = eps_optimal_dual_residual_absolute / eps_optimal_dual_residual_relative
optional double l_inf_componentwise_dual_residual = 25;getLInfComponentwiseDualResidual in interface ConvergenceInformationOrBuilderpublic boolean hasLInfPrimalVariable()
The maximum absolute value of the primal variables, i.e., the l_∞ norm. This is useful to detect when the primal iterates are diverging. Divergence of the primal variables could be an algorithmic issue, or indicate that the dual is infeasible.
optional double l_inf_primal_variable = 14;hasLInfPrimalVariable in interface ConvergenceInformationOrBuilderpublic double getLInfPrimalVariable()
The maximum absolute value of the primal variables, i.e., the l_∞ norm. This is useful to detect when the primal iterates are diverging. Divergence of the primal variables could be an algorithmic issue, or indicate that the dual is infeasible.
optional double l_inf_primal_variable = 14;getLInfPrimalVariable in interface ConvergenceInformationOrBuilderpublic boolean hasL2PrimalVariable()
The l_2 norm of the primal variables.
optional double l2_primal_variable = 15;hasL2PrimalVariable in interface ConvergenceInformationOrBuilderpublic double getL2PrimalVariable()
The l_2 norm of the primal variables.
optional double l2_primal_variable = 15;getL2PrimalVariable in interface ConvergenceInformationOrBuilderpublic boolean hasLInfDualVariable()
The maximum absolute value of the dual variables, i.e., the l_∞ norm. This is useful to detect when the dual iterates are diverging. Divergence of the dual variables could be an algorithmic issue, or indicate the primal is infeasible.
optional double l_inf_dual_variable = 16;hasLInfDualVariable in interface ConvergenceInformationOrBuilderpublic double getLInfDualVariable()
The maximum absolute value of the dual variables, i.e., the l_∞ norm. This is useful to detect when the dual iterates are diverging. Divergence of the dual variables could be an algorithmic issue, or indicate the primal is infeasible.
optional double l_inf_dual_variable = 16;getLInfDualVariable in interface ConvergenceInformationOrBuilderpublic boolean hasL2DualVariable()
The l_2 norm of the dual variables.
optional double l2_dual_variable = 17;hasL2DualVariable in interface ConvergenceInformationOrBuilderpublic double getL2DualVariable()
The l_2 norm of the dual variables.
optional double l2_dual_variable = 17;getL2DualVariable in interface ConvergenceInformationOrBuilderpublic final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessagepublic void writeTo(com.google.protobuf.CodedOutputStream output)
throws java.io.IOException
writeTo in interface com.google.protobuf.MessageLitewriteTo in class com.google.protobuf.GeneratedMessagejava.io.IOExceptionpublic int getSerializedSize()
getSerializedSize in interface com.google.protobuf.MessageLitegetSerializedSize in class com.google.protobuf.GeneratedMessagepublic boolean equals(java.lang.Object obj)
equals in interface com.google.protobuf.Messageequals in class com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode in interface com.google.protobuf.MessagehashCode in class com.google.protobuf.AbstractMessagepublic static ConvergenceInformation parseFrom(java.nio.ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ConvergenceInformation parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ConvergenceInformation parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ConvergenceInformation parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ConvergenceInformation parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ConvergenceInformation parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ConvergenceInformation parseFrom(java.io.InputStream input) throws java.io.IOException
java.io.IOExceptionpublic static ConvergenceInformation parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
java.io.IOExceptionpublic static ConvergenceInformation parseDelimitedFrom(java.io.InputStream input) throws java.io.IOException
java.io.IOExceptionpublic static ConvergenceInformation parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
java.io.IOExceptionpublic static ConvergenceInformation parseFrom(com.google.protobuf.CodedInputStream input) throws java.io.IOException
java.io.IOExceptionpublic static ConvergenceInformation parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
java.io.IOExceptionpublic ConvergenceInformation.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static ConvergenceInformation.Builder newBuilder()
public static ConvergenceInformation.Builder newBuilder(ConvergenceInformation prototype)
public ConvergenceInformation.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected ConvergenceInformation.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
newBuilderForType in class com.google.protobuf.AbstractMessagepublic static ConvergenceInformation getDefaultInstance()
public static com.google.protobuf.Parser<ConvergenceInformation> parser()
public com.google.protobuf.Parser<ConvergenceInformation> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessagepublic ConvergenceInformation getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2024. All rights reserved.