Sleipnir C++ API
Loading...
Searching...
No Matches
slp::IterateDiagnosticsTable Class Reference

#include </home/runner/work/Sleipnir/Sleipnir/include/sleipnir/util/print_diagnostics.hpp>

Public Member Functions

template<typename Scalar >
 IterateDiagnosticsTable (bool print, Scalar error, Scalar cost, Scalar infeasibility, Scalar complementarity, Scalar μ)
 
 ~IterateDiagnosticsTable ()
 Prints the table bottom if requested.
 
 IterateDiagnosticsTable (const IterateDiagnosticsTable &)=delete
 
IterateDiagnosticsTable & operator= (const IterateDiagnosticsTable &)=delete
 

Detailed Description

Prints the iterate diagnostics table's heading and initial iterate on construction and the table's bottom on destruction.

Construct this where the iterate diagnostics table should start, so every solver exit after that closes the table and every exit before it doesn't.

Constructor & Destructor Documentation

◆ IterateDiagnosticsTable()

template<typename Scalar >
slp::IterateDiagnosticsTable::IterateDiagnosticsTable ( bool  print,
Scalar  error,
Scalar  cost,
Scalar  infeasibility,
Scalar  complementarity,
Scalar  μ 
)
inline

Prints the table heading and initial iterate diagnostics if requested.

Template Parameters
ScalarScalar type.
Parameters
printWhether to print the table.
errorThe error.
costThe cost.
infeasibilityThe infeasibility.
complementarityThe complementarity.
μThe barrier parameter.

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