topo::SpanningTreeVertex Class Reference

Contains indices to direct children. More...

#include <spanningTreeVertex.h>

Collaboration diagram for topo::SpanningTreeVertex:

[legend]

Public Member Functions
	SpanningTreeVertex (const vtxType _id=-1)
	Constructor.
bool	sameCoordinates (const SpanningTreeVertex &v) const
Data Fields
vtxType	id
	The id (PE) of the vertex.
std::vector< int >	X
	The parent of this vertex. Uncomment if needed.
std::vector< int >	childIndex
	Relative distance (in the container) from the position of this vertex to direct children (and their sub-tree members).
Friends
std::ostream &	operator<< (std::ostream &out, const SpanningTreeVertex &obj)
	Stream inserter. Note: not a member function.
bool	operator== (const SpanningTreeVertex &obj, const vtxType vtxID)
	Overload == and < to keep users happy.
bool	operator== (const vtxType vtxID, const SpanningTreeVertex &obj)
bool	operator< (const SpanningTreeVertex &obj, const vtxType vtxID)
bool	operator< (const vtxType vtxID, const SpanningTreeVertex &obj)

---

Detailed Description

Contains indices to direct children.

childIndex[i]+1 and childIndex[i+1] are the first and beyondLast indices of the sub-tree members of the child at childIndex[i].

Note:

: We're using a (vertex, edge) terminology to talk about spanning trees. Consciously staying away from using "node" to avoid ambiguity with machine nodes and PEs. This is inspite of the fact that typically a vertex of a spanning tree is a machine node / PE.

Definition at line 19 of file spanningTreeVertex.h.

---

Constructor & Destructor Documentation

topo::SpanningTreeVertex::SpanningTreeVertex

(

const vtxType

_id = -1

)

[inline]

Constructor.

Definition at line 31 of file spanningTreeVertex.h.

---

Member Function Documentation

bool topo::SpanningTreeVertex::sameCoordinates

(

const SpanningTreeVertex &

v

)

const [inline]

Definition at line 33 of file spanningTreeVertex.h.

References X.

---

Friends And Related Function Documentation

bool operator==	(	const SpanningTreeVertex &	obj,
		const vtxType	vtxID
	)			[friend]

Overload == and < to keep users happy.

Note: not member functions

Definition at line 38 of file spanningTreeVertex.h.

bool operator==	(	const vtxType	vtxID,
		const SpanningTreeVertex &	obj
	)			[friend]

Definition at line 41 of file spanningTreeVertex.h.

bool operator<	(	const SpanningTreeVertex &	obj,
		const vtxType	vtxID
	)			[friend]

Definition at line 44 of file spanningTreeVertex.h.

bool operator<	(	const vtxType	vtxID,
		const SpanningTreeVertex &	obj
	)			[friend]

Definition at line 47 of file spanningTreeVertex.h.

std::ostream& operator<<	(	std::ostream &	out,
		const SpanningTreeVertex &	obj
	)			[friend]

Stream inserter. Note: not a member function.

Definition at line 52 of file spanningTreeVertex.h.

---

Field Documentation

vtxType topo::SpanningTreeVertex::id

The id (PE) of the vertex.

Definition at line 23 of file spanningTreeVertex.h.

Referenced by topo::topo::SpanningTreeStrategy_3dTorus_minHops< Iterator, vtxType >::buildNextGen(), topo::topo::SpanningTreeStrategy_3dTorus_minBytesHops< Iterator, vtxType >::buildNextGen(), topo::getProcID(), topo::getSpanningTreeStrategy(), and topo::impl::vtxEqual::operator()().

std::vector<int> topo::SpanningTreeVertex::X

The parent of this vertex. Uncomment if needed.

The machine coordinates of this vertex

Definition at line 27 of file spanningTreeVertex.h.

Referenced by topo::impl::TreeBoundingBoxOn3dTorus< Iterator >::lessThan::operator()(), and sameCoordinates().

std::vector<int> topo::SpanningTreeVertex::childIndex

Relative distance (in the container) from the position of this vertex to direct children (and their sub-tree members).

Definition at line 29 of file spanningTreeVertex.h.

Referenced by topo::topo::SpanningTreeStrategy_topoUnaware< Iterator, SpanningTreeVertex >::buildNextGen(), topo::topo::SpanningTreeStrategy_nodeAware_minGens< Iterator, SpanningTreeVertex >::buildNextGen(), topo::topo::SpanningTreeStrategy_nodeAware_minBytes< Iterator, SpanningTreeVertex >::buildNextGen(), topo::topo::SpanningTreeStrategy_3dTorus_minBytesHops< Iterator, SpanningTreeVertex >::buildNextGen(), topo::impl::buildNextGen_nodeAware_minBytes(), topo::impl::buildNextGen_nodeAware_minGens(), topo::impl::buildNextGen_topoUnaware(), and topo::impl::buildSpanningTree().

---

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

• util/spanningTreeVertex.h