FiberVISH 0.2
Fish - The Fiber Bundle API for the Vish Visualization Shell
Public Types | Public Member Functions | List of all members
Fiber::DirectProductMemArray< T, Category, MDIMS > Class Template Reference
Inheritance diagram for Fiber::DirectProductMemArray< T, Category, MDIMS >:
Fiber::DirectProductMemArrayBase< T, Category, MDIMS > Fiber::TypedArray< T > Fiber::MemArrayBase< MDIMS > Fiber::MemBase Fiber::MemBase MemCore::Cacheable MemCore::Intercube MemCore::Cacheable MemCore::Intercube MemCore::ReferenceBase< Cacheable > MemCore::ReferenceBase< Cacheable > Fiber::LinearDirectProductMemArray< Eagle::point3, Eagle::tvector3 > Fiber::LinearDirectProductMemArray< T, DeltaT, MDIMS > Fiber::UniformCartesianArray

Public Types

enum  { COMPONENTS = DirectProductMemArrayBase_t::COMPONENTS , Dims = DirectProductMemArrayBase_t::Dims }
 
typedef MemArray< MDIMS, T > MemArray_t
 
typedefvalue_type
 The type of values that are delivered here.
 
typedef T::value_type component_type
 The type of the elements of each component.
 
typedef DirectProductMemArrayBase< typename T::FixedArray_t, Category, MDIMSDirectProductMemArrayBase_t
 
- Public Types inherited from Fiber::DirectProductMemArrayBase< T, Category, MDIMS >
enum  { COMPONENTS = T::SIZE , Dims = MDIMS }
 
typedef T::value_type component_type
 The components of the structured type T.
 
typedef CoordinateAxisArray< component_type, CategoryCoordinateAxisArray_t
 
typedef FixedArray< double, MDIMSFloatIndex_t
 A multidimensional floating-point index.
 
- Public Types inherited from Fiber::MemArrayBase< MDIMS >
enum  Dims_t
 
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 >
typedefvalue_type
 

Public Member Functions

template<class TBase >
 DirectProductMemArray (const DirectProductMemArrayCreateBaseArray &, const DirectProductMemArray< TBase, Category > &D, const MemBase::Creator_t &C=MemCore::NullPtr())
 The base value which is used as default for each component when the ComponentMap does not specify a mapping from the manifold index to a Component array.
 
 DirectProductMemArray (const MemBase::Creator_t &C=MemCore::NullPtr())
 
 DirectProductMemArray (const DirectProductMemArray &DPM, const MemBase::Creator_t &C=MemCore::NullPtr())
 
operator[] (const MultiIndex< Dims > &I) const
 
getElement (const index_t i) const
 
std::string getElementAsString (size_t index) const override
 
RefPtr< MemBasecopy (const MemBase::Creator_t &C=nullptr) const override
 Create a copy of the current array, duplicating all data and allocating new memory for it.
 
RefPtr< MemBasemakeMemArray (const MemBase::Creator_t &C) const override
 Create an actual memory-occupying array from the procedural data here.
 
RefPtr< MemBasenewMemArraynD (const MultiIndex< Dims > &, const MemBase::Creator_t &C) const override
 
RefPtr< MemBasecreateSubMemArray (const MultiIndex< Dims > &, const MultiIndex< Dims > &, const MemBase::Creator_t &C) const override
 
const type_infogetType () const override
 Return the element type of the certain array.
 
CreativeIterator< T > * creativeIterator () override
 Procedural arrays return 0 here.
 
const CreativeIterator< T > * creativeIterator () const override
 Procedural arrays return 0 here.
 
RefPtr< MemCore::TypedChunk< T > > myChunk () const override
 Procedural arrays return a NullPtr here.
 
const voidOriginPtr () const override
 Get pointer to origin of linearly procedural array, if it is linear.
 
const voidDeltaPtr () const override
 Get pointer to delta of linearly procedural array, if it is linear.
 
first () const override
 Get the data value at the firstIndex()
 
last () const override
 Get the data value at the lastIndex()
 
MultiIndex< Dims > Size () const override
 Return the multidimensional number of points covered by this array.
 
- Public Member Functions inherited from Fiber::DirectProductMemArrayBase< T, Category, MDIMS >
 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< CoordinateAxisArray_t > C[COMPONENTS], const Eagle::Vector< int, Dims > &CMap, const MemBase::Creator_t &theCreator=MemCore::NullPtr())
 
 DirectProductMemArrayBase (const DirectProductMemArrayBase &Src, const MemBase::Creator_t &theCreator=MemCore::NullPtr())
 
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.
 
MemCore::memsize_t memsize () const override
 
bool copyFrom (const RefPtr< MemCore::ChunkBase > &theChunk) override
 
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.
 
RefPtr< MemBasecreateEquallySizedMemArray (const RefPtr< MemCore::ChunkBase > &Storage, const MemBase::Creator_t &C) const override
 Create a memory array of the same dimensions as the current array, but with data as provided by the Storage.
 
RefPtr< MemBasegetComponentArray (int member, const MemBase::Creator_t &C) override
 
void retrieve (T &retval, const MultiIndex< Dims > &I) const
 Evaluate an index, deliver the coordinate value.
 
FloatIndex_t getIndex (const T &PointCoordinates) const
 Given the coordinates of a point, yield the index where it resides in the array.
 
MultiIndex< DimsSize () const override
 Return the multidimensional number of points covered by this array.
 
MultiIndex< DimsfirstIndex () const
 Return a multidimensional index for the 1st data element, which is just all components to be zero.
 
MultiIndex< DimslastIndex () 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.
 
RefPtr< MemBasegetSlice (index_t i, const MemBase::Creator_t &C) const override
 For a multidimensional array retrieve the nth slice.
 
voidgetPtr () override
 Implementation of the virtual MemArray function.
 
HyperslabParametersgetHyperslabParameters () override
 
- Public Member Functions inherited from Fiber::MemArrayBase< MDIMS >
 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< 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
 
- 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 index_t nElements () const
 return the number of elements in this array
 
auto NumberOfElements () const
 
auto getNumberOfElements () const
 
MemCore::WeakPtr< FiberTypeBasegetFiberType () const
 
MemCore::memsize_t element_memsize () const
 
bool copyFrom (const RefPtr< MemBase > &Mb)
 Copy all data values from the given MemBase.
 
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.
 
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)
 
- 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::ChunkBasegetChunk () const override
 Implement the virtual getChunk() function.
 
const type_infogetType () const override
 Return the element type of the certain array.
 
template<class UnaryOperator >
RefPtr< MemBaseapplyOperator (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< MemBaseapplyFunction (const std::function< result_t(const T &)> &theOperator) const
 Apply a functor, possibly yielding a different type.
 
RefPtr< MemBaseapplyFunction (const std::function< T(const T &)> &theOperator) const
 Apply a functor yielding the same type.
 
template<class result_t >
RefPtr< MemBaseapplyFunction (const std::function< result_t(const T &, index_t I)> &theOperator) const
 Apply a functor, possibly yielding a different type.
 
RefPtr< MemBaseapplyFunction (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< MemBaseapplyFunction (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< MemBaseapplyOperator (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< 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.
 

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 Member Functions inherited from Fiber::TypedArray< T >
static MemCore::WeakPtr< FiberTypeBasegetFiberType ()
 
static RefPtr< MemBasecreate (const RefPtr< MemBase > &SourceLayout, const type_info &layout=typeid(void))
 
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.
 
- Public Attributes inherited from Fiber::DirectProductMemArrayBase< T, Category, MDIMS >
RefPtr< CoordinateAxisArray_tComponents [COMPONENTS]
 The respective components of the array.
 
Eagle::Vector< int, DimsComponentMap
 Mapping from manifold dimension to component array.
 
- 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<class T, class Category = LinearCoordinateAxisArray, int MDIMS = T::SIZE>
class Fiber::DirectProductMemArray< T, Category, MDIMS >
Examples
uniform_scalar.cpp.

Constructor & Destructor Documentation

◆ DirectProductMemArray()

template<class T , class Category = LinearCoordinateAxisArray, int MDIMS = T::SIZE>
template<class TBase >
Fiber::DirectProductMemArray< T, Category, MDIMS >::DirectProductMemArray ( const DirectProductMemArrayCreateBaseArray ,
const DirectProductMemArray< TBase, Category > &  D,
const MemBase::Creator_t C = MemCore::NullPtr() 
)
inline

The base value which is used as default for each component when the ComponentMap does not specify a mapping from the manifold index to a Component array.

Create direct product array from another direct product array of the same category, but different numerical type.

Member Function Documentation

◆ copy()

template<class T , class Category = LinearCoordinateAxisArray, int MDIMS = T::SIZE>
RefPtr< MemBase > Fiber::DirectProductMemArray< T, Category, MDIMS >::copy ( const MemBase::Creator_t C = nullptr) const
inlineoverridevirtual

Create a copy of the current array, duplicating all data and allocating new memory for it.

Implements Fiber::MemBase.

Reimplemented in Fiber::UniformCartesianArray.

◆ creativeIterator() [1/2]

template<class T , class Category = LinearCoordinateAxisArray, int MDIMS = T::SIZE>
const CreativeIterator< T > * Fiber::DirectProductMemArray< T, Category, MDIMS >::creativeIterator ( ) const
inlineoverridevirtual

Procedural arrays return 0 here.

Implements Fiber::TypedArray< T >.

◆ creativeIterator() [2/2]

template<class T , class Category = LinearCoordinateAxisArray, int MDIMS = T::SIZE>
CreativeIterator< T > * Fiber::DirectProductMemArray< T, Category, MDIMS >::creativeIterator ( )
inlineoverridevirtual

Procedural arrays return 0 here.

Implements Fiber::TypedArray< T >.

◆ DeltaPtr()

template<class T , class Category = LinearCoordinateAxisArray, int MDIMS = T::SIZE>
const void * Fiber::DirectProductMemArray< T, Category, MDIMS >::DeltaPtr ( ) const
inlineoverridevirtual

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

Implements Fiber::MemBase.

Reimplemented in Fiber::LinearDirectProductMemArray< T, DeltaT, MDIMS >, and Fiber::LinearDirectProductMemArray< Eagle::point3, Eagle::tvector3 >.

◆ first()

template<class T , class Category = LinearCoordinateAxisArray, int MDIMS = T::SIZE>
T Fiber::DirectProductMemArray< T, Category, MDIMS >::first ( ) const
inlineoverridevirtual

◆ getElementAsString()

template<class T , class Category = LinearCoordinateAxisArray, int MDIMS = T::SIZE>
std::string Fiber::DirectProductMemArray< T, Category, MDIMS >::getElementAsString ( size_t  index) const
inlineoverridevirtual

Implements Fiber::MemBase.

◆ getType()

template<class T , class Category = LinearCoordinateAxisArray, int MDIMS = T::SIZE>
const type_info & Fiber::DirectProductMemArray< T, Category, MDIMS >::getType ( ) const
inlineoverridevirtual

Return the element type of the certain array.

Implements Fiber::MemBase.

◆ last()

template<class T , class Category = LinearCoordinateAxisArray, int MDIMS = T::SIZE>
T Fiber::DirectProductMemArray< T, Category, MDIMS >::last ( ) const
inlineoverridevirtual

◆ makeMemArray()

template<class T , class Category = LinearCoordinateAxisArray, int MDIMS = T::SIZE>
RefPtr< MemBase > Fiber::DirectProductMemArray< T, Category, MDIMS >::makeMemArray ( const MemBase::Creator_t C) const
inlineoverridevirtual

Create an actual memory-occupying array from the procedural data here.

Implements Fiber::MemBase.

References Fiber::DirectProductMemArrayBase< T, Category, MDIMS >::retrieve(), and Fiber::DirectProductMemArray< T, Category, MDIMS >::Size().

◆ myChunk()

template<class T , class Category = LinearCoordinateAxisArray, int MDIMS = T::SIZE>
RefPtr< MemCore::TypedChunk< T > > Fiber::DirectProductMemArray< T, Category, MDIMS >::myChunk ( ) const
inlineoverridevirtual

Procedural arrays return a NullPtr here.

Implements Fiber::TypedArray< T >.

◆ OriginPtr()

template<class T , class Category = LinearCoordinateAxisArray, int MDIMS = T::SIZE>
const void * Fiber::DirectProductMemArray< T, Category, MDIMS >::OriginPtr ( ) const
inlineoverridevirtual

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

Implements Fiber::MemBase.

Reimplemented in Fiber::LinearDirectProductMemArray< T, DeltaT, MDIMS >, and Fiber::LinearDirectProductMemArray< Eagle::point3, Eagle::tvector3 >.

◆ Size()

template<class T , class Category = LinearCoordinateAxisArray, int MDIMS = T::SIZE>
MultiIndex< Dims > Fiber::DirectProductMemArrayBase< T, Category, MDIMS >::Size ( ) const
inlineoverridevirtual

Return the multidimensional number of points covered by this array.

Implements Fiber::MemArrayBase< MDIMS >.

Referenced by Fiber::DirectProductMemArray< T, Category, MDIMS >::makeMemArray().