Navigation
API > API/Plugins > API/Plugins/Learning
References
| Module | Learning |
| Header | /Engine/Plugins/Experimental/LearningAgents/Source/Learning/Public/MultiArrayView.h |
| Include | #include "MultiArrayView.h" |
Syntax
template<typename InElementType, bool bInIsChecked, bool bInIsRestrict, typename InSizeType>
class TMultiArrayView< 1, InElementType, bInIsChecked, bInIsRestrict, InSizeType >
Remarks
Specialization for single dimensional MultiArrayView
Functions
| Type | Name | Description | |
|---|---|---|---|
| ElementType * | begin () |
DO NOT USE DIRECTLY STL-like iterators to enable range-based for loop support. | |
| void | Checks array invariants: if array size is greater than zero on each dimension | ||
| bool | Contains
(
const ComparisonType& Item |
Checks if this array contains the element. | |
| void | DimensionCheck
(
uint8 Dimension |
Checks if a dimension is within the allowed number of dimensions | |
| ElementType * | end () |
||
| const PointerType | GetData () |
Helper function for returning a typed pointer to the first array entry. | |
| PointerType | GetData () |
Helper function for returning a typed pointer to the first array entry. | |
| constexpr size_t | Helper function returning the alignment of the inner type. | ||
| constexpr size_t | GetTypeSize () |
Helper function returning the size of the inner type. | |
| bool | IsEmpty () |
Returns true if the array is empty and contains no elements. | |
| bool | IsEmpty
(
uint8 Dimension |
Returns true if the dimension is empty and contains no elements. | |
| SizeType | Num () |
Returns the total number of elements | |
| SizeType | Num () |
Returns the number of elements in a dimension. | |
| SizeType | Num
(
uint8 Dimension |
Returns the number of elements in a dimension. | |
| void | RangeCheck
(
uint8 Dimension, |
Checks if index is in dimension range. | |
| SizeType | Rank () |
Returns the number of dimensions. | |
| TMultiArrayShape< DimNum, SizeType > | Shape () |
Returns the number of elements in each dimension. | |
| TMultiArrayView | Returns a sliced view. Slicing outside of the range of the view is illegal. | ||
| void | SliceRangeCheck
(
uint8 Dimension, |
Checks if a slice range [Index, Index+InNum) is in dimension range. | |
| SizeType | Stride
(
uint8 Dimension |
Returns the stride for a dimension. | |
TMultiArrayView
(
ElementType* InData, |
Construct a view of an arbitrary pointer | ||
| Constructor. | |||
TMultiArrayView
(
OtherRangeType&& Other |
Constructor from another range | ||
TMultiArrayView
(
std::initializer_list< ElementType > List |
Construct a view of an initializer list. | ||
TMultiArrayView
(
OtherElementType* InData, |
Construct a view of an arbitrary pointer |
Operators
| Type | Name | Description | |
|---|---|---|---|
| Implicit cast to TArrayView. | |||
| Implicit cast for Checked and Restrict. | |||
| Implicit cast for Checked and Restrict. | |||
| Implicit cast for Checked and Restrict. | |||
| Implicit cast for Checked and Restrict. | |||
| Implicit cast for Checked and Restrict. | |||
| Implicit cast for Checked and Restrict. | |||
| Implicit cast for Checked and Restrict. | |||
| Implicit cast for Checked and Restrict. | |||
| ElementType & | operator[]
(
SizeType Index |
Array bracket operator. Returns a reference to the element at given index. |
Typedefs
| Name | Description |
|---|---|
| ElementType | |
| PointerType | |
| SizeType | |
| TIsCompatibleElementType | |
| TIsCompatibleRangeType | |
| TIsReinterpretableRangeType |
Constants
| Name | Description |
|---|---|
| bIsChecked | |
| bIsRestrict | |
| DimNum |