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 { OPT_ERROR_REDUCED_GRADIENT_LAGR, OPT_ERROR_GRADIENT_LAGR }
Public Types inherited from IterationPack::AlgorithmTracker
typedef Teuchos::RCP < std::ostream >	ostream_ptr_t

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...
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	initialize ()
	Reinitialize the track object right before it is used. 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
void	print_header (const NLPAlgoState &s) const
	Print the header to the output. More...
std::ostream &	o () const

Private Member Functions
	MoochoTrackerSummaryStd ()

Private Attributes
ostream_ptr_t	o_
EOptError	opt_error_
int	num_total_qp_iter_
quasi_newton_stats_iq_member	quasi_newton_stats_
qp_solver_stats_iq_member	qp_solver_stats_
act_set_stats_iq_member	act_set_stats_

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

Enumerator
OPT_ERROR_REDUCED_GRADIENT_LAGR
OPT_ERROR_GRADIENT_LAGR

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.

Definition at line 59 of file MoochoPack_MoochoTrackerSummaryStd.cpp.

MoochoPack::MoochoTrackerSummaryStd::MoochoTrackerSummaryStd ( )

private

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

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.

std::ostream& MoochoPack::MoochoTrackerSummaryStd::o ( ) const

inlineprotected

Definition at line 97 of file MoochoPack_MoochoTrackerSummaryStd.hpp.

Member Data Documentation

ostream_ptr_t MoochoPack::MoochoTrackerSummaryStd::o_

private

Definition at line 101 of file MoochoPack_MoochoTrackerSummaryStd.hpp.

EOptError MoochoPack::MoochoTrackerSummaryStd::opt_error_

private

Definition at line 102 of file MoochoPack_MoochoTrackerSummaryStd.hpp.

int MoochoPack::MoochoTrackerSummaryStd::num_total_qp_iter_

mutableprivate

Definition at line 103 of file MoochoPack_MoochoTrackerSummaryStd.hpp.

quasi_newton_stats_iq_member MoochoPack::MoochoTrackerSummaryStd::quasi_newton_stats_

private

Definition at line 104 of file MoochoPack_MoochoTrackerSummaryStd.hpp.

qp_solver_stats_iq_member MoochoPack::MoochoTrackerSummaryStd::qp_solver_stats_

private

Definition at line 105 of file MoochoPack_MoochoTrackerSummaryStd.hpp.

act_set_stats_iq_member MoochoPack::MoochoTrackerSummaryStd::act_set_stats_

private

Definition at line 106 of file MoochoPack_MoochoTrackerSummaryStd.hpp.

---

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

• MoochoPack_MoochoTrackerSummaryStd.hpp
• MoochoPack_MoochoTrackerSummaryStd.cpp