1. Epic GamesDeveloper
  3. FGenericPlatformMath

FGenericPlatformMath

Generic implementation for most platforms

Unreal Engine C++ API Reference > Runtime > Core > GenericPlatform

Inheritance Hierarchy

References

   
Module Core
Header /Engine/Source/Runtime/Core/Public/GenericPlatform/GenericPlatformMath.h
Include #include "GenericPlatform/GenericPlatformMath.h"

Syntax

struct FGenericPlatformMath

Remarks

Generic implementation for most platforms

Functions

  Type Name Description
Public function Static constexpr T

Abs ( const T A
)

 Computes absolute value in a generic way
Public function double

Abs ( const double A
)

  
Public function float

Abs ( const float A
)

 Float specialization
Public function Static float

Acos ( float Value
)

  
Public function Static double

Acos ( double Value
)

  
Public function Static float

AsFloat ( uint32 U
)

 Performs a bit cast of the given unsigned int to float of the same bit width.
Public function Static double

AsFloat ( uint64 U
)

 Performs a bit cast of the given unsigned int to float of the same bit width.
Public function Static float

Asin ( float Value
)

  
Public function Static double

Asin ( double Value
)

  
Public function Static uint32

AsUInt ( float F
)

 Performs a bit cast of the given float to an unsigned int of the same bit width.
Public function Static uint64

AsUInt ( double F
)

 Performs a bit cast of the given double to an unsigned int of the same bit width.
Public function Static float

Atan ( float Value
)

  
Public function Static double

Atan ( double Value
)

  
Public function Static float

Atan2 ( float Y,
float X
)

  
Public function Static double

Atan2 ( double Y,
double X
)

  
Public function Static auto

Atan2 ( Arg1 X,
Arg2 Y
)

  
Public function Static constexpr uint32

CeilLogTwo ( uint32 Arg
)

 Returns smallest N such that (1<=Arg. Note: CeilLogTwo(0)=0
Public function Static constexpr uint64

CeilLogTwo64 ( uint64 Arg
)

  
Public function Static double

CeilToDouble ( double F
)

 Converts a double to the nearest greater or equal integer.
Public function Static double

CeilToFloat ( double F
)

  
Public function Static float

CeilToFloat ( float F
)

 Converts a float to the nearest greater or equal integer.
Public function Static int64

CeilToInt ( double F
)

  
Public function Static int32

CeilToInt ( float F
)

  
Public function Static int32

CeilToInt32 ( float F
)

 Converts a float to the nearest greater or equal integer.
Public function Static int32

CeilToInt32 ( double F
)

  
Public function Static int64

CeilToInt64 ( double F
)

  
Public function Static constexpr uint8

ConstExprCeilLogTwo ( SIZE_T Arg
)

 Returns the smallest N such that (1<=Arg.
Public function Static double

Cos ( double Value
)

  
Public function Static float

Cos ( float Value
)

  
Public function Static double

Cosh ( double Value
)

  
Public function Static float

Cosh ( float Value
)

  
Public function Static constexpr int32

CountBits ( uint64 Bits
)

  
Public function Static constexpr uint32

CountLeadingZeros ( uint32 Value
)

 Counts the number of leading zeros in the bit representation of the 32-bit value
Public function Static constexpr uint64

CountLeadingZeros64 ( uint64 Value
)

 Counts the number of leading zeros in the bit representation of the 64-bit value
Public function Static constexpr uint8

CountLeadingZeros8 ( uint8 Value
)

 Counts the number of leading zeros in the bit representation of the 8-bit value
Public function Static constexpr uint32

CountTrailingZeros ( uint32 Value
)

 Counts the number of trailing zeros in the bit representation of the value
Public function Static constexpr uint64

CountTrailingZeros64 ( uint64 Value
)

 Counts the number of trailing zeros in the bit representation of the value
Public function Static double

Exp ( double Value
)

  
Public function Static float

Exp ( float Value
)

 Returns e^Value.
Public function Static float

Exp2 ( float Value
)

 Returns 2^Value.
Public function Static double

Exp2 ( double Value
)

  
Public function Static constexpr float

FloatSelect ( float Comparand,
float ValueGEZero,
float ValueLTZero
)

 Returns value based on comparand.
Public function Static constexpr double

FloatSelect ( double Comparand,
double ValueGEZero,
double ValueLTZero
)

 Returns value based on comparand.
Public function Static constexpr uint32

FloorLog2 ( uint32 Value
)

 Computes the base 2 logarithm for an integer value.
Public function Static constexpr uint64

FloorLog2_64 ( uint64 Value
)

 Computes the base 2 logarithm for a 64-bit value.
Public function Static double

FloorToDouble ( double F
)

 Converts a double to a less or equal integer.
Public function Static float

FloorToFloat ( float F
)

 Converts a float to the nearest less or equal integer.
Public function Static double

FloorToFloat ( double F
)

  
Public function Static int32

FloorToInt ( float F
)

  
Public function Static int64

FloorToInt ( double F
)

  
Public function Static int32

FloorToInt32 ( float F
)

 Converts a float to a nearest less or equal integer.
Public function Static int32

FloorToInt32 ( double F
)

  
Public function Static int64

FloorToInt64 ( double F
)

  
Public function Static float

Fmod ( float X,
float Y
)

 Returns the floating-point remainder of X / Y Warning: Always returns remainder toward 0, not toward the smaller multiple of Y.
Public function Static double

Fmod ( double X,
double Y
)

 Returns the floating-point remainder of X / Y Warning: Always returns remainder toward 0, not toward the smaller multiple of Y.
Public function Static auto

Fmod ( Arg1 X,
Arg2 Y
)

  
Public function Static float

Frac ( float Value
)

 Returns the fractional part of a float.
Public function Static double

Frac ( double Value
)

  
Public function Static float

Fractional ( float Value
)

 Returns signed fractional part of a float.
Public function Static double

Fractional ( double Value
)

  
Public function Static float

FRand ()

 Returns a random float between 0 and 1, inclusive.
Public function Static int32 Returns the current seed for SRand().
Public function Static float

InvSqrt ( float F
)

 Computes a fully accurate inverse square root
Public function Static double

InvSqrt ( double F
)

  
Public function Static float

InvSqrtEst ( float F
)

 Computes a faster but less accurate inverse square root
Public function Static double

InvSqrtEst ( double F
)

  
Public function Static bool

IsFinite ( float A
)

 Return true if value is finite (not NaN and not Infinity).
Public function Static bool

IsFinite ( double A
)

  
Public function Static bool

IsNaN ( double A
)

  
Public function Static bool

IsNaN ( float A
)

 Return true if value is NaN (not a number).
Public function Static bool  
Public function Static bool  
Public function Static constexpr float

LoadHalf ( const uint16* Ptr
)

 Load half (F16) to float https://gist.github.com/rygorous/2156668
Public function Static double

Log2 ( double Value
)

 1.0 / Loge(2) = 1.442695040888963387
Public function Static float

Log2 ( float Value
)

 1.0 / Loge(2) = 1.4426950f
Public function Static float

Loge ( float Value
)

  
Public function Static double

Loge ( double Value
)

  
Public function Static auto

LogX ( Arg1 X,
Arg2 Y
)

  
Public function Static double

LogX ( double Base,
double Value
)

  
Public function Static float

LogX ( float Base,
float Value
)

  
Public function Static constexpr auto

Max ( Arg1 X,
Arg2 Y
)

 Allow mixing of signed integral types.
Public function VectorRegister4Double  
Public function VectorRegister4Float Returns the larger of the two values (operates on each component individually)
Public function Static T

Max ( const TArray< T >& Values,
int32* MaxIndex
)

 Max of Array
Public function Static auto

Max ( Arg1 X,
Arg2 Y
)

 Allow mixing of float types to promote to highest precision type.
Public function Static constexpr T

Max ( const T A,
const T B
)

 Returns higher value in a generic way
Public function Static auto

Min ( Arg1 X,
Arg2 Y
)

  
Public function Static constexpr T

Min ( const T A,
const T B
)

 Returns lower value in a generic way
Public function VectorRegister4Float Returns the smaller of the two values (operates on each component individually)
Public function Static constexpr auto

Min ( Arg1 X,
Arg2 Y
)

  
Public function Static T

Min ( const TArray< T >& Values,
int32* MinIndex
)

 Min of Array
Public function VectorRegister4Double  
Public function Static float

Modf ( const float InValue,
float* OutIntPart
)

 Breaks the given value into an integral and a fractional part.
Public function Static double

Modf ( const double InValue,
double* OutIntPart
)

 Breaks the given value into an integral and a fractional part.
Public function Static constexpr uint32

MortonCode2 ( uint32 x
)

 Spreads bits to every other.
Public function Static constexpr uint64

MortonCode2_64 ( uint64 x
)

  
Public function Static constexpr uint32

MortonCode3 ( uint32 x
)

 Spreads bits to every 3rd.
Public function Static float

Pow ( float A,
float B
)

  
Public function Static auto

Pow ( Arg1 X,
Arg2 Y
)

  
Public function Static double

Pow ( double A,
double B
)

  
Public function Static int32

Rand ()

 Returns a random integer between 0 and RAND_MAX, inclusive
Public function Static void

RandInit ( int32 Seed
)

 Seeds global random number functions Rand() and FRand()
Public function Static constexpr uint32

ReverseMortonCode2 ( uint32 x
)

 Reverses MortonCode2. Compacts every other bit to the right.
Public function Static constexpr uint64

ReverseMortonCode2_64 ( uint64 x
)

  
Public function Static constexpr uint32

ReverseMortonCode3 ( uint32 x
)

 Reverses MortonCode3. Compacts every 3rd bit to the right.
Public function Static double

RoundToDouble ( double F
)

 Converts a double to the nearest integer. Rounds up when the fraction is .5
Public function Static float

RoundToFloat ( float F
)

 Converts a float to the nearest integer. Rounds up when the fraction is .5
Public function Static double

RoundToFloat ( double F
)

  
Public function Static int32

RoundToInt ( float F
)

  
Public function Static int64

RoundToInt ( double F
)

  
Public function Static int32

RoundToInt32 ( float F
)

 Converts a float to the nearest integer. Rounds up when the fraction is .5
Public function Static int32

RoundToInt32 ( double F
)

  
Public function Static int64

RoundToInt64 ( double F
)

  
Public function Static int64 Converts a double to nearest int64 with ties rounding to nearest even May incur a performance penalty.
Public function Static constexpr uint32

RoundUpToPowerOfTwo ( uint32 Arg
)

  
Public function Static constexpr uint64

RoundUpToPowerOfTwo64 ( uint64 V
)

  
Public function Static constexpr T

Sign ( const T A
)

 Returns 1, 0, or -1 depending on relation of T to 0
Public function Static float

Sin ( float Value
)

  
Public function Static double

Sin ( double Value
)

  
Public function Static double

Sinh ( double Value
)

  
Public function Static float

Sinh ( float Value
)

  
Public function Static double

Sqrt ( double Value
)

  
Public function Static float

Sqrt ( float Value
)

  
Public function Static float

SRand ()

 Returns a seeded random float in the range [0,1), using the seed from SRandInit().
Public function Static void

SRandInit ( int32 Seed
)

 Seeds future calls to SRand()
Public function Static constexpr void

StoreHalf ( uint16* Ptr,
float Value
)

 Store float to half (F16) converts with RTNE = round to nearest even values too large for F16 are stored as +-Inf https://gist.github.com/rygorous/2156668 float_to_half_fast3_rtne
Public function Static float

Tan ( float Value
)

  
Public function Static double

Tan ( double Value
)

  
Public function Static double

Tanh ( double Value
)

  
Public function Static float

Tanh ( float Value
)

  
Public function Static double

TruncToDouble ( double F
)

 Converts a double to an integer value with truncation towards zero.
Public function Static double

TruncToFloat ( double F
)

  
Public function Static float

TruncToFloat ( float F
)

 Converts a float to an integer value with truncation towards zero.
Public function Static constexpr int32

TruncToInt ( float F
)

  
Public function Static constexpr int64

TruncToInt ( double F
)

  
Public function Static constexpr int32

TruncToInt32 ( double F
)

  
Public function Static constexpr int32

TruncToInt32 ( float F
)

 Converts a float to an integer with truncation towards zero.
Public function Static constexpr int64

TruncToInt64 ( double F
)

  
Public function Static constexpr void

VectorLoadHalf ( float*__restrict Dst,
const uint16*__restrict Src
)

  
Public function Static constexpr void

VectorStoreHalf ( uint16*__restrict Dst,
const float*__restrict Src
)

  
Public function Static constexpr void

WideVectorLoadHalf ( float*__restrict Dst,
const uint16*__restrict Src
)

  
Public function Static constexpr void

WideVectorStoreHalf ( uint16*__restrict Dst,
const float*__restrict Src
)

  

Deprecated Functions

  Type Name Description
Public function Static bool

IsNegative ( double A
)

 IsNegative has been deprecated in favor of IsNegativeOrNegativeZero or simply A < 0.
Public function Static bool

IsNegative ( float A
)

 IsNegative has been deprecated in favor of IsNegativeOrNegativeZero or simply A < 0.
Public function Static bool

IsNegativeDouble ( double A
)

 IsNegativeDouble has been deprecated in favor of IsNegativeOrNegativeZero or simply A < 0.
Public function Static bool

IsNegativeFloat ( float A
)

 IsNegativeFloat has been deprecated in favor of IsNegativeOrNegativeZero or simply A < 0.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page