A class that computes and returns quality metrics. More...

#include <Zoltan2_EvaluatePartition.hpp>

Inheritance diagram for Zoltan2::EvaluatePartition< Adapter >:

Collaboration diagram for Zoltan2::EvaluatePartition< Adapter >:

Public Member Functions
virtual	~EvaluatePartition ()

	EvaluatePartition (const Adapter ia, ParameterList p, const PartitioningSolution< Adapter > *soln, const RCP< const GraphModel< typename Adapter::base_adapter_t > > &graphModel=Teuchos::null)
	Constructor where communicator is Teuchos default. More...

	EvaluatePartition (const Adapter ia, ParameterList p, const RCP< const Comm< int > > &problemComm, const PartitioningSolution< Adapter > *soln, const RCP< const GraphModel< typename Adapter::base_adapter_t > > &graphModel=Teuchos::null)
	Constructor where Teuchos communicator is specified. More...

ArrayView< RCP< base_metric_type > >	getAllMetricsOfType (std::string metricType) const
	Return the metric list for types matching the given metric type. More...

scalar_t	getObjectCountImbalance () const
	Return the object count imbalance. More...

scalar_t	getNormedImbalance () const
	Return the object normed weight imbalance. Normed imbalance is only valid if there is at least 2 elements - the second one is the normed imbalance. If we have weights (which start at the second element) the spec is to have this return that element. More...

scalar_t	getWeightImbalance (int weightIndex) const
	Return the imbalance for the requested weight. More...

scalar_t	getMaxEdgeCut () const
	Return the max cut for the requested weight. More...

scalar_t	getMaxWeightEdgeCut (int weightIndex) const
	getMaxWeightEdgeCuts weighted for the specified index More...

scalar_t	getTotalEdgeCut () const
	getTotalEdgeCut More...

scalar_t	getTotalWeightEdgeCut (int weightIndex) const
	getTotalWeightEdgeCut weighted for the specified index More...

void	printMetrics (std::ostream &os) const
	Print all metrics. More...

Public Member Functions inherited from Zoltan2::EvaluateBaseClassRoot
virtual	~EvaluateBaseClassRoot ()

Protected Member Functions
void	sharedConstructor (const Adapter ia, ParameterList p, const RCP< const Comm< int > > &problemComm, const PartitioningSolution< Adapter > *soln, const RCP< const GraphModel< typename Adapter::base_adapter_t > > &graphModel)

	EvaluatePartition (const Adapter ia, ParameterList p, const RCP< const Comm< int > > &problemComm, const PartitioningSolution< Adapter > *soln, bool force_evaluate, const RCP< const GraphModel< typename Adapter::base_adapter_t > > &graphModel=Teuchos::null)
	Constructor where communicator is Teuchos default, and takes another parameter whether to evaluate metrics within the constructor or not. More...

virtual void	calculate_graph_metrics (const RCP< const Environment > &_env, const RCP< const Comm< int > > &_problemComm, const RCP< const GraphModel< typename Adapter::base_adapter_t > > &_graph, const ArrayView< const typename Adapter::part_t > &_partArray, typename Adapter::part_t &_numGlobalParts, ArrayRCP< RCP< BaseClassMetrics< typename Adapter::scalar_t > > > &_metricsBase, ArrayRCP< typename Adapter::scalar_t > &_globalSums)

Detailed Description

template<typename Adapter>
class Zoltan2::EvaluatePartition< Adapter >

A class that computes and returns quality metrics.

Todo:

For some problems it will be necessary to build the Model again in order to compute metrics. For now we don't have any problems like that.

write a unit test for this class

Examples:: rcb_C.cpp.

Definition at line 114 of file Zoltan2_EvaluatePartition.hpp.

Constructor & Destructor Documentation

◆ EvaluatePartition() [1/3]

template<typename Adapter >

Zoltan2::EvaluatePartition< Adapter >::EvaluatePartition	(	const Adapter *	ia,
		ParameterList *	p,
		const RCP< const Comm< int > > &	problemComm,
		const PartitioningSolution< Adapter > *	soln,
		bool	force_evaluate,
		const RCP< const GraphModel< typename Adapter::base_adapter_t > > &	graphModel = `Teuchos::null`
	)

inlineprotected

Constructor where communicator is Teuchos default, and takes another parameter whether to evaluate metrics within the constructor or not.

Parameters

ia	the problem input adapter
p	the parameter list
problemComm	the problem communicator
soln	the solution
force_evaluate	whether to evaluate within to constructor or not.
graphModel	the graph model The constructor does global communication to compute the metrics . The rest of the methods are local.

Definition at line 154 of file Zoltan2_EvaluatePartition.hpp.

◆ ~EvaluatePartition()

template<typename Adapter >

virtual Zoltan2::EvaluatePartition< Adapter >::~EvaluatePartition ( )

inlinevirtual

Definition at line 182 of file Zoltan2_EvaluatePartition.hpp.

◆ EvaluatePartition() [2/3]

template<typename Adapter >

Zoltan2::EvaluatePartition< Adapter >::EvaluatePartition	(	const Adapter *	ia,
		ParameterList *	p,
		const PartitioningSolution< Adapter > *	soln,
		const RCP< const GraphModel< typename Adapter::base_adapter_t > > &	graphModel = `Teuchos::null`
	)

inline

Constructor where communicator is Teuchos default.

Parameters

ia	the problem input adapter
p	the parameter list
soln	the solution
graphModel	the graph model The constructor does global communication to compute the metrics. The rest of the methods are local.

Definition at line 192 of file Zoltan2_EvaluatePartition.hpp.

◆ EvaluatePartition() [3/3]

template<typename Adapter >

Zoltan2::EvaluatePartition< Adapter >::EvaluatePartition	(	const Adapter *	ia,
		ParameterList *	p,
		const RCP< const Comm< int > > &	problemComm,
		const PartitioningSolution< Adapter > *	soln,
		const RCP< const GraphModel< typename Adapter::base_adapter_t > > &	graphModel = `Teuchos::null`
	)

inline

Constructor where Teuchos communicator is specified.

Parameters

ia	the problem input adapter
p	the parameter list
problemComm	the problem communicator
soln	the solution
graphModel	the graph model The constructor does global communication to compute the metrics. The rest of the methods are local.

Definition at line 214 of file Zoltan2_EvaluatePartition.hpp.

Member Function Documentation

◆ sharedConstructor()

template<typename Adapter >

void Zoltan2::EvaluatePartition< Adapter >::sharedConstructor	(	const Adapter *	ia,
		ParameterList *	p,
		const RCP< const Comm< int > > &	problemComm,
		const PartitioningSolution< Adapter > *	soln,
		const RCP< const GraphModel< typename Adapter::base_adapter_t > > &	graphModel
	)

protected

Definition at line 443 of file Zoltan2_EvaluatePartition.hpp.

◆ calculate_graph_metrics()

template<typename Adapter >

virtual void Zoltan2::EvaluatePartition< Adapter >::calculate_graph_metrics	(	const RCP< const Environment > &	_env,
		const RCP< const Comm< int > > &	_problemComm,
		const RCP< const GraphModel< typename Adapter::base_adapter_t > > &	_graph,
		const ArrayView< const typename Adapter::part_t > &	_partArray,
		typename Adapter::part_t &	_numGlobalParts,
		ArrayRCP< RCP< BaseClassMetrics< typename Adapter::scalar_t > > > &	_metricsBase,
		ArrayRCP< typename Adapter::scalar_t > &	_globalSums
	)

inlineprotectedvirtual

Reimplemented in Zoltan2::EvaluateMapping< Adapter, MachineRep >.

Definition at line 168 of file Zoltan2_EvaluatePartition.hpp.

◆ getAllMetricsOfType()

template<typename Adapter >

ArrayView<RCP<base_metric_type> > Zoltan2::EvaluatePartition< Adapter >::getAllMetricsOfType ( std::string metricType ) const

inline

Return the metric list for types matching the given metric type.

Definition at line 260 of file Zoltan2_EvaluatePartition.hpp.

◆ getObjectCountImbalance()

template<typename Adapter >

scalar_t Zoltan2::EvaluatePartition< Adapter >::getObjectCountImbalance ( ) const

inline

Return the object count imbalance.

Definition at line 282 of file Zoltan2_EvaluatePartition.hpp.

◆ getNormedImbalance()

template<typename Adapter >

scalar_t Zoltan2::EvaluatePartition< Adapter >::getNormedImbalance ( ) const

inline

Return the object normed weight imbalance. Normed imbalance is only valid if there is at least 2 elements - the second one is the normed imbalance. If we have weights (which start at the second element) the spec is to have this return that element.

Definition at line 298 of file Zoltan2_EvaluatePartition.hpp.