Navigation
API > API/Runtime > API/Runtime/Core > API/Runtime/Core/FMath
Overloads
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static bool IsNearlyEqualByULP
(
float A, |
Check if two floating point numbers are nearly equal to within specific number of units of last place (ULP). | Math/UnrealMathUtility.h | |
static bool IsNearlyEqualByULP
(
double A, |
Check if two floating point numbers are nearly equal to within specific number of units of last place (ULP). | Math/UnrealMathUtility.h |
IsNearlyEqualByULP(float, float, int32)
Description
Check if two floating point numbers are nearly equal to within specific number of units of last place (ULP). A single ULP difference between two floating point numbers means that they have an adjacent representation and that no other floating point number can be constructed to fit between them. This enables making consistent comparisons based on representational distance between floating point numbers, regardless of their magnitude.
Use when the two numbers vary greatly in range. Otherwise, if absolute tolerance is required, use IsNearlyEqual instead.
Note: Since IEEE 754 floating point operations are guaranteed to be exact to 0.5 ULP, a value of 4 ought to be sufficient for all but the most complex float operations.
| Name | IsNearlyEqualByULP |
| Type | function |
| Header File | /Engine/Source/Runtime/Core/Public/Math/UnrealMathUtility.h |
| Include Path | #include "Math/UnrealMathUtility.h" |
static bool IsNearlyEqualByULP
(
float A,
float B,
int32 MaxUlps
)
true if the two values are nearly equal.
Parameters
| Name | Remarks |
|---|---|
| A | First number to compare |
| B | Second number to compare |
| MaxUlps | The maximum ULP distance by which neighboring floating point numbers are allowed to differ. |
IsNearlyEqualByULP(double, double, int32)
Description
Check if two floating point numbers are nearly equal to within specific number of units of last place (ULP). A single ULP difference between two floating point numbers means that they have an adjacent representation and that no other floating point number can be constructed to fit between them. This enables making consistent comparisons based on representational distance between floating point numbers, regardless of their magnitude.
Note: Since IEEE 754 floating point operations are guaranteed to be exact to 0.5 ULP, a value of 4 ought to be sufficient for all but the most complex float operations.
| Name | IsNearlyEqualByULP |
| Type | function |
| Header File | /Engine/Source/Runtime/Core/Public/Math/UnrealMathUtility.h |
| Include Path | #include "Math/UnrealMathUtility.h" |
static bool IsNearlyEqualByULP
(
double A,
double B,
int32 MaxUlps
)
true if the two values are nearly equal.
Parameters
| Name | Remarks |
|---|---|
| A | First number to compare |
| B | Second number to compare |
| MaxUlps | The maximum ULP distance by which neighboring floating point numbers are allowed to differ. |