Skip to content

Commit 93d2533

Browse files
authored
docs: update examples for complex/float32/base/sub
PR-URL: #7293 Reviewed-by: Athan Reines <[email protected]>
1 parent 2f0510e commit 93d2533

File tree

5 files changed

+5
-57
lines changed

5 files changed

+5
-57
lines changed

lib/node_modules/@stdlib/complex/float32/base/sub/README.md

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -42,20 +42,12 @@ Subtracts two single-precision complex floating-point numbers.
4242

4343
```javascript
4444
var Complex64 = require( '@stdlib/complex/float32/ctor' );
45-
var realf = require( '@stdlib/complex/float32/real' );
46-
var imagf = require( '@stdlib/complex/float32/imag' );
4745

4846
var z1 = new Complex64( 5.0, 3.0 );
4947
var z2 = new Complex64( -2.0, 1.0 );
5048

5149
var v = csubf( z1, z2 );
52-
// returns <Complex64>
53-
54-
var re = realf( v );
55-
// returns 7.0
56-
57-
var im = imagf( v );
58-
// returns 2.0
50+
// returns <Complex64>[ 7.0, 2.0 ]
5951
```
6052

6153
</section>

lib/node_modules/@stdlib/complex/float32/base/sub/docs/types/index.d.ts

Lines changed: 1 addition & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -31,23 +31,12 @@ import { Complex64 } from '@stdlib/types/complex';
3131
*
3232
* @example
3333
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
34-
* var realf = require( '@stdlib/complex/float32/real' );
35-
* var imagf = require( '@stdlib/complex/float32/imag' );
3634
*
3735
* var z1 = new Complex64( 5.0, 3.0 );
38-
* // returns <Complex64>
39-
*
4036
* var z2 = new Complex64( -2.0, 1.0 );
41-
* // returns <Complex64>
4237
*
4338
* var out = csubf( z1, z2 );
44-
* // returns <Complex64>
45-
*
46-
* var re = realf( out );
47-
* // returns 7.0
48-
*
49-
* var im = imagf( out );
50-
* // returns 2.0
39+
* // returns <Complex64>[ 7.0, 2.0 ]
5140
*/
5241
declare function csubf( z1: Complex64, z2: Complex64 ): Complex64;
5342

lib/node_modules/@stdlib/complex/float32/base/sub/lib/index.js

Lines changed: 1 addition & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -25,24 +25,13 @@
2525
*
2626
* @example
2727
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
28-
* var realf = require( '@stdlib/complex/float32/real' );
29-
* var imagf = require( '@stdlib/complex/float32/imag' );
3028
* var csubf = require( '@stdlib/complex/float32/base/sub' );
3129
*
3230
* var z1 = new Complex64( 5.0, 3.0 );
33-
* // returns <Complex64>
34-
*
3531
* var z2 = new Complex64( -2.0, 1.0 );
36-
* // returns <Complex64>
3732
*
3833
* var out = csubf( z1, z2 );
39-
* // returns <Complex64>
40-
*
41-
* var re = realf( out );
42-
* // returns 7.0
43-
*
44-
* var im = imagf( out );
45-
* // returns 2.0
34+
* // returns <Complex64>[ 7.0, 2.0 ]
4635
*/
4736

4837
// MODULES //

lib/node_modules/@stdlib/complex/float32/base/sub/lib/main.js

Lines changed: 1 addition & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -37,23 +37,12 @@ var imagf = require( '@stdlib/complex/float32/imag' );
3737
*
3838
* @example
3939
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
40-
* var realf = require( '@stdlib/complex/float32/real' );
41-
* var imagf = require( '@stdlib/complex/float32/imag' );
4240
*
4341
* var z1 = new Complex64( 5.0, 3.0 );
44-
* // returns <Complex64>
45-
*
4642
* var z2 = new Complex64( -2.0, 1.0 );
47-
* // returns <Complex64>
4843
*
4944
* var out = csubf( z1, z2 );
50-
* // returns <Complex64>
51-
*
52-
* var re = realf( out );
53-
* // returns 7.0
54-
*
55-
* var im = imagf( out );
56-
* // returns 2.0
45+
* // returns <Complex64>[ 7.0, 2.0 ]
5746
*/
5847
function csubf( z1, z2 ) {
5948
var re = f32( realf( z1 ) - realf( z2 ) );

lib/node_modules/@stdlib/complex/float32/base/sub/lib/native.js

Lines changed: 1 addition & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -36,23 +36,12 @@ var addon = require( './../src/addon.node' );
3636
*
3737
* @example
3838
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
39-
* var realf = require( '@stdlib/complex/float32/real' );
40-
* var imagf = require( '@stdlib/complex/float32/imag' );
4139
*
4240
* var z1 = new Complex64( 5.0, 3.0 );
43-
* // returns <Complex64>
44-
*
4541
* var z2 = new Complex64( -2.0, 1.0 );
46-
* // returns <Complex64>
4742
*
4843
* var out = csubf( z1, z2 );
49-
* // returns <Complex64>
50-
*
51-
* var re = realf( out );
52-
* // returns 7.0
53-
*
54-
* var im = imagf( out );
55-
* // returns 2.0
44+
* // returns <Complex64>[ 7.0, 2.0 ]
5645
*/
5746
function csubf( z1, z2 ) {
5847
var v = addon( z1, z2 );

0 commit comments

Comments
 (0)