Zoltan2::BaseClassMetrics< scalar_t > Class Template Reference

#include <Zoltan2_BaseClassMetrics.hpp>

Inheritance diagram for Zoltan2::BaseClassMetrics< scalar_t >:

of this metric
static std::string	static_unknown_metricTypeName_
static std::vector< std::string >	static_metricNames_ = {}
static std::vector< std::string >	static_allMetricNames_
scalar_t	getValue (int enumIndex) const
void	setValue (int enumIndex, scalar_t value)
	BaseClassMetrics ()
	Constructor - for compiling but not used. More...
	BaseClassMetrics (int memCount, std::string mname)
	Constructor. More...
	BaseClassMetrics (int memCount)
	Constructor. More...
virtual	~BaseClassMetrics ()
virtual void	printLine (std::ostream &os) const
virtual const std::vector < std::string > &	getMetrics () const
virtual const std::string &	getMetricType () const
	Get the class type of the metric. More...
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

Detailed Description

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

class BaseClassMetrics for the metric classes.

Definition at line 62 of file Zoltan2_BaseClassMetrics.hpp.

Constructor & Destructor Documentation

template<typename scalar_t >

Zoltan2::BaseClassMetrics< scalar_t >::BaseClassMetrics ( )

inline

Constructor - for compiling but not used.

Definition at line 91 of file Zoltan2_BaseClassMetrics.hpp.

template<typename scalar_t >

Zoltan2::BaseClassMetrics< scalar_t >::BaseClassMetrics ( int  memCount, std::string  mname  )

inline

Constructor.

Definition at line 96 of file Zoltan2_BaseClassMetrics.hpp.

template<typename scalar_t >

Zoltan2::BaseClassMetrics< scalar_t >::BaseClassMetrics ( int  memCount )

inline

Constructor.

Definition at line 102 of file Zoltan2_BaseClassMetrics.hpp.

template<typename scalar_t >

virtual Zoltan2::BaseClassMetrics< scalar_t >::~BaseClassMetrics ( )

inlinevirtual

Deconstructor

Definition at line 108 of file Zoltan2_BaseClassMetrics.hpp.

Member Function Documentation

template<typename scalar_t >

scalar_t Zoltan2::BaseClassMetrics< scalar_t >::getValue ( int  enumIndex ) const

inlineprotected

to getting values_

Definition at line 83 of file Zoltan2_BaseClassMetrics.hpp.

template<typename scalar_t >

void Zoltan2::BaseClassMetrics< scalar_t >::setValue ( int  enumIndex, scalar_t  value  )

inlineprotected

to setting _values

Definition at line 86 of file Zoltan2_BaseClassMetrics.hpp.

template<typename scalar_t >

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

inlinevirtual

printLine. Not abstract so that we can generically support stl containers like maps.

Reimplemented in Zoltan2::ImbalanceMetrics< scalar_t >, and Zoltan2::GraphMetrics< scalar_t >.

Definition at line 113 of file Zoltan2_BaseClassMetrics.hpp.

template<typename scalar_t >

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

inlinevirtual

getMetrics. Forces declaration of a static string list of the different metric types

Reimplemented in Zoltan2::ImbalanceMetrics< scalar_t >, and Zoltan2::GraphMetrics< scalar_t >.

Definition at line 118 of file Zoltan2_BaseClassMetrics.hpp.

template<typename scalar_t >

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

inlinevirtual

Get the class type of the metric.

Reimplemented in Zoltan2::ImbalanceMetrics< scalar_t >, and Zoltan2::GraphMetrics< scalar_t >.

Definition at line 122 of file Zoltan2_BaseClassMetrics.hpp.

template<typename scalar_t >

const std::string& Zoltan2::BaseClassMetrics< scalar_t >::getName ( ) const

inline

Get the name of the item measured.

Definition at line 126 of file Zoltan2_BaseClassMetrics.hpp.

template<typename scalar_t >

void Zoltan2::BaseClassMetrics< scalar_t >::setName ( std::string  name )

inline

Set or reset the name.

Definition at line 129 of file Zoltan2_BaseClassMetrics.hpp.

template<typename scalar_t >

bool Zoltan2::BaseClassMetrics< scalar_t >::hasMetricValue ( const std::string &  metric_name ) const

inline

.

Definition at line 132 of file Zoltan2_BaseClassMetrics.hpp.

template<typename scalar_t >

scalar_t Zoltan2::BaseClassMetrics< scalar_t >::getMetricValue ( const std::string &  metric_name ) const

inline

\ return a metric value specified by name

Definition at line 137 of file Zoltan2_BaseClassMetrics.hpp.

template<typename scalar_t >

void Zoltan2::BaseClassMetrics< scalar_t >::setMetricValue ( const std::string &  metric_name, scalar_t  value  ) const

inline

\ set a metric value specified by name

Definition at line 146 of file Zoltan2_BaseClassMetrics.hpp.

template<typename scalar_t >

size_t Zoltan2::BaseClassMetrics< scalar_t >::convertMetricNameToIndex ( const std::string &  metric_name ) const

inline

function converts the name to an index.

Definition at line 154 of file Zoltan2_BaseClassMetrics.hpp.

Member Data Documentation

template<typename scalar_t >

std::string Zoltan2::BaseClassMetrics< scalar_t >::static_unknown_metricTypeName_

static

Initial value:

=
  UNKNOWN_METRICS_TYPE_NAME

a static string name indicating my class name. This stub name exists so that this base class is not virtual to resolve problems with using metrics with stl. It should never be used.

class name for string - used to identify by parameter lists. This name should never be used and allows us to be not abstract - so that we can generically support stl containers like maps.

Definition at line 166 of file Zoltan2_BaseClassMetrics.hpp.

template<typename scalar_t >

std::vector< std::string > Zoltan2::BaseClassMetrics< scalar_t >::static_metricNames_ = {}

static

a static vector of strings. Non virtual so that we can generically support stl containers like maps.

this with the enum list. Empty list allows us to be not abstract - so that we can generically support stl containers like maps.

Definition at line 171 of file Zoltan2_BaseClassMetrics.hpp.

template<typename scalar_t >

std::vector<std::string> Zoltan2::BaseClassMetrics< scalar_t >::static_allMetricNames_

static

is a list of all possible types - it is used to generate a 'was not used' message, if that's you want.

Definition at line 176 of file Zoltan2_BaseClassMetrics.hpp.

---

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

• Zoltan2_BaseClassMetrics.hpp