#include <Zoltan2_MetricAnalyzer.hpp>

Inheritance diagram for MetricAnalyzer< Adapter >:

Public Member Functions
	MetricAnalyzer (RCP< Zoltan2::EvaluateBaseClass< Adapter >> evaluate)
	MetricAnalyzer constructor takes an EvaluateBaseClass such as EvaluateOrdering or EvaluatePartition. More...

bool	analyzeMetrics (const ParameterList &metricsParameters, std::ostringstream &msg_stream)
	analyzeMetrics for a problem based on a range of tolerances More...

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. More...

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. More...

virtual bool	isMetricCheckNameValid (std::string metricCheckName) const
	Return true for any names we accept. More...

Protected Attributes
RCP < Zoltan2::EvaluateBaseClass < Adapter > >	evaluate_

Detailed Description

template<class Adapter>
class MetricAnalyzer< Adapter >

Definition at line 46 of file Zoltan2_MetricAnalyzer.hpp.

Constructor & Destructor Documentation

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 59 of file Zoltan2_MetricAnalyzer.hpp.

Member Function Documentation

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

	metricsPlist	parameter list defining tolerances
[out]	msg_stream	to return information from the analysis

Returns: returns a boolean value indicated pass/failure.

Definition at line 68 of file Zoltan2_MetricAnalyzer.hpp.

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 MetricAnalyzerEvaluateOrdering< Adapter >, and MetricAnalyzerEvaluatePartition< Adapter >.

template<class Adapter >

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

inline

Definition at line 113 of file Zoltan2_MetricAnalyzer.hpp.

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 144 of file Zoltan2_MetricAnalyzer.hpp.

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 195 of file Zoltan2_MetricAnalyzer.hpp.