MoochoPack : Framework for Large-Scale Optimization Algorithms  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Member Functions | Protected Member Functions | List of all members
MoochoPack::MoochoTrackerXMLSummary Class Reference

This class outputs an XML summary file of the algorithm results and performance. More...

#include <MoochoPack_MoochoTrackerXMLSummary.hpp>

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

Public Member Functions

 MoochoTrackerXMLSummary (const Teuchos::RCP< std::ostream > &journal_out, const std::string xml_filename, const std::string problem_name, const std::string algorithm_description)
 Construct with an output stream. More...
 
void output_pre_file () const
 Set the output stream for summary outputting. More...
 

Protected Member Functions

void open_problem_element (std::ostream &out, const Algorithm &algo) 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 outputs an XML summary file of the algorithm results and performance.

Definition at line 58 of file MoochoPack_MoochoTrackerXMLSummary.hpp.

Constructor & Destructor Documentation

MoochoPack::MoochoTrackerXMLSummary::MoochoTrackerXMLSummary ( const Teuchos::RCP< std::ostream > &  journal_out,
const std::string  xml_filename,
const std::string  problem_name,
const std::string  algorithm_description 
)

Construct with an output stream.

Definition at line 62 of file MoochoPack_MoochoTrackerXMLSummary.cpp.

Member Function Documentation

void MoochoPack::MoochoTrackerXMLSummary::output_pre_file ( ) const

Set the output stream for summary outputting.

Get the output stream for summary outputting. Output a basic file (with failed status)

Definition at line 253 of file MoochoPack_MoochoTrackerXMLSummary.cpp.

void MoochoPack::MoochoTrackerXMLSummary::output_iteration ( const Algorithm algo) const
virtual

Reimplemented from IterationPack::AlgorithmTracker.

Definition at line 77 of file MoochoPack_MoochoTrackerXMLSummary.cpp.

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

Reimplemented from IterationPack::AlgorithmTracker.

Definition at line 108 of file MoochoPack_MoochoTrackerXMLSummary.cpp.

void MoochoPack::MoochoTrackerXMLSummary::open_problem_element ( std::ostream &  out,
const Algorithm algo 
) const
protected

Print the header to the output.

Definition at line 305 of file MoochoPack_MoochoTrackerXMLSummary.cpp.


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