LibGeoDecomp::Region< DIM > Class Template Reference

Region stores a set of coordinates. More...

#include <region.h>

List of all members.

Classes
class	Iterator
class	StreakIterator
Public Types
typedef std::pair< int, int >	IntPair
typedef SuperVector< IntPair >	VecType
Public Member Functions
	Region ()
template<class ITERATOR1 , class ITERATOR2 >
	Region (const ITERATOR1 &start, const ITERATOR2 &end)
template<class ITERATOR1 , class ITERATOR2 >
void	load (const ITERATOR1 &start, const ITERATOR2 &end)
void	clear ()
const CoordBox< DIM > &	boundingBox () const
const long &	size () const
const unsigned	numStreaks () const
Region	expand (const unsigned &width=1) const
template<typename TOPOLOGY >
Region	expandWithTopology (const unsigned &width, const Coord< DIM > &dimensions, TOPOLOGY) const
	does the same as expand, but will wrap overlap at edges correctly.
bool	operator== (const Region< DIM > &other) const
bool	count (const Streak< DIM > &s) const
bool	count (const Coord< DIM > &c) const
template<typename ADDEND >
void	insert (const ADDEND &a)
Region &	operator<< (const Streak< DIM > &s)
Region &	operator<< (const Coord< DIM > &c)
Region &	operator<< (CoordBox< DIM > box)
Region &	operator>> (const Streak< DIM > &s)
Region &	operator>> (const Coord< DIM > &c)
void	operator-= (const Region &other)
Region	operator- (const Region &other) const
void	operator&= (const Region &other)
Region	operator& (const Region &other) const
void	operator+= (const Region &other)
Region	operator+ (const Region &other) const
SuperVector< Streak< DIM > >	toVector () const
std::string	toString () const
bool	empty () const
StreakIterator	beginStreak () const
StreakIterator	endStreak () const
Iterator	begin () const
Iterator	end () const
Private Member Functions
void	determineGeometry () const
void	resetGeometryCache () const
Streak< DIM >	trimStreak (const Streak< DIM > &s, const Coord< DIM > &dimensions) const
template<typename TOPOLOGY >
void	splitStreak (const Streak< DIM > &streak, Region *target, const Coord< DIM > &dimensions) const
template<typename TOPOLOGY >
void	normalizeStreak (const Streak< DIM > &streak, Region *target, const Coord< DIM > &dimensions) const
Private Attributes
VecType	indices [DIM]
CoordBox< DIM >	myBoundingBox
long	mySize
bool	geometryCacheTainted
Friends
class	RegionLookupHelper
class	RegionInsertHelper
class	RegionRemoveHelper
class	RegionTest

---

Detailed Description

template<int DIM>
class LibGeoDecomp::Region< DIM >

Region stores a set of coordinates.

It performs a run-length coding. Instead of storing complete Streak objects, these objects get split up and are stored implicitly in the hierarchical indices vectors.

---

Member Typedef Documentation

template<int DIM>

typedef std::pair<int, int> LibGeoDecomp::Region< DIM >::IntPair

template<int DIM>

typedef SuperVector<IntPair> LibGeoDecomp::Region< DIM >::VecType

---

Constructor & Destructor Documentation

template<int DIM>

LibGeoDecomp::Region< DIM >::Region

(

)

[inline]

template<int DIM>

template<class ITERATOR1 , class ITERATOR2 >

LibGeoDecomp::Region< DIM >::Region	(	const ITERATOR1 &	start,
		const ITERATOR2 &	end
	)			[inline]

References LibGeoDecomp::Region< DIM >::load().

---

Member Function Documentation

template<int DIM>

Iterator LibGeoDecomp::Region< DIM >::begin

(

void

)

const [inline]

References LibGeoDecomp::Region< DIM >::beginStreak().

Referenced by LibGeoDecomp::TestSteerer< DIM >::nextStep(), and CoordEnumerationBronze::performance().

template<int DIM>

StreakIterator LibGeoDecomp::Region< DIM >::beginStreak

(

)

const [inline]

Referenced by LibGeoDecomp::Region< DIM >::begin(), LibGeoDecomp::Region< DIM >::determineGeometry(), LibGeoDecomp::Region< DIM >::expand(), LibGeoDecomp::Region< DIM >::expandWithTopology(), LibGeoDecomp::HiParSimulator::GridVecConv::gridToVector(), LibGeoDecomp::Region< DIM >::operator&(), LibGeoDecomp::Region< DIM >::operator+=(), LibGeoDecomp::Region< DIM >::operator-=(), LibGeoDecomp::DisplacedGrid< CELL, BufferTopology >::paste(), LibGeoDecomp::DisplacedGrid< CELL, BufferTopology >::pasteGridBase(), CoordEnumerationGold::performance(), LibGeoDecomp::MPIIO< CELL_TYPE, TOPOLOGY >::readRegion(), LibGeoDecomp::MPILayer::recvUnregisteredRegion(), LibGeoDecomp::MPILayer::sendUnregisteredRegion(), LibGeoDecomp::Region< DIM >::toVector(), LibGeoDecomp::HiParSimulator::VanillaStepper< CELL_TYPE >::update(), LibGeoDecomp::StripingSimulator< CELL_TYPE >::updateRegion(), LibGeoDecomp::HiParSimulator::GridVecConv::vectorToGrid(), LibGeoDecomp::MPIIO< CELL_TYPE, TOPOLOGY >::writeRegion(), and LibGeoDecomp::BOVWriter< CELL_TYPE, SELECTOR_TYPE >::writeRegion().

template<int DIM>

const CoordBox<DIM>& LibGeoDecomp::Region< DIM >::boundingBox

(

)

const [inline]

References LibGeoDecomp::Region< DIM >::geometryCacheTainted, LibGeoDecomp::Region< DIM >::myBoundingBox, and LibGeoDecomp::Region< DIM >::resetGeometryCache().

template<int DIM>

void LibGeoDecomp::Region< DIM >::clear

(

)

[inline]

References LibGeoDecomp::Region< DIM >::geometryCacheTainted, LibGeoDecomp::Region< DIM >::indices, LibGeoDecomp::Region< DIM >::myBoundingBox, and LibGeoDecomp::Region< DIM >::mySize.

Referenced by LibGeoDecomp::MPILayer::recvRegion().

template<int DIM>

bool LibGeoDecomp::Region< DIM >::count

(

const Streak< DIM > &

s

)

const [inline]

Referenced by RegionCount::performance().

template<int DIM>

bool LibGeoDecomp::Region< DIM >::count

(

const Coord< DIM > &

c

)

const [inline]

template<int DIM>

void LibGeoDecomp::Region< DIM >::determineGeometry

(

)

const [inline, private]

References LibGeoDecomp::Region< DIM >::beginStreak(), LibGeoDecomp::Region< DIM >::empty(), LibGeoDecomp::Region< DIM >::endStreak(), LibGeoDecomp::Region< DIM >::myBoundingBox, LibGeoDecomp::Region< DIM >::mySize, and LibGeoDecomp::Streak< DIM >::origin.

Referenced by LibGeoDecomp::Region< DIM >::resetGeometryCache().

template<int DIM>

bool LibGeoDecomp::Region< DIM >::empty

(

void

)

const [inline]

References LibGeoDecomp::Region< DIM >::indices, and LibGeoDecomp::Region< DIM >::size().

Referenced by LibGeoDecomp::Region< DIM >::determineGeometry(), and LibGeoDecomp::Region< DIM >::operator>>().

template<int DIM>

Iterator LibGeoDecomp::Region< DIM >::end

(

void

)

const [inline]

References LibGeoDecomp::Region< DIM >::endStreak().

Referenced by LibGeoDecomp::TestSteerer< DIM >::nextStep(), and CoordEnumerationBronze::performance().

template<int DIM>

StreakIterator LibGeoDecomp::Region< DIM >::endStreak

(

)

const [inline]

Referenced by LibGeoDecomp::Region< DIM >::determineGeometry(), LibGeoDecomp::Region< DIM >::end(), LibGeoDecomp::Region< DIM >::expand(), LibGeoDecomp::Region< DIM >::expandWithTopology(), LibGeoDecomp::HiParSimulator::GridVecConv::gridToVector(), LibGeoDecomp::Region< DIM >::operator&(), LibGeoDecomp::Region< DIM >::operator+=(), LibGeoDecomp::Region< DIM >::operator-=(), LibGeoDecomp::DisplacedGrid< CELL, BufferTopology >::paste(), LibGeoDecomp::DisplacedGrid< CELL, BufferTopology >::pasteGridBase(), CoordEnumerationGold::performance(), LibGeoDecomp::MPIIO< CELL_TYPE, TOPOLOGY >::readRegion(), LibGeoDecomp::MPILayer::recvUnregisteredRegion(), LibGeoDecomp::MPILayer::sendUnregisteredRegion(), LibGeoDecomp::Region< DIM >::toVector(), LibGeoDecomp::HiParSimulator::VanillaStepper< CELL_TYPE >::update(), LibGeoDecomp::StripingSimulator< CELL_TYPE >::updateRegion(), LibGeoDecomp::HiParSimulator::GridVecConv::vectorToGrid(), LibGeoDecomp::MPIIO< CELL_TYPE, TOPOLOGY >::writeRegion(), and LibGeoDecomp::BOVWriter< CELL_TYPE, SELECTOR_TYPE >::writeRegion().

template<int DIM>

Region LibGeoDecomp::Region< DIM >::expand

(

const unsigned &

width = 1

)

const [inline]

References LibGeoDecomp::CoordBox< DIM >::begin(), LibGeoDecomp::Region< DIM >::beginStreak(), LibGeoDecomp::CoordBox< DIM >::end(), LibGeoDecomp::Region< DIM >::endStreak(), LibGeoDecomp::Streak< DIM >::endX, and LibGeoDecomp::Streak< DIM >::origin.

template<int DIM>

template<typename TOPOLOGY >

Region LibGeoDecomp::Region< DIM >::expandWithTopology	(	const unsigned &	width,
		const Coord< DIM > &	dimensions,
		TOPOLOGY
	)			const [inline]

does the same as expand, but will wrap overlap at edges correctly.

The instance of the TOPOLOGY is actually unused, but without it g++ would complain...

References LibGeoDecomp::CoordBox< DIM >::begin(), LibGeoDecomp::Region< DIM >::beginStreak(), LibGeoDecomp::CoordBox< DIM >::end(), LibGeoDecomp::Region< DIM >::endStreak(), LibGeoDecomp::Streak< DIM >::endX, LibGeoDecomp::Streak< DIM >::origin, and LibGeoDecomp::Region< DIM >::trimStreak().

Referenced by LibGeoDecomp::HiParSimulator::PartitionManager< DIM, Topology >::fillOwnRegion(), and LibGeoDecomp::HiParSimulator::PartitionManager< DIM, Topology >::fillRegion().

template<int DIM>

template<typename ADDEND >

void LibGeoDecomp::Region< DIM >::insert

(

const ADDEND &

a

)

[inline]

template<int DIM>

template<class ITERATOR1 , class ITERATOR2 >

void LibGeoDecomp::Region< DIM >::load	(	const ITERATOR1 &	start,
		const ITERATOR2 &	end
	)			[inline]

Referenced by LibGeoDecomp::MPILayer::recvRegion(), and LibGeoDecomp::Region< DIM >::Region().

template<int DIM>

template<typename TOPOLOGY >

void LibGeoDecomp::Region< DIM >::normalizeStreak	(	const Streak< DIM > &	streak,
		Region< DIM > *	target,
		const Coord< DIM > &	dimensions
	)			const [inline, private]

References LibGeoDecomp::Streak< DIM >::endX, LibGeoDecomp::Streak< DIM >::length(), and LibGeoDecomp::Streak< DIM >::origin.

template<int DIM>

const unsigned LibGeoDecomp::Region< DIM >::numStreaks

(

)

const [inline]

References LibGeoDecomp::Region< DIM >::indices.

Referenced by LibGeoDecomp::MPILayer::sendRegion(), and LibGeoDecomp::Region< DIM >::toVector().

template<int DIM>

Region LibGeoDecomp::Region< DIM >::operator&

(

const Region< DIM > &

other

)

const [inline]

References LibGeoDecomp::Region< DIM >::beginStreak(), LibGeoDecomp::Region< DIM >::endStreak(), LibGeoDecomp::Streak< DIM >::endX, and LibGeoDecomp::Streak< DIM >::origin.

template<int DIM>

void LibGeoDecomp::Region< DIM >::operator&=

(

const Region< DIM > &

other

)

[inline]

template<int DIM>

Region LibGeoDecomp::Region< DIM >::operator+

(

const Region< DIM > &

other

)

const [inline]

template<int DIM>

void LibGeoDecomp::Region< DIM >::operator+=

(

const Region< DIM > &

other

)

[inline]

References LibGeoDecomp::Region< DIM >::beginStreak(), and LibGeoDecomp::Region< DIM >::endStreak().

template<int DIM>

Region LibGeoDecomp::Region< DIM >::operator-

(

const Region< DIM > &

other

)

const [inline]

template<int DIM>

void LibGeoDecomp::Region< DIM >::operator-=

(

const Region< DIM > &

other

)

[inline]

References LibGeoDecomp::Region< DIM >::beginStreak(), and LibGeoDecomp::Region< DIM >::endStreak().

template<int DIM>

Region& LibGeoDecomp::Region< DIM >::operator<<

(

const Streak< DIM > &

s

)

[inline]

References LibGeoDecomp::Region< DIM >::geometryCacheTainted.

template<int DIM>

Region& LibGeoDecomp::Region< DIM >::operator<<

(

const Coord< DIM > &

c

)

[inline]

template<int DIM>

Region& LibGeoDecomp::Region< DIM >::operator<<

(

CoordBox< DIM >

box

)

[inline]

template<int DIM>

bool LibGeoDecomp::Region< DIM >::operator==

(

const Region< DIM > &

other

)

const [inline]

References LibGeoDecomp::Region< DIM >::indices.

template<int DIM>

Region& LibGeoDecomp::Region< DIM >::operator>>

(

const Coord< DIM > &

c

)

[inline]

template<int DIM>

Region& LibGeoDecomp::Region< DIM >::operator>>

(

const Streak< DIM > &

s

)

[inline]

References LibGeoDecomp::Region< DIM >::empty(), LibGeoDecomp::Streak< DIM >::endX, LibGeoDecomp::Region< DIM >::geometryCacheTainted, and LibGeoDecomp::Streak< DIM >::origin.

template<int DIM>

void LibGeoDecomp::Region< DIM >::resetGeometryCache

(

)

const [inline, private]

References LibGeoDecomp::Region< DIM >::determineGeometry(), and LibGeoDecomp::Region< DIM >::geometryCacheTainted.

Referenced by LibGeoDecomp::Region< DIM >::boundingBox(), and LibGeoDecomp::Region< DIM >::size().

template<int DIM>

const long& LibGeoDecomp::Region< DIM >::size

(

void

)

const [inline]

References LibGeoDecomp::Region< DIM >::geometryCacheTainted, LibGeoDecomp::Region< DIM >::mySize, and LibGeoDecomp::Region< DIM >::resetGeometryCache().

Referenced by LibGeoDecomp::Region< DIM >::empty(), LibGeoDecomp::HiParSimulator::GridVecConv::gridToVector(), and LibGeoDecomp::HiParSimulator::GridVecConv::vectorToGrid().

template<int DIM>

template<typename TOPOLOGY >

void LibGeoDecomp::Region< DIM >::splitStreak	(	const Streak< DIM > &	streak,
		Region< DIM > *	target,
		const Coord< DIM > &	dimensions
	)			const [inline, private]

References LibGeoDecomp::Streak< DIM >::endX, and LibGeoDecomp::Streak< DIM >::origin.

template<int DIM>

std::string LibGeoDecomp::Region< DIM >::toString

(

)

const [inline]

References LibGeoDecomp::Region< DIM >::indices.

template<int DIM>

SuperVector<Streak<DIM> > LibGeoDecomp::Region< DIM >::toVector

(

)

const [inline]

References LibGeoDecomp::Region< DIM >::beginStreak(), LibGeoDecomp::copy(), LibGeoDecomp::Region< DIM >::endStreak(), and LibGeoDecomp::Region< DIM >::numStreaks().

Referenced by LibGeoDecomp::MPILayer::sendRegion().

template<int DIM>

Streak<DIM> LibGeoDecomp::Region< DIM >::trimStreak	(	const Streak< DIM > &	s,
		const Coord< DIM > &	dimensions
	)			const [inline, private]

References LibGeoDecomp::Streak< DIM >::endX, and LibGeoDecomp::Streak< DIM >::origin.

Referenced by LibGeoDecomp::Region< DIM >::expandWithTopology().

---

Friends And Related Function Documentation

template<int DIM>

friend class RegionInsertHelper [friend]

template<int DIM>

friend class RegionLookupHelper [friend]

template<int DIM>

friend class RegionRemoveHelper [friend]

template<int DIM>

friend class RegionTest [friend]

---

Member Data Documentation

template<int DIM>

bool LibGeoDecomp::Region< DIM >::geometryCacheTainted [mutable, private]

Referenced by LibGeoDecomp::Region< DIM >::boundingBox(), LibGeoDecomp::Region< DIM >::clear(), LibGeoDecomp::Region< DIM >::operator<<(), LibGeoDecomp::Region< DIM >::operator>>(), LibGeoDecomp::Region< DIM >::resetGeometryCache(), and LibGeoDecomp::Region< DIM >::size().

template<int DIM>

VecType LibGeoDecomp::Region< DIM >::indices[DIM] [private]

Referenced by LibGeoDecomp::Region< DIM >::clear(), LibGeoDecomp::Region< DIM >::empty(), LibGeoDecomp::Region< DIM >::numStreaks(), LibGeoDecomp::RegionRemoveHelper< 0 >::operator()(), LibGeoDecomp::RegionRemoveHelper< DIM >::operator()(), LibGeoDecomp::RegionInsertHelper< 0 >::operator()(), LibGeoDecomp::RegionInsertHelper< DIM >::operator()(), LibGeoDecomp::RegionLookupHelper< 0 >::operator()(), LibGeoDecomp::RegionLookupHelper< DIM >::operator()(), LibGeoDecomp::Region< DIM >::operator==(), and LibGeoDecomp::Region< DIM >::toString().

template<int DIM>

CoordBox<DIM> LibGeoDecomp::Region< DIM >::myBoundingBox [mutable, private]

Referenced by LibGeoDecomp::Region< DIM >::boundingBox(), LibGeoDecomp::Region< DIM >::clear(), and LibGeoDecomp::Region< DIM >::determineGeometry().

template<int DIM>

long LibGeoDecomp::Region< DIM >::mySize [mutable, private]

Referenced by LibGeoDecomp::Region< DIM >::clear(), LibGeoDecomp::Region< DIM >::determineGeometry(), and LibGeoDecomp::Region< DIM >::size().

---

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

• misc/region.h