Zoltan2
Public Types | Public Member Functions | Static Public Member Functions | List of all members
Zoltan2::GraphMetricValues< scalar_t > Class Template Reference

A class containing the metrics for one measurable item. More...

#include <Zoltan2_Metric.hpp>

Public Types

Public Member Functions

void printLine (std::ostream &os) const
 Print a standard line of data that fits under the header. More...
 
 GraphMetricValues (std::string mname)
 Constructor. More...
 
 GraphMetricValues ()
 Constructor. More...
 
void setName (std::string name)
 Set or reset the name. More...
 
void setGlobalSum (scalar_t x)
 Set the global sum. More...
 
void setGlobalMax (scalar_t x)
 Set the global maximum across parts. More...
 
const std::string & getName () const
 Get the name of the item measured. More...
 
scalar_t getGlobalSum () const
 Get the global sum for all parts. More...
 
scalar_t getGlobalMax () const
 Get the global maximum across all parts. More...
 

Static Public Member Functions

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

Detailed Description

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

A class containing the metrics for one measurable item.

Definition at line 201 of file Zoltan2_Metric.hpp.

Member Enumeration Documentation

template<typename scalar_t>
enum Zoltan2::GraphMetricValues::metricOffset

Enumerator for offsets into metric data.

Enumerator
evalGlobalSum 

the global total on all parts

evalGlobalMax 

the maximum across all parts

evalNumMetrics 

the number of metric values_

Definition at line 216 of file Zoltan2_Metric.hpp.

Constructor & Destructor Documentation

template<typename scalar_t>
Zoltan2::GraphMetricValues< scalar_t >::GraphMetricValues ( std::string  mname)
inline

Constructor.

Definition at line 230 of file Zoltan2_Metric.hpp.

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

Constructor.

Definition at line 235 of file Zoltan2_Metric.hpp.

Member Function Documentation

template<typename scalar_t >
void Zoltan2::GraphMetricValues< scalar_t >::printHeader ( std::ostream &  os)
static

Print a standard header.

Definition at line 323 of file Zoltan2_Metric.hpp.

template<typename scalar_t >
void Zoltan2::GraphMetricValues< scalar_t >::printLine ( std::ostream &  os) const

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

Definition at line 312 of file Zoltan2_Metric.hpp.

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

Set or reset the name.

Definition at line 240 of file Zoltan2_Metric.hpp.

template<typename scalar_t>
void Zoltan2::GraphMetricValues< scalar_t >::setGlobalSum ( scalar_t  x)
inline

Set the global sum.

Definition at line 243 of file Zoltan2_Metric.hpp.

template<typename scalar_t>
void Zoltan2::GraphMetricValues< scalar_t >::setGlobalMax ( scalar_t  x)
inline

Set the global maximum across parts.

Definition at line 246 of file Zoltan2_Metric.hpp.

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

Get the name of the item measured.

Definition at line 249 of file Zoltan2_Metric.hpp.

template<typename scalar_t>
scalar_t Zoltan2::GraphMetricValues< scalar_t >::getGlobalSum ( ) const
inline

Get the global sum for all parts.

Definition at line 252 of file Zoltan2_Metric.hpp.

template<typename scalar_t>
scalar_t Zoltan2::GraphMetricValues< scalar_t >::getGlobalMax ( ) const
inline

Get the global maximum across all parts.

Definition at line 255 of file Zoltan2_Metric.hpp.


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