ViewIndexer< Dim, Dim2 > Class Template Reference

ViewIndexer translates indices in a Dim-dimensional domain back to the corresponding indices in the original Dim2-dimensional domain, taking into account things like slices. More...

#include <ViewIndexer.h>

Inheritance diagram for ViewIndexer< Dim, Dim2 >:

[legend]

Collaboration diagram for ViewIndexer< Dim, Dim2 >:

[legend]

List of all members.

Public Types
typedef ViewIndexer< Dim, Dim2 >	This_t
typedef Interval< Dim >	Domain_t
typedef Range< Dim2 >	BaseDomain_t
typedef Loc< Dim2 >	Mask_t
Public Member Functions
	ViewIndexer ()
template<class DT >
	ViewIndexer (const SliceDomain< DT > &dom)
template<class DT >
	ViewIndexer (const ViewIndexer< Dim, Dim2 > &orig, const Domain< Dim, DT > &dom)
template<int OrigDim, class DT >
	ViewIndexer (const ViewIndexer< OrigDim, Dim2 > &orig, const SliceDomain< DT > &dom)
	ViewIndexer (const This_t &model)
This_t &	operator= (const This_t &rhs)
const Domain_t &	domain () const
const BaseDomain_t &	baseDomain () const
int	indirection (int i) const
const Mask_t &	mask () const
int	offset (int i) const
int	stride (int i) const
void	translate (const Loc< Dim > &loc, Loc< Dim2 > &oloc) const
void	translate (int i0, Loc< Dim2 > &loc) const
void	translate (int i0, int i1, Loc< Dim2 > &loc) const
void	translate (int i0, int i1, int i2, Loc< Dim2 > &loc) const
void	translate (int i0, int i1, int i2, int i3, Loc< Dim2 > &loc) const
void	translate (int i0, int i1, int i2, int i3, int i4, Loc< Dim2 > &loc) const
void	translate (int i0, int i1, int i2, int i3, int i4, int i5, Loc< Dim2 > &loc) const
void	translate (int i0, int i1, int i2, int i3, int i4, int i5, int i6, Loc< Dim2 > &loc) const
template<class DT >
BaseDomain_t &	localToBase (const Domain< Dim, DT > &dlocal, BaseDomain_t &base) const
template<class DT >
SliceRange< Dim2, Dim > &	localToBase (const Domain< Dim, DT > &dlocal, SliceRange< Dim2, Dim > &base) const
Interval< Dim > &	baseToLocal (const BaseDomain_t &base, Interval< Dim > &local) const
Range< Dim > &	baseToLocal (const BaseDomain_t &base, Range< Dim > &local) const
Interval< Dim > &	baseToLocalInterval (const Interval< Dim2 > &base, Interval< Dim > &local) const

---

Detailed Description

template<int Dim, int Dim2>
class ViewIndexer< Dim, Dim2 >

ViewIndexer translates indices in a Dim-dimensional domain back to the corresponding indices in the original Dim2-dimensional domain, taking into account things like slices.

Exported typedefs:

• BaseDomain_t - the type of base domain for this ViewIndexer.
• Domain_t - the type of domain for this ViewIndexer.
• Mask_t - the type of mask for this ViewIndexer.
• This_t - this class.

Constructors:

• ViewIndexer() - default initialization creates empty domains and leaves the rest uninitialized. Initialization can be completed with operator=().
• ViewIndexer(const SliceDomain<DT> &) - constructs a ViewIndexer for the first slice-type view of a domain.
• ViewIndexer(const ViewIndexer<Dim, Dim2> &, const Domain<Dim, DT> &) - constructs a new ViewIndexer from another one by taking a non-slice view.
• ViewIndexer(const ViewIndexer<OrigDim, Dim2> &, const SliceDomain<DT> &) constructs a new ViewIndexer from another one by taking a slice.
• ViewIndexer(const This_t &) - copy constructor.

Operators:

• operator=(const This_t &) - copy assignment operator.

Accessors:

• baseDomain() - returns the base domain.
• domain() - returns the domain.
• indirection(int i ) - returns the ith indirection index.
• mask() - returns the mask.
• offset(int i ) - returns the ith offset.
• stride(int i ) - returns the ith stride.
• translate(int i0[, ... int i6], Loc<Dim2>) - translates 1-7 indices to a Loc in the base coordinate system.

Utility functions:

• localToBase - transforms a domain in the local coordinate system to the corresponding domain in base coordinates.
• baseToLocal - transforms a domain in the base coordinate system to the corresponding domain in local coordinates.

---

Member Typedef Documentation

template<int Dim, int Dim2>

typedef ViewIndexer<Dim, Dim2> ViewIndexer< Dim, Dim2 >::This_t

template<int Dim, int Dim2>

typedef Interval<Dim> ViewIndexer< Dim, Dim2 >::Domain_t

template<int Dim, int Dim2>

typedef Range<Dim2> ViewIndexer< Dim, Dim2 >::BaseDomain_t

template<int Dim, int Dim2>

typedef Loc<Dim2> ViewIndexer< Dim, Dim2 >::Mask_t

---

Constructor & Destructor Documentation

template<int Dim, int Dim2>

ViewIndexer< Dim, Dim2 >::ViewIndexer

(

)

[inline]

template<int Dim, int Dim2>

template<class DT >

ViewIndexer< Dim, Dim2 >::ViewIndexer

(

const SliceDomain< DT > &

dom

)

[inline]

template<int Dim, int Dim2>

template<class DT >

ViewIndexer< Dim, Dim2 >::ViewIndexer	(	const ViewIndexer< Dim, Dim2 > &	orig,
		const Domain< Dim, DT > &	dom
	)			[inline]

template<int Dim, int Dim2>

template<int OrigDim, class DT >

ViewIndexer< Dim, Dim2 >::ViewIndexer	(	const ViewIndexer< OrigDim, Dim2 > &	orig,
		const SliceDomain< DT > &	dom
	)			[inline]

template<int Dim, int Dim2>

ViewIndexer< Dim, Dim2 >::ViewIndexer

(

const This_t &

model

)

[inline]

---

Member Function Documentation

template<int Dim, int Dim2>

This_t& ViewIndexer< Dim, Dim2 >::operator=

(

const This_t &

rhs

)

[inline]

template<int Dim, int Dim2>

const Domain_t& ViewIndexer< Dim, Dim2 >::domain

(

)

const [inline]

Referenced by ViewIndexer< Dim, OriginalDim >::operator=(), ViewIndexer< Dim, Dim >::ViewIndexer(), and ViewIndexer< Dim, OriginalDim >::ViewIndexer().

template<int Dim, int Dim2>

const BaseDomain_t& ViewIndexer< Dim, Dim2 >::baseDomain

(

)

const [inline]

Referenced by SparseTileLayoutViewData< Dim, Dim2 >::computeSubdomains(), LayoutBaseViewData< Dim, Dim2, SparseTileLayout< Dim2 > >::computeSubdomains(), ViewIntersector< Dim, ViewD1, ViewD2 >::intersect(), ViewIndexer< Dim, OriginalDim >::operator=(), and ViewIndexer< Dim, OriginalDim >::ViewIndexer().

template<int Dim, int Dim2>

int ViewIndexer< Dim, Dim2 >::indirection

(

int

i

)

const [inline]

Referenced by ViewIndexer< Dim, OriginalDim >::operator=(), and ViewIndexer< Dim, OriginalDim >::ViewIndexer().

template<int Dim, int Dim2>

const Mask_t& ViewIndexer< Dim, Dim2 >::mask

(

)

const [inline]

Referenced by ViewIndexer< Dim, OriginalDim >::operator=().

template<int Dim, int Dim2>

int ViewIndexer< Dim, Dim2 >::offset

(

int

i

)

const [inline]

Referenced by ViewIndexer< Dim, OriginalDim >::operator=(), and ViewIndexer< Dim, OriginalDim >::ViewIndexer().

template<int Dim, int Dim2>

int ViewIndexer< Dim, Dim2 >::stride

(

int

i

)

const [inline]

Referenced by ViewIndexer< Dim, Dim >::baseToLocal(), ViewIndexer< Dim, OriginalDim >::baseToLocal(), ViewIndexer< Dim, Dim >::localToBase(), ViewIndexer< Dim, OriginalDim >::localToBase(), ViewIndexer< Dim, OriginalDim >::operator=(), and ViewIndexer< Dim, OriginalDim >::ViewIndexer().

template<int Dim, int Dim2>

void ViewIndexer< Dim, Dim2 >::translate	(	const Loc< Dim > &	loc,
		Loc< Dim2 > &	oloc
	)			const [inline]

template<int Dim, int Dim2>

void ViewIndexer< Dim, Dim2 >::translate	(	int	i0,
		Loc< Dim2 > &	loc
	)			const [inline]

template<int Dim, int Dim2>

void ViewIndexer< Dim, Dim2 >::translate	(	int	i0,
		int	i1,
		Loc< Dim2 > &	loc
	)			const [inline]

template<int Dim, int Dim2>

void ViewIndexer< Dim, Dim2 >::translate	(	int	i0,
		int	i1,
		int	i2,
		Loc< Dim2 > &	loc
	)			const [inline]

template<int Dim, int Dim2>

void ViewIndexer< Dim, Dim2 >::translate	(	int	i0,
		int	i1,
		int	i2,
		int	i3,
		Loc< Dim2 > &	loc
	)			const [inline]

template<int Dim, int Dim2>

void ViewIndexer< Dim, Dim2 >::translate	(	int	i0,
		int	i1,
		int	i2,
		int	i3,
		int	i4,
		Loc< Dim2 > &	loc
	)			const [inline]

template<int Dim, int Dim2>

void ViewIndexer< Dim, Dim2 >::translate	(	int	i0,
		int	i1,
		int	i2,
		int	i3,
		int	i4,
		int	i5,
		Loc< Dim2 > &	loc
	)			const [inline]

template<int Dim, int Dim2>

void ViewIndexer< Dim, Dim2 >::translate	(	int	i0,
		int	i1,
		int	i2,
		int	i3,
		int	i4,
		int	i5,
		int	i6,
		Loc< Dim2 > &	loc
	)			const [inline]

template<int Dim, int Dim2>

template<class DT >

BaseDomain_t& ViewIndexer< Dim, Dim2 >::localToBase	(	const Domain< Dim, DT > &	dlocal,
		BaseDomain_t &	base
	)			const [inline]

Referenced by ViewIntersector< Dim, ViewD1, ViewD2 >::intersect(), SparseTileLayoutViewData< Dim, Dim2 >::touches(), LayoutBaseViewData< Dim, Dim2, SparseTileLayout< Dim2 > >::touches(), ViewIndexer< Dim, Dim >::ViewIndexer(), and ViewIndexer< Dim, OriginalDim >::ViewIndexer().

template<int Dim, int Dim2>

template<class DT >

SliceRange<Dim2, Dim>& ViewIndexer< Dim, Dim2 >::localToBase	(	const Domain< Dim, DT > &	dlocal,
		SliceRange< Dim2, Dim > &	base
	)			const [inline]

template<int Dim, int Dim2>

Interval<Dim>& ViewIndexer< Dim, Dim2 >::baseToLocal	(	const BaseDomain_t &	base,
		Interval< Dim > &	local
	)			const [inline]

Referenced by SparseTileLayoutViewData< Dim, Dim2 >::computeSubdomains(), LayoutBaseViewData< Dim, Dim2, SparseTileLayout< Dim2 > >::computeSubdomains(), SparseTileLayoutViewData< Dim, Dim2 >::touches(), and LayoutBaseViewData< Dim, Dim2, SparseTileLayout< Dim2 > >::touches().

template<int Dim, int Dim2>

Range<Dim>& ViewIndexer< Dim, Dim2 >::baseToLocal	(	const BaseDomain_t &	base,
		Range< Dim > &	local
	)			const [inline]

template<int Dim, int Dim2>

Interval<Dim>& ViewIndexer< Dim, Dim2 >::baseToLocalInterval	(	const Interval< Dim2 > &	base,
		Interval< Dim > &	local
	)			const [inline]

Referenced by ViewIntersector< Dim, ViewD1, ViewD2 >::intersect().

---

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

• ViewIndexer.h