Class SolveLog

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.ortools.pdlp.SolveLog
All Implemented Interfaces:
SolveLogOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class SolveLog extends com.google.protobuf.GeneratedMessage implements SolveLogOrBuilder
Protobuf type operations_research.pdlp.SolveLog
See Also:

  • Field Details

    • INSTANCE_NAME_FIELD_NUMBER

      public static final int INSTANCE_NAME_FIELD_NUMBER
      See Also:

    • PARAMS_FIELD_NUMBER

      public static final int PARAMS_FIELD_NUMBER
      See Also:

    • TERMINATION_REASON_FIELD_NUMBER

      public static final int TERMINATION_REASON_FIELD_NUMBER
      See Also:

    • TERMINATION_STRING_FIELD_NUMBER

      public static final int TERMINATION_STRING_FIELD_NUMBER
      See Also:

    • ITERATION_COUNT_FIELD_NUMBER

      public static final int ITERATION_COUNT_FIELD_NUMBER
      See Also:

    • PREPROCESSING_TIME_SEC_FIELD_NUMBER

      public static final int PREPROCESSING_TIME_SEC_FIELD_NUMBER
      See Also:

    • SOLVE_TIME_SEC_FIELD_NUMBER

      public static final int SOLVE_TIME_SEC_FIELD_NUMBER
      See Also:

    • SOLUTION_STATS_FIELD_NUMBER

      public static final int SOLUTION_STATS_FIELD_NUMBER
      See Also:

    • SOLUTION_TYPE_FIELD_NUMBER

      public static final int SOLUTION_TYPE_FIELD_NUMBER
      See Also:

    • ITERATION_STATS_FIELD_NUMBER

      public static final int ITERATION_STATS_FIELD_NUMBER
      See Also:

    • ORIGINAL_PROBLEM_STATS_FIELD_NUMBER

      public static final int ORIGINAL_PROBLEM_STATS_FIELD_NUMBER
      See Also:

    • PREPROCESSED_PROBLEM_STATS_FIELD_NUMBER

      public static final int PREPROCESSED_PROBLEM_STATS_FIELD_NUMBER
      See Also:

    • FEASIBILITY_POLISHING_DETAILS_FIELD_NUMBER

      public static final int FEASIBILITY_POLISHING_DETAILS_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • hasInstanceName

      public boolean hasInstanceName()
       The name of the optimization problem.
      optional string instance_name = 1;
      Specified by:
      hasInstanceName in interface SolveLogOrBuilder
      Returns:
      Whether the instanceName field is set.

    • getInstanceName

      public String getInstanceName()
       The name of the optimization problem.
      optional string instance_name = 1;
      Specified by:
      getInstanceName in interface SolveLogOrBuilder
      Returns:
      The instanceName.

    • getInstanceNameBytes

      public com.google.protobuf.ByteString getInstanceNameBytes()
       The name of the optimization problem.
      optional string instance_name = 1;
      Specified by:
      getInstanceNameBytes in interface SolveLogOrBuilder
      Returns:
      The bytes for instanceName.

    • hasParams

      public boolean hasParams()
       If solved with PDLP, the parameters for this solve.
      optional .operations_research.pdlp.PrimalDualHybridGradientParams params = 14;
      Specified by:
      hasParams in interface SolveLogOrBuilder
      Returns:
      Whether the params field is set.

    • getParams

      public PrimalDualHybridGradientParams getParams()
       If solved with PDLP, the parameters for this solve.
      optional .operations_research.pdlp.PrimalDualHybridGradientParams params = 14;
      Specified by:
      getParams in interface SolveLogOrBuilder
      Returns:
      The params.

    • getParamsOrBuilder

      public PrimalDualHybridGradientParamsOrBuilder getParamsOrBuilder()
       If solved with PDLP, the parameters for this solve.
      optional .operations_research.pdlp.PrimalDualHybridGradientParams params = 14;
      Specified by:
      getParamsOrBuilder in interface SolveLogOrBuilder

    • hasTerminationReason

      public boolean hasTerminationReason()
       The reason that the solve terminated.
      optional .operations_research.pdlp.TerminationReason termination_reason = 3;
      Specified by:
      hasTerminationReason in interface SolveLogOrBuilder
      Returns:
      Whether the terminationReason field is set.

    • getTerminationReason

      public TerminationReason getTerminationReason()
       The reason that the solve terminated.
      optional .operations_research.pdlp.TerminationReason termination_reason = 3;
      Specified by:
      getTerminationReason in interface SolveLogOrBuilder
      Returns:
      The terminationReason.

    • hasTerminationString

      public boolean hasTerminationString()
       Optional extra information about the termination reason.
      optional string termination_string = 4;
      Specified by:
      hasTerminationString in interface SolveLogOrBuilder
      Returns:
      Whether the terminationString field is set.

    • getTerminationString

      public String getTerminationString()
       Optional extra information about the termination reason.
      optional string termination_string = 4;
      Specified by:
      getTerminationString in interface SolveLogOrBuilder
      Returns:
      The terminationString.

    • getTerminationStringBytes

      public com.google.protobuf.ByteString getTerminationStringBytes()
       Optional extra information about the termination reason.
      optional string termination_string = 4;
      Specified by:
      getTerminationStringBytes in interface SolveLogOrBuilder
      Returns:
      The bytes for terminationString.

    • hasIterationCount

      public boolean hasIterationCount()
       The total number of iterations during the solve. For a solve with
 `use_feasibility_polishing` this count includes the iterations from
 the feasibility polishing phases.
      optional int32 iteration_count = 5;
      Specified by:
      hasIterationCount in interface SolveLogOrBuilder
      Returns:
      Whether the iterationCount field is set.

    • getIterationCount

      public int getIterationCount()
       The total number of iterations during the solve. For a solve with
 `use_feasibility_polishing` this count includes the iterations from
 the feasibility polishing phases.
      optional int32 iteration_count = 5;
      Specified by:
      getIterationCount in interface SolveLogOrBuilder
      Returns:
      The iterationCount.

    • hasPreprocessingTimeSec

      public boolean hasPreprocessingTimeSec()
       Time for preprocessing (everything before iteration 0). This is also
 included in `solve_time_sec`.
      optional double preprocessing_time_sec = 13;
      Specified by:
      hasPreprocessingTimeSec in interface SolveLogOrBuilder
      Returns:
      Whether the preprocessingTimeSec field is set.

    • getPreprocessingTimeSec

      public double getPreprocessingTimeSec()
       Time for preprocessing (everything before iteration 0). This is also
 included in `solve_time_sec`.
      optional double preprocessing_time_sec = 13;
      Specified by:
      getPreprocessingTimeSec in interface SolveLogOrBuilder
      Returns:
      The preprocessingTimeSec.

    • hasSolveTimeSec

      public boolean hasSolveTimeSec()
       The runtime of the solve. Note: This should not be used for comparing
 methods unless care is taken to control for noise in runtime measurement.
 For a solve with `use_feasibility_polishing` this count includes the
 iterations from the feasibility polishing phases.
      optional double solve_time_sec = 6;
      Specified by:
      hasSolveTimeSec in interface SolveLogOrBuilder
      Returns:
      Whether the solveTimeSec field is set.

    • getSolveTimeSec

      public double getSolveTimeSec()
       The runtime of the solve. Note: This should not be used for comparing
 methods unless care is taken to control for noise in runtime measurement.
 For a solve with `use_feasibility_polishing` this count includes the
 iterations from the feasibility polishing phases.
      optional double solve_time_sec = 6;
      Specified by:
      getSolveTimeSec in interface SolveLogOrBuilder
      Returns:
      The solveTimeSec.

    • hasSolutionStats

      public boolean hasSolutionStats()
       The `IterationStats` for the final iteration of the solver. For a solve
 with `use_feasibility_polishing`, the work metrics (iteration_count,
 cumulative_kkt_matrix_passes, etc.) will include the work done in the
 feasibility polishing phases.
 NOTE: Regardless of preprocessing (i.e. scaling or presolve) the optimality
 or infeasibility information is evaluated with respect to the original
 problem.
      optional .operations_research.pdlp.IterationStats solution_stats = 8;
      Specified by:
      hasSolutionStats in interface SolveLogOrBuilder
      Returns:
      Whether the solutionStats field is set.

    • getSolutionStats

      public IterationStats getSolutionStats()
       The `IterationStats` for the final iteration of the solver. For a solve
 with `use_feasibility_polishing`, the work metrics (iteration_count,
 cumulative_kkt_matrix_passes, etc.) will include the work done in the
 feasibility polishing phases.
 NOTE: Regardless of preprocessing (i.e. scaling or presolve) the optimality
 or infeasibility information is evaluated with respect to the original
 problem.
      optional .operations_research.pdlp.IterationStats solution_stats = 8;
      Specified by:
      getSolutionStats in interface SolveLogOrBuilder
      Returns:
      The solutionStats.

    • getSolutionStatsOrBuilder

      public IterationStatsOrBuilder getSolutionStatsOrBuilder()
       The `IterationStats` for the final iteration of the solver. For a solve
 with `use_feasibility_polishing`, the work metrics (iteration_count,
 cumulative_kkt_matrix_passes, etc.) will include the work done in the
 feasibility polishing phases.
 NOTE: Regardless of preprocessing (i.e. scaling or presolve) the optimality
 or infeasibility information is evaluated with respect to the original
 problem.
      optional .operations_research.pdlp.IterationStats solution_stats = 8;
      Specified by:
      getSolutionStatsOrBuilder in interface SolveLogOrBuilder

    • hasSolutionType

      public boolean hasSolutionType()
       The type of the output point that the solver returned. The quality of the
 point is reported in the corresponding entry of
 solution_stats.convergence_information and/or
 solution_stats.infeasibility_information. If termination_reason is
 TERMINATION_REASON_OPTIMAL, it's guaranteed that the corresponding entry of
 solution_stats.convergence_information satisfies the optimality conditions.
 Similarly, if termination_reason is either
 TERMINATION_REASON_PRIMAL_INFEASIBLE or TERMINATION_REASON_DUAL_INFEASIBLE
 the corresponding entry of solution_stats.infeasibility_information
 satisifes conditions for declaring primal or dual infeasibility,
 respectively.
 If termination_reason is anything else, e.g. TERMINATION_REASON_TIME_LIMIT
 or TERMINATION_REASON_PRIMAL_OR_DUAL_INFEASIBLE, the solution may not
 satisfy the optimality or infeasibility conditions.
      optional .operations_research.pdlp.PointType solution_type = 10;
      Specified by:
      hasSolutionType in interface SolveLogOrBuilder
      Returns:
      Whether the solutionType field is set.

    • getSolutionType

      public PointType getSolutionType()
       The type of the output point that the solver returned. The quality of the
 point is reported in the corresponding entry of
 solution_stats.convergence_information and/or
 solution_stats.infeasibility_information. If termination_reason is
 TERMINATION_REASON_OPTIMAL, it's guaranteed that the corresponding entry of
 solution_stats.convergence_information satisfies the optimality conditions.
 Similarly, if termination_reason is either
 TERMINATION_REASON_PRIMAL_INFEASIBLE or TERMINATION_REASON_DUAL_INFEASIBLE
 the corresponding entry of solution_stats.infeasibility_information
 satisifes conditions for declaring primal or dual infeasibility,
 respectively.
 If termination_reason is anything else, e.g. TERMINATION_REASON_TIME_LIMIT
 or TERMINATION_REASON_PRIMAL_OR_DUAL_INFEASIBLE, the solution may not
 satisfy the optimality or infeasibility conditions.
      optional .operations_research.pdlp.PointType solution_type = 10;
      Specified by:
      getSolutionType in interface SolveLogOrBuilder
      Returns:
      The solutionType.

    • getIterationStatsList

      public List<IterationStats> getIterationStatsList()
       A history of iteration stats for the solve. The iteration_number fields
 should be in increasing order. The frequency at which these stats should be
 recorded is not specified. This field is "more" optional than the others
 because it often significantly increases the size of the message, and
 because the information may not be available for third-party solvers.
 For a solve with `use_feasibility_polishing`, these iteration stats will
 only reflect the work done in the main iterations (not the feasibility
 polishing phases).
      repeated .operations_research.pdlp.IterationStats iteration_stats = 7;
      Specified by:
      getIterationStatsList in interface SolveLogOrBuilder

    • getIterationStatsOrBuilderList

      public List<? extends IterationStatsOrBuilder> getIterationStatsOrBuilderList()
       A history of iteration stats for the solve. The iteration_number fields
 should be in increasing order. The frequency at which these stats should be
 recorded is not specified. This field is "more" optional than the others
 because it often significantly increases the size of the message, and
 because the information may not be available for third-party solvers.
 For a solve with `use_feasibility_polishing`, these iteration stats will
 only reflect the work done in the main iterations (not the feasibility
 polishing phases).
      repeated .operations_research.pdlp.IterationStats iteration_stats = 7;
      Specified by:
      getIterationStatsOrBuilderList in interface SolveLogOrBuilder

    • getIterationStatsCount

      public int getIterationStatsCount()
       A history of iteration stats for the solve. The iteration_number fields
 should be in increasing order. The frequency at which these stats should be
 recorded is not specified. This field is "more" optional than the others
 because it often significantly increases the size of the message, and
 because the information may not be available for third-party solvers.
 For a solve with `use_feasibility_polishing`, these iteration stats will
 only reflect the work done in the main iterations (not the feasibility
 polishing phases).
      repeated .operations_research.pdlp.IterationStats iteration_stats = 7;
      Specified by:
      getIterationStatsCount in interface SolveLogOrBuilder

    • getIterationStats

      public IterationStats getIterationStats(int index)
       A history of iteration stats for the solve. The iteration_number fields
 should be in increasing order. The frequency at which these stats should be
 recorded is not specified. This field is "more" optional than the others
 because it often significantly increases the size of the message, and
 because the information may not be available for third-party solvers.
 For a solve with `use_feasibility_polishing`, these iteration stats will
 only reflect the work done in the main iterations (not the feasibility
 polishing phases).
      repeated .operations_research.pdlp.IterationStats iteration_stats = 7;
      Specified by:
      getIterationStats in interface SolveLogOrBuilder

    • getIterationStatsOrBuilder

      public IterationStatsOrBuilder getIterationStatsOrBuilder(int index)
       A history of iteration stats for the solve. The iteration_number fields
 should be in increasing order. The frequency at which these stats should be
 recorded is not specified. This field is "more" optional than the others
 because it often significantly increases the size of the message, and
 because the information may not be available for third-party solvers.
 For a solve with `use_feasibility_polishing`, these iteration stats will
 only reflect the work done in the main iterations (not the feasibility
 polishing phases).
      repeated .operations_research.pdlp.IterationStats iteration_stats = 7;
      Specified by:
      getIterationStatsOrBuilder in interface SolveLogOrBuilder

    • hasOriginalProblemStats

      public boolean hasOriginalProblemStats()
       Statistics of the original problem.
      optional .operations_research.pdlp.QuadraticProgramStats original_problem_stats = 11;
      Specified by:
      hasOriginalProblemStats in interface SolveLogOrBuilder
      Returns:
      Whether the originalProblemStats field is set.

    • getOriginalProblemStats

      public QuadraticProgramStats getOriginalProblemStats()
       Statistics of the original problem.
      optional .operations_research.pdlp.QuadraticProgramStats original_problem_stats = 11;
      Specified by:
      getOriginalProblemStats in interface SolveLogOrBuilder
      Returns:
      The originalProblemStats.

    • getOriginalProblemStatsOrBuilder

      public QuadraticProgramStatsOrBuilder getOriginalProblemStatsOrBuilder()
       Statistics of the original problem.
      optional .operations_research.pdlp.QuadraticProgramStats original_problem_stats = 11;
      Specified by:
      getOriginalProblemStatsOrBuilder in interface SolveLogOrBuilder

    • hasPreprocessedProblemStats

      public boolean hasPreprocessedProblemStats()
       Statistics of the problem after preprocessing.
      optional .operations_research.pdlp.QuadraticProgramStats preprocessed_problem_stats = 12;
      Specified by:
      hasPreprocessedProblemStats in interface SolveLogOrBuilder
      Returns:
      Whether the preprocessedProblemStats field is set.

    • getPreprocessedProblemStats

      public QuadraticProgramStats getPreprocessedProblemStats()
       Statistics of the problem after preprocessing.
      optional .operations_research.pdlp.QuadraticProgramStats preprocessed_problem_stats = 12;
      Specified by:
      getPreprocessedProblemStats in interface SolveLogOrBuilder
      Returns:
      The preprocessedProblemStats.

    • getPreprocessedProblemStatsOrBuilder

      public QuadraticProgramStatsOrBuilder getPreprocessedProblemStatsOrBuilder()
       Statistics of the problem after preprocessing.
      optional .operations_research.pdlp.QuadraticProgramStats preprocessed_problem_stats = 12;
      Specified by:
      getPreprocessedProblemStatsOrBuilder in interface SolveLogOrBuilder

    • getFeasibilityPolishingDetailsList

      public List<FeasibilityPolishingDetails> getFeasibilityPolishingDetailsList()
       If solving with `use_feasibility_polishing`, details about the primal and
 dual feasibility polishing phases.
      repeated .operations_research.pdlp.FeasibilityPolishingDetails feasibility_polishing_details = 15;
      Specified by:
      getFeasibilityPolishingDetailsList in interface SolveLogOrBuilder

    • getFeasibilityPolishingDetailsOrBuilderList

      public List<? extends FeasibilityPolishingDetailsOrBuilder> getFeasibilityPolishingDetailsOrBuilderList()
       If solving with `use_feasibility_polishing`, details about the primal and
 dual feasibility polishing phases.
      repeated .operations_research.pdlp.FeasibilityPolishingDetails feasibility_polishing_details = 15;
      Specified by:
      getFeasibilityPolishingDetailsOrBuilderList in interface SolveLogOrBuilder

    • getFeasibilityPolishingDetailsCount

      public int getFeasibilityPolishingDetailsCount()
       If solving with `use_feasibility_polishing`, details about the primal and
 dual feasibility polishing phases.
      repeated .operations_research.pdlp.FeasibilityPolishingDetails feasibility_polishing_details = 15;
      Specified by:
      getFeasibilityPolishingDetailsCount in interface SolveLogOrBuilder

    • getFeasibilityPolishingDetails

      public FeasibilityPolishingDetails getFeasibilityPolishingDetails(int index)
       If solving with `use_feasibility_polishing`, details about the primal and
 dual feasibility polishing phases.
      repeated .operations_research.pdlp.FeasibilityPolishingDetails feasibility_polishing_details = 15;
      Specified by:
      getFeasibilityPolishingDetails in interface SolveLogOrBuilder

    • getFeasibilityPolishingDetailsOrBuilder

      public FeasibilityPolishingDetailsOrBuilder getFeasibilityPolishingDetailsOrBuilder(int index)
       If solving with `use_feasibility_polishing`, details about the primal and
 dual feasibility polishing phases.
      repeated .operations_research.pdlp.FeasibilityPolishingDetails feasibility_polishing_details = 15;
      Specified by:
      getFeasibilityPolishingDetailsOrBuilder in interface SolveLogOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static SolveLog parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SolveLog parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SolveLog parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SolveLog parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SolveLog parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SolveLog parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SolveLog parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static SolveLog parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static SolveLog parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static SolveLog parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static SolveLog parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static SolveLog parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public SolveLog.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static SolveLog.Builder newBuilder()

    • newBuilder

      public static SolveLog.Builder newBuilder(SolveLog prototype)

    • toBuilder

      public SolveLog.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected SolveLog.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static SolveLog getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<SolveLog> parser()

    • getParserForType

      public com.google.protobuf.Parser<SolveLog> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public SolveLog getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder