Fiber::DirectProductMemArrayBase< T, MDIMS > Class Template Reference [Multidimensional arrays whose values are direct products.]

Class for creating structured types as direct product of one-dimensional arrays. More...

#include <DirectProductArray.hpp>

List of all members.

Public Types

• enum { COMPONENTS = T::SIZE, Dims = MDIMS }
• typedef T::value_type component_type

  The components of the structured type T.
  

• typedef PolynomialArray
  < component_type > PolynomialArray_t

Public Member Functions

• DirectProductMemArrayBase (const MemBase::Creator_t &C=MemCore::NullPtr())

  The constructor sets the component map such that the dimensions of the manifold are mapped to the first components of the structure.
  

• DirectProductMemArrayBase (const RefPtr< PolynomialArray_t > C[COMPONENTS], const Eagle::Vector< int, Dims > &CMap, const MemBase::Creator_t &theCreator=MemCore::NullPtr())
• override void DeferredConstructor ()
• override MemCore::memsize_t memsize () const
• override RefPtr< MemBase > newMemArray () const
• RefPtr< MemArray< MDIMS, T > > createMemArray (const RefPtr< MemCore::ChunkBase > &Data, const MemBase::Creator_t &C) const

  Create a memory array of the same dimensions as the current array, but with data as provided by the Storage.
  

• override RefPtr< MemBase > createEquallySizedMemArray (const RefPtr< MemCore::ChunkBase > &Storage, const MemBase::Creator_t &C) const

  Create a memory array of the same dimensions as the current array, but with data as provided by the Storage.
  

• override RefPtr< MemBase > getComponentArray (int member, const MemBase::Creator_t &C)
• void retrieve (T &retval, const MultiIndex< Dims > &I) const
• bool locate (T &pos) const
• override MultiIndex< Dims > Size () const
• MultiIndex< Dims > firstIndex () const

  Return a multidimensional index for the 1st data element, which is just all components to be zero.
  

• MultiIndex< Dims > lastIndex () const

  Return a multidimensional index for the last data element, which is just the largest index in each dimension, the number of elements minus one.
  

• override const type_info & getType () const

  Return the element type of the certain array.
  

• override RefPtr< MemBase > getSlice (index_t i, const MemBase::Creator_t &C) const
• override const FiberTypeBase & getFiberType () const

  Implementation of the virtual MemArray function.
  

• override void * getPtr ()

  Implementation of the virtual MemArray function.
  

• override HyperslabParameters & getHyperslabParameters ()

Public Attributes

• RefPtr< PolynomialArray_t > Components [COMPONENTS]

  The respective components of the array.
  

• Eagle::Vector< int, Dims > ComponentMap

  Mapping from manifold dimension to component array.
  

---

Detailed Description

template<class T, int MDIMS>
class Fiber::DirectProductMemArrayBase< T, MDIMS >

Class for creating structured types as direct product of one-dimensional arrays.

An n-dimensional data type is defined over an n-dimensional manifold by assigning the value of the ith coordinate index to the ith component of the data type. Thus, given a set of one-dimensional arrays , the resulting field is .

Examples for the one-dimensional component arrays can be data arrays explicitely specifying values, or a procedural array like the PolynomialArray<> that computes the data value from a set of coefficients. All component arrays must be childs of the virtual 1D array class VArray1D<>.

Parameters:

T

The type that is created from the respective arrays at each index. It must provide an SIZE enum constant integer and a member typedef "value_type", such that T is equivalent to value_type[SIZE]. Only homogeneous types are allowed. The type T must also provide an element access operator [] that is accessible with an int and is convertible to the value_type.

---

Member Enumeration Documentation

template<class T, int MDIMS>

anonymous enum

Enumerator:

COMPONENTS	The number of components of the value type.
Dims	The dimensionality of the base manifold.

---

Constructor & Destructor Documentation

template<class T, int MDIMS>

Fiber::DirectProductMemArrayBase< T, MDIMS >::DirectProductMemArrayBase

(

const MemBase::Creator_t &

C = MemCore::NullPtr()

)

[inline]

The constructor sets the component map such that the dimensions of the manifold are mapped to the first components of the structure.

All other components are set according to the value of this->origin, which is component-wise initialized with zero.

---

Member Function Documentation

template<class T, int MDIMS>

override RefPtr<MemBase> Fiber::DirectProductMemArrayBase< T, MDIMS >::createEquallySizedMemArray	(	const RefPtr< MemCore::ChunkBase > &	Storage,
		const MemBase::Creator_t &	C
	)			const [inline]

Create a memory array of the same dimensions as the current array, but with data as provided by the Storage.

Will return NullPtr if the sizes don't match. Calls createMemArray() .

template<class T, int MDIMS>

RefPtr<MemArray<MDIMS,T> > Fiber::DirectProductMemArrayBase< T, MDIMS >::createMemArray	(	const RefPtr< MemCore::ChunkBase > &	Data,
		const MemBase::Creator_t &	C
	)			const [inline]

Create a memory array of the same dimensions as the current array, but with data as provided by the Storage.

Will return NullPtr if the sizes don't match.

Referenced by Fiber::DirectProductMemArrayBase< Eagle::point3::FixedArray_t, MDIMS >::createEquallySizedMemArray().

---

Member Data Documentation

template<class T, int MDIMS>

Eagle::Vector<int, Dims> Fiber::DirectProductMemArrayBase< T, MDIMS >::ComponentMap

Mapping from manifold dimension to component array.

Unused entries are marked by negative values; those components will be set to zero.

Referenced by Fiber::DirectProductMemArrayBase< Eagle::point3::FixedArray_t, MDIMS >::DirectProductMemArrayBase().