Zoltan2
|
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... | |
MetricValues (std::string mname) | |
Constructor. More... | |
MetricValues () | |
Constructor. More... | |
void | setName (std::string name) |
Set or reset the name. More... | |
void | setNorm (multiCriteriaNorm normVal) |
Set or reset the norm. More... | |
void | setLocalSum (scalar_t x) |
Set the sum on the local process. More... | |
void | setGlobalSum (scalar_t x) |
Set the global sum. More... | |
void | setGlobalMin (scalar_t x) |
Set the global minimum across parts. More... | |
void | setGlobalMax (scalar_t x) |
Set the global maximum across parts. More... | |
void | setGlobalAvg (scalar_t x) |
Set the global average (sum / numParts). More... | |
void | setMinImbalance (scalar_t x) |
Set the imbalance of the least imbalanced part. More... | |
void | setMaxImbalance (scalar_t x) |
Set the imbalance of the worst imbalanced part. This is what we normally call the imbalance of a partition. More... | |
void | setAvgImbalance (scalar_t x) |
Set the average imbalance of all parts. More... | |
const std::string & | getName () const |
Get the name of the item measured. More... | |
multiCriteriaNorm | getNorm () |
Get the norm. More... | |
scalar_t | getLocalSum () const |
Get the sum on the local process. More... | |
scalar_t | getGlobalSum () const |
Get the global sum for all parts. More... | |
scalar_t | getGlobalMin () const |
Get the global minimum across all parts. More... | |
scalar_t | getGlobalMax () const |
Get the global maximum across all parts. More... | |
scalar_t | getGlobalAvg () const |
Get the average of the sum over all parts. More... | |
scalar_t | getMinImbalance () const |
Get the imbalance of the least imbalanced part. More... | |
scalar_t | getMaxImbalance () const |
Get the imbalance of the most imbalanced part. This is what we normally call the imbalance of a partition. More... | |
scalar_t | getAvgImbalance () const |
Get the average of the part imbalances. More... | |
Static Public Member Functions | |
static void | printHeader (std::ostream &os) |
Print a standard header. More... | |
A class containing the metrics for one measurable item.
Definition at line 75 of file Zoltan2_Metric.hpp.
enum Zoltan2::MetricValues::metricOffset |
Enumerator for offsets into metric data.
When part sizes are all uniform, it is sufficient to look at totals per part. For non-uniform part sizes, the total is not really significant, but rather the min, max and average part imbalances. We provide both types of metrics.
Definition at line 96 of file Zoltan2_Metric.hpp.
|
inline |
Constructor.
Definition at line 121 of file Zoltan2_Metric.hpp.
|
inline |
Constructor.
Definition at line 126 of file Zoltan2_Metric.hpp.
|
static |
Print a standard header.
Definition at line 296 of file Zoltan2_Metric.hpp.
void Zoltan2::MetricValues< scalar_t >::printLine | ( | std::ostream & | os | ) | const |
Print a standard line of data that fits under the header.
Definition at line 260 of file Zoltan2_Metric.hpp.
|
inline |
Set or reset the name.
Definition at line 131 of file Zoltan2_Metric.hpp.
|
inline |
Set or reset the norm.
Definition at line 134 of file Zoltan2_Metric.hpp.
|
inline |
Set the sum on the local process.
Definition at line 138 of file Zoltan2_Metric.hpp.
|
inline |
Set the global sum.
Definition at line 141 of file Zoltan2_Metric.hpp.
|
inline |
Set the global minimum across parts.
Definition at line 144 of file Zoltan2_Metric.hpp.
|
inline |
Set the global maximum across parts.
Definition at line 147 of file Zoltan2_Metric.hpp.
|
inline |
Set the global average (sum / numParts).
Definition at line 150 of file Zoltan2_Metric.hpp.
|
inline |
Set the imbalance of the least imbalanced part.
Definition at line 153 of file Zoltan2_Metric.hpp.
|
inline |
Set the imbalance of the worst imbalanced part. This is what we normally call the imbalance of a partition.
Definition at line 158 of file Zoltan2_Metric.hpp.
|
inline |
Set the average imbalance of all parts.
Definition at line 161 of file Zoltan2_Metric.hpp.
|
inline |
Get the name of the item measured.
Definition at line 164 of file Zoltan2_Metric.hpp.
|
inline |
Get the norm.
Definition at line 167 of file Zoltan2_Metric.hpp.
|
inline |
Get the sum on the local process.
Definition at line 170 of file Zoltan2_Metric.hpp.
|
inline |
Get the global sum for all parts.
Definition at line 173 of file Zoltan2_Metric.hpp.
|
inline |
Get the global minimum across all parts.
Definition at line 176 of file Zoltan2_Metric.hpp.
|
inline |
Get the global maximum across all parts.
Definition at line 179 of file Zoltan2_Metric.hpp.
|
inline |
Get the average of the sum over all parts.
Definition at line 182 of file Zoltan2_Metric.hpp.
|
inline |
Get the imbalance of the least imbalanced part.
Definition at line 185 of file Zoltan2_Metric.hpp.
|
inline |
Get the imbalance of the most imbalanced part. This is what we normally call the imbalance of a partition.
Definition at line 190 of file Zoltan2_Metric.hpp.
|
inline |
Get the average of the part imbalances.
Definition at line 193 of file Zoltan2_Metric.hpp.