Zoltan2::MetricOutputManager< T > Class Template Reference

MetricOutputManager handles output of profiling messages. More...

#include <Zoltan2_MetricOutputManager.hpp>

Public Member Functions
	MetricOutputManager (int rank, bool doPrinting, std::ofstream &Os, bool metricsOn, std::string units=std::string(""), int width=10)
	Constructor for output to a file. More...
	MetricOutputManager (int rank, bool doPrinting, std::ostream &Os, bool metricsOn, std::string units=std::string(""), int width=10)
	Constructor for output to a stream. More...
	~MetricOutputManager ()
	Destructor. More...
std::ostream *	getOStream () const
	Return the output stream for messages. More...
bool	getMetricsOn () const
	Return true if any process outputs metrics. More...
void	print (const std::string &msg, const T val)
	Print a line of information. More...
void	print (const char *msg, T val)
	A version of print that takes char to avoid the cost of converting char * to string. More...

Detailed Description

template<typename T>
class Zoltan2::MetricOutputManager< T >

MetricOutputManager handles output of profiling messages.

The template parameter is the data type of the value that is being measured. An Environment has a MetricOutputManager for memory profiling.

Parameters governing memory output:

• memory_procs
• memory_output_stream
• memory_output_file

For more information see at their definitions in createAllParameters() in Zoltan2_Parameters.cpp.

Definition at line 74 of file Zoltan2_MetricOutputManager.hpp.

Constructor & Destructor Documentation

template<typename T>

Zoltan2::MetricOutputManager< T >::MetricOutputManager ( int  rank, bool  doPrinting, std::ofstream &  Os, bool  metricsOn, std::string  units = std::string(""), int  width = 10  )

inline

Constructor for output to a file.

Parameters

rank	the MPI rank of this process.
doPrinting	true if this process outputs messages.
messageOs	the output stream for messages.
metricsOn	true if any process outputs messages.
units	name of units for metrics printed
width	field width for metric value

It is the caller's responsibility to close and free the ofstream.

Definition at line 90 of file Zoltan2_MetricOutputManager.hpp.

template<typename T>

Zoltan2::MetricOutputManager< T >::MetricOutputManager ( int  rank, bool  doPrinting, std::ostream &  Os, bool  metricsOn, std::string  units = std::string(""), int  width = 10  )

inline

Constructor for output to a stream.

Parameters

rank	the MPI rank of this process.
doPrinting	true if this process outputs messages.
messageOs	the output stream for messages.
metricsOn	true if any process outputs messages.
units	name of units for metrics printed
width	field width for metric value

Definition at line 107 of file Zoltan2_MetricOutputManager.hpp.

template<typename T>

Zoltan2::MetricOutputManager< T >::~MetricOutputManager ( )

inline

Destructor.

Definition at line 115 of file Zoltan2_MetricOutputManager.hpp.

Member Function Documentation

template<typename T>

std::ostream* Zoltan2::MetricOutputManager< T >::getOStream ( ) const

inline

Return the output stream for messages.

Definition at line 119 of file Zoltan2_MetricOutputManager.hpp.

template<typename T>

bool Zoltan2::MetricOutputManager< T >::getMetricsOn ( ) const

inline

Return true if any process outputs metrics.

Definition at line 123 of file Zoltan2_MetricOutputManager.hpp.

template<typename T>

void Zoltan2::MetricOutputManager< T >::print ( const std::string &  msg, const T  val  )

inline

Print a line of information.

Parameters

msg	a message to go with the information
val	the value to print

Definition at line 129 of file Zoltan2_MetricOutputManager.hpp.

template<typename T>

void Zoltan2::MetricOutputManager< T >::print ( const char *  msg, T  val  )

inline

A version of print that takes char to avoid the cost of converting char * to string.

Parameters

msg	a message to go with the information
units	the units in which the value is measured
val	the value to print

Definition at line 150 of file Zoltan2_MetricOutputManager.hpp.

---

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

• Zoltan2_MetricOutputManager.hpp