#include <Zoltan2_ImbalanceMetrics.hpp>

Inheritance diagram for Zoltan2::ImbalanceMetrics< scalar_t >:

Collaboration diagram for Zoltan2::ImbalanceMetrics< scalar_t >:

Public Member Functions
	ImbalanceMetrics (std::string mname)
	Constructor.
	ImbalanceMetrics ()
	Constructor.
virtual const std::string &	getMetricType () const
	Get the class type of the metric.
virtual void	printLine (std::ostream &os) const
	Print a standard line of data that fits under the header.
void	setNorm (multiCriteriaNorm normVal)
	Set or reset the norm.
multiCriteriaNorm	getNorm ()
	Get the norm.
void	setLocalSum (scalar_t x)
	Set the sum on the local process.
void	setGlobalSum (scalar_t x)
	Set the global sum.
void	setGlobalMin (scalar_t x)
	Set the global minimum across parts.
void	setGlobalMax (scalar_t x)
	Set the global maximum across parts.
void	setMaxImbalance (scalar_t x)
	Set the imbalance of the worst imbalanced part. This is what we normally call the imbalance of a partition.
void	setAvgImbalance (scalar_t x)
	Set the average imbalance of all parts.
scalar_t	getLocalSum () const
	Get the sum on the local process.
scalar_t	getGlobalSum () const
	Get the global sum for all parts.
scalar_t	getGlobalMin () const
	Get the global minimum across all parts.
scalar_t	getGlobalMax () const
	Get the global maximum across all parts.
scalar_t	getMaxImbalance () const
	Get the imbalance of the most imbalanced part. This is what we normally call the imbalance of a partition.
scalar_t	getAvgImbalance () const
	Get the average of the part imbalances.
virtual const std::vector< std::string > &	getMetrics () const
	BaseClassMetrics ()
	Constructor - for compiling but not used.
	BaseClassMetrics (int memCount, std::string mname)
	Constructor.
	BaseClassMetrics (int memCount)
	Constructor.
virtual	~BaseClassMetrics ()
const std::string &	getName () const
	Get the name of the item measured.
void	setName (std::string name)
	Set or reset the name.
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.

Static Public Attributes
static std::string	static_metricTypeName_
static std::vector< std::string >	static_metricNames_
static std::string	static_unknown_metricTypeName_
static std::vector< std::string >	static_metricNames_
static std::vector< std::string >	static_allMetricNames_

Additional Inherited Members
scalar_t	getValue (int enumIndex) const
void	setValue (int enumIndex, scalar_t value)

Detailed Description

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

\ImbalanceMetrics class containing the metrics for one measurable item.

Definition at line 26 of file Zoltan2_ImbalanceMetrics.hpp.

Constructor & Destructor Documentation

◆ ImbalanceMetrics() [1/2]

template<typename scalar_t>

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

inline

Constructor.

Definition at line 33 of file Zoltan2_ImbalanceMetrics.hpp.

◆ ImbalanceMetrics() [2/2]

template<typename scalar_t>

Zoltan2::ImbalanceMetrics< scalar_t >::ImbalanceMetrics ( )

inline

Constructor.

Definition at line 36 of file Zoltan2_ImbalanceMetrics.hpp.

Member Function Documentation

◆ getMetricType()

template<typename scalar_t>

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

inlinevirtual

Get the class type of the metric.

Reimplemented from Zoltan2::BaseClassMetrics< scalar_t >.

Definition at line 39 of file Zoltan2_ImbalanceMetrics.hpp.

◆ printHeader()

template<typename scalar_t>

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

static

Print a standard header.

Definition at line 117 of file Zoltan2_ImbalanceMetrics.hpp.

◆ printLine()

template<typename scalar_t>

void Zoltan2::ImbalanceMetrics< 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 127 of file Zoltan2_ImbalanceMetrics.hpp.

◆ setNorm()

template<typename scalar_t>

void Zoltan2::ImbalanceMetrics< scalar_t >::setNorm ( multiCriteriaNorm normVal )

inline

Set or reset the norm.

Definition at line 48 of file Zoltan2_ImbalanceMetrics.hpp.

◆ getNorm()

template<typename scalar_t>

multiCriteriaNorm Zoltan2::ImbalanceMetrics< scalar_t >::getNorm ( )

inline

Get the norm.

Definition at line 51 of file Zoltan2_ImbalanceMetrics.hpp.

◆ setLocalSum()

template<typename scalar_t>

void Zoltan2::ImbalanceMetrics< scalar_t >::setLocalSum ( scalar_t x )

inline

Set the sum on the local process.

Definition at line 54 of file Zoltan2_ImbalanceMetrics.hpp.

◆ setGlobalSum()

template<typename scalar_t>

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

inline

Set the global sum.

Definition at line 57 of file Zoltan2_ImbalanceMetrics.hpp.

◆ setGlobalMin()

template<typename scalar_t>

void Zoltan2::ImbalanceMetrics< scalar_t >::setGlobalMin ( scalar_t x )

inline

Set the global minimum across parts.

Definition at line 60 of file Zoltan2_ImbalanceMetrics.hpp.

◆ setGlobalMax()

template<typename scalar_t>

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

inline

Set the global maximum across parts.

Definition at line 63 of file Zoltan2_ImbalanceMetrics.hpp.

◆ setMaxImbalance()

template<typename scalar_t>

void Zoltan2::ImbalanceMetrics< scalar_t >::setMaxImbalance ( scalar_t x )

inline

Set the imbalance of the worst imbalanced part. This is what we normally call the imbalance of a partition.

Definition at line 66 of file Zoltan2_ImbalanceMetrics.hpp.

◆ setAvgImbalance()

template<typename scalar_t>

void Zoltan2::ImbalanceMetrics< scalar_t >::setAvgImbalance ( scalar_t x )

inline

Set the average imbalance of all parts.

Definition at line 69 of file Zoltan2_ImbalanceMetrics.hpp.

◆ getLocalSum()

template<typename scalar_t>

scalar_t Zoltan2::ImbalanceMetrics< scalar_t >::getLocalSum ( ) const

inline

Get the sum on the local process.

Definition at line 72 of file Zoltan2_ImbalanceMetrics.hpp.

◆ getGlobalSum()

template<typename scalar_t>

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

inline

Get the global sum for all parts.

Definition at line 75 of file Zoltan2_ImbalanceMetrics.hpp.

◆ getGlobalMin()

template<typename scalar_t>

scalar_t Zoltan2::ImbalanceMetrics< scalar_t >::getGlobalMin ( ) const

inline

Get the global minimum across all parts.

Definition at line 78 of file Zoltan2_ImbalanceMetrics.hpp.

◆ getGlobalMax()

template<typename scalar_t>

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

inline

Get the global maximum across all parts.

Definition at line 81 of file Zoltan2_ImbalanceMetrics.hpp.

◆ getMaxImbalance()

template<typename scalar_t>

scalar_t Zoltan2::ImbalanceMetrics< scalar_t >::getMaxImbalance ( ) const

inline

Get the imbalance of the most imbalanced part. This is what we normally call the imbalance of a partition.

Definition at line 86 of file Zoltan2_ImbalanceMetrics.hpp.

◆ getAvgImbalance()

template<typename scalar_t>

scalar_t Zoltan2::ImbalanceMetrics< scalar_t >::getAvgImbalance ( ) const

inline

Get the average of the part imbalances.

Definition at line 89 of file Zoltan2_ImbalanceMetrics.hpp.

◆ getMetrics()

template<typename scalar_t>

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

inlinevirtual

\this method is enforced by the base class.

Reimplemented from Zoltan2::BaseClassMetrics< scalar_t >.

Definition at line 92 of file Zoltan2_ImbalanceMetrics.hpp.

Member Data Documentation

◆ static_metricTypeName_

template<typename scalar_t>

std::string Zoltan2::ImbalanceMetrics< scalar_t >::static_metricTypeName_

static

\setup a static string name indicating my class name.

Definition at line 95 of file Zoltan2_ImbalanceMetrics.hpp.

◆ static_metricNames_

template<typename scalar_t>

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

static

\setup a static vector of strings.

Definition at line 98 of file Zoltan2_ImbalanceMetrics.hpp.

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

Zoltan2_ImbalanceMetrics.hpp

Public Member Functions

Static Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ImbalanceMetrics() [1/2]

◆ ImbalanceMetrics() [2/2]

Member Function Documentation

◆ getMetricType()

◆ printHeader()

◆ printLine()

◆ setNorm()

◆ getNorm()

◆ setLocalSum()

◆ setGlobalSum()

◆ setGlobalMin()

◆ setGlobalMax()

◆ setMaxImbalance()

◆ setAvgImbalance()

◆ getLocalSum()

◆ getGlobalSum()

◆ getGlobalMin()

◆ getGlobalMax()

◆ getMaxImbalance()

◆ getAvgImbalance()

◆ getMetrics()

Member Data Documentation

◆ static_metricTypeName_

◆ static_metricNames_