File tree Expand file tree Collapse file tree 3 files changed +16
-6
lines changed
lib/node_modules/@stdlib/number/float64/base/assert/is-almost-equal-value Expand file tree Collapse file tree 3 files changed +16
-6
lines changed Original file line number Diff line number Diff line change 37
37
* var bool = isAlmostEqualValue( 1.0, 1.0+EPS, 1 );
38
38
* // returns true
39
39
*
40
- * var bool = isAlmostEqualValue( 1.0+EPS, 1.0, 1 );
40
+ * bool = isAlmostEqualValue( 1.0+EPS, 1.0, 1 );
41
41
* // returns true
42
42
*
43
43
* bool = isAlmostEqualValue( 1.0, 1.0+EPS+EPS, 1 );
Original file line number Diff line number Diff line change 24
24
* @module @stdlib /number/float64/base/assert/is-almost-equal-value
25
25
*
26
26
* @example
27
+ * var EPS = require( '@stdlib/constants/float64/eps' );
27
28
* var isAlmostEqualValue = require( '@stdlib/number/float64/base/assert/is-almost-equal-value' );
28
29
*
29
- * var bool = isAlmostEqualValue( 3.14, 3.14 );
30
+ * var bool = isAlmostEqualValue( 1.0, 1.0+EPS, 1 );
30
31
* // returns true
31
32
*
32
- * bool = isAlmostEqualValue( -0.0, -0.0 );
33
+ * bool = isAlmostEqualValue( 1.0+EPS, 1.0, 1 );
33
34
* // returns true
34
35
*
35
- * bool = isAlmostEqualValue( -0 .0, 0.0 );
36
+ * bool = isAlmostEqualValue( 1 .0, 1.0+EPS+EPS, 1 );
36
37
* // returns false
37
38
*
38
- * bool = isAlmostEqualValue( NaN, NaN );
39
+ * bool = isAlmostEqualValue( 1.0, 1.0+EPS, 0 );
40
+ * // returns false
41
+ *
42
+ * bool = isAlmostEqualValue( 0.0, -0.0, 0 );
39
43
* // returns true
44
+ *
45
+ * bool = isAlmostEqualValue( 1.0, NaN, 1 );
46
+ * // returns false
47
+ *
48
+ * bool = isAlmostEqualValue( NaN, NaN, 1 );
49
+ * // returns false
40
50
*/
41
51
42
52
// MODULES //
Original file line number Diff line number Diff line change @@ -44,7 +44,7 @@ var ulpdiff = require( '@stdlib/number/float64/base/ulp-difference' );
44
44
* var bool = isAlmostEqualValue( 1.0, 1.0+EPS, 1 );
45
45
* // returns true
46
46
*
47
- * var bool = isAlmostEqualValue( 1.0+EPS, 1.0, 1 );
47
+ * bool = isAlmostEqualValue( 1.0+EPS, 1.0, 1 );
48
48
* // returns true
49
49
*
50
50
* bool = isAlmostEqualValue( 1.0, 1.0+EPS+EPS, 1 );
You can’t perform that action at this time.
0 commit comments