Skip to content

FBoxSpaceDimension

struct FBoxSpaceDimension

A struct representing a dimension of a box(continuous) space of possible observations or actions.

Dependencies: FBoxSpaceDimension

Public Interface

Constructors:

FBoxSpaceDimension

FBoxSpaceDimension()

Construct a BoxSpaceDimension with default values.

Source: Schola/Source/Schola/Public/Common/Spaces/BoxSpaceDimension.h (line 26, column 1)

Implementation: Schola/Source/Schola/Private/Common/Spaces/BoxSpaceDimension.cpp (lines 6-8)

FBoxSpaceDimension

FBoxSpaceDimension(float Low, float High)

Construct a BoxSpaceDimension with the given bounds.

Parameters:

  • Low (float) – [in] The lower bound
  • High (float) – [in] The upper bound

Source: Schola/Source/Schola/Public/Common/Spaces/BoxSpaceDimension.h (line 33, column 1)

Implementation: Schola/Source/Schola/Private/Common/Spaces/BoxSpaceDimension.cpp (lines 10-13)

Public Functions:

FillProtobuf

void FillProtobuf(Schola::BoxSpace::BoxSpaceDimension *Dimension) const const

Parameters:

NameTypeDefault
DimensionSchola::BoxSpace::BoxSpaceDimension *“

Attributes: const

Source: Schola/Source/Schola/Public/Common/Spaces/BoxSpaceDimension.h (line 35, column 6)

Implementation: Schola/Source/Schola/Private/Common/Spaces/BoxSpaceDimension.cpp (lines 15-19)

RescaleValue

float RescaleValue(float Value) const const

Rescale a normalized value to be within this space.

Returns: The rescaled value

Parameters:

  • Value (float) – [in] The value to rescale

Returns: float

Attributes: const

Source: Schola/Source/Schola/Public/Common/Spaces/BoxSpaceDimension.h (line 54, column 7)

Implementation: Schola/Source/Schola/Private/Common/Spaces/BoxSpaceDimension.cpp (lines 22-25)

RescaleValue

float RescaleValue(float Value, float OldHigh, float OldLow) const const

Rescale from an another box space dimension to be within this space.

Returns: The rescaled value

Parameters:

  • Value (float) – [in] The value to rescale
  • OldHigh (float) – [in] The upper bound of the input space
  • OldLow (float) – [in] The lower bound of the input space

Returns: float

Attributes: const

Source: Schola/Source/Schola/Public/Common/Spaces/BoxSpaceDimension.h (line 63, column 7)

Implementation: Schola/Source/Schola/Private/Common/Spaces/BoxSpaceDimension.cpp (lines 33-40)

NormalizeValue

float NormalizeValue(float Value) const const

Normalize a value from this space to be in the range [0, 1].

Returns: The normalized value

Parameters:

  • Value (float) – [in] The value to normalize

Returns: float

Attributes: const

Source: Schola/Source/Schola/Public/Common/Spaces/BoxSpaceDimension.h (line 70, column 7)

Implementation: Schola/Source/Schola/Private/Common/Spaces/BoxSpaceDimension.cpp (lines 27-31)

operator==

bool operator==(const FBoxSpaceDimension &Other) const const

Check if two BoxSpaces are equal.

Returns: True if the BoxSpaces are equal

Parameters:

  • Other (const FBoxSpaceDimension &) – [in] The BoxSpace to compare to

Returns: bool

Attributes: const

Source: Schola/Source/Schola/Public/Common/Spaces/BoxSpaceDimension.h (line 77, column 6)

Implementation: Schola/Source/Schola/Private/Common/Spaces/BoxSpaceDimension.cpp (lines 42-45)

ZeroOneUnitDimension

inline static FBoxSpaceDimension ZeroOneUnitDimension()

Get a unit sized BoxSpaceDimension centered at 0.5.

Returns: A BoxSpaceDimension with bounds [0, 1]

Returns: FBoxSpaceDimension

Attributes: static, inline

Source: Schola/Source/Schola/Public/Common/Spaces/BoxSpaceDimension.h (line 41, column 34)

CenteredUnitDimension

inline static FBoxSpaceDimension CenteredUnitDimension()

Get a unit sized BoxSpaceDimension centered at 0.

Returns: A BoxSpaceDimension with bounds [-0.5, 0.5]

Returns: FBoxSpaceDimension

Attributes: static, inline

Source: Schola/Source/Schola/Public/Common/Spaces/BoxSpaceDimension.h (line 47, column 34)

Public Members:

float High

float High = = 1.0

The upper bound on this dimension.

Source: Schola/Source/Schola/Public/Common/Spaces/BoxSpaceDimension.h (line 17, column 7)

float Low

float Low = = -1.0

The lower bound on this dimension.

Source: Schola/Source/Schola/Public/Common/Spaces/BoxSpaceDimension.h (line 21, column 7)

Used By

This type is used by:

Source: Schola/Source/Schola/Public/Common/Spaces/BoxSpaceDimension.h (line 11, column 1)