Zoltan2::GraphMetrics< scalar_t > Class Template Reference

#include <Zoltan2_GraphMetrics.hpp>

Inheritance diagram for Zoltan2::GraphMetrics< scalar_t >:

Collaboration diagram for Zoltan2::GraphMetrics< scalar_t >:

Public Member Functions
	GraphMetrics (std::string mname)
	Constructor. More...
	GraphMetrics ()
	Constructor. More...
virtual const std::string &	getMetricType () const
	Get the class type of the metric. More...
virtual void	printLine (std::ostream &os) const
	Print a standard line of data that fits under the header. More...
void	setGlobalSum (scalar_t x)
	Set the global sum. More...
void	setGlobalMax (scalar_t x)
	Set the global maximum across parts. More...
scalar_t	getGlobalSum () const
	Get the global sum of edge cuts for all parts. More...
scalar_t	getGlobalMax () const
	Get the global maximum of edge cuts per part across all parts. More...
virtual const std::vector < std::string > &	getMetrics () const
Public Member Functions inherited from Zoltan2::BaseClassMetrics< scalar_t >
	BaseClassMetrics ()
	Constructor - for compiling but not used. More...
	BaseClassMetrics (int memCount, std::string mname)
	Constructor. More...
	BaseClassMetrics (int memCount)
	Constructor. More...
virtual	~BaseClassMetrics ()
const std::string &	getName () const
	Get the name of the item measured. More...
void	setName (std::string name)
	Set or reset the name. More...
bool	hasMetricValue (const std::string &metric_name) const
scalar_t	getMetricValue (const std::string &metric_name) const
void	setMetricValue (const std::string &metric_name, scalar_t value) const
size_t	convertMetricNameToIndex (const std::string &metric_name) const

Static Public Member Functions
static void	printHeader (std::ostream &os)
	Print a standard header. More...

Static Public Attributes
static std::vector< std::string >	static_metricNames_
static std::string	static_metricTypeName_ = GRAPH_METRICS_TYPE_NAME
Static Public Attributes inherited from Zoltan2::BaseClassMetrics< scalar_t >
static std::string	static_unknown_metricTypeName_
static std::vector< std::string >	static_metricNames_ = {}
static std::vector< std::string >	static_allMetricNames_

Detailed Description

template<typename scalar_t>
class Zoltan2::GraphMetrics< scalar_t >

class containing the metrics for one measurable item.

Definition at line 62 of file Zoltan2_GraphMetrics.hpp.

Constructor & Destructor Documentation

template<typename scalar_t >

Zoltan2::GraphMetrics< scalar_t >::GraphMetrics ( std::string  mname )

inline

Constructor.

Definition at line 66 of file Zoltan2_GraphMetrics.hpp.

template<typename scalar_t >

Zoltan2::GraphMetrics< scalar_t >::GraphMetrics ( )

inline

Constructor.

Definition at line 69 of file Zoltan2_GraphMetrics.hpp.

Member Function Documentation

template<typename scalar_t >

virtual const std::string& Zoltan2::GraphMetrics< scalar_t >::getMetricType ( ) const

inlinevirtual

Get the class type of the metric.

Reimplemented from Zoltan2::BaseClassMetrics< scalar_t >.

Definition at line 72 of file Zoltan2_GraphMetrics.hpp.

template<typename scalar_t >

void Zoltan2::GraphMetrics< scalar_t >::printHeader ( std::ostream &  os )

static

Print a standard header.

Definition at line 114 of file Zoltan2_GraphMetrics.hpp.

template<typename scalar_t >

void Zoltan2::GraphMetrics< scalar_t >::printLine ( std::ostream &  os ) const

virtual

Print a standard line of data that fits under the header.

Reimplemented from Zoltan2::BaseClassMetrics< scalar_t >.

Definition at line 122 of file Zoltan2_GraphMetrics.hpp.

template<typename scalar_t >

void Zoltan2::GraphMetrics< scalar_t >::setGlobalSum ( scalar_t  x )

inline

Set the global sum.

Definition at line 81 of file Zoltan2_GraphMetrics.hpp.

template<typename scalar_t >

void Zoltan2::GraphMetrics< scalar_t >::setGlobalMax ( scalar_t  x )

inline

Set the global maximum across parts.

Definition at line 84 of file Zoltan2_GraphMetrics.hpp.

template<typename scalar_t >

scalar_t Zoltan2::GraphMetrics< scalar_t >::getGlobalSum ( ) const

inline

Get the global sum of edge cuts for all parts.

Definition at line 87 of file Zoltan2_GraphMetrics.hpp.

template<typename scalar_t >

scalar_t Zoltan2::GraphMetrics< scalar_t >::getGlobalMax ( ) const

inline

Get the global maximum of edge cuts per part across all parts.

Definition at line 90 of file Zoltan2_GraphMetrics.hpp.

template<typename scalar_t >

virtual const std::vector<std::string>& Zoltan2::GraphMetrics< scalar_t >::getMetrics ( ) const

inlinevirtual

method is enforced by the base class.

Reimplemented from Zoltan2::BaseClassMetrics< scalar_t >.

Definition at line 93 of file Zoltan2_GraphMetrics.hpp.

Member Data Documentation

template<typename scalar_t >

std::vector< std::string > Zoltan2::GraphMetrics< scalar_t >::static_metricNames_

static

Initial value:

= {
  "global sum",
  "global maximum"
}

a static vector of strings.

all metrics for this class.

Definition at line 96 of file Zoltan2_GraphMetrics.hpp.

template<typename scalar_t >

std::string Zoltan2::GraphMetrics< scalar_t >::static_metricTypeName_ = GRAPH_METRICS_TYPE_NAME

static

a static string name indicating my class name.

class name for string - used to identify by parameter lists.

Definition at line 99 of file Zoltan2_GraphMetrics.hpp.

---

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

• Zoltan2_GraphMetrics.hpp