Algorithm defines the base class for all algorithms. More...

#include <Zoltan2_Algorithm.hpp>

Inheritance diagram for Zoltan2::Algorithm< Adapter >:

Public Types
typedef Adapter::lno_t	lno_t

typedef Adapter::gno_t	gno_t

typedef Adapter::scalar_t	scalar_t

typedef Adapter::part_t	part_t

Public Member Functions
virtual	~Algorithm ()

virtual int	localOrder (const RCP< LocalOrderingSolution< lno_t > > &)
	Ordering method. More...

virtual int	globalOrder (const RCP< GlobalOrderingSolution< gno_t > > &)
	Ordering method. More...

virtual void	color (const RCP< ColoringSolution< Adapter > > &)
	Coloring method. More...

virtual void	match ()
	Matching method. More...

virtual void	partition (const RCP< PartitioningSolution< Adapter > > &)
	Partitioning method. More...

virtual void	partitionMatrix (const RCP< MatrixPartitioningSolution< Adapter > > &)
	Matrix Partitioning method. More...

virtual void	map (const RCP< MappingSolution< Adapter > > &)
	Mapping method. More...

virtual bool	isPartitioningTreeBinary () const
	return if algorithm determins tree to be binary More...

virtual void	getPartitionTree (part_t, part_t &, std::vector< part_t > &, std::vector< part_t > &, std::vector< part_t > &, std::vector< part_t > &) const
	for partitioning methods, fill arrays with partition tree info More...

virtual std::vector < coordinateModelPartBox > &	getPartBoxesView () const
	for partitioning methods, return bounding boxes of the More...

virtual part_t	pointAssign (int, scalar_t *) const
	pointAssign method: Available only for some partitioning algorithms More...

virtual void	boxAssign (int, scalar_t , scalar_t , size_t &, part_t **) const
	boxAssign method: Available only for some partitioning algorithms More...

virtual void	getCommunicationGraph (const PartitioningSolution< Adapter > *, ArrayRCP< part_t > &, ArrayRCP< part_t > &)
	returns serial communication graph of a computed partition More...

virtual int	getRankForPart (part_t)
	In mapping, returns the rank to which a part is assigned. More...

virtual void	getMyPartsView (part_t &, part_t *&)
	In mapping, returns a view of parts assigned to the current rank. More...

Detailed Description

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

Algorithm defines the base class for all algorithms.

Definition at line 19 of file Zoltan2_Algorithm.hpp.

Member Typedef Documentation

template<typename Adapter >

typedef Adapter::lno_t Zoltan2::Algorithm< Adapter >::lno_t

Definition at line 46 of file Zoltan2_Algorithm.hpp.

template<typename Adapter >

typedef Adapter::gno_t Zoltan2::Algorithm< Adapter >::gno_t

Definition at line 47 of file Zoltan2_Algorithm.hpp.

template<typename Adapter >

typedef Adapter::scalar_t Zoltan2::Algorithm< Adapter >::scalar_t

Definition at line 48 of file Zoltan2_Algorithm.hpp.

template<typename Adapter >

typedef Adapter::part_t Zoltan2::Algorithm< Adapter >::part_t

Definition at line 49 of file Zoltan2_Algorithm.hpp.

Constructor & Destructor Documentation

template<typename Adapter >

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

inlinevirtual

Definition at line 52 of file Zoltan2_Algorithm.hpp.

Member Function Documentation

template<typename Adapter >

virtual int Zoltan2::Algorithm< Adapter >::localOrder ( const RCP< LocalOrderingSolution< lno_t > > & )

inlinevirtual

Ordering method.

Reimplemented in Zoltan2::AlgAMD< Adapter >, Zoltan2::AlgRCM< Adapter >, Zoltan2::AlgSortedDegree< Adapter >, Zoltan2::AlgMetis< Adapter >, Zoltan2::AlgRandom< Adapter >, and Zoltan2::AlgNatural< Adapter >.

Definition at line 55 of file Zoltan2_Algorithm.hpp.

template<typename Adapter >

virtual int Zoltan2::Algorithm< Adapter >::globalOrder ( const RCP< GlobalOrderingSolution< gno_t > > & )

inlinevirtual

Ordering method.

Reimplemented in Zoltan2::AlgAMD< Adapter >, Zoltan2::AlgRCM< Adapter >, Zoltan2::AlgSortedDegree< Adapter >, Zoltan2::AlgMetis< Adapter >, Zoltan2::AlgNatural< Adapter >, and Zoltan2::AlgRandom< Adapter >.

Definition at line 61 of file Zoltan2_Algorithm.hpp.

template<typename Adapter >

virtual void Zoltan2::Algorithm< Adapter >::color ( const RCP< ColoringSolution< Adapter > > & )

inlinevirtual

Coloring method.

Reimplemented in Zoltan2::AlgTwoGhostLayer< Adapter >, Zoltan2::AlgDistance1< Adapter >, and Zoltan2::AlgSerialGreedy< Adapter >.

Definition at line 67 of file Zoltan2_Algorithm.hpp.

template<typename Adapter >

virtual void Zoltan2::Algorithm< Adapter >::match ( )

inlinevirtual

Matching method.

Definition at line 73 of file Zoltan2_Algorithm.hpp.

template<typename Adapter >

virtual void Zoltan2::Algorithm< Adapter >::partition ( const RCP< PartitioningSolution< Adapter > > & )

inlinevirtual

Partitioning method.

Reimplemented in Zoltan2::Zoltan2_AlgMJ< Adapter >, Zoltan2::AlgZoltan< Adapter >, Zoltan2::AlgQuotient< Adapter >, Zoltan2::AlgBlock< Adapter >, and Zoltan2::AlgForTestingOnly< Adapter >.

Definition at line 78 of file Zoltan2_Algorithm.hpp.

template<typename Adapter >

virtual void Zoltan2::Algorithm< Adapter >::partitionMatrix ( const RCP< MatrixPartitioningSolution< Adapter > > & )

inlinevirtual

Matrix Partitioning method.

Reimplemented in Zoltan2::AlgMatrix< Adapter >.

Definition at line 84 of file Zoltan2_Algorithm.hpp.

template<typename Adapter >

virtual void Zoltan2::Algorithm< Adapter >::map ( const RCP< MappingSolution< Adapter > > & )

inlinevirtual

Mapping method.

Reimplemented in Zoltan2::CoordinateTaskMapper< Adapter, part_t >.

Definition at line 90 of file Zoltan2_Algorithm.hpp.

template<typename Adapter >

virtual bool Zoltan2::Algorithm< Adapter >::isPartitioningTreeBinary ( ) const

inlinevirtual

return if algorithm determins tree to be binary

Definition at line 96 of file Zoltan2_Algorithm.hpp.

template<typename Adapter >

virtual void Zoltan2::Algorithm< Adapter >::getPartitionTree	(	part_t	,
		part_t &	,
		std::vector< part_t > &	,
		std::vector< part_t > &	,
		std::vector< part_t > &	,
		std::vector< part_t > &
	)		const

inlinevirtual

for partitioning methods, fill arrays with partition tree info

Definition at line 102 of file Zoltan2_Algorithm.hpp.

template<typename Adapter >

virtual std::vector<coordinateModelPartBox>& Zoltan2::Algorithm< Adapter >::getPartBoxesView ( ) const

inlinevirtual

for partitioning methods, return bounding boxes of the

Reimplemented in Zoltan2::Zoltan2_AlgMJ< Adapter >.

Definition at line 118 of file Zoltan2_Algorithm.hpp.

template<typename Adapter >

virtual part_t Zoltan2::Algorithm< Adapter >::pointAssign	(	int	,
		scalar_t *
	)		const

inlinevirtual

pointAssign method: Available only for some partitioning algorithms

Definition at line 132 of file Zoltan2_Algorithm.hpp.

template<typename Adapter >

virtual void Zoltan2::Algorithm< Adapter >::boxAssign	(	int	,
		scalar_t *	,
		scalar_t *	,
		size_t &	,
		part_t **
	)		const

inlinevirtual

boxAssign method: Available only for some partitioning algorithms

Definition at line 150 of file Zoltan2_Algorithm.hpp.

template<typename Adapter >

virtual void Zoltan2::Algorithm< Adapter >::getCommunicationGraph	(	const PartitioningSolution< Adapter > *	,
		ArrayRCP< part_t > &	,
		ArrayRCP< part_t > &
	)

inlinevirtual

returns serial communication graph of a computed partition

Definition at line 166 of file Zoltan2_Algorithm.hpp.

template<typename Adapter >

virtual int Zoltan2::Algorithm< Adapter >::getRankForPart ( part_t )

inlinevirtual

In mapping, returns the rank to which a part is assigned.

Reimplemented in Zoltan2::AlgBlockMapping< Adapter, MachineRep >, Zoltan2::AlgDefaultMapping< Adapter, MachineRep >, Zoltan2::AlgDefaultMapping< Adapter, MachineRep >, and Zoltan2::AlgDefaultMapping< Adapter, MachineRep >.

Definition at line 183 of file Zoltan2_Algorithm.hpp.

template<typename Adapter >

virtual void Zoltan2::Algorithm< Adapter >::getMyPartsView	(	part_t &	,
		part_t *&
	)

inlinevirtual

In mapping, returns a view of parts assigned to the current rank.

Reimplemented in Zoltan2::AlgDefaultMapping< Adapter, MachineRep >, and Zoltan2::AlgBlockMapping< Adapter, MachineRep >.

Definition at line 198 of file Zoltan2_Algorithm.hpp.

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

Zoltan2_Algorithm.hpp

Public Types

Public Member Functions

Detailed Description

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

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

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