Zoltan2
List of all members
Zoltan2::BaseClassMetrics< scalar_t > Class Template Reference

#include <Zoltan2_BaseClassMetrics.hpp>

Inheritance diagram for Zoltan2::BaseClassMetrics< scalar_t >:
Inheritance graph
[legend]

of this metric

static std::string static_unknown_metricTypeName_ = UNKNOWN_METRICS_TYPE_NAME
 
static std::vector< std::string > static_metricNames_ = {}
 
static std::vector< std::string > static_allMetricNames_ = { IMBALANCE_METRICS_TYPE_NAME, GRAPH_METRICS_TYPE_NAME }
 
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 65 of file Zoltan2_BaseClassMetrics.hpp.

Constructor & Destructor Documentation

◆ BaseClassMetrics() [1/3]

template<typename scalar_t >
Zoltan2::BaseClassMetrics< scalar_t >::BaseClassMetrics ( )
inline

Constructor - for compiling but not used.

Definition at line 92 of file Zoltan2_BaseClassMetrics.hpp.

◆ BaseClassMetrics() [2/3]

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

Constructor.

Definition at line 98 of file Zoltan2_BaseClassMetrics.hpp.

◆ BaseClassMetrics() [3/3]

template<typename scalar_t >
Zoltan2::BaseClassMetrics< scalar_t >::BaseClassMetrics ( int  memCount)
inline

Constructor.

Definition at line 104 of file Zoltan2_BaseClassMetrics.hpp.

◆ ~BaseClassMetrics()

template<typename scalar_t >
virtual Zoltan2::BaseClassMetrics< scalar_t >::~BaseClassMetrics ( )
inlinevirtual

Deconstructor

Definition at line 110 of file Zoltan2_BaseClassMetrics.hpp.

Member Function Documentation

◆ getValue()

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

to getting values_

Definition at line 84 of file Zoltan2_BaseClassMetrics.hpp.

◆ setValue()

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

to setting _values

Definition at line 87 of file Zoltan2_BaseClassMetrics.hpp.

◆ printLine()

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.

◆ getMetrics()

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 116 of file Zoltan2_BaseClassMetrics.hpp.

◆ getMetricType()

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 119 of file Zoltan2_BaseClassMetrics.hpp.

◆ getName()

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

Get the name of the item measured.

Definition at line 122 of file Zoltan2_BaseClassMetrics.hpp.

◆ setName()

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

Set or reset the name.

Definition at line 125 of file Zoltan2_BaseClassMetrics.hpp.

◆ hasMetricValue()

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

.

Definition at line 128 of file Zoltan2_BaseClassMetrics.hpp.

◆ getMetricValue()

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 133 of file Zoltan2_BaseClassMetrics.hpp.

◆ setMetricValue()

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 142 of file Zoltan2_BaseClassMetrics.hpp.

◆ convertMetricNameToIndex()

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

function converts the name to an enum index.

Definition at line 150 of file Zoltan2_BaseClassMetrics.hpp.

Member Data Documentation

◆ static_unknown_metricTypeName_

template<typename scalar_t >
std::string Zoltan2::BaseClassMetrics< scalar_t >::static_unknown_metricTypeName_ = UNKNOWN_METRICS_TYPE_NAME
static

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 158 of file Zoltan2_BaseClassMetrics.hpp.

◆ static_metricNames_

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 161 of file Zoltan2_BaseClassMetrics.hpp.

◆ static_allMetricNames_

template<typename scalar_t >
std::vector< std::string > Zoltan2::BaseClassMetrics< scalar_t >::static_allMetricNames_ = { IMBALANCE_METRICS_TYPE_NAME, GRAPH_METRICS_TYPE_NAME }
static

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

is a list of all possible types - it is used to generate an empty output for print messages when a metric does not appear in a list.

Definition at line 164 of file Zoltan2_BaseClassMetrics.hpp.


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