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:

[legend]
List of all members.

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
 

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.
std::ostream & o () const

Private Types

 NUM_PRINT_LINES = 10
enum  { NUM_PRINT_LINES = 10 }

Private Member Functions

 MoochoTrackerConsoleStd ()

Private Attributes

ostream_ptr_t o_
StopWatchPack::stopwatch timer_
int printed_lines_
quasi_newton_stats_iq_member quasi_newton_stats_

Static Private Attributes

static int w_i2_ = 2
static char ul_i2_ [] = "--"
static int w_i4_ = 4
static char ul_i4_ [] = "----"
static int p2_ = 1
static int w_p2_ = 8
static char ul_p2_ [] = "--------"
static int p3_ = 2
static int w_p3_ = 9
static char ul_p3_ [] = "---------"

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 96 of file MoochoPack_MoochoTrackerConsoleStd.hpp.


Member Enumeration Documentation

anonymous enum [private]

Enumerator:
NUM_PRINT_LINES 

Definition at line 138 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 60 of file MoochoPack_MoochoTrackerConsoleStd.cpp.

MoochoPack::MoochoTrackerConsoleStd::MoochoTrackerConsoleStd (  )  [private]


Member Function Documentation

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

Set the output stream for console outputting.

Definition at line 69 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 75 of file MoochoPack_MoochoTrackerConsoleStd.cpp.

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

Restarts the timer.

Reimplemented from IterationPack::AlgorithmTracker.

Definition at line 80 of file MoochoPack_MoochoTrackerConsoleStd.cpp.

void MoochoPack::MoochoTrackerConsoleStd::output_iteration ( const Algorithm algo  )  const [virtual]

Reimplemented from IterationPack::AlgorithmTracker.

Definition at line 86 of file MoochoPack_MoochoTrackerConsoleStd.cpp.

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

Definition at line 201 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 368 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 400 of file MoochoPack_MoochoTrackerConsoleStd.cpp.

std::ostream& MoochoPack::MoochoTrackerConsoleStd::o (  )  const [inline, protected]

Definition at line 130 of file MoochoPack_MoochoTrackerConsoleStd.hpp.


Member Data Documentation

ostream_ptr_t MoochoPack::MoochoTrackerConsoleStd::o_ [private]

Definition at line 143 of file MoochoPack_MoochoTrackerConsoleStd.hpp.

StopWatchPack::stopwatch MoochoPack::MoochoTrackerConsoleStd::timer_ [mutable, private]

Definition at line 144 of file MoochoPack_MoochoTrackerConsoleStd.hpp.

int MoochoPack::MoochoTrackerConsoleStd::printed_lines_ [mutable, private]

Definition at line 145 of file MoochoPack_MoochoTrackerConsoleStd.hpp.

quasi_newton_stats_iq_member MoochoPack::MoochoTrackerConsoleStd::quasi_newton_stats_ [private]

Definition at line 146 of file MoochoPack_MoochoTrackerConsoleStd.hpp.

int MoochoPack::MoochoTrackerConsoleStd::w_i2_ = 2 [static, private]

Definition at line 149 of file MoochoPack_MoochoTrackerConsoleStd.hpp.

char MoochoPack::MoochoTrackerConsoleStd::ul_i2_ = "--" [static, private]

Definition at line 150 of file MoochoPack_MoochoTrackerConsoleStd.hpp.

int MoochoPack::MoochoTrackerConsoleStd::w_i4_ = 4 [static, private]

Definition at line 151 of file MoochoPack_MoochoTrackerConsoleStd.hpp.

char MoochoPack::MoochoTrackerConsoleStd::ul_i4_ = "----" [static, private]

Definition at line 152 of file MoochoPack_MoochoTrackerConsoleStd.hpp.

int MoochoPack::MoochoTrackerConsoleStd::p2_ = 1 [static, private]

Definition at line 153 of file MoochoPack_MoochoTrackerConsoleStd.hpp.

int MoochoPack::MoochoTrackerConsoleStd::w_p2_ = 8 [static, private]

Definition at line 154 of file MoochoPack_MoochoTrackerConsoleStd.hpp.

char MoochoPack::MoochoTrackerConsoleStd::ul_p2_ = "--------" [static, private]

Definition at line 155 of file MoochoPack_MoochoTrackerConsoleStd.hpp.

int MoochoPack::MoochoTrackerConsoleStd::p3_ = 2 [static, private]

Definition at line 156 of file MoochoPack_MoochoTrackerConsoleStd.hpp.

int MoochoPack::MoochoTrackerConsoleStd::w_p3_ = 9 [static, private]

Definition at line 157 of file MoochoPack_MoochoTrackerConsoleStd.hpp.

char MoochoPack::MoochoTrackerConsoleStd::ul_p3_ = "---------" [static, private]

Definition at line 158 of file MoochoPack_MoochoTrackerConsoleStd.hpp.


The documentation for this class was generated from the following files:
Generated on Tue Oct 20 12:54:17 2009 for MOOCHO (Single Doxygen Collection) by doxygen 1.4.7