Zoltan2
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | List of all members
MetricAnalyzer< Adapter > Class Template Referenceabstract

#include <Zoltan2_MetricAnalyzer.hpp>

Inheritance diagram for MetricAnalyzer< Adapter >:
Inheritance graph
[legend]

Public Member Functions

 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.
 

Protected Attributes

RCP< Zoltan2::EvaluateBaseClass< Adapter > > evaluate_
 

Detailed Description

template<class Adapter>
class MetricAnalyzer< Adapter >

Definition at line 82 of file Zoltan2_MetricAnalyzer.hpp.

Constructor & Destructor Documentation

◆ MetricAnalyzer()

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

MetricAnalyzer constructor takes an EvaluateBaseClass such as EvaluateOrdering or EvaluatePartition.

Definition at line 95 of file Zoltan2_MetricAnalyzer.hpp.

Member Function Documentation

◆ analyzeMetrics()

template<class Adapter >
bool MetricAnalyzer< Adapter >::analyzeMetrics ( const ParameterList & metricsParameters,
std::ostringstream & msg_stream )
inline

analyzeMetrics for a problem based on a range of tolerances

Parameters
metricsPlistparameter list defining tolerances
[out]msg_streamto return information from the analysis
Returns
returns a boolean value indicated pass/failure.

Definition at line 104 of file Zoltan2_MetricAnalyzer.hpp.

◆ getMetricResult()

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

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.

Implemented in MetricAnalyzerEvaluatePartition< Adapter >, and MetricAnalyzerEvaluateOrdering< Adapter >.

◆ LoadMetricInfo()

template<class Adapter >
void MetricAnalyzer< Adapter >::LoadMetricInfo ( std::vector< MetricAnalyzerInfo > & metricInfoSet,
const ParameterList & metricsParameters )
inline

Definition at line 149 of file Zoltan2_MetricAnalyzer.hpp.

◆ getMetricAnalyzerInfo()

template<class Adapter >
MetricAnalyzerInfo MetricAnalyzer< Adapter >::getMetricAnalyzerInfo ( const ParameterList & metricCheckParameters) const
inline

getMetricAnalyzerInfo is responsible for reading a metric value and then checking it against upper and lower bounds. Any fomratting errors should throw.

Definition at line 180 of file Zoltan2_MetricAnalyzer.hpp.

◆ isMetricCheckNameValid()

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

Return true for any names we accept.

Reimplemented in MetricAnalyzerEvaluatePartition< Adapter >.

Definition at line 231 of file Zoltan2_MetricAnalyzer.hpp.

Member Data Documentation

◆ evaluate_

template<class Adapter >
RCP<Zoltan2::EvaluateBaseClass<Adapter> > MetricAnalyzer< Adapter >::evaluate_
protected

Definition at line 85 of file Zoltan2_MetricAnalyzer.hpp.


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