MDA_AccessConst< MDA_TYPE, MDA_DIM, OrderType > Class Template Reference

Const data version of the multidimensional array access template class MDA_Access. More...

#include <source/patchdata/array/array_access/MDA_Access.h>

Inheritance diagram for MDA_AccessConst< MDA_TYPE, MDA_DIM, OrderType >:

[legend]List of all members.

Public Types
typedef const MDA_TYPE	value_t
	Type of data.
typedef MDA_IndexRange< MDA_DIM >	range_t
typedef range_t::dim_t	dim_t
typedef range_t::index_t	index_t
typedef OrderType	order_t
Public Member Functions
	MDA_AccessConst (value_t *p=((MDA_TYPE *) 0), const size_t *sz=((size_t *) 0), const index_t *st=((index_t *) 0))
	See the MDA_Access version of this function.
	MDA_AccessConst (value_t *p, const index_t *si, const index_t *sf)
	See the MDA_Access version of this function.
	MDA_AccessConst (value_t *p, const MDA_IndexRange< MDA_DIM > &r)
	See the MDA_Access version of this function.
	MDA_AccessConst (const MDA_Access< MDA_TYPE, MDA_DIM, OrderType > &r)
	Construct from an object of the non-const version.
const MDA_AccessConst &	operator= (const MDA_Access< MDA_TYPE, MDA_DIM, OrderType > &r)
	Assign value from an object of the non-const version.

---

Detailed Description

template<class MDA_TYPE, unsigned short MDA_DIM, class OrderType = MDA_OrderRowMajor<MDA_DIM>>
class MDA_AccessConst< MDA_TYPE, MDA_DIM, OrderType >

Const data version of the multidimensional array access template class MDA_Access.

This class is almost exactly identical to its non-const counterpart, MDA_Access. It is used when the data is const.

This class differs only in that the value type is a const. In fact, this class is trivial, except for the public inheritance of MDA_Access with the const type for the first template argument, a constructor to build an object from a MDA_Access object and an assignment operator to assign from a MDA_Access object. Other than that, see MDA_Access for documentations.

The interfaces that are added by this class are trivial, mirroring the interfaces defined in MDA_Access with minor changes.

See also:

MDA_Access

---

Member Typedef Documentation

template<class MDA_TYPE, unsigned short MDA_DIM, class OrderType = MDA_OrderRowMajor<MDA_DIM>>

typedef const MDA_TYPE MDA_AccessConst< MDA_TYPE, MDA_DIM, OrderType >::value_t

Type of data.

This declaration is redundant because it should already be inherited, but the xlC compiler on ASCI Blue does not get it.

Reimplemented from MDA_Access< MDA_TYPE, MDA_DIM, OrderType >.

template<class MDA_TYPE, unsigned short MDA_DIM, class OrderType = MDA_OrderRowMajor<MDA_DIM>>

typedef MDA_IndexRange<MDA_DIM> MDA_AccessConst< MDA_TYPE, MDA_DIM, OrderType >::range_t

Reimplemented from MDA_Access< MDA_TYPE, MDA_DIM, OrderType >.

template<class MDA_TYPE, unsigned short MDA_DIM, class OrderType = MDA_OrderRowMajor<MDA_DIM>>

typedef range_t::dim_t MDA_AccessConst< MDA_TYPE, MDA_DIM, OrderType >::dim_t

Reimplemented from MDA_Access< MDA_TYPE, MDA_DIM, OrderType >.

template<class MDA_TYPE, unsigned short MDA_DIM, class OrderType = MDA_OrderRowMajor<MDA_DIM>>

typedef range_t::index_t MDA_AccessConst< MDA_TYPE, MDA_DIM, OrderType >::index_t

Reimplemented from MDA_Access< MDA_TYPE, MDA_DIM, OrderType >.

template<class MDA_TYPE, unsigned short MDA_DIM, class OrderType = MDA_OrderRowMajor<MDA_DIM>>

typedef OrderType MDA_AccessConst< MDA_TYPE, MDA_DIM, OrderType >::order_t

Reimplemented from MDA_Access< MDA_TYPE, MDA_DIM, OrderType >.

---

Constructor & Destructor Documentation

template<class MDA_TYPE, unsigned short MDA_DIM, class OrderType = MDA_OrderRowMajor<MDA_DIM>>

MDA_AccessConst< MDA_TYPE, MDA_DIM, OrderType >::MDA_AccessConst	(	value_t *	p = ((MDA_TYPE*)0),
		const size_t *	sz = ((size_t*)0),
		const index_t *	st = ((index_t*)0)
	)			[inline]

See the MDA_Access version of this function.

See also:

MDA_Access::MDA_Access(value_t*,const size_t*,const index_t*)

Parameters:

p	Pointer to data
sz	Array sizes
st	Array starting indices

template<class MDA_TYPE, unsigned short MDA_DIM, class OrderType = MDA_OrderRowMajor<MDA_DIM>>

MDA_AccessConst< MDA_TYPE, MDA_DIM, OrderType >::MDA_AccessConst	(	value_t *	p,
		const index_t *	si,
		const index_t *	sf
	)			[inline]

See the MDA_Access version of this function.

See also:

MDA_Access::MDA_Access(value_t*,const index_t*,const index_t*)

Parameters:

p	Pointer to data
si	Array of initial indices
sf	Array of final indices

template<class MDA_TYPE, unsigned short MDA_DIM, class OrderType = MDA_OrderRowMajor<MDA_DIM>>

MDA_AccessConst< MDA_TYPE, MDA_DIM, OrderType >::MDA_AccessConst	(	value_t *	p,
		const MDA_IndexRange< MDA_DIM > &	r
	)			[inline]

See the MDA_Access version of this function.

See also:

MDA_Access::MDA_Access(value_t*,const MDA_IndexRange<MDA_DIM>&)

Parameters:

p	Pointer to data
r	Array index object

template<class MDA_TYPE, unsigned short MDA_DIM, class OrderType = MDA_OrderRowMajor<MDA_DIM>>

MDA_AccessConst< MDA_TYPE, MDA_DIM, OrderType >::MDA_AccessConst

(

const MDA_Access< MDA_TYPE, MDA_DIM, OrderType > &

r

)

[inline]

Construct from an object of the non-const version.

See also:

MDA_Access::MDA_Access(const MDA_Access<const MDA_TYPE,MDA_DIM>&)

---

Member Function Documentation

template<class MDA_TYPE, unsigned short MDA_DIM, class OrderType = MDA_OrderRowMajor<MDA_DIM>>

const MDA_AccessConst& MDA_AccessConst< MDA_TYPE, MDA_DIM, OrderType >::operator=

(

const MDA_Access< MDA_TYPE, MDA_DIM, OrderType > &

r

)

[inline]

Assign value from an object of the non-const version.

---

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

• source/patchdata/array/array_access/MDA_Access.h

---