Skip to content

Commit a39fad8

Browse files
authored
docs: update examples for complex/float64/base/neg
PR-URL: #7270 Reviewed-by: Athan Reines <[email protected]>
1 parent 22106cb commit a39fad8

File tree

5 files changed

+15
-143
lines changed

5 files changed

+15
-143
lines changed

lib/node_modules/@stdlib/complex/float64/base/neg/README.md

Lines changed: 3 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -46,41 +46,21 @@ Negates a double-precision complex floating-point number.
4646

4747
```javascript
4848
var Complex128 = require( '@stdlib/complex/float64/ctor' );
49-
var real = require( '@stdlib/complex/float64/real' );
50-
var imag = require( '@stdlib/complex/float64/imag' );
5149

5250
var z = new Complex128( -4.2, 5.5 );
5351

5452
var out = cneg( z );
55-
// returns <Complex128>
56-
57-
var re = real( out );
58-
// returns 4.2
59-
60-
var im = imag( out );
61-
// returns -5.5
53+
// returns <Complex128>[ 4.2, -5.5 ]
6254

6355
z = new Complex128( 0.0, 0.0 );
6456

6557
out = cneg( z );
66-
// returns <Complex128>
67-
68-
re = real( out );
69-
// returns -0.0
70-
71-
im = imag( out );
72-
// returns -0.0
58+
// returns <Complex128>[ -0.0, -0.0 ]
7359

7460
z = new Complex128( NaN, NaN );
7561

7662
out = cneg( z );
77-
// returns <Complex128>
78-
79-
re = real( out );
80-
// returns NaN
81-
82-
im = imag( out );
83-
// returns NaN
63+
// returns <Complex128>[ NaN, NaN ]
8464
```
8565

8666
</section>

lib/node_modules/@stdlib/complex/float64/base/neg/docs/types/index.d.ts

Lines changed: 3 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -30,54 +30,27 @@ 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 z1 = new Complex128( -4.2, 5.5 );
37-
* // returns <Complex128>
3835
*
3936
* var out = cneg( z1 );
40-
* // returns <Complex128>
41-
*
42-
* var re = real( out );
43-
* // returns 4.2
44-
*
45-
* var im = imag( out );
46-
* // returns -5.5
37+
* // returns <Complex128>[ 4.2, -5.5 ]
4738
*
4839
* @example
4940
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
50-
* var real = require( '@stdlib/complex/float64/real' );
51-
* var imag = require( '@stdlib/complex/float64/imag' );
5241
*
5342
* var z2 = new Complex128( 0.0, 0.0 );
54-
* // returns <Complex128>
5543
*
5644
* var out = cneg( z2 );
57-
* // returns <Complex128>
58-
*
59-
* var re = real( out );
60-
* // returns -0.0
61-
*
62-
* var im = imag( out );
63-
* // returns -0.0
45+
* // returns <Complex128>[ -0.0, -0.0 ]
6446
*
6547
* @example
6648
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
67-
* var real = require( '@stdlib/complex/float64/real' );
68-
* var imag = require( '@stdlib/complex/float64/imag' );
6949
*
7050
* var z3 = new Complex128( NaN, NaN );
71-
* // returns <Complex128>
7251
*
7352
* var out = cneg( z3 );
74-
* // returns <Complex128>
75-
*
76-
* var re = real( out );
77-
* // returns NaN
78-
*
79-
* var im = imag( out );
80-
* // returns NaN
53+
* // returns <Complex128>[ NaN, NaN ]
8154
*/
8255
declare function cneg( z: Complex128 ): Complex128;
8356

lib/node_modules/@stdlib/complex/float64/base/neg/lib/index.js

Lines changed: 3 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -25,57 +25,30 @@
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 cneg = require( '@stdlib/complex/float64/base/neg' );
3129
*
3230
* var z = new Complex128( -4.2, 5.5 );
33-
* // returns <Complex128>
3431
*
3532
* var out = cneg( z );
36-
* // returns <Complex128>
37-
*
38-
* var re = real( out );
39-
* // returns 4.2
40-
*
41-
* var im = imag( out );
42-
* // returns -5.5
33+
* // returns <Complex128>[ 4.2, -5.5 ]
4334
*
4435
* @example
4536
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
46-
* var real = require( '@stdlib/complex/float64/real' );
47-
* var imag = require( '@stdlib/complex/float64/imag' );
4837
* var cneg = require( '@stdlib/complex/float64/base/neg' );
4938
*
5039
* var z = new Complex128( 0.0, 0.0 );
51-
* // returns <Complex128>
5240
*
5341
* var out = cneg( z );
54-
* // returns <Complex128>
55-
*
56-
* var re = real( out );
57-
* // returns -0.0
58-
*
59-
* var im = imag( out );
60-
* // returns -0.0
42+
* // returns <Complex128>[ -0.0, -0.0 ]
6143
*
6244
* @example
6345
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
64-
* var real = require( '@stdlib/complex/float64/real' );
65-
* var imag = require( '@stdlib/complex/float64/imag' );
6646
* var cneg = require( '@stdlib/complex/float64/base/neg' );
6747
*
6848
* var z = new Complex128( NaN, NaN );
69-
* // returns <Complex128>
7049
*
7150
* var out = cneg( z );
72-
* // returns <Complex128>
73-
*
74-
* var re = real( out );
75-
* // returns NaN
76-
*
77-
* var im = imag( out );
78-
* // returns NaN
51+
* // returns <Complex128>[ NaN, NaN ]
7952
*/
8053

8154
// MODULES //

lib/node_modules/@stdlib/complex/float64/base/neg/lib/main.js

Lines changed: 3 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -35,54 +35,27 @@ var Complex128 = require( '@stdlib/complex/float64/ctor' );
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 z = new Complex128( -4.2, 5.5 );
42-
* // returns <Complex128>
4340
*
4441
* var out = cneg( z );
45-
* // returns <Complex128>
46-
*
47-
* var re = real( out );
48-
* // returns 4.2
49-
*
50-
* var im = imag( out );
51-
* // returns -5.5
42+
* // returns <Complex128>[ 4.2, -5.5 ]
5243
*
5344
* @example
5445
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
55-
* var real = require( '@stdlib/complex/float64/real' );
56-
* var imag = require( '@stdlib/complex/float64/imag' );
5746
*
5847
* var z = new Complex128( 0.0, 0.0 );
59-
* // returns <Complex128>
6048
*
6149
* var out = cneg( z );
62-
* // returns <Complex128>
63-
*
64-
* var re = real( out );
65-
* // returns -0.0
66-
*
67-
* var im = imag( out );
68-
* // returns -0.0
50+
* // returns <Complex128>[ -0.0, -0.0 ]
6951
*
7052
* @example
7153
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
72-
* var real = require( '@stdlib/complex/float64/real' );
73-
* var imag = require( '@stdlib/complex/float64/imag' );
7454
*
7555
* var z = new Complex128( NaN, NaN );
76-
* // returns <Complex128>
7756
*
7857
* var out = cneg( z );
79-
* // returns <Complex128>
80-
*
81-
* var re = real( out );
82-
* // returns NaN
83-
*
84-
* var im = imag( out );
85-
* // returns NaN
58+
* // returns <Complex128>[ NaN, NaN ]
8659
*/
8760
function cneg( z ) {
8861
return new Complex128( -real( z ), -imag( z ) );

lib/node_modules/@stdlib/complex/float64/base/neg/lib/native.js

Lines changed: 3 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -35,54 +35,27 @@ 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 z = new Complex128( -4.2, 5.5 );
42-
* // returns <Complex128>
4340
*
4441
* var out = cneg( z );
45-
* // returns <Complex128>
46-
*
47-
* var re = real( out );
48-
* // returns 4.2
49-
*
50-
* var im = imag( out );
51-
* // returns -5.5
42+
* // returns <Complex128>[ 4.2, -5.5 ]
5243
*
5344
* @example
5445
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
55-
* var real = require( '@stdlib/complex/float64/real' );
56-
* var imag = require( '@stdlib/complex/float64/imag' );
5746
*
5847
* var z = new Complex128( 0.0, 0.0 );
59-
* // returns <Complex128>
6048
*
6149
* var out = cneg( z );
62-
* // returns <Complex128>
63-
*
64-
* var re = real( out );
65-
* // returns -0.0
66-
*
67-
* var im = imag( out );
68-
* // returns -0.0
50+
* // returns <Complex128>[ -0.0, -0.0 ]
6951
*
7052
* @example
7153
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
72-
* var real = require( '@stdlib/complex/float64/real' );
73-
* var imag = require( '@stdlib/complex/float64/imag' );
7454
*
7555
* var z = new Complex128( NaN, NaN );
76-
* // returns <Complex128>
7756
*
7857
* var out = cneg( z );
79-
* // returns <Complex128>
80-
*
81-
* var re = real( out );
82-
* // returns NaN
83-
*
84-
* var im = imag( out );
85-
* // returns NaN
58+
* // returns <Complex128>[ NaN, NaN ]
8659
*/
8760
function cneg( z ) {
8861
var v = addon( z );

0 commit comments

Comments
 (0)