MoochoPack::MoochoTrackerSummaryStd Class Reference

This class simply outputs the convergence information for each iteration. More...

#include <MoochoPack_MoochoTrackerSummaryStd.hpp>

Inheritance diagram for MoochoPack::MoochoTrackerSummaryStd:

Public Types
enum	EOptError

Public Member Functions
	MoochoTrackerSummaryStd (const ostream_ptr_t &o, const ostream_ptr_t &journal_out, EOptError opt_error=OPT_ERROR_REDUCED_GRADIENT_LAGR)
	Construct with an output stream. More...
void	set_output_stream (const ostream_ptr_t &o)
	Set the output stream for summary outputting. More...
const ostream_ptr_t &	get_output_stream () const
	Get the output stream for summary outputting. More...
int	num_total_qp_iter () const
	Output the total number of qp iterations back to and the k=0 iteration. More...

Protected Member Functions
void	print_header (const NLPAlgoState &s) const
	Print the header to the output. More...

Overridden from AlgorithmTracker
void	output_iteration (const Algorithm &algo) const
void	output_final (const Algorithm &algo, EAlgoReturn algo_return) const

Detailed Description

This class simply outputs the convergence information for each iteration.

Definition at line 55 of file MoochoPack_MoochoTrackerSummaryStd.hpp.

Member Enumeration Documentation

enum MoochoPack::MoochoTrackerSummaryStd::EOptError

Definition at line 61 of file MoochoPack_MoochoTrackerSummaryStd.hpp.

Constructor & Destructor Documentation

MoochoPack::MoochoTrackerSummaryStd::MoochoTrackerSummaryStd	(	const ostream_ptr_t &	o,
		const ostream_ptr_t &	journal_out,
		EOptError	opt_error = OPT_ERROR_REDUCED_GRADIENT_LAGR
	)

Construct with an output stream.

Member Function Documentation

void MoochoPack::MoochoTrackerSummaryStd::set_output_stream

(

const ostream_ptr_t &

o

)

Set the output stream for summary outputting.

Definition at line 70 of file MoochoPack_MoochoTrackerSummaryStd.cpp.

const MoochoTrackerSummaryStd::ostream_ptr_t & MoochoPack::MoochoTrackerSummaryStd::get_output_stream

(

)

const

Get the output stream for summary outputting.

Definition at line 76 of file MoochoPack_MoochoTrackerSummaryStd.cpp.

int MoochoPack::MoochoTrackerSummaryStd::num_total_qp_iter ( ) const

inline

Output the total number of qp iterations back to and the k=0 iteration.

Definition at line 79 of file MoochoPack_MoochoTrackerSummaryStd.hpp.

void MoochoPack::MoochoTrackerSummaryStd::output_iteration ( const Algorithm &  algo ) const

virtual

Reimplemented from IterationPack::AlgorithmTracker.

Definition at line 81 of file MoochoPack_MoochoTrackerSummaryStd.cpp.

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

virtual

Reimplemented from IterationPack::AlgorithmTracker.

Definition at line 248 of file MoochoPack_MoochoTrackerSummaryStd.cpp.

void MoochoPack::MoochoTrackerSummaryStd::print_header ( const NLPAlgoState &  s ) const

protected

Print the header to the output.

Definition at line 424 of file MoochoPack_MoochoTrackerSummaryStd.cpp.

---

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

• MoochoPack_MoochoTrackerSummaryStd.hpp
• MoochoPack_MoochoTrackerSummaryStd.cpp