Skip to content

Commit 8da46ee

Browse files
authored
docs: improve doctests for complex number instances in math/base/special/cfloor
PR-URL: #9766 Ref: #8641 Reviewed-by: Philipp Burckhardt <pburckhardt@outlook.com> Signed-off-by: Vishal Gaikwad <154438441+ivishal-g@users.noreply.github.com>
1 parent 16e4fd3 commit 8da46ee

File tree

6 files changed

+16
-123
lines changed

6 files changed

+16
-123
lines changed

lib/node_modules/@stdlib/math/base/special/cfloor/README.md

Lines changed: 4 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -36,44 +36,19 @@ Rounds a double-precision complex floating-point number toward negative infinity
3636

3737
```javascript
3838
var Complex128 = require( '@stdlib/complex/float64/ctor' );
39-
var real = require( '@stdlib/complex/float64/real' );
40-
var imag = require( '@stdlib/complex/float64/imag' );
4139

4240
var v = cfloor( new Complex128( -4.2, 5.5 ) );
43-
// returns <Complex128>
44-
45-
var re = real( v );
46-
// returns -5.0
47-
48-
var im = imag( v );
49-
// returns 5.0
41+
// returns <Complex128>[ -5.0, 5.0 ]
5042

5143
v = cfloor( new Complex128( 9.99999, 0.1 ) );
52-
// returns <Complex128>
53-
54-
re = real( v );
55-
// returns 9.0
56-
57-
im = imag( v );
58-
// returns 0.0
44+
// returns <Complex128>[ 9.0, 0.0 ]
5945

6046
v = cfloor( new Complex128( 0.0, 0.0 ) );
61-
// returns <Complex128>
62-
63-
re = real( v );
64-
// returns 0.0
65-
66-
im = imag( v );
67-
// returns 0.0
47+
// returns <Complex128>[ 0.0, 0.0 ]
6848

6949
v = cfloor( new Complex128( NaN, NaN ) );
70-
// returns <Complex128>
71-
72-
re = real( v );
73-
// returns NaN
50+
// returns <Complex128>[ NaN, NaN ]
7451

75-
im = imag( v );
76-
// returns NaN
7752
```
7853

7954
</section>

lib/node_modules/@stdlib/math/base/special/cfloor/docs/repl.txt

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,7 @@
1616
Examples
1717
--------
1818
> var v = {{alias}}( new {{alias:@stdlib/complex/float64/ctor}}( 5.5, 3.3 ) )
19-
<Complex128>
20-
> var re = {{alias:@stdlib/complex/float64/real}}( v )
21-
5.0
22-
> var im = {{alias:@stdlib/complex/float64/imag}}( v )
23-
3.0
19+
<Complex128>[ 5.0, 3.0 ]
2420

2521
See Also
2622
--------

lib/node_modules/@stdlib/math/base/special/cfloor/docs/types/index.d.ts

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -30,17 +30,9 @@ import { Complex128 } from '@stdlib/types/complex';
3030
*
3131
* @example
3232
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
33-
* var real = require( '@stdlib/complex/float64/real' );
34-
* var imag = require( '@stdlib/complex/float64/imag' );
3533
*
3634
* var v = cfloor( new Complex128( 5.5, 3.3 ) );
37-
* // returns <Complex128>
38-
*
39-
* var re = real( v );
40-
* // returns 5.0
41-
*
42-
* var im = imag( v );
43-
* // returns 3.0
35+
* // returns <Complex128>[ 5.0, 3.0 ]
4436
*/
4537
declare function cfloor( z: Complex128 ): Complex128;
4638

lib/node_modules/@stdlib/math/base/special/cfloor/lib/index.js

Lines changed: 4 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -25,63 +25,31 @@
2525
*
2626
* @example
2727
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
28-
* var real = require( '@stdlib/complex/float64/real' );
29-
* var imag = require( '@stdlib/complex/float64/imag' );
3028
* var cfloor = require( '@stdlib/math/base/special/cfloor' );
3129
*
3230
* var v = cfloor( new Complex128( -4.2, 5.5 ) );
33-
* // returns <Complex128>
34-
*
35-
* var re = real( v );
36-
* // returns -5.0
37-
*
38-
* var im = imag( v );
39-
* // returns 5.0
31+
* // returns <Complex128>[ -5.0, 5.0 ]
4032
*
4133
* @example
4234
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
43-
* var real = require( '@stdlib/complex/float64/real' );
44-
* var imag = require( '@stdlib/complex/float64/imag' );
4535
* var cfloor = require( '@stdlib/math/base/special/cfloor' );
4636
*
4737
* var v = cfloor( new Complex128( 9.99999, 0.1 ) );
48-
* // returns <Complex128>
49-
*
50-
* var re = real( v );
51-
* // returns 9.0
52-
*
53-
* var im = imag( v );
54-
* // returns 0.0
38+
* // returns <Complex128>[ 9.0, 0.0 ]
5539
*
5640
* @example
5741
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
58-
* var real = require( '@stdlib/complex/float64/real' );
59-
* var imag = require( '@stdlib/complex/float64/imag' );
6042
* var cfloor = require( '@stdlib/math/base/special/cfloor' );
6143
*
6244
* var v = cfloor( new Complex128( 0.0, 0.0 ) );
63-
* // returns <Complex128>
64-
*
65-
* var re = real( v );
66-
* // returns 0.0
67-
*
68-
* var im = imag( v );
69-
* // returns 0.0
45+
* // returns <Complex128>[ 0.0, 0.0 ]
7046
*
7147
* @example
7248
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
73-
* var real = require( '@stdlib/complex/float64/real' );
74-
* var imag = require( '@stdlib/complex/float64/imag' );
7549
* var cfloor = require( '@stdlib/math/base/special/cfloor' );
7650
*
7751
* var v = cfloor( new Complex128( NaN, NaN ) );
78-
* // returns <Complex128>
79-
*
80-
* var re = real( v );
81-
* // returns NaN
82-
*
83-
* var im = imag( v );
84-
* // returns NaN
52+
* // returns <Complex128>[ NaN, NaN ]
8553
*/
8654

8755
// MODULES //

lib/node_modules/@stdlib/math/base/special/cfloor/lib/main.js

Lines changed: 5 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -36,59 +36,28 @@ var imag = require( '@stdlib/complex/float64/imag' );
3636
*
3737
* @example
3838
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
39-
* var real = require( '@stdlib/complex/float64/real' );
40-
* var imag = require( '@stdlib/complex/float64/imag' );
4139
*
4240
* var v = cfloor( new Complex128( -4.2, 5.5 ) );
43-
* // returns <Complex128>
44-
*
45-
* var re = real( v );
46-
* // returns -5.0
47-
*
48-
* var im = imag( v );
49-
* // returns 5.0
41+
* // returns <Complex128>[ -5.0, 5.0 ]
5042
*
5143
* @example
5244
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
53-
* var real = require( '@stdlib/complex/float64/real' );
54-
* var imag = require( '@stdlib/complex/float64/imag' );
5545
*
5646
* var v = cfloor( new Complex128( 9.99999, 0.1 ) );
57-
* // returns <Complex128>
58-
*
59-
* var re = real( v );
60-
* // returns 9.0
61-
*
62-
* var im = imag( v );
63-
* // returns 0.0
47+
* // returns <Complex128>[ 9.0, 0.0 ]
6448
*
6549
* @example
6650
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
67-
* var real = require( '@stdlib/complex/float64/real' );
68-
* var imag = require( '@stdlib/complex/float64/imag' );
6951
*
7052
* var v = cfloor( new Complex128( 0.0, 0.0 ) );
71-
* // returns <Complex128>
72-
*
73-
* var re = real( v );
74-
* // returns 0.0
75-
*
76-
* var im = imag( v );
77-
* // returns 0.0
53+
* // returns <Complex128>[ 0.0, 0.0 ]
7854
*
7955
* @example
8056
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
81-
* var real = require( '@stdlib/complex/float64/real' );
82-
* var imag = require( '@stdlib/complex/float64/imag' );
8357
*
8458
* var v = cfloor( new Complex128( NaN, NaN ) );
85-
* // returns <Complex128>
86-
*
87-
* var re = real( v );
88-
* // returns NaN
89-
*
90-
* var im = imag( v );
91-
* // returns NaN
59+
* // returns <Complex128>[ NaN, NaN ]
60+
9261
*/
9362
function cfloor( z ) {
9463
return new Complex128( floor( real( z ) ), floor( imag( z ) ) );

lib/node_modules/@stdlib/math/base/special/cfloor/lib/native.js

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -35,17 +35,10 @@ var addon = require( './../src/addon.node' );
3535
*
3636
* @example
3737
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
38-
* var real = require( '@stdlib/complex/float64/real' );
39-
* var imag = require( '@stdlib/complex/float64/imag' );
4038
*
4139
* var v = cfloor( new Complex128( -1.5, 2.5 ) );
42-
* // returns <Complex128>
40+
* // returns <Complex128>[ -2.0, 2.0 ]
4341
*
44-
* var re = real( v );
45-
* // returns -2.0
46-
*
47-
* var im = imag( v );
48-
* // returns 2.0
4942
*/
5043
function cfloor( z ) {
5144
var v = addon( z );

0 commit comments

Comments
 (0)