The ArrayContainer class manages arrays with arbitrary component data types. More...
#include <array.hpp>
Inherits TGD::ArrayDescription.
Inherited by TGD::Array< T >.
Public Member Functions | |
Constructors / Destructor | |
| ArrayContainer () | |
| Constructor for an empty array container. More... | |
| ArrayContainer (const ArrayDescription &desc) | |
| Constructor for an array container. More... | |
| ArrayContainer (const std::vector< size_t > &dimensions, size_t components, Type componentType) | |
| Constructor for an array container. More... | |
| ArrayContainer | deepCopy () const |
| Construct an array and perform deep copy of data. More... | |
Data access | |
| const void * | data () const |
| Returns a pointer to the data. This will return a null pointer as long as the data was not allocated yet; see allocateData(). More... | |
| void * | data () |
| Returns a pointer to the data. This will return a null pointer as long as the data was not allocated yet; see allocateData(). More... | |
| template<typename T > | |
| const T * | get (size_t elementIndex) const |
| Returns a pointer to the element with index elementIndex. Note that the data must be allocated, see createData(). More... | |
| template<typename T > | |
| const T * | get (const std::vector< size_t > &elementIndex) const |
| Returns a pointer to the element with index elementIndex. Note that the data must be allocated, see createData(). More... | |
| template<typename T > | |
| const T * | get (const std::initializer_list< size_t > &elementIndex) const |
| Returns a pointer to the element with index elementIndex. Note that the data must be allocated, see createData(). More... | |
| template<typename T > | |
| T * | get (size_t elementIndex) |
| Returns a pointer to the element with index elementIndex. Note that the data must be allocated, see createData(). More... | |
| template<typename T > | |
| T * | get (const std::vector< size_t > &elementIndex) |
| Returns a pointer to the element with index elementIndex. Note that the data must be allocated, see createData(). More... | |
| template<typename T > | |
| T * | get (const std::initializer_list< size_t > &elementIndex) |
| Returns a pointer to the element with index elementIndex. Note that the data must be allocated, see createData(). More... | |
| template<typename T > | |
| void | set (size_t elementIndex, const std::vector< T > &elementValue) |
| Sets the components of the element with index elementIndex to the given values. More... | |
| template<typename T > | |
| void | set (size_t elementIndex, const std::initializer_list< T > &elementValue) |
| Sets the components of the element with index elementIndex to the given values. More... | |
| template<typename T > | |
| void | set (const std::vector< size_t > &elementIndex, const std::vector< T > &elementValue) |
| Sets the components of the element with index elementIndex to the given values. More... | |
| template<typename T > | |
| void | set (const std::vector< size_t > &elementIndex, const std::initializer_list< T > &elementValue) |
| Sets the components of the element with index elementIndex to the given values. More... | |
| template<typename T > | |
| void | set (const std::initializer_list< size_t > &elementIndex, const std::vector< T > &elementValue) |
| Sets the components of the element with index elementIndex to the given values. More... | |
| template<typename T > | |
| void | set (const std::initializer_list< size_t > &elementIndex, const std::initializer_list< T > &elementValue) |
| Sets the components of the element with index elementIndex to the given values. More... | |
| template<typename T > | |
| T | get (size_t elementIndex, size_t componentIndex) const |
| Returns the value of the component with index componentIndex within the element with index elementIndex. More... | |
| template<typename T > | |
| T | get (const std::vector< size_t > &elementIndex, size_t componentIndex) const |
| Returns the value of the component with index componentIndex within the element with index elementIndex. More... | |
| template<typename T > | |
| T | get (const std::initializer_list< size_t > &elementIndex, size_t componentIndex) const |
| Returns the value of the component with index componentIndex within the element with index elementIndex. More... | |
| template<typename T > | |
| void | set (size_t elementIndex, size_t componentIndex, T value) |
| Sets the component with index componentIndex within the element with index elementIndex to value. More... | |
| template<typename T > | |
| void | set (const std::vector< size_t > &elementIndex, size_t componentIndex, T value) |
| Sets the component with index componentIndex within the element with index elementIndex to value. More... | |
| template<typename T > | |
| void | set (const std::initializer_list< size_t > &elementIndex, size_t componentIndex, T value) |
| Sets the component with index componentIndex within the element with index elementIndex to value. More... | |
 Public Member Functions inherited from TGD::ArrayDescription | |
| ArrayDescription () | |
| Constructor for an empty array description. More... | |
| ArrayDescription (const std::vector< size_t > &dimensions, size_t componentCount, Type componentType) | |
| Constructor for an array description. More... | |
| ArrayDescription (const ArrayDescription &descr, Type type) | |
| Constructor for an array description. More... | |
| size_t | dimensionCount () const |
| Returns the number of dimensions. More... | |
| size_t | dimension (size_t d) const |
| Returns the size of dimension d. More... | |
| const std::vector< size_t > & | dimensions () const |
| Returns the list of dimensions. More... | |
| size_t | componentCount () const |
| Returns the number of components in each element. More... | |
| Type | componentType () const |
| Returns the type represented by each element component. More... | |
| size_t | componentSize () const |
| Returns the size of a component. More... | |
| size_t | elementSize () const |
| Returns the size of an element. More... | |
| size_t | elementCount () const |
| Returns the number of elements in the array. More... | |
| size_t | dataSize () const |
| Returns the total data size. More... | |
| bool | isCompatible (const ArrayDescription &a) const |
| Returns whether the dimensions and components of array match those of this array. More... | |
| const ArrayDescription & | description () const |
| Returns this as a description. This is useful for derived classes. More... | |
| size_t | toLinearIndex (const std::vector< size_t > &elementIndex) const |
| Convert the given multidimensional element index to a linear element index. For example, for a 800x600 array, the multidimensional index { 1, 1 } is converted to linear index 601. More... | |
| size_t | toLinearIndex (const std::initializer_list< size_t > &elementIndex) const |
| Convert the given multidimensional element index to a linear element index. For example, for a 800x600 array, the multidimensional index { 1, 1 } is converted to linear index 601. More... | |
| void | toVectorIndex (size_t elementIndex, size_t *vectorIndex) const |
| Convert the given linear element index to a multidimensional index. For example, for a 800x600 array, the linear index 601 is converted to the multidimensional index { 1, 1 }. More... | |
| size_t | elementOffset (size_t elementIndex) const |
| Returns the offset of the element with index elementIndex within the data. More... | |
| size_t | elementOffset (const std::vector< size_t > &elementIndex) const |
| Returns the offset of the element with index elementIndex within the data. More... | |
| size_t | elementOffset (const std::initializer_list< size_t > &elementIndex) const |
| Returns the offset of the element with index elementIndex within the data. More... | |
| size_t | componentOffset (size_t componentIndex) const |
| Returns the offset of the component with index componentIndex within an array element. More... | |
| size_t | componentOffset (size_t elementIndex, size_t componentIndex) const |
| Returns the offset of the component with index componentIndex in the element with index elementIndex within an array element. More... | |
| size_t | componentOffset (const std::vector< size_t > &elementIndex, size_t componentIndex) const |
| Returns the offset of the component with index componentIndex in the element with index elementIndex within an array element. More... | |
| size_t | componentOffset (const std::initializer_list< size_t > &elementIndex, size_t componentIndex) const |
| Returns the offset of the component with index componentIndex in the element with index elementIndex within an array element. More... | |
| const TagList & | globalTagList () const |
| Returns the global tag list. More... | |
| TagList & | globalTagList () |
| Returns the global tag list. More... | |
| const TagList & | dimensionTagList (size_t d) const |
| Returns the tag list for dimension d. More... | |
| TagList & | dimensionTagList (size_t d) |
| Returns the tag list for dimension d. More... | |
| const TagList & | componentTagList (size_t c) const |
| Returns the tag list for component c. More... | |
| TagList & | componentTagList (size_t c) |
| Returns the tag list for component c. More... | |
Detailed Description
The ArrayContainer class manages arrays with arbitrary component data types.
Constructor & Destructor Documentation
◆ ArrayContainer() [1/3]
|
inline |
Constructor for an empty array container.
◆ ArrayContainer() [2/3]
|
inlineexplicit |
Constructor for an array container.
◆ ArrayContainer() [3/3]
|
inline |
Constructor for an array container.
Member Function Documentation
◆ data() [1/2]
|
inline |
Returns a pointer to the data. This will return a null pointer as long as the data was not allocated yet; see allocateData().
◆ data() [2/2]
|
inline |
Returns a pointer to the data. This will return a null pointer as long as the data was not allocated yet; see allocateData().
◆ deepCopy()
|
inline |
Construct an array and perform deep copy of data.
◆ get() [1/9]
template<typename T >
|
inline |
Returns a pointer to the element with index elementIndex. Note that the data must be allocated, see createData().
◆ get() [2/9]
template<typename T >
|
inline |
Returns a pointer to the element with index elementIndex. Note that the data must be allocated, see createData().
◆ get() [3/9]
template<typename T >
|
inline |
Returns the value of the component with index componentIndex within the element with index elementIndex.
◆ get() [4/9]
template<typename T >
|
inline |
Returns a pointer to the element with index elementIndex. Note that the data must be allocated, see createData().
◆ get() [5/9]
template<typename T >
|
inline |
Returns a pointer to the element with index elementIndex. Note that the data must be allocated, see createData().
◆ get() [6/9]
template<typename T >
|
inline |
Returns the value of the component with index componentIndex within the element with index elementIndex.
◆ get() [7/9]
template<typename T >
|
inline |
Returns a pointer to the element with index elementIndex. Note that the data must be allocated, see createData().
◆ get() [8/9]
template<typename T >
|
inline |
Returns a pointer to the element with index elementIndex. Note that the data must be allocated, see createData().
◆ get() [9/9]
template<typename T >
|
inline |
Returns the value of the component with index componentIndex within the element with index elementIndex.
◆ set() [1/9]
template<typename T >
|
inline |
Sets the components of the element with index elementIndex to the given values.
◆ set() [2/9]
template<typename T >
|
inline |
Sets the components of the element with index elementIndex to the given values.
◆ set() [3/9]
template<typename T >
|
inline |
Sets the component with index componentIndex within the element with index elementIndex to value.
◆ set() [4/9]
template<typename T >
|
inline |
Sets the components of the element with index elementIndex to the given values.
◆ set() [5/9]
template<typename T >
|
inline |
Sets the components of the element with index elementIndex to the given values.
◆ set() [6/9]
template<typename T >
|
inline |
Sets the component with index componentIndex within the element with index elementIndex to value.
◆ set() [7/9]
template<typename T >
|
inline |
Sets the components of the element with index elementIndex to the given values.
◆ set() [8/9]
template<typename T >
|
inline |
Sets the components of the element with index elementIndex to the given values.
◆ set() [9/9]
template<typename T >
|
inline |
Sets the component with index componentIndex within the element with index elementIndex to value.
The documentation for this class was generated from the following file:
