A memory array that may share its data storage with something else. More...

#include <ReferencingMemArray.hpp>

Inheritance diagram for Fiber::ReferencingMemArray< N, T >:

Public Types
typedef RefPtr< MemCore::Chunk< T > >	MemChunk

typedef MultiArray< N, T >	MultiArray_t

Public Types inherited from Fiber::MemArrayBase< N >
enum	Dims_t { Dims = N }

typedef MultiIndex< N >	MIndex_t

Public Types inherited from Fiber::MemBase
typedef WeakPtrCreativeArrayBase_t	Creator_t

Public Types inherited from MemCore::Cacheable
typedef unsigned long	cachecounter_t

Public Types inherited from MemCore::ReferenceBase< Cacheable >
typedef Object	reference_domain_t

typedef WeakPtr< Object, Object >	SelfPtr_t

Public Types inherited from Fiber::TypedArray< T >
typedef T	value_type

Public Member Functions
	ReferencingMemArray (const Iterator< T > &data, const MultiIndex< N > &Sz, const RefPtr< MemCore::ChunkBase > &theStorage, const WeakPtr< CreativeArrayBase > &theCreator)
	Constructor.

	ReferencingMemArray (const RefPtr< Chunk< T > > &data, const MultiIndex< N > &Sz, const WeakPtr< CreativeArrayBase > &theCreator)
	Construct from memory chunk and multidimensional index.

	ReferencingMemArray (const RefPtr< MemCore::ChunkBase > &theStorage, const MultiArray< N, T > &M, const WeakPtr< CreativeArrayBase > &theCreator)
	Create referencing mem array from an existing multi array and some memory reference.

	ReferencingMemArray (const ReferencingMemArray &RMA)
	Copy constructor.

bool	copyFrom (const RefPtr< MemCore::ChunkBase > &theChunk) override

RefPtr< MemCore::TypedChunk< T > >	myChunk () const override
	Return storage type.

MemCore::memsize_t	memsize () const override
	Note: memsize does not return the number of elements here, but the actual memory that is occupied.

index_t	nElements () const override
	return the number of elements in this array

std::string	getElementAsString (size_t index) const override

void	DeferredConstructor () override
	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.

const type_info &	getType () const override
	Return the element type of the certain array.

const type_info &	getBaseType () const
	Return the element type of the certain array.

HyperslabParameters &	getHyperslabParameters () override

void *	getPtr () override
	Special Array Storage.

const void *	OriginPtr () const override
	Get pointer to origin of linearly procedural array, if it is linear.

const void *	DeltaPtr () const override
	Get pointer to delta of linearly procedural array, if it is linear.

T	first () const override
	Retrieve the first element.

T	last () const override
	Retrieve the last element.

CreativeIterator< T > *	creativeIterator () override

const CreativeIterator< T > *	creativeIterator () const override

const RefPtr< MemCore::TypedChunk< T > > &	StoragePtr () const

const RefPtr< MemCore::TypedChunk< T > > &	getStorage () const

const RefPtr< MemCore::TypedChunk< T > > &	getTypedStorage () const

MultiIndex< N >	Size () const override
	Return the number of dimensions.

Public Member Functions inherited from Fiber::MemArrayBase< N >
	MemArrayBase (const FiberTypeIndex &theFiberTypeIndex, const WeakPtr< CreativeArrayBase > &theCreator)

	MemArrayBase (const MemArrayBase< N > &)=delete

void	operator= (const MemArrayBase< N > &)=delete

Fiber::Dims_t	rank () const override
	Return the number of array dimensions.

virtual RefPtr< MemBase >	newMemArraynD (const MultiIndex< N > &NewSize, const MemBase::Creator_t &C) const =0
	Create a new array of the same type as the current one, but using the specified dimensions.

virtual RefPtr< MemBase >	createSubMemArray (const MultiIndex< N > &Offset, const MultiIndex< N > &CopySize, const MemBase::Creator_t &C) const =0
	Create a new MemArray from a subset of the current array's data.

RefPtr< MemBase >	createSubArray (const DynamicSize &Offset, const DynamicSize &CopySize, const MemBase::Creator_t &C) const override
	Implement creation of new memory sub array using the DynamicSize class.

DynamicSize	getSize () const override
	Return the size of this dataset.

RefPtr< ArrayInterpolator >	getInterpolator () const

virtual RefPtr< MemBase >	getSlice (index_t n, const MemBase::Creator_t &C) const =0
	For a multidimensional array retrieve the nth slice.

Public Member Functions inherited from Fiber::MemBase
	MemBase (const FiberTypeIndex &theFiberTypeIndex, const Creator_t &theCreator)
	Empty default constructor.

	~MemBase ()
	Destructor.

	MemBase (const MemBase &)=delete

MemCore::WeakPtr< MemBase >	membase () const

auto	NumberOfElements () const

auto	getNumberOfElements () const

MemCore::WeakPtr< FiberTypeBase >	getFiberType () const

MemCore::memsize_t	element_memsize () const

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 >	getComponentArray (int member, const MemBase::Creator_t &C)=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.

bool	copyFrom (const RefPtr< MemBase > &Mb)
	Copy all data values from the given MemBase.

virtual RefPtr< MemBase >	copy (const MemBase::Creator_t &C=nullptr) const =0
	Create a copy of the current array, duplicating all data and allocating new memory for it.

RefPtr< MemBase >	create (const RefPtr< FiberTypeBase > &FT, const type_info &layout=typeid(void)) const
	Create a new mem array of the same dimensions but different type.

template<class T >
RefPtr< MemBase >	create (const type_info &layout=typeid(void)) const
	Create a new mem array of the same dimensions but different type.

RefPtr< MemBase >	create (const DynamicSize &DS, const type_info &layout=typeid(void)) const
	Create a new mem array of the same type but different dimensions.

RefPtr< MemBase >	create (const type_info &layout=typeid(void)) const
	Create a new mem array of the same type and dimensions, but default values.

Public Member Functions inherited from MemCore::Cacheable
	Cacheable (const WeakPtr< Creature > &C)

bool	isCached () const

bool	isUncached () const

bool	markAsUsed ()

WeakPtr< CacheBase >	myCache () const

const WeakPtr< Creature > &	myCreator () const

int	NumberOfListEntries () const

void	PreDestructor ()

void	push_back (CacheQueue &Q)

void	push_front (CacheQueue &Q)

void	setCreator (const WeakPtr< Creature > &C)

Public Member Functions inherited from MemCore::ReferenceBase< Cacheable >
auto	getObjectCountID () const noexcept

bool	isIdentical (const WeakPtr< Object, Object > &PossibleSelf) const noexcept

void	mkAutoDestructive ()

refcount_t	refcount () const noexcept

	ReferenceBase (Object *that) noexcept

const auto &	self () const

refcount_t	wrefcount () const noexcept

Public Member Functions inherited from MemCore::Intercube
void	addInterface (const RefPtr< InterfaceBase > &I) const

void	addInterfaceData (const Data &D)

void	addInterfaceData (const Data &D)

void	clearInterfaces ()

bool	const_iterateInterfaces (const RefPtr< InterfaceIterationParameter > &IIP) const

virtual RefPtr< InterfaceBase >	createInterface (const type_info &) const

RefPtr< InterfaceBase >	findInterface (const type_info &t) const

RefPtr< InterfaceBase >	getInterface (const type_info &t)

std::string	getInterfaceNames (const char delim=';') const

bool	gotNewInterfaceData (const Data &D)

bool	gotNewInterfaceData (mutex &M, const Data &D)

bool	gotNewInterfaceData (mutex &M, const Data &D)

bool	gotNewInterfaceData (mutex &M, const Data &D, const Selector &S)

bool	gotNewInterfaceData (mutex &M, const Data &D, const Selector *S)

bool	hasChangedInterfaceData (const Data &D) const

bool	hasChangedInterfaceData (const Data &D) const

bool	hasChangedInterfaceData (const Data &D, const Selector &) const

bool	hasChangedInterfaceData (const Data &D, const Selector *) const

bool	hasInterface (const type_info &t) const

bool	iterateInterfaces (const RefPtr< InterfaceIterationParameter > &IIP)

void	printInterfaces () const

void	registerInterface (const type_info &t)

void	removeInterface ()

void	removeInterfaceBase (const type_info &InterfaceBaseID)

Public Member Functions inherited from Fiber::TypedArray< T >
	TypedArray (const MemBase::Creator_t &C)

	TypedArray (const TypedArray< T > &)=delete

void	operator= (const TypedArray< T > &)=delete

RefPtr< MemCore::ChunkBase >	getChunk () const override
	Implement the virtual getChunk() function.

const type_info &	getType () const override
	Return the element type of the certain array.

template<class UnaryOperator >
RefPtr< MemBase >	applyOperator (const UnaryOperator &theOperator, const MemBase::Creator_t &theCreator) const
	Apply an unary operator on the data contained here, and provide a new memory array of the same size and dimensionality.

template<class result_t >
RefPtr< MemBase >	applyFunction (const std::function< result_t(const T &)> &theOperator) const
	Apply a functor, possibly yielding a different type.

RefPtr< MemBase >	applyFunction (const std::function< T(const T &)> &theOperator) const
	Apply a functor yielding the same type.

template<class result_t >
RefPtr< MemBase >	applyFunction (const std::function< result_t(const T &, index_t I)> &theOperator) const
	Apply a functor, possibly yielding a different type.

RefPtr< MemBase >	applyFunction (const std::function< T(const T &, index_t I)> &theOperator) const
	Apply a functor yielding the same type.

template<class result_t , class SecondType >
RefPtr< MemBase >	applyFunction (const TypedArray< SecondType > &R, const std::function< result_t(const T &, const SecondType &ST, index_t I)> &theOperator) const
	Apply a binary functor, possibly yielding a different type.

template<class BinaryOperator >
RefPtr< MemBase >	applyOperator (const BinaryOperator &theOperator, const RefPtr< MemBase > &rightValue, const MemBase::Creator_t &theCreator) const
	Apply a binary operator on the data contained here, and provide a new memory array of the same size and dimensionality.

auto	getComponent (int Component) -> decltype(getComponentArrayIterator(*this, Component))

auto	operator() (int Component) -> decltype(getComponentArrayIterator(*this, Component))

ranged_for_iterator< T >	begin ()

ranged_for_iterator< T >	end ()

const_ranged_for_iterator< T >	begin () const

const_ranged_for_iterator< T >	end () const

RefPtr< MemBase >	create (const RefPtr< FiberTypeBase > &FT, const type_info &layout=typeid(void)) const
	Create a new mem array of the same dimensions but different type.

template<class T >
RefPtr< MemBase >	create (const type_info &layout=typeid(void)) const
	Create a new mem array of the same dimensions but different type.

RefPtr< MemBase >	create (const DynamicSize &DS, const type_info &layout=typeid(void)) const
	Create a new mem array of the same type but different dimensions.

RefPtr< MemBase >	create (const type_info &layout=typeid(void)) const
	Create a new mem array of the same type and dimensions, but default values.

Protected Member Functions
	~ReferencingMemArray ()
	Protected Destructor to avoid static creation.

Protected Member Functions inherited from MemCore::Cacheable
void	adjustCacheableSize (memsize_t memDiff)

Protected Member Functions inherited from MemCore::ReferenceBase< Cacheable >
virtual void	extremeUnction ()

ReferenceBase &	operator= (const ReferenceBase &R)

void	suicide ()

Protected Attributes
RefPtr< MemCore::TypedChunk< T > >	myStorage

Additional Inherited Members
Static Public Member Functions inherited from Fiber::MemBase
static RefPtr< MemBase >	create (const RefPtr< FiberTypeBase > &FT, const DynamicSize &DS, 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 Member Functions inherited from Fiber::TypedArray< T >
static MemCore::WeakPtr< FiberTypeBase >	getFiberType ()

static RefPtr< MemBase >	create (const RefPtr< MemBase > &SourceLayout, const type_info &layout=typeid(void))

static RefPtr< MemBase >	create (const RefPtr< FiberTypeBase > &FT, const DynamicSize &DS, 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 Public Attributes inherited from Fiber::MemBase
static int	RegisteredTypes = 0

Detailed Description

template<Dims_t N, class T>
class Fiber::ReferencingMemArray< N, T >

A memory array that may share its data storage with something else.

Author: Werner Benger

Constructor & Destructor Documentation

◆ ReferencingMemArray() [1/2]

template<Dims_t N, class T >

Fiber::ReferencingMemArray< N, T >::ReferencingMemArray	(	const RefPtr< MemCore::ChunkBase > &	theStorage,
		const MultiArray< N, T > &	M,
		const WeakPtr< CreativeArrayBase > &	theCreator
	)

inline

Create referencing mem array from an existing multi array and some memory reference.

It is assumed that the data reference is associated with the provided multi array, otherwise calling this constructor makes no sense. However, the base offset of the memory location does not need to overlap. This is useful when the multiarray refers to a subset of a larger memory instance. Required for the getSlice() function.

◆ ReferencingMemArray() [2/2]

template<Dims_t N, class T >

Fiber::ReferencingMemArray< N, T >::ReferencingMemArray ( const ReferencingMemArray< N, T > & RMA )

inline

Copy constructor.

Copies no data, only shares the storage.

References MemCore::Cacheable::myCreator().

Member Function Documentation

◆ copyFrom()

template<Dims_t N, class T >

bool Fiber::ReferencingMemArray< N, T >::copyFrom ( const RefPtr< MemCore::ChunkBase > & theChunk )

inlineoverridevirtual

Implements Fiber::MemBase.

◆ creativeIterator() [1/2]

template<Dims_t N, class T >

const CreativeIterator< T > * Fiber::ReferencingMemArray< N, T >::creativeIterator ( ) const

inlineoverridevirtual

Implements Fiber::TypedArray< T >.

◆ creativeIterator() [2/2]

template<Dims_t N, class T >

CreativeIterator< T > * Fiber::ReferencingMemArray< N, T >::creativeIterator ( )

inlineoverridevirtual

Implements Fiber::TypedArray< T >.

◆ DeferredConstructor()

template<Dims_t N, class T >

void Fiber::ReferencingMemArray< N, T >::DeferredConstructor ( )

inlineoverridevirtual

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.

Implements Fiber::MemBase.

◆ DeltaPtr()

template<Dims_t N, class T >

const void * Fiber::ReferencingMemArray< N, T >::DeltaPtr ( ) const

inlineoverridevirtual

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

Implements Fiber::MemBase.

◆ first()

template<Dims_t N, class T >

T Fiber::ReferencingMemArray< N, T >::first ( ) const

inlineoverridevirtual

Retrieve the first element.

Implements Fiber::TypedArray< T >.

◆ getElementAsString()

template<Dims_t N, class T >

std::string Fiber::ReferencingMemArray< N, T >::getElementAsString ( size_t index ) const

inlineoverridevirtual

Implements Fiber::MemBase.

◆ getHyperslabParameters()

template<Dims_t N, class T >

HyperslabParameters & Fiber::ReferencingMemArray< N, T >::getHyperslabParameters ( )

inlineoverridevirtual

Implements Fiber::MemBase.

◆ getPtr()

template<Dims_t N, class T >

void * Fiber::ReferencingMemArray< N, T >::getPtr ( )

inlineoverridevirtual

Special Array Storage.

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

Implements Fiber::MemBase.

◆ getType()

template<Dims_t N, class T >

const type_info & Fiber::ReferencingMemArray< N, T >::getType ( ) const

inlineoverridevirtual

Return the element type of the certain array.

Implements Fiber::MemBase.

◆ last()

template<Dims_t N, class T >

T Fiber::ReferencingMemArray< N, T >::last ( ) const

inlineoverridevirtual

Retrieve the last element.

Implements Fiber::TypedArray< T >.

◆ memsize()

template<Dims_t N, class T >

MemCore::memsize_t Fiber::ReferencingMemArray< N, T >::memsize ( ) const

inlineoverridevirtual

Note: memsize does not return the number of elements here, but the actual memory that is occupied.

Reimplemented from Fiber::MemBase.

◆ myChunk()

template<Dims_t N, class T >

RefPtr< MemCore::TypedChunk< T > > Fiber::ReferencingMemArray< N, T >::myChunk ( ) const

inlineoverridevirtual

Return storage type.

Implements Fiber::TypedArray< T >.

◆ nElements()

template<Dims_t N, class T >

index_t Fiber::ReferencingMemArray< N, T >::nElements ( ) const

inlineoverridevirtual

return the number of elements in this array

Reimplemented from Fiber::MemBase.

◆ OriginPtr()

template<Dims_t N, class T >

const void * Fiber::ReferencingMemArray< N, T >::OriginPtr ( ) const

inlineoverridevirtual

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

Implements Fiber::MemBase.

◆ Size()

template<Dims_t N, class T >

MultiIndex< N > Fiber::ReferencingMemArray< N, T >::Size ( ) const

inlineoverridevirtual

Return the number of dimensions.

Implements Fiber::MemArrayBase< N >.

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ReferencingMemArray() [1/2]

◆ ReferencingMemArray() [2/2]

Member Function Documentation

◆ copyFrom()

◆ creativeIterator() [1/2]

◆ creativeIterator() [2/2]

◆ DeferredConstructor()

◆ DeltaPtr()

◆ first()

◆ getElementAsString()

◆ getHyperslabParameters()

◆ getPtr()

◆ getType()

◆ last()

◆ memsize()

◆ myChunk()

◆ nElements()

◆ OriginPtr()

◆ Size()