MoochoPack : Framework for Large-Scale Optimization Algorithms Version of the Day
Public Member Functions | Protected Member Functions
MoochoPack::MoochoTrackerConsoleStd Class Reference

This rSQP iteration class provides a tablular output suitable for an 80 char wide console. More...

#include <MoochoPack_MoochoTrackerConsoleStd.hpp>

Inheritance diagram for MoochoPack::MoochoTrackerConsoleStd:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 MoochoTrackerConsoleStd (const ostream_ptr_t &o, const ostream_ptr_t &journal_out)
 Construct with an output stream (console presumably)
void set_output_stream (const ostream_ptr_t &o)
 Set the output stream for console outputting.
const ostream_ptr_tget_output_stream () const
 Get the output stream for console outputting.

Protected Member Functions

void print_top_header (const NLPAlgoState &s, const NLPAlgo &algo) const
 Print the top header to the output.
void print_header (const NLPAlgoState &s, const NLPAlgo &algo) const
 Print the header to the output.

Overridden from AlgorithmTracker

void initialize ()
 Restarts the timer.
void output_iteration (const Algorithm &algo) const
 
void output_final (const Algorithm &algo, EAlgoReturn algo_return) const
 

Detailed Description

This rSQP iteration class provides a tablular output suitable for an 80 char wide console.

Specifically, these object produces a table with the following fields:

The above quantities can tell you a lot about the progress of the SQP algorithm.

ToDo: Finish discussion.

After the algorithm is finished the total solution time will be printed as well as if the solution was found or not. Also, the number of function and gradient evaluations will be printed. Note that the timer is started from the moment this object is created or when set_output_stream(...) is called.

Definition at line 109 of file MoochoPack_MoochoTrackerConsoleStd.hpp.


Constructor & Destructor Documentation

MoochoPack::MoochoTrackerConsoleStd::MoochoTrackerConsoleStd ( const ostream_ptr_t o,
const ostream_ptr_t journal_out 
)

Construct with an output stream (console presumably)

Definition at line 73 of file MoochoPack_MoochoTrackerConsoleStd.cpp.


Member Function Documentation

void MoochoPack::MoochoTrackerConsoleStd::set_output_stream ( const ostream_ptr_t o)

Set the output stream for console outputting.

Definition at line 82 of file MoochoPack_MoochoTrackerConsoleStd.cpp.

const MoochoTrackerConsoleStd::ostream_ptr_t & MoochoPack::MoochoTrackerConsoleStd::get_output_stream ( ) const

Get the output stream for console outputting.

Definition at line 88 of file MoochoPack_MoochoTrackerConsoleStd.cpp.

void MoochoPack::MoochoTrackerConsoleStd::initialize ( ) [virtual]

Restarts the timer.

Reimplemented from AlgorithmTracker.

Definition at line 93 of file MoochoPack_MoochoTrackerConsoleStd.cpp.

void MoochoPack::MoochoTrackerConsoleStd::output_iteration ( const Algorithm algo) const

Definition at line 99 of file MoochoPack_MoochoTrackerConsoleStd.cpp.

void MoochoPack::MoochoTrackerConsoleStd::output_final ( const Algorithm algo,
EAlgoReturn  algo_return 
) const

Definition at line 214 of file MoochoPack_MoochoTrackerConsoleStd.cpp.

void MoochoPack::MoochoTrackerConsoleStd::print_top_header ( const NLPAlgoState s,
const NLPAlgo algo 
) const [protected]

Print the top header to the output.

Definition at line 381 of file MoochoPack_MoochoTrackerConsoleStd.cpp.

void MoochoPack::MoochoTrackerConsoleStd::print_header ( const NLPAlgoState s,
const NLPAlgo algo 
) const [protected]

Print the header to the output.

Definition at line 413 of file MoochoPack_MoochoTrackerConsoleStd.cpp.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends