UE::NNE::FSymbolicTensorShape Class Reference

#include <NNETypes.h>

Public Member Functions
	FSymbolicTensorShape ()=default
	FSymbolicTensorShape (const FSymbolicTensorShape &OtherShape)=default
TConstArrayView< int32 >	GetData () const
int32	Rank () const
NNE_API bool	IsConcrete () const
NNE_API bool	operator== (const FSymbolicTensorShape &OtherShape) const
NNE_API bool	operator!= (const FSymbolicTensorShape &OtherShape) const
NNE_API void	operator= (const FSymbolicTensorShape &OtherShape)

Static Public Member Functions
static NNE_API FSymbolicTensorShape	Make (TConstArrayView< int32 > Data)

Static Public Attributes
static constexpr int32	MaxRank = 8

Detailed Description

A symbolic tensor shape represents the shape of a tensor with potentially variable dimension.

The variable dimensions are represented by -1 values.

Constructor & Destructor Documentation

FSymbolicTensorShape() [1/2]

UE::NNE::FSymbolicTensorShape::FSymbolicTensorShape ( )

default

Default construct a symbolic tensor shape.

FSymbolicTensorShape() [2/2]

UE::NNE::FSymbolicTensorShape::FSymbolicTensorShape ( const FSymbolicTensorShape &  OtherShape )

default

Construct this symbolic tensor shape from another one.

Parameters

OtherShape

the other symbolic tensor shape to copy from.

Member Function Documentation

GetData()

TConstArrayView< int32 > UE::NNE::FSymbolicTensorShape::GetData ( ) const

inline

Get the dimensions of the symbolic tensor shape.

Returns

a view on the dimensions of the symbolic tensor shape.

IsConcrete()

bool UE::NNE::FSymbolicTensorShape::IsConcrete

(

)

const

Check if the symbolic tensor shape has no variable dimensions, aka is concrete.

Returns

true if the symbolic tensor shape is concrete, false otherwise.

Make()

FSymbolicTensorShape UE::NNE::FSymbolicTensorShape::Make ( TConstArrayView< int32 >  Data )

static

Construct a symbolic tensor shape with the given dimensions.

Parameters

Data	an array of dimensions.

Returns

a symbolic tensor shape with the given dimensions.

operator!=()

bool UE::NNE::FSymbolicTensorShape::operator!=

(

const FSymbolicTensorShape &

OtherShape

)

const

Check if the symbolic tensor shape is different from another one.

Parameters

OtherShape

the other symbolic tensor shape.

Returns

true if the symbolic tensor shape is different from the other one, false otherwise.

operator=()

void UE::NNE::FSymbolicTensorShape::operator=

(

const FSymbolicTensorShape &

OtherShape

)

Assign this symbolic tensor shape from another one.

Parameters

OtherShape

the other symbolic tensor shape to copy from.

operator==()

bool UE::NNE::FSymbolicTensorShape::operator==

(

const FSymbolicTensorShape &

OtherShape

)

const

Check if the symbolic tensor shape is equal to another one.

Parameters

OtherShape

the other symbolic tensor shape.

Returns

true if the symbolic tensor shape is equal to the other one, false otherwise.

Rank()

int32 UE::NNE::FSymbolicTensorShape::Rank ( ) const

inline

Get the number of dimensions of the symbolic tensor shape, aka the rank.

Returns

the number of dimensions of the symbolic tensor shape.

Member Data Documentation

MaxRank

constexpr int32 UE::NNE::FSymbolicTensorShape::MaxRank = 8

staticconstexpr

The maximum number of dimensions supported by the symbolic tensor shape, aka the rank.

---

The documentation for this class was generated from the following files:

• Engine/Source/Runtime/NNE/Public/NNETypes.h
• Engine/Source/Runtime/NNE/Private/NNETypes.cpp