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

#include <Zoltan2_Algorithm.hpp>

Inheritance diagram for Zoltan2::Algorithm< Adapter >:

[legend]

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 > > &solution)
	Ordering method. More...

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

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

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

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

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

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

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

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

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

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

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

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

virtual void	getMyPartsView (part_t &numParts, part_t *&parts)
	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 55 of file Zoltan2_Algorithm.hpp.

Member Typedef Documentation

◆ lno_t

template<typename Adapter>

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

Definition at line 81 of file Zoltan2_Algorithm.hpp.

◆ gno_t

template<typename Adapter>

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

Definition at line 82 of file Zoltan2_Algorithm.hpp.

◆ scalar_t

template<typename Adapter>

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

Definition at line 83 of file Zoltan2_Algorithm.hpp.

◆ part_t

template<typename Adapter>

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

Definition at line 84 of file Zoltan2_Algorithm.hpp.

Constructor & Destructor Documentation

◆ ~Algorithm()

template<typename Adapter>

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

inlinevirtual

Definition at line 87 of file Zoltan2_Algorithm.hpp.

Member Function Documentation

◆ localOrder()

template<typename Adapter>

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

inlinevirtual

Ordering method.

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

Definition at line 90 of file Zoltan2_Algorithm.hpp.

◆ globalOrder()

template<typename Adapter>

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

inlinevirtual

Ordering method.

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

Definition at line 96 of file Zoltan2_Algorithm.hpp.

◆ color()

template<typename Adapter>

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

inlinevirtual

Coloring method.

Reimplemented in Zoltan2::AlgSerialGreedy< Adapter >.

Definition at line 102 of file Zoltan2_Algorithm.hpp.

◆ match()

template<typename Adapter>

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

inlinevirtual

Matching method.

Definition at line 108 of file Zoltan2_Algorithm.hpp.

◆ partition()

template<typename Adapter>

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

inlinevirtual

Partitioning method.

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

Definition at line 113 of file Zoltan2_Algorithm.hpp.

◆ map()

template<typename Adapter>

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

inlinevirtual

Mapping method.

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

Definition at line 119 of file Zoltan2_Algorithm.hpp.

◆ isPartitioningTreeBinary()

template<typename Adapter>

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

inlinevirtual

return if algorithm determins tree to be binary

Definition at line 125 of file Zoltan2_Algorithm.hpp.

◆ getPartitionTree()

template<typename Adapter>

virtual void Zoltan2::Algorithm< Adapter >::getPartitionTree	(	part_t	numParts,
		part_t &	numTreeVerts,
		std::vector< part_t > &	permPartNums,
		std::vector< part_t > &	splitRangeBeg,
		std::vector< part_t > &	splitRangeEnd,
		std::vector< part_t > &	treeVertParents
	)		const

inlinevirtual

for partitioning methods, fill arrays with partition tree info

Definition at line 131 of file Zoltan2_Algorithm.hpp.

◆ getPartBoxesView()

template<typename Adapter>

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

inlinevirtual

for partitioning methods, return bounding boxes of the

Reimplemented in Zoltan2::Zoltan2_AlgMJ< Adapter >.

Definition at line 147 of file Zoltan2_Algorithm.hpp.

◆ pointAssign()

template<typename Adapter>

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

inlinevirtual

pointAssign method: Available only for some partitioning algorithms

Definition at line 161 of file Zoltan2_Algorithm.hpp.

◆ boxAssign()

template<typename Adapter>

virtual void Zoltan2::Algorithm< Adapter >::boxAssign	(	int	dim,
		scalar_t *	lower,
		scalar_t *	upper,
		size_t &	nParts,
		part_t **	partsFound
	)		const

inlinevirtual

boxAssign method: Available only for some partitioning algorithms

Definition at line 179 of file Zoltan2_Algorithm.hpp.

◆ getCommunicationGraph()

template<typename Adapter>

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

inlinevirtual

returns serial communication graph of a computed partition

Definition at line 195 of file Zoltan2_Algorithm.hpp.

◆ getRankForPart()

template<typename Adapter>

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

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 212 of file Zoltan2_Algorithm.hpp.

◆ getMyPartsView()

template<typename Adapter>

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

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 227 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

◆ lno_t

◆ gno_t

◆ scalar_t

◆ part_t

Constructor & Destructor Documentation

◆ ~Algorithm()

Member Function Documentation

◆ localOrder()

◆ globalOrder()

◆ color()

◆ match()

◆ partition()

◆ map()

◆ isPartitioningTreeBinary()

◆ getPartitionTree()

◆ getPartBoxesView()

◆ pointAssign()

◆ boxAssign()

◆ getCommunicationGraph()

◆ getRankForPart()

◆ getMyPartsView()

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