diff --git a/lib/node_modules/@stdlib/number/float64/base/assert/is-almost-same-value/README.md b/lib/node_modules/@stdlib/number/float64/base/assert/is-almost-same-value/README.md index a7f64ae35aab..ef0fc086545c 100644 --- a/lib/node_modules/@stdlib/number/float64/base/assert/is-almost-same-value/README.md +++ b/lib/node_modules/@stdlib/number/float64/base/assert/is-almost-same-value/README.md @@ -117,6 +117,123 @@ console.log( bool ); + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/number/float64/base/assert/is_almost_same_value.h" +``` + +#### stdlib_base_float64_is_almost_same_value( a, b, maxULP ) + +Tests if two double-precision floating-point numbers `a` and `b` are approximately the same value within a specified number of ULPs (units in the last place). + +```c +#include + +bool v = stdlib_base_float64_is_almost_same_value( 1.0, 1.0 + 2.220446049250313e-16, 1 ); +// returns true + +v = stdlib_base_float64_is_almost_same_value( 0.0, -0.0, 0 ); +// returns false +``` + +The function accepts the following arguments: + +- **a**: `[in] double` first input value. +- **b**: `[in] double` second input value. +- **maxULP**: `[in] int32_t` maximum allowed ULP difference. + +```c +bool stdlib_base_float64_is_almost_same_value( const double a, const double b, const int32_t maxULP ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/number/float64/base/assert/is_almost_same_value.h" +#include +#include +#include + +int main( void ) { + const double a[] = { + 5.0, + -2.0, + 0.0, + 0.0/0.0, + 1.0, + 1.0 + 2.220446049250313e-16 + }; + const double b[] = { + 5.0, + 2.0, + -0.0, + 0.0/0.0, + 1.0 + 2.220446049250313e-16, + 1.0 + }; + const int32_t maxULP[] = { + 0, + 1, + 0, + 1, + 1, + 0 + }; + + bool v; + int i; + for ( i = 0; i < 6; i++ ) { + v = stdlib_base_float64_is_almost_same_value( a[ i ], b[ i ], maxULP[ i ] ); + printf( "Almost same value? %s\n", ( v ) ? "True" : "False" ); + } +} +``` + +
+ + + +
+ + +