Zoltan2
Loading...
Searching...
No Matches
Public Member Functions | List of all members
MetricAnalyzerEvaluatePartition< Adapter > Class Template Reference

#include <Zoltan2_MetricAnalyzer.hpp>

Inheritance diagram for MetricAnalyzerEvaluatePartition< Adapter >:
Inheritance graph
[legend]
Collaboration diagram for MetricAnalyzerEvaluatePartition< Adapter >:
Collaboration graph
[legend]

Public Member Functions

 MetricAnalyzerEvaluatePartition (RCP< Zoltan2::EvaluateBaseClass< Adapter > > evaluate)
 MetricAnalyzerEvaluatePartition constructor.
 
virtual MetricAnalyzerInfo getMetricResult (const ParameterList &metricCheckParameters, std::string keyWord) const
 Reads a metric value for bounds checking. Handle any special optional parameters.
 
virtual bool isMetricCheckNameValid (std::string metricCheckName) const
 Return true for any names we accept.
 
- Public Member Functions inherited from MetricAnalyzer< Adapter >
 MetricAnalyzer (RCP< Zoltan2::EvaluateBaseClass< Adapter > > evaluate)
 MetricAnalyzer constructor takes an EvaluateBaseClass such as EvaluateOrdering or EvaluatePartition.
 
bool analyzeMetrics (const ParameterList &metricsParameters, std::ostringstream &msg_stream)
 analyzeMetrics for a problem based on a range of tolerances
 
virtual MetricAnalyzerInfo getMetricResult (const ParameterList &metricCheckParameters, std::string keyWord) const =0
 getMetricValue is abstract and the derived class must define the proper method to check optional values and determine the resulting scalar value. The derived class will also throw if formatting is incorrect.
 
void LoadMetricInfo (std::vector< MetricAnalyzerInfo > &metricInfoSet, const ParameterList &metricsParameters)
 
MetricAnalyzerInfo getMetricAnalyzerInfo (const ParameterList &metricCheckParameters) const
 getMetricAnalyzerInfo is responsible for reading a metric value and then checking it against upper and lower bounds. Any fomratting errors should throw.
 
virtual bool isMetricCheckNameValid (std::string metricCheckName) const
 Return true for any names we accept.
 

Additional Inherited Members

- Protected Attributes inherited from MetricAnalyzer< Adapter >
RCP< Zoltan2::EvaluateBaseClass< Adapter > > evaluate_
 

Detailed Description

template<class Adapter>
class MetricAnalyzerEvaluatePartition< Adapter >

Definition at line 288 of file Zoltan2_MetricAnalyzer.hpp.

Constructor & Destructor Documentation

◆ MetricAnalyzerEvaluatePartition()

template<class Adapter >
MetricAnalyzerEvaluatePartition< Adapter >::MetricAnalyzerEvaluatePartition ( RCP< Zoltan2::EvaluateBaseClass< Adapter > >  evaluate)
inline

MetricAnalyzerEvaluatePartition constructor.

Definition at line 296 of file Zoltan2_MetricAnalyzer.hpp.

Member Function Documentation

◆ getMetricResult()

template<class Adapter >
virtual MetricAnalyzerInfo MetricAnalyzerEvaluatePartition< Adapter >::getMetricResult ( const ParameterList &  metricCheckParameters,
std::string  keyWord 
) const
inlinevirtual

Reads a metric value for bounds checking. Handle any special optional parameters.

Implements MetricAnalyzer< Adapter >.

Definition at line 304 of file Zoltan2_MetricAnalyzer.hpp.

◆ isMetricCheckNameValid()

template<class Adapter >
virtual bool MetricAnalyzerEvaluatePartition< Adapter >::isMetricCheckNameValid ( std::string  metricCheckName) const
inlinevirtual

Return true for any names we accept.

Reimplemented from MetricAnalyzer< Adapter >.

Definition at line 413 of file Zoltan2_MetricAnalyzer.hpp.


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