1. Epic GamesDeveloper
  3. Learning

Learning

API > API/Plugins

Classes

  Type Name Description
Public struct FAccelerationFeature Feature for an array of accelerations  
Public struct FAdamOptimizer Adam Optimizer  
Public struct FAdamOptimizerSettings    
Public struct FAngleFeature Feature for an array of angles  
Public struct FAngularAccelerationFeature Feature for an array of angular accelerations  
Public struct FAngularVelocityFeature Feature for an array of angular velocities  
Public struct FAnyCompletion Terminates if any of the provided completions terminate  
Public struct FArrayMap A map of differently sized and typed multi-dimensional arrays  
Public struct FArrayMapHandle Untyped handle to an array stored in an FArrayMap  
Public struct FArrayMapKey Key type for FArrayMap.  
Public struct FCMAOptimizer CMA OptimizerBlack box optimizer based on Covariance Matrix Adaption  
Public struct FCMAOptimizerSettings Settings for the CMA Optimizer  
Public struct FCompletionObject Base class for an object which computes if an instance should be completion from a set of other arrays.  
Public struct FConcatenateFeature Feature that concatenates multiple other features  
Public struct FConditionalCompletion Completion due to some condition being true  
Public struct FConditionalConstantReward Conditional Constant Reward  
Public struct FConstantPenalty Constant Penalty  
Public struct FConstantReward Constant Reward  
Public struct FCopyVectorsFunction Copies vector data from one array to another  
Public struct FDirectionFeature Feature for an array of directions  
Public struct FExtractPositionsAndRotationsFromTransformsFunction Computes positions and rotations given transforms  
Public struct FExtractRotationsFromTransformsFunction Computes rotations given transforms  
Public struct FFacingDirectionAngularDifferencePenalty Penalty based on the difference between two rotations facing directions  
Public struct FFacingTowardsTargetAngularDifferencePenalty Penalty based on the difference between a rotation facing direction and a position  
Public struct FFeatureObject Base class for an object which can do the encoding or decoding of features from a set of other arrays.  
Public struct FFloatFeature Feature for an array of floats  
Public struct FFloatReward Basic Float Reward  
Public struct FFunctionObject Base class for an object which outputs to some arrays stored in a [FArrayMap](API\Plugins\Learning\FArrayMap)_, using other arrays in the FArrayMap_ as input.  
Public struct FIndexSet FIndexSet represents a set of indices - more specifically, either a slice of indices, or an ArrayView of int32 which acts as the set of indices.  
Public struct FIndexSetIterator Iterator for FIndexSet (see below)  
Public class FLearningModule    
Public struct FLocalDirectionalVelocityReward Reward based on how large a velocity is in a particular local direction  
Public struct FNeuralNetwork Simple feed-forward network data.  
Public struct FNeuralNetworkCriticFunction Neural-network based critic object.  
Public struct FNeuralNetworkCriticFunctionSettings Settings object for a neural network based critic  
Public struct FNeuralNetworkPolicyFunction Neural-network based policy object.  
Public struct FNeuralNetworkPolicyFunctionSettings Settings object for a neural network based policy  
Public struct FOptimizationPlannerBuffer Basic buffer containing some additional data used during optimization planning  
Public struct FPCAEncoder Represents a PCA transformation which can be used to encode data  
Public struct FPCAResult Details of the result of the PCA fitting.  
Public struct FPCASettings PCA settings.  
Public struct FPlanarAccelerationFeature Feature for an array of planar accelerations  
Public struct FPlanarAngularAccelerationFeature Feature for an array of planar angular accelerations  
Public struct FPlanarDirectionFeature Feature for an array of planar directions  
Public struct FPlanarPositionDifferenceCompletion Completion due to the difference between any two planar positions exceeding a given threshold  
Public struct FPlanarPositionDifferencePenalty Penalty based on the difference between two planar positions  
Public struct FPlanarPositionFeature Feature for an array of planar positions  
Public struct FPlanarPositionSimilarityCompletion Completion due to the similarity between any two planar positions being below a given threshold  
Public struct FPlanarVelocityFeature Feature for an array of planar velocities  
Public struct FPositionArraySimilarityReward Reward based on the similarity between two arrays of position  
Public struct FPositionDifferencePenalty Penalty based on the difference between two positions  
Public struct FPositionFeature Feature for an array of positions  
Public struct FProgress Simple thread-safe structure to record progress of some long-running computation.  
Public struct FPSOOptimizer PSO OptimizerGradient free optimizer based on Particle Swarm Optimization  
Public struct FPSOOptimizerSettings Settings for the PSO Optimizer.  
Public struct FRandomPlanarClippedGaussianFunction Samples values from a planar clipped Gaussian distribution.  
Public struct FRandomPlanarDirectionFunction Samples planar directions.  
Public struct FRandomPlanarDirectionVelocityFunction Samples planar directions with corresponding velocities.  
Public struct FRandomUniformFunction Samples scalar values from a uniform distribution  
Public struct FRecorderObject The RecorderObject_ can be used to record the values of certain arrays in an FArrayMap_.  
Public struct FResetInstanceBuffer This object stores essentially a list of instances that need to be reset.  
Public struct FRewardObject Base class for an object which computes a reward or penalty value from a set of other arrays.  
Public struct FRotationFeature Feature for an array of rotations  
Public struct FRotationVectorFeature Feature for an array of rotation vectors  
Public struct FScalarAccelerationFeature Feature for an array of scalar accelerations  
Public struct FScalarAngularAccelerationFeature Feature for an array of scalar angular accelerations  
Public struct FScalarAngularVelocityDifferenceCompletion Completion due to the difference between two scalar angular velocities exceeding a given threshold  
Public struct FScalarAngularVelocityFeature Feature for an array of scalar angular velocities  
Public struct FScalarAngularVelocitySimilarityReward Reward based on the similarity between two scalar angular velocities  
Public struct FScalarPositionDifferenceCompletion Completion due to the difference between any two scalar positions exceeding a given threshold  
Public struct FScalarPositionFeature Feature for an array of scalar positions  
Public struct FScalarPositionSimilarityReward Reward based on the similarity between two scalar position  
Public struct FScalarRotationDifferenceCompletion Completion due to the difference between any two scalar rotations exceeding a given threshold  
Public struct FScalarRotationSimilarityReward Reward based on the similarity between two rotations  
Public struct FScalarVelocityDifferenceCompletion Completion due to the difference between any two scalar velocities exceeding a given threshold  
Public struct FScalarVelocityFeature Feature for an array of scalar velocities  
Public struct FScalarVelocityReward Reward based on how large (and positive) a scalar velocity is  
Public struct FScaleFeature Feature for an array of scales  
Public struct FScopeNullableReadLock Scoped read lock, which can optionally be null  
Public struct FScopeNullableWriteLock Scoped write lock, which can optionally be null  
Public struct FSequentialFunction Executes another set of function objects in sequence  
Public struct FSpringInertializationPenalty Penalty based on the average spring inertialization displacement introduced when transitioning between two moving points  
Public struct FSumReward Reward that sums the results of multiple other reward functions  
Public struct FTimeElapsedCompletion Completion due to time having elapsed  
Public struct FTimeFeature Feature for an array of times  
Public struct FVectorAverageMagnitudePenalty Penalty based on the average absolute magnitude of each dimension of a vector  
Public struct FVelocityDifferencePenalty Penalty based on the difference between two velocities  
Public struct FVelocityFeature Feature for an array of velocities  
Public struct IOptimizer Interface for an Optimizer  
Public struct TArrayMapHandle Type-safe handle to an array stored in an FArrayMap  
Public struct TIsCompatibleElementType Copied from Core/Public/Containers/ArrayView.h  
Public struct TIsCompatibleRangeType Copied from Core/Public/Containers/ArrayView.h  
Public struct TIsReinterpretableRangeType Copied from Core/Public/Containers/ArrayView.h  
Public class TMultiArray Templated dynamic multi-dimensional array  
Public class TMultiArrayShape    
Public class TMultiArrayView Templated fixed-size view of multi-dimensional array  
Public struct TTypeId Compile-time function to generate a type id from a C++ type.  

Constants

Name Description
UE::Learning::Completion::DefaultThresholdAngle  
UE::Learning::Completion::DefaultThresholdAngularVelocity  
UE::Learning::Completion::DefaultThresholdHeight  
UE::Learning::Completion::DefaultThresholdPosition  
UE::Learning::Completion::DefaultThresholdTime  
UE::Learning::Completion::DefaultThresholdVelocity  
UE::Learning::Feature::DefaultScale  
UE::Learning::Feature::DefaultScaleAcceleration  
UE::Learning::Feature::DefaultScaleAngle  
UE::Learning::Feature::DefaultScaleAngularAcceleration  
UE::Learning::Feature::DefaultScaleAngularVelocity  
UE::Learning::Feature::DefaultScaleDirection  
UE::Learning::Feature::DefaultScalePosition  
UE::Learning::Feature::DefaultScaleScale  
UE::Learning::Feature::DefaultScaleTime  
UE::Learning::Feature::DefaultScaleVelocity  
UE::Learning::Reward::DefaultScale  
UE::Learning::Reward::DefaultScaleAngle  
UE::Learning::Reward::DefaultScaleAngularVelocity  
UE::Learning::Reward::DefaultScalePosition  
UE::Learning::Reward::DefaultScaleSpringInertialization  
UE::Learning::Reward::DefaultScaleVelocity  

Typedefs

Name Description
TConstMultiArrayView  
TLearningArray  
TLearningArrayShape  
TLearningArrayView  
TLearningConstArrayView  
TMultiArrayElementsAreCompatible Copied from Core/Public/Containers/Array.h

Enums

  Type Name Description
Public enum UE::Learning:: Shared memory is used by Learning to efficiently share both experience and policy data between a Python training sub-process and potentially multiple unreal processes (which may be gathering that experience).  
Public enum UE::Learning::EActivationFunction Activation Function for use in a Neural Network  
Public enum UE::Learning::ECompletionMode Completion Mode  
Public enum UE::Learning::ELogSetting Log Settings  

Functions

  Type Name Description
Public function void

UE::Learning::Array::Check ( const TLearningArrayView< InDimNum, const InElementType > View,
const FIndexSet Indices
)

 Check that an array view does not contain any NaN, Inf, -Inf, MAX_flt, or -MAX_flt
Public function void

UE::Learning::Array::Check ( const TLearningArray< InDimNum, InElementType, Allocator >& View
)

 Check that an array does not contain any NaN, Inf, -Inf, MAX_flt, or -MAX_flt
Public function void

UE::Learning::Array::Check ( const TLearningArrayView< InDimNum, InElementType > View
)

 Check that an array view does not contain any NaN, Inf, -Inf, MAX_flt, or -MAX_flt
Public function void

UE::Learning::Array::CheckShapesEqual ( const TLearningArrayShape< InDimNum >& Lhs,
const TLearningArrayShape< InDimNum >& Rhs
)

 Check that two array shapes are equal.
Public function void

UE::Learning::Array::Copy ( TLearningArray< InDimNum, InElementType, Allocator >& Dst,
const TLearningArrayView< InDimNum, const InElementType > Src,
const FIndexSet Indices
)

 Copy the contents of one array view into another
Public function void

UE::Learning::Array::Copy ( TLearningArray< InDimNum, InElementType, AllocatorLhs >& Dst,
const TLearningArray< InDimNum, InElementType, AllocatorRhs >& Src,
const FIndexSet Indices
)

 Copy the contents of one array view into another
Public function void

UE::Learning::Array::Copy ( TLearningArrayView< InDimNum, InElementType > Dst,
const TLearningArray< InDimNum, InElementType, Allocator >& Src,
const FIndexSet Indices
)

 Copy the contents of one array view into another
Public function void

UE::Learning::Array::Copy ( TLearningArrayView< InDimNum, InElementType > Dst,
const TLearningArrayView< InDimNum, const InElementType > Src,
const FIndexSet Indices
)

 Copy the contents of one array view into another
Public function void

UE::Learning::Array::Copy ( TLearningArray< InDimNum, InElementType, AllocatorLhs >& Dst,
const TLearningArray< InDimNum, InElementType, AllocatorRhs >& Src
)

 Copy the contents of one array into another array
Public function void

UE::Learning::Array::Copy ( TLearningArrayView< InDimNum, InElementType > Dst,
const TLearningArray< InDimNum, InElementType, Allocator >& Src
)

 Copy the contents of one array into another array view
Public function void

UE::Learning::Array::Copy ( TLearningArrayView< InDimNum, InElementType > Dst,
TLearningArrayView< InDimNum, InElementType > Src
)

 Copy the contents of one array view into another
Public function void

UE::Learning::Array::Copy ( TLearningArray< InDimNum, InElementType, Allocator >& Dst,
const TLearningArrayView< InDimNum, const InElementType > Src
)

 Copy the contents of one array view into another array
Public function void

UE::Learning::Array::DeserializeFromBytes ( int32& InOutOffset,
TLearningArrayView< 1, const uint8 > Bytes,
TLearningArray< InDimNum, InElementType, Allocator >& OutArray
)

 Serialize an array from bytes
Public function bool

UE::Learning::Array::Equal ( const TLearningArray< InDimNum, InElementType, AllocatorLhs >& Lhs,
const TLearningArrayView< InDimNum, const InElementType >& Rhs
)

 Check if the contents of one array equals the contents of another.
Public function bool

UE::Learning::Array::Equal ( const TLearningArrayView< InDimNum, const InElementType > Lhs,
const TLearningArray< InDimNum, InElementType, AllocatorRhs >& Rhs
)

 Check if the contents of one array equals the contents of another.
Public function bool

UE::Learning::Array::Equal ( const TLearningArray< InDimNum, InElementType, AllocatorLhs >& Lhs,
const TLearningArray< InDimNum, InElementType, AllocatorRhs >& Rhs
)

 Check if the contents of one array equals the contents of another.
Public function bool

UE::Learning::Array::Equal ( const TLearningArrayView< InDimNum, const InElementType > Lhs,
const TLearningArrayView< InDimNum, const InElementType > Rhs
)

 Check if the contents of one array equals the contents of another.
Public function FString

UE::Learning::Array::Format ( const TLearningArrayView< 1, const InElementType > Array,
const TFunctionRef< FString(const InElementType&)> Formatter,
const int32 MaxItemNum
)

  
Public function Static FString

UE::Learning::Array::FormatFloat ( const TLearningArrayView< 1, const float > Array,
const int32 MaxItemNum
)

  
Public function Static FString

UE::Learning::Array::FormatInt32 ( const TLearningArrayView< 1, const int32 > Array,
const int32 MaxItemNum
)

  
Public function Static FString

UE::Learning::Array::FormatUint64 ( const TLearningArrayView< 1, const uint64 > Array,
const int32 MaxItemNum
)

  
Public function int32

UE::Learning::Array::IndexOf ( const TLearningArray< 1, InElementType >& Array,
const InElementType& Element
)

  
Public function int32

UE::Learning::Array::IndexOf ( const TLearningArrayView< 1, const InElementType > Array,
const InElementType& Element
)

  
Public function int32 Serialization byte num
Public function void

UE::Learning::Array::Serialize ( FArchive& Ar,
TLearningArray< InDimNum, InElementType, Allocator >& Array
)

 Serialize an array
Public function void

UE::Learning::Array::SerializeToBytes ( int32& InOutOffset,
TLearningArrayView< 1, uint8 > Bytes,
const TLearningArray< InDimNum, InElementType, Allocator >& InArray
)

 Serialize an array to bytes
Public function void

UE::Learning::Array::Set ( TLearningArray< InDimNum, InElementType, Allocator >& View,
const InElementType& Element
)

 Set each item of an array to the given element
Public function void

UE::Learning::Array::Set ( TLearningArrayView< InDimNum, InElementType > View,
const InElementType& Element
)

 Set each item of an array view to the given element
Public function void

UE::Learning::Array::Set ( TLearningArrayView< InDimNum, InElementType > View,
const InElementType& Element,
const FIndexSet Indices
)

 Set each item of an array view to the given element
Public function void

UE::Learning::Array::Set ( TLearningArray< InDimNum, InElementType, Allocator >& View,
const InElementType& Element,
const FIndexSet Indices
)

 Set each item of an array to the given element
Public function void

UE::Learning::Array::ShiftLeft ( TLearningArray< InDimNum, InElementType, Allocator >& Array,
const int32 ShiftNum
)

 Shift all elements in an array to the left. Data at the end of the array will remain the same.
Public function void

UE::Learning::Array::ShiftLeft ( TLearningArray< 1, InElementType, Allocator >& Array,
const int32 ShiftNum
)

 Shift all elements in an array to the left. Data at the end of the array will remain the same.
Public function void

UE::Learning::Array::ShiftLeft ( TLearningArrayView< InDimNum, InElementType > Array,
const int32 ShiftNum
)

 Shift all elements in an array to the left. Data at the end of the array will remain the same.
Public function void

UE::Learning::Array::ShiftLeft ( TLearningArrayView< 1, InElementType > Array,
const int32 ShiftNum
)

 Shift all elements in an array to the left. Data at the end of the array will remain the same.
Public function void

UE::Learning::Array::Zero ( TLearningArrayView< InDimNum, InElementType > View
)

 Zero the memory of an array view
Public function void

UE::Learning::Array::Zero ( TLearningArray< InDimNum, InElementType, Allocator >& Array
)

 Zero the memory of an array
Public function void

UE::Learning::Array::Zero ( TLearningArray< InDimNum, InElementType, Allocator >& View,
const FIndexSet Indices
)

 Zero the memory of an array view
Public function void

UE::Learning::Array::Zero ( TLearningArrayView< InDimNum, InElementType > View,
const FIndexSet Indices
)

 Zero the memory of an array view
Public function void

UE::Learning::ArrayMapPrivate::DestructArrayItems ( void* Elements,
const int32 DimNum,
const int32* Shape
)

 Destructor for an array of elements of a given type
Public function Static int32

UE::Learning::ArrayMapPrivate::RoundUpToMultiple ( const int32 Value,
const int32 Multiple
)

  
Public function const TCHAR * Compile-time function to get a debug name for a C++ type
Public function Static void

UE::Learning::DeserializeFromBytes ( int32& InOutOffset,
TLearningArrayView< 1, const uint8 > Bytes,
int32& OutValue
)

 Serialize an integer from bytes
Public function void

UE::Learning::Feature::Decode::Float ( float& Value,
const TLearningArrayView< 1, const float > Input,
const float Scale
)

  
Public function void

UE::Learning::Feature::Decode::Time ( float& OutTime,
const TLearningArrayView< 1, const float > Input,
const float RelativeTime,
const float Scale
)

  
Public function void

UE::Learning::Random::PlanarDirectionVelocity ( FVector& OutDirection,
FVector& OutVelocity,
const uint32 State,
const float VelocityScale,
const FVector Axis0,
const FVector Axis1
)

  
Public function void

UE::Learning::RecorderObjectPrivate::Copy ( TLearningArrayView< 1, int32 > InOutStepNums,
const FArrayMap& SrcArrayMap,
const FArrayMap& LogArrayMap,
const FArrayMapHandle SrcHandle,
const FArrayMapHandle LogHandle,
const int32 MaxStepNum,
const FIndexSet Instances
)

  
Public function Static void

UE::Learning::SerializeToBytes ( int32& InOutOffset,
TLearningArrayView< 1, uint8 > Bytes,
const int32 InValue
)

 Serialize an integer to bytes
Public function decltype(auto) Copied from Core/Public/Containers/ArrayView.h
Public function decltype(auto) Copied from Core/Public/Containers/ArrayView.h

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page