Skip to content

Commit 949dde6

Browse files
authored
docs: move imports
Signed-off-by: Athan <[email protected]>
1 parent 8133098 commit 949dde6

File tree

1 file changed

+2
-15
lines changed
  • lib/node_modules/@stdlib/assert/is-almost-equal

1 file changed

+2
-15
lines changed

lib/node_modules/@stdlib/assert/is-almost-equal/README.md

Lines changed: 2 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -50,13 +50,14 @@ bool = isAlmostEqual( {}, {}, 1 );
5050
The function returns `false` if either input value is `NaN` or, in the case of [complex numbers][@stdlib/complex], if either the real or imaginary component is `NaN`.
5151

5252
```javascript
53+
var Complex128 = require( '@stdlib/complex/float64/ctor' );
54+
5355
var bool = isAlmostEqual( NaN, 1.0, 1 );
5456
// returns false
5557

5658
bool = isAlmostEqual( NaN, NaN, 1 );
5759
// returns false
5860

59-
var Complex128 = require( '@stdlib/complex/float64/ctor' );
6061
var z1 = new Complex128( NaN, 3.0 );
6162
var z2 = new Complex128( 1.0, 3.0 );
6263

@@ -70,20 +71,6 @@ bool = isAlmostEqual( z1, z2, 1 );
7071
// returns false
7172
```
7273

73-
The function does not distinguish between `-0` and `+0`, treating them as equal.
74-
75-
```javascript
76-
var bool = isAlmostEqual( 0.0, -0.0, 0 );
77-
// returns true
78-
79-
var Complex128 = require( '@stdlib/complex/float64/ctor' );
80-
var z1 = new Complex128( 0.0, 0.0 );
81-
var z2 = new Complex128( -0.0, -0.0 );
82-
83-
bool = isAlmostEqual( z1, z2, 0 );
84-
// returns true
85-
```
86-
8774
</section>
8875

8976
<!-- /.usage -->

0 commit comments

Comments
 (0)