Fiber::MemBase Class Reference [Interfacing the Vector library with the MemCore library.]

Base class for multidimensional arrays with MemCore memory management. More...

#include <MemBase.hpp>

List of all members.

Classes

• class Allocator

  An allocator is an action that can be added to a type. More...
  

Public Types

• typedef MemCore::WeakPtr
  < MemCore::CreatorBase
  < MemBase > > Creator_t

Public Member Functions

• MemBase (const Creator_t &theCreator)

  Empty default constructor.
  

• ~MemBase ()

  Destructor.
  

• virtual void DeferredConstructor ()=0

  Virtual deferred reference pointer construction pointer Don't overload if you don't know exactly what this function is supposed to do. See class DynPtr for more info.
  

• virtual int rank () const =0

  Return the number of dimensions.
  

• virtual DynamicSize getSize () const =0

  Return the size of this dataset.
  

• virtual index_t nElements () const

  return the number of elements in this array
  

• virtual const type_info & getType () const =0

  Return the type of the certain array.
  

• virtual HyperslabParameters & getHyperslabParameters ()=0
• virtual const FiberTypeBase & getFiberType () const =0
• virtual RefPtr< MemBase > makeMemArray (const MemBase::Creator_t &C) const =0

  Provide a MemArray, even though the actual data is a procedural array.
  

• virtual RefPtr< MemBase > newMemArray (const MemBase::Creator_t &C) const =0

  Create a MemArray object of the same type and size, but no data values set up.
  

• virtual RefPtr< MemBase > getComponentArray (int member, const MemBase::Creator_t &C)=0
• virtual RefPtr< MemBase > createSubArray (const DynamicSize &Offset, const DynamicSize &CopySize, const MemBase::Creator_t &C) const =0
• virtual RefPtr< MemBase > createEquallySizedMemArray (const RefPtr< MemCore::ChunkBase > &Storage, const MemBase::Creator_t &C) const =0

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

• virtual RefPtr< MemBase > newMemArray (const DynamicSize &newSize, const MemBase::Creator_t &C) const =0
• virtual RefPtr< MemBase > createIndirection (const DynamicSize &newSize, const std::vector< index_t > &Indirection, const MemBase::Creator_t &theCreator) const =0

  Create a new array of the same type as the current one but with only those values that are specified in the Indirection array.
  

• RefPtr< MemBase > create (const RefPtr< FiberTypeBase > &FT, const Creator_t &C, const type_info &layout=typeid(void))

• virtual void * getPtr ()=0

  Special Array Storage.
  

• virtual RefPtr
  < MemCore::ChunkBase > getChunk () const =0

  Get chunk to underlying data, if this is a contiguous array.
  

• virtual const void * OriginPtr () const =0

  Get pointer to origin of linearly procedural array, if it is linear.
  

• virtual const void * DeltaPtr () const =0

  Get pointer to delta of linearly procedural array, if it is linear.
  

Static Public Member Functions

• static RefPtr< MemBase > create (const RefPtr< FiberTypeBase > &FT, int rank, const index_t dims[], const Creator_t &C, const type_info &layout=typeid(void))

  Given a description of a certain data type for each element on array, allocate a multidimensional array of the given type.
  

• static bool registerCreator (const RefPtr< Allocator > &A, const RefPtr< FiberTypeBase > &FT)

Static Public Attributes

• static FIELD_API int RegisteredTypes = 0
• static FIELD_API int StandardTypes = RegisterStandardCharts() + RegisterStandardMemArrayTypes()

---

Detailed Description

Base class for multidimensional arrays with MemCore memory management.

---

Member Function Documentation

RefPtr< MemBase > MemBase::create	(	const RefPtr< FiberTypeBase > &	FT,
		int	rank,
		const index_t	dims[],
		const Creator_t &	C,
		const type_info &	layout = typeid(void)
	)			[static]

Given a description of a certain data type for each element on array, allocate a multidimensional array of the given type.

The creation will be forwarded to certain Allocators of this specific type, which have been registered through registerCreator();

virtual RefPtr<MemBase> Fiber::MemBase::createEquallySizedMemArray	(	const RefPtr< MemCore::ChunkBase > &	Storage,
		const MemBase::Creator_t &	C
	)			const [pure virtual]

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 size and types don't match. Calls MemArray::createMemArray() .

Referenced by Fiber::TypedArray< Eagle::point3 >::applyOperator().

virtual RefPtr<MemBase> Fiber::MemBase::createIndirection	(	const DynamicSize &	newSize,
		const std::vector< index_t > &	Indirection,
		const MemBase::Creator_t &	theCreator
	)			const [pure virtual]

Create a new array of the same type as the current one but with only those values that are specified in the Indirection array.

The size() of the Indirection must match the number of elements in the newSize.

Implemented in Fiber::TypedArray< T >, and Fiber::TypedArray< Eagle::point3 >.

virtual void* Fiber::MemBase::getPtr

(

)

[pure virtual]

Special Array Storage.

Get pointer to underlying data, if this is a contiguous array

Implemented in Fiber::ReferencingMemArray< N, T >.

virtual RefPtr<MemBase> Fiber::MemBase::makeMemArray

(

const MemBase::Creator_t &

C

)

const [pure virtual]

Provide a MemArray, even though the actual data is a procedural array.

This is useful when some code explicitely needs to deal with data pointer, even though it is inefficient in terms of memory.

Implemented in Fiber::DirectProductMemArray< T, MDIMS >, and Fiber::DirectProductMemArray< Eagle::point3, Eagle::point3::SIZE >.