DenseIntVectSet Class Reference

#include <DenseIntVectSet.H>

List of all members.

---

Detailed Description

Dense representation implementation of IntVectSet class.

Performance-oriented class that reproduces most of the functionality of IntVectSet. This object stores a dense representation of an IntVectSet over the box of definition

Storage is performed with a BitSet. This stores 0 or 1 on a per-bit basis for each location in the IntVectSet.

For an explanation of undocumented functions look at IntVectSet

See also:

IntVectSet

Public Member Functions
	DenseIntVectSet ()
	DenseIntVectSet (const Box &a_domain, bool init=true)
DenseIntVectSet &	operator-= (const Box &box)
DenseIntVectSet &	operator-= (const IntVect &intvect)
DenseIntVectSet &	operator-= (const DenseIntVectSet &ivs)
DenseIntVectSet &	operator &= (const Box &box)
DenseIntVectSet &	operator &= (const ProblemDomain &domain)
DenseIntVectSet &	operator|= (const IntVect &intvect)
DenseIntVectSet &	operator|= (const Box &b)
DenseIntVectSet &	operator|= (const DenseIntVectSet &b)
DenseIntVectSet &	operator &= (const DenseIntVectSet &ivs)
void	shift (const IntVect &iv)
	Shift every cell in the set by the input. Fast.
bool	operator[] (const IntVect &index) const
	O(1) time inquiry of containment.
bool	contains (const Box &box) const
	O(1) time inquiry of containment.
void	coarsen (int iref)
void	refine (int iref)
void	grow (int igrow)
void	grow (int idir, int igrow)
void	growHi ()
void	growHi (const int a_dir)
void	makeEmptyBits ()
DenseIntVectSet	chop (int dir, int chop_pnt)
const Box &	box () const
void	nestingRegion (int a_radius, const Box &a_domain)
void	nestingRegion (int a_radius, const ProblemDomain &a_domain)
bool	isEmpty () const
	cheaper than numPts()==0 by wide margin
bool	isFull () const
	cheaper than numPts()==box().numPts(), by significant margin
bool	isHighEmpty () const
bool	isHighEmpty (const int a_dir) const
int	numPts () const
bool	operator== (const DenseIntVectSet &a_lhs) const
bool	operator< (const DenseIntVectSet &a_ivs) const
Vector< Box >	createBoxes () const
void	compact () const
void	recalcMinBox () const
const Box &	mBox () const
Linearization routines
int	linearSize () const
void	linearIn (const void *const inBuf)
void	linearOut (void *const a_outBuf) const
Private Member Functions
void	grow (const IntVect &iv)
DenseIntVectSet &	intersect (const DenseIntVectSet &rhs)
bool	isHighEmpty (const int a_dirS, const int a_dirE) const
Private Attributes
Box	m_domain
BitSet	m_bits
Box	m_minBox
Friends
class	DenseIntVectSetIterator

---

Constructor & Destructor Documentation

DenseIntVectSet::DenseIntVectSet

(

)

[inline]

DenseIntVectSet::DenseIntVectSet	(	const Box &	a_domain,
		bool	init = true
	)

you can either have the domain begin all true, or all false

---

Member Function Documentation

DenseIntVectSet& DenseIntVectSet::operator-=

(

const Box &

box

)

make this set the complement of itself and the input

DenseIntVectSet & DenseIntVectSet::operator-=

(

const IntVect &

intvect

)

[inline]

make this set the complement of itself and the input

References Box::contains(), Box::index(), m_bits, m_domain, and BitSet::setFalse().

DenseIntVectSet& DenseIntVectSet::operator-=

(

const DenseIntVectSet &

ivs

)

make this set the complement of itself and the input

DenseIntVectSet& DenseIntVectSet::operator &=

(

const Box &

box

)

make this set the intersection of itself and the input

DenseIntVectSet& DenseIntVectSet::operator &=

(

const ProblemDomain &

domain

)

make this set the intersection of itself and the input

DenseIntVectSet& DenseIntVectSet::operator|=

(

const IntVect &

intvect

)

make this set the union of itself and the input. intvect MUST be within the domain of of the DenseIntVectSet or this will throw an error

DenseIntVectSet& DenseIntVectSet::operator|=

(

const Box &

b

)

make this set the union of itself and the input. b MUST be within the domain of of the DenseIntVectSet or this will throw an error

DenseIntVectSet& DenseIntVectSet::operator|=

(

const DenseIntVectSet &

b

)

make this set the union of itself and the input. resulting DenseIntVectSet has domain of the minBox holding both oeprator and operand

DenseIntVectSet& DenseIntVectSet::operator &=

(

const DenseIntVectSet &

ivs

)

make this set the intersection of itself and the input

void DenseIntVectSet::shift

(

const IntVect &

iv

)

[inline]

Shift every cell in the set by the input. Fast.

Shift every cell in the set by the input.

References m_domain, m_minBox, and Box::shift().

bool DenseIntVectSet::operator[]

(

const IntVect &

index

)

const

O(1) time inquiry of containment.

bool DenseIntVectSet::contains

(

const Box &

box

)

const

O(1) time inquiry of containment.

returns 'true' if the entire set of points specified by the box 'b' is a member of the IntvectSet

void DenseIntVectSet::coarsen

(

int

iref

)

coarsen the set by the input

void DenseIntVectSet::refine

(

int

iref

)

refine the set by the input

void DenseIntVectSet::grow

(

int

igrow

)

grow the set by the input

void DenseIntVectSet::grow	(	int	idir,
		int	igrow
	)

grow the set by the input

void DenseIntVectSet::growHi

(

)

See also:

IntVectSet::growHi

void DenseIntVectSet::growHi

(

const int

a_dir

)

See also:

IntVectSet::growHi(int)

void DenseIntVectSet::makeEmptyBits

(

)

Make empty by setting all bits to false

DenseIntVectSet DenseIntVectSet::chop	(	int	dir,
		int	chop_pnt
	)

Chop the DenseIntVectSet at the chop_pnt in the dir direction Returns one DenseIntVectSet and modifies the object DenseIntVectSet. The union of the two is the original IntVectSet. The modified DenseIntVectSet is the low end, the returned DenseIntvectSet is the high end.

See also:

IntVectSet::chop

const Box & DenseIntVectSet::box

(

)

const [inline]

References m_domain.

void DenseIntVectSet::nestingRegion	(	int	a_radius,
		const Box &	a_domain
	)

See also:

IntVectSet::nestingRegion

void DenseIntVectSet::nestingRegion	(	int	a_radius,
		const ProblemDomain &	a_domain
	)

bool DenseIntVectSet::isEmpty

(

)

const

cheaper than numPts()==0 by wide margin

return true if the set has no points

bool DenseIntVectSet::isFull

(

)

const

cheaper than numPts()==box().numPts(), by significant margin

return true if the set consists of a set of a full box

bool DenseIntVectSet::isHighEmpty

(

)

const

Return true if all bits on the high hyperfaces are zero

bool DenseIntVectSet::isHighEmpty

(

const int

a_dir

)

const

Return true if all bits on the high hyperface are zero

int DenseIntVectSet::numPts

(

)

const

return the number of points in the set

bool DenseIntVectSet::operator==

(

const DenseIntVectSet &

a_lhs

)

const

bool DenseIntVectSet::operator<

(

const DenseIntVectSet &

a_ivs

)

const

Primary sorting criterion: Box::operator<() applied to m_domain. Secondary sorting criterion: BitSet::operator<() applied to m_bits.

Vector<Box> DenseIntVectSet::createBoxes

(

)

const

turn DenseIntVectSet into a Vector of Boxes

void DenseIntVectSet::compact

(

)

const

set object to its minimum representation. changes data, but is a logically const operation

void DenseIntVectSet::recalcMinBox

(

)

const

const Box& DenseIntVectSet::mBox

(

)

const [inline]

References m_minBox.

int DenseIntVectSet::linearSize

(

)

const

void DenseIntVectSet::linearIn

(

const void *const

inBuf

)

void DenseIntVectSet::linearOut

(

void *const

a_outBuf

)

const

void DenseIntVectSet::grow

(

const IntVect &

iv

)

[private]

DenseIntVectSet& DenseIntVectSet::intersect

(

const DenseIntVectSet &

rhs

)

[private]

bool DenseIntVectSet::isHighEmpty	(	const int	a_dirS,
		const int	a_dirE
	)			const [private]

---

Friends And Related Function Documentation

friend class DenseIntVectSetIterator [friend]

---

Member Data Documentation

Box DenseIntVectSet::m_domain [private]

Referenced by box(), operator-=(), DenseIntVectSetIterator::setStride(), and shift().

BitSet DenseIntVectSet::m_bits [private]

Referenced by DenseIntVectSetIterator::define(), and operator-=().

Box DenseIntVectSet::m_minBox [private]

Referenced by mBox(), and shift().

---

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

• DenseIntVectSet.H