topo::SpanningTreeStrategy< Iterator, ValueType > Class Template Reference

The spanning tree build strategy interface. More...

#include <spanningTreeStrategy.h>

Inheritance diagram for topo::SpanningTreeStrategy< Iterator, ValueType >:

[legend]

Public Member Functions
virtual	~SpanningTreeStrategy ()
virtual SpanningTreeVertex *	buildNextGen (const Iterator firstVtx, const Iterator beyondLastVtx, const int maxBranches=2)=0
	Concrete builders should implement this (preferably only for the appropriate specializations).

---

Detailed Description

template<typename Iterator, typename ValueType>
class topo::SpanningTreeStrategy< Iterator, ValueType >

The spanning tree build strategy interface.

Partitions and reorders a collection of tree members, and returns information about children and their sub-trees.

Warning:

: User code should only specify typename Iterator. ValType is automatically given the default value based on Iterator and should not be specified by the user.

Todo:

: If compile-time asserts become available in the charm world, then assert that ValType is nothing illegal in the appropriate subclasses. Better still, (if possible) let the subclass remain abstract and implement buildNextGen only for the appropriate partial specializations of ValType.

Definition at line 169 of file spanningTreeStrategy.h.

---

Constructor & Destructor Documentation

template<typename Iterator, typename ValueType>

virtual topo::SpanningTreeStrategy< Iterator, ValueType >::~SpanningTreeStrategy

(

)

[inline, virtual]

Definition at line 172 of file spanningTreeStrategy.h.

---

Member Function Documentation

template<typename Iterator, typename ValueType>

virtual SpanningTreeVertex* topo::SpanningTreeStrategy< Iterator, ValueType >::buildNextGen	(	const Iterator	firstVtx,
		const Iterator	beyondLastVtx,
		const int	maxBranches = 2
	)			[pure virtual]

Concrete builders should implement this (preferably only for the appropriate specializations).

Implemented in topo::SpanningTreeStrategy_3dTorus_minBytesHops< Iterator, ValueType >, topo::topo::SpanningTreeStrategy_3dTorus_minBytesHops< Iterator, SpanningTreeVertex >, topo::topo::SpanningTreeStrategy_3dTorus_minBytesHops< Iterator, vtxType >, topo::SpanningTreeStrategy_3dTorus_minHops< Iterator, ValueType >, topo::topo::SpanningTreeStrategy_3dTorus_minHops< Iterator, SpanningTreeVertex >, topo::topo::SpanningTreeStrategy_3dTorus_minHops< Iterator, vtxType >, topo::SpanningTreeStrategy_nodeAware_minBytes< Iterator, ValueType >, topo::topo::SpanningTreeStrategy_nodeAware_minBytes< Iterator, SpanningTreeVertex >, topo::SpanningTreeStrategy_nodeAware_minGens< Iterator, ValueType >, topo::topo::SpanningTreeStrategy_nodeAware_minGens< Iterator, SpanningTreeVertex >, topo::SpanningTreeStrategy_topoUnaware< Iterator, ValueType >, and topo::topo::SpanningTreeStrategy_topoUnaware< Iterator, SpanningTreeVertex >.

Referenced by topo::buildSpanningTreeGeneration().

Here is the caller graph for this function:

---

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

• util/spanningTreeStrategy.h