1. Epic GamesDeveloper
  3. TMultiArray

TMultiArray

Templated dynamic multi-dimensional array

API > API/Plugins > API/Plugins/Learning

References

   
Module Learning
Header /Engine/Plugins/Experimental/LearningAgents/Source/Learning/Public/MultiArray.h
Include #include "MultiArray.h"

Syntax

template<uint8 InDimNum, typename InElementType, typename InAllocatorType, bool bInIsChecked, bool bInIsRestrict>  
class TMultiArray

Remarks

Templated dynamic multi-dimensional array

A dynamically sized array of typed elements. Makes the assumption that your elements are relocatable; i.e. that they can be transparently moved to new memory without a copy constructor.

Variables

  Type Name Description
Protected variable ElementAllocatorType AllocatorInstance  
Protected variable TMultiArrayShape< DimNum, SizeType > ArrayShape  

Constructors

  Type Name Description
Public function   Constructor, initializes element number counters.
Public function  

TMultiArray ( const TMultiArrayView< DimNum, OtherElementType, bOtherIsChecked, bOtherIsRestrict, OtherSizeType > ...
)

  
Public function  

TMultiArray ( const TMultiArray< DimNum, OtherElementType, OtherAllocator, bOtherIsChecked >& Other
)

 Copy constructor with changed allocator. Use the common routine to perform the copy.
Public function  

TMultiArray ( const TMultiArray& Other
)

 Copy constructor. Use the common routine to perform the copy.
Public function  

TMultiArray ( TMultiArray&& Other
)

 Move constructor.
Public function  

TMultiArray ( TMultiArray< DimNum, OtherElementType, OtherAllocator, bOtherIsChecked >&& Other
)

 Move constructor.
Public function  

TMultiArray ( const ElementType* Ptr,
TMultiArrayShape< DimNum, SizeType > Shape
)

 Constructor from a raw array of elements.

Destructors

  Type Name Description
Public function   Destructor.

Functions

  Type Name Description
Public function Const ElementType *

begin ()

 DO NOT USE DIRECTLY STL-like iterators to enable range-based for loop support.
Public function Const void Checks array invariants: if array size is greater than zero and less than maximum.
Public function Const bool

Contains ( const ComparisonType& Item
)

 Checks if this array contains the element.
Public function Const void

DimensionCheck ( uint8 Dimension
)

 Checks if a dimension is within the allowed number of dimensions
Public function void

Empty ()

 Empties the array. It calls the destructors on held items if needed.
Public function Const ElementType *

end ()

  
Public function TMultiArrayView< DimNum-1, ElementType, bIsChecked, bIsRestrict, SizeType >

Flatten ( uint8 Dimension
)

 Flattens the array on a given dimension, merging that dimension and the following one.
Public function Const TMultiArrayView< DimNum-1, const ElementType, bIsChecked, bIsRestrict, SizeType >

Flatten ()

 Flattens the array on a given dimension, merging that dimension and the following one.
Public function TMultiArrayView< DimNum-1, ElementType, bIsChecked, bIsRestrict, SizeType >

Flatten ()

 Flattens the array on a given dimension, merging that dimension and the following one.
Public function Const TMultiArrayView< 1, const ElementType, bIsChecked, bIsRestrict, SizeType >

Flatten ()

 Flattens the array view into a single dimension.
Public function TMultiArrayView< 1, ElementType, bIsChecked, bIsRestrict, SizeType >

Flatten ()

 Flattens the array view into a single dimension.
Public function Const TMultiArrayView< DimNum-1, const ElementType, bIsChecked, bIsRestrict, SizeType >

Flatten ( uint8 Dimension
)

 Flattens the array on a given dimension, merging that dimension and the following one.
Public function ElementAllocatorType &  
Public function Const const ElementAllocatorType &  
Public function Const const PointerType

GetData ()

 Helper function for returning a typed pointer to the first array entry.
Public function PointerType

GetData ()

 Helper function for returning a typed pointer to the first array entry.
Public function Const uint32 Helper function returning the size of the inner type.
Public function Const bool

IsEmpty ( uint8 Dimension
)

 Returns true if the dimension is empty and contains no elements.
Public function Const bool

IsEmpty ()

 Returns true if the array is empty and contains no elements.
Public function Const SizeType

Num ()

 Returns total number of elements
Public function Const SizeType

Num ()

 Returns number of elements in a dimension.
Public function Const SizeType

Num ( uint8 Dimension
)

 Returns number of elements in a dimension.
Public function Const void

RangeCheck ( uint8 Dimension,
SizeType Index
)

 Checks if index is in dimension range.
Public function Const SizeType

Rank ()

 Returns number of dimensions.
Public function void

SetNum ( TMultiArrayShape< DimNum, SizeType > NewShape
)

 Resizes array to given number of elements.
Public function void Resizes array to given number of elements. New elements will be uninitialized.
Public function void

SetNumZeroed ( TMultiArrayShape< DimNum, SizeType > NewShape
)

 Resizes array to given number of elements. New elements will be zeroed.
Public function Const TMultiArrayShape< DimNum, SizeType >

Shape ()

 Returns the number of elements in each dimension.
Public function TMultiArrayView< DimNum, ElementType, bIsChecked, bIsRestrict, SizeType >

Slice ( SizeType Index,
SizeType InNum
)

 Returns a sliced view. Slicing outside of the range of the view is illegal.
Public function Const TMultiArrayView< DimNum, const ElementType, bIsChecked, bIsRestrict, SizeType >

Slice ( SizeType Index,
SizeType InNum
)

 Returns a sliced view. Slicing outside of the range of the view is illegal.
Public function Const void

SliceRangeCheck ( uint8 Dimension,
SizeType Index,
SizeType InNum
)

 Checks if a slice range [Index, Index+InNum) is in dimension range.
Public function Const SizeType

Stride ( uint8 Dimension
)

 Returns the stride for a dimension.

Operators

  Type Name Description
Public function Const    
Public function    
Public function Const TMultiArrayView< DimNum-1, const ElementType, bIsChecked, bIsRestrict, SizeType >

operator[] ( SizeType Index
)

 Array bracket operator. Returns reference to element at given index.Const version of the above.
Public function TMultiArrayView< DimNum-1, ElementType, bIsChecked, bIsRestrict, SizeType >

operator[] ( SizeType Index
)

 Array bracket operator. Returns reference to element at given index.
Public function TMultiArray &

operator= ( const TMultiArray< DimNum, ElementType, OtherAllocatorType, bOtherIsChecked >& Other
)

 Assignment operator.
Public function TMultiArray &

operator= ( const TMultiArray& Other
)

 Assignment operator.
Public function TMultiArray &

operator= ( const TMultiArrayView< DimNum, OtherElementType, bOtherIsChecked, bOtherIsRestrict, OtherSizeType > ...
)

  
Public function TMultiArray &

operator= ( TMultiArray&& Other
)

 Move assignment operator.

Typedefs

Name Description
AllocatorType  
ElementAllocatorType  
ElementType  
PointerType  
SizeType  

Constants

Name Description
bIsChecked  
bIsRestrict  
DimNum  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page