MOOCHO (Single Doxygen Collection)
Version of the Day
|
This is a simple track class for getting statistics about a solved (or not solved) NLP. More...
#include <MoochoPack_MoochoTrackerStatsStd.hpp>
Public Member Functions | |
MoochoTrackerStatsStd (const ostream_ptr_t &o, const ostream_ptr_t &journal_out) | |
Construct with an output stream object. More... | |
void | set_output_stream (const ostream_ptr_t &o) |
const ostream_ptr_t & | get_output_stream () const |
Get the output stream for statistics outputting. More... | |
Public Member Functions inherited from IterationPack::AlgorithmTracker | |
virtual | ~AlgorithmTracker () |
AlgorithmTracker (const ostream_ptr_t &journal_out) | |
Construct with an output stream for journal_out. More... | |
virtual void | output_final (const Algorithm &algo, EAlgoReturn algo_return) const |
Output information about a just completed algorithm. More... | |
virtual void | set_journal_out (const ostream_ptr_t &journal_out) |
Set a smart pointer to the journal file. More... | |
const ostream_ptr_t & | get_journal_out () const |
Get the smart pointer to the journal file. More... | |
virtual std::ostream & | journal_out () const |
Return a reference to a std::ostream to be used to output debug information and the like. More... | |
Protected Member Functions | |
std::ostream & | o () const |
Private Member Functions | |
MoochoTrackerStatsStd () | |
Private Attributes | |
ostream_ptr_t | o_ |
int | num_QN_updates_ |
quasi_newton_stats_iq_member | quasi_newton_stats_ |
StopWatchPack::stopwatch | timer_ |
Overridden from AlgorithmTracker | |
void | initialize () |
Restarts the timer. More... | |
void | output_iteration (const Algorithm &algo) const |
void | output_final (const Algorithm &algo, EAlgoReturn algo_return) const |
This is a simple track class for getting statistics about a solved (or not solved) NLP.
When output_final(...) is called the output stream will have the following written to it:
{verbatim} status = solved; # solved, except, max_iter, max_run_time niter = 10; # Number of rSQP iterations nfunc = 15; # max( number f(x) evals, number c(x) evals ) ngrad = 13; # max( number Gf(x) evals, number Gc(x) evals ) CPU = 0.50; # Number of CPU seconds total obj_func = 1.046e-2; # Objective function value f(x) at final point feas_kkt_err = 2.457e-10; # Feasibility error at final point (scaled ||c(x)||inf) opt_kkt_err = 4.568e-7; # Optimality error at final point (scaled ||rGL||inf) nact = 40; # Number of total active constraints at the final point nbasis_change = 1; # Number of basis changes nquasi_newton = 6; # Number of quasi-newton updates {verbatim}
Any statistic that is not known will be given the value '-'. If the returned status is 'execpt' then some exception was thrown or some other error occured so current information may not be available. In this case every effort is made to fill the rest of the information from prior iterations. The names of these fields will not change and the 'stat = value; # comment' format can be counted. However, the spacing and the precision of the numbers may be different from what is shown above.
Definition at line 79 of file MoochoPack_MoochoTrackerStatsStd.hpp.
MoochoPack::MoochoTrackerStatsStd::MoochoTrackerStatsStd | ( | const ostream_ptr_t & | o, |
const ostream_ptr_t & | journal_out | ||
) |
Construct with an output stream object.
Definition at line 67 of file MoochoPack_MoochoTrackerStatsStd.cpp.
|
private |
void MoochoPack::MoochoTrackerStatsStd::set_output_stream | ( | const ostream_ptr_t & | o | ) |
Definition at line 75 of file MoochoPack_MoochoTrackerStatsStd.cpp.
const MoochoTrackerStatsStd::ostream_ptr_t & MoochoPack::MoochoTrackerStatsStd::get_output_stream | ( | ) | const |
Get the output stream for statistics outputting.
Definition at line 81 of file MoochoPack_MoochoTrackerStatsStd.cpp.
|
virtual |
Restarts the timer.
Reimplemented from IterationPack::AlgorithmTracker.
Definition at line 86 of file MoochoPack_MoochoTrackerStatsStd.cpp.
Reimplemented from IterationPack::AlgorithmTracker.
Definition at line 93 of file MoochoPack_MoochoTrackerStatsStd.cpp.
void MoochoPack::MoochoTrackerStatsStd::output_final | ( | const Algorithm & | algo, |
EAlgoReturn | algo_return | ||
) | const |
Definition at line 110 of file MoochoPack_MoochoTrackerStatsStd.cpp.
|
inlineprotected |
Definition at line 109 of file MoochoPack_MoochoTrackerStatsStd.hpp.
|
private |
Definition at line 113 of file MoochoPack_MoochoTrackerStatsStd.hpp.
|
mutableprivate |
Definition at line 114 of file MoochoPack_MoochoTrackerStatsStd.hpp.
|
private |
Definition at line 115 of file MoochoPack_MoochoTrackerStatsStd.hpp.
|
mutableprivate |
Definition at line 116 of file MoochoPack_MoochoTrackerStatsStd.hpp.