Skip to content

Commit 4d41d28

Browse files
authored
docs: update examples for complex/float64/base/add
PR-URL: #7253 Reviewed-by: Athan Reines <[email protected]>
1 parent 7457723 commit 4d41d28

File tree

5 files changed

+6
-59
lines changed

5 files changed

+6
-59
lines changed

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

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -42,19 +42,11 @@ Adds two double-precision complex floating-point numbers.
4242

4343
```javascript
4444
var Complex128 = require( '@stdlib/complex/float64/ctor' );
45-
var real = require( '@stdlib/complex/float64/real' );
46-
var imag = require( '@stdlib/complex/float64/imag' );
4745

4846
var z = new Complex128( -1.5, 2.5 );
4947

5048
var v = add( z, z );
51-
// returns <Complex128>
52-
53-
var re = real( v );
54-
// returns -3.0
55-
56-
var im = imag( v );
57-
// returns 5.0
49+
// returns <Complex128>[ -3.0, 5.0 ]
5850
```
5951

6052
#### add.assign( re1, im1, re2, im2, out, strideOut, offsetOut )

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

Lines changed: 2 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -36,20 +36,11 @@ interface Add {
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 z = new Complex128( 5.0, 3.0 );
43-
* // returns <Complex128>
4441
*
4542
* var out = add( z, z );
46-
* // returns <Complex128>
47-
*
48-
* var re = real( out );
49-
* // returns 10.0
50-
*
51-
* var im = imag( out );
52-
* // returns 6.0
43+
* // returns <Complex128>[ 10.0, 6.0 ]
5344
*/
5445
( z1: Complex128, z2: Complex128 ): Complex128;
5546

@@ -112,20 +103,11 @@ interface Add {
112103
*
113104
* @example
114105
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
115-
* var real = require( '@stdlib/complex/float64/real' );
116-
* var imag = require( '@stdlib/complex/float64/imag' );
117106
*
118107
* var z = new Complex128( 5.0, 3.0 );
119-
* // returns <Complex128>
120108
*
121109
* var out = add( z, z );
122-
* // returns <Complex128>
123-
*
124-
* var re = real( out );
125-
* // returns 10.0
126-
*
127-
* var im = imag( out );
128-
* // returns 6.0
110+
* // returns <Complex128>[ 10.0, 6.0 ]
129111
*
130112
* @example
131113
* var Float64Array = require( '@stdlib/array/float64' );

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

Lines changed: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -25,21 +25,12 @@
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 cadd = require( '@stdlib/complex/float64/base/add' );
3129
*
3230
* var z = new Complex128( 5.0, 3.0 );
33-
* // returns <Complex128>
3431
*
3532
* var out = cadd( z, z );
36-
* // returns <Complex128>
37-
*
38-
* var re = real( out );
39-
* // returns 10.0
40-
*
41-
* var im = imag( out );
42-
* // returns 6.0
33+
* // returns <Complex128>[ 10.0, 6.0 ]
4334
*/
4435

4536
// MODULES //

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

Lines changed: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -36,20 +36,11 @@ 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 z = new Complex128( 5.0, 3.0 );
43-
* // returns <Complex128>
4441
*
4542
* var out = cadd( z, z );
46-
* // returns <Complex128>
47-
*
48-
* var re = real( out );
49-
* // returns 10.0
50-
*
51-
* var im = imag( out );
52-
* // returns 6.0
43+
* // returns <Complex128>[ 10.0, 6.0 ]
5344
*/
5445
function cadd( z1, z2 ) {
5546
var re = real( z1 ) + real( z2 );

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

Lines changed: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -36,20 +36,11 @@ var addon = require( './../src/addon.node' );
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 z = new Complex128( 5.0, 3.0 );
43-
* // returns <Complex128>
4441
*
4542
* var out = cadd( z, z );
46-
* // returns <Complex128>
47-
*
48-
* var re = real( out );
49-
* // returns 10.0
50-
*
51-
* var im = imag( out );
52-
* // returns 6.0
43+
* // returns <Complex128>[ 10.0, 6.0 ]
5344
*/
5445
function cadd( z1, z2 ) {
5546
var v = addon( z1, z2 );

0 commit comments

Comments
 (0)