FiberVISH 0.2
Fish - The Fiber Bundle API for the Vish Visualization Shell
Public Types | Public Member Functions | List of all members
Fiber::MemArrayBase< N > Class Template Referenceabstract

Abstract class for N-dimensional MultiArrays with MemCore memory management. More...

#include <MemArrayBase.hpp>

Inheritance diagram for Fiber::MemArrayBase< N >:
Fiber::MemBase MemCore::Cacheable MemCore::Intercube MemCore::ReferenceBase< Cacheable > Fiber::ReferencingMemArray< N, T > Fiber::MemArray< N, T >

Public Types

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 Member Functions

 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 MultiIndex< N > Size () const =0
 The multi-dimensional size of this array.
 
virtual RefPtr< MemBasenewMemArraynD (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< MemBasecreateSubMemArray (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< MemBasecreateSubArray (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< ArrayInterpolatorgetInterpolator () const
 
virtual RefPtr< MemBasegetSlice (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< MemBasemembase () const
 
virtual void DeferredConstructor () override=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 index_t nElements () const
 return the number of elements in this array
 
auto NumberOfElements () const
 
auto getNumberOfElements () const
 
virtual const type_infogetType () const =0
 Return the element type of the certain array.
 
virtual HyperslabParametersgetHyperslabParameters ()=0
 
virtual std::string getElementAsString (size_t index) const =0
 
MemCore::WeakPtr< FiberTypeBasegetFiberType () const
 
MemCore::memsize_t element_memsize () const
 
virtual RefPtr< MemBasemakeMemArray (const MemBase::Creator_t &C) const =0
 Provide a MemArray, even though the actual data is a procedural array.
 
virtual RefPtr< MemBasegetComponentArray (int member, const MemBase::Creator_t &C)=0
 
virtual RefPtr< MemBasecreateEquallySizedMemArray (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 bool copyFrom (const RefPtr< MemCore::ChunkBase > &theChunk)=0
 
bool copyFrom (const RefPtr< MemBase > &Mb)
 Copy all data values from the given MemBase.
 
virtual RefPtr< MemBasecopy (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< MemBasecreate (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< MemBasecreate (const type_info &layout=typeid(void)) const
 Create a new mem array of the same dimensions but different type.
 
RefPtr< MemBasecreate (const DynamicSize &DS, const type_info &layout=typeid(void)) const
 Create a new mem array of the same type but different dimensions.
 
RefPtr< MemBasecreate (const type_info &layout=typeid(void)) const
 Create a new mem array of the same type and dimensions, but default values.
 
virtual voidgetPtr ()=0
 Special Array Storage.
 
virtual RefPtr< MemCore::ChunkBasegetChunk () const =0
 Get chunk to underlying data, if this is a contiguous array.
 
virtual const voidOriginPtr () const =0
 Get pointer to origin of linearly procedural array, if it is linear.
 
virtual const voidDeltaPtr () const =0
 Get pointer to delta of linearly procedural array, if it is linear.
 
MemCore::memsize_t memsize () const override
 How much memory is occupied here at all in case it's stored in a chunk?
 
- Public Member Functions inherited from MemCore::Cacheable
 Cacheable (const WeakPtr< Creature > &C)
 
bool isCached () const
 
bool isUncached () const
 
bool markAsUsed ()
 
WeakPtr< CacheBasemyCache () 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< InterfaceBasecreateInterface (const type_info &) const
 
RefPtr< InterfaceBasefindInterface (const type_info &t) const
 
RefPtr< InterfaceBasegetInterface (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)
 

Additional Inherited Members

- Static Public Member Functions inherited from Fiber::MemBase
static RefPtr< MemBasecreate (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 Attributes inherited from Fiber::MemBase
static int RegisteredTypes = 0
 
- Protected Member Functions inherited from MemCore::Cacheable
void adjustCacheableSize (memsize_t memDiff)
 
- Protected Member Functions inherited from MemCore::ReferenceBase< Cacheable >
virtual void extremeUnction ()
 
ReferenceBaseoperator= (const ReferenceBase &R)
 
void suicide ()
 

Detailed Description

template<Dims_t N>
class Fiber::MemArrayBase< N >

Abstract class for N-dimensional MultiArrays with MemCore memory management.

Member Function Documentation

◆ createSubArray()

template<Dims_t N>
RefPtr< MemBase > Fiber::MemArrayBase< N >::createSubArray ( const DynamicSize Offset,
const DynamicSize CopySize,
const MemBase::Creator_t C 
) const
inlineoverridevirtual

Implement creation of new memory sub array using the DynamicSize class.

Implements Fiber::MemBase.

References Fiber::MemArrayBase< N >::createSubMemArray().

◆ createSubMemArray()

template<Dims_t N>
virtual RefPtr< MemBase > Fiber::MemArrayBase< N >::createSubMemArray ( const MultiIndex< N > &  Offset,
const MultiIndex< N > &  CopySize,
const MemBase::Creator_t C 
) const
pure virtual

Create a new MemArray from a subset of the current array's data.

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

Referenced by Fiber::MemArrayBase< N >::createSubArray().

◆ getSize()

template<Dims_t N>
DynamicSize Fiber::MemArrayBase< N >::getSize ( ) const
inlineoverridevirtual

Return the size of this dataset.

Implements Fiber::MemBase.

References Fiber::MemArrayBase< N >::Size().

◆ getSlice()

template<Dims_t N>
virtual RefPtr< MemBase > Fiber::MemArrayBase< N >::getSlice ( index_t  n,
const MemBase::Creator_t C 
) const
pure virtual

For a multidimensional array retrieve the nth slice.

The result will be of one dimension less. A Creator object must be given for Cache management.

Implemented in Fiber::DirectProductMemArrayBase< T, Category, MDIMS >, Fiber::DirectProductMemArrayBase< T::FixedArray_t, LinearCoordinateAxisArray, MDIMS >, Fiber::DirectProductMemArrayBase< T::FixedArray_t, LinearCoordinateAxisArray, T::SIZE >, and Fiber::MemArray< N, T >.

◆ newMemArraynD()

template<Dims_t N>
virtual RefPtr< MemBase > Fiber::MemArrayBase< N >::newMemArraynD ( const MultiIndex< N > &  NewSize,
const MemBase::Creator_t C 
) const
pure virtual

Create a new array of the same type as the current one, but using the specified dimensions.

Content-wise the new array will be unrelated to the current one, but only be of the same type. The new array's data will be initialized with the type's default values.

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

References Fiber::MemArrayBase< N >::newMemArraynD().

Referenced by Fiber::MemArrayBase< N >::newMemArraynD().

◆ rank()

template<Dims_t N>
Fiber::Dims_t Fiber::MemArrayBase< N >::rank ( ) const
inlineoverridevirtual

Return the number of array dimensions.

Implements Fiber::MemBase.

◆ Size()

template<Dims_t N>
virtual MultiIndex< N > Fiber::MemArrayBase< N >::Size ( ) const
pure virtual