Skip to content

Commit 91765b1

Browse files
authored
docs: update examples for complex/float64/base/identity
PR-URL: #7264 Reviewed-by: Athan Reines <kgryte@gmail.com>
1 parent 73c0e28 commit 91765b1

File tree

5 files changed

+5
-45
lines changed

5 files changed

+5
-45
lines changed

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

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -59,17 +59,9 @@ Evaluates the [identity function][identity-function] for a double-precision [com
5959

6060
```javascript
6161
var Complex128 = require( '@stdlib/complex/float64/ctor' );
62-
var real = require( '@stdlib/complex/float64/real' );
63-
var imag = require( '@stdlib/complex/float64/imag' );
6462

6563
var v = cidentity( new Complex128( -1.0, 2.0 ) );
66-
// returns <Complex128>
67-
68-
var re = real( v );
69-
// returns -1.0
70-
71-
var im = imag( v );
72-
// returns 2.0
64+
// returns <Complex128>[ -1.0, 2.0 ]
7365
```
7466

7567
</section>

lib/node_modules/@stdlib/complex/float64/base/identity/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 = cidentity( new Complex128( -1.0, 2.0 ) );
37-
* // returns <Complex128>
38-
*
39-
* var re = real( v );
40-
* // returns -1.0
41-
*
42-
* var im = imag( v );
43-
* // returns 2.0
35+
* // returns <Complex128>[ -1.0, 2.0 ]
4436
*/
4537
declare function cidentity( z: Complex128 ): Complex128;
4638

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

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -25,18 +25,10 @@
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 cidentity = require( '@stdlib/complex/float64/base/identity' );
3129
*
3230
* var v = cidentity( new Complex128( -1.0, 2.0 ) );
33-
* // returns <Complex128>
34-
*
35-
* var re = real( v );
36-
* // returns -1.0
37-
*
38-
* var im = imag( v );
39-
* // returns 2.0
31+
* // returns <Complex128>[ -1.0, 2.0 ]
4032
*/
4133

4234
// MODULES //

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

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -28,17 +28,9 @@
2828
*
2929
* @example
3030
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
31-
* var real = require( '@stdlib/complex/float64/real' );
32-
* var imag = require( '@stdlib/complex/float64/imag' );
3331
*
3432
* var v = cidentity( new Complex128( -1.0, 2.0 ) );
35-
* // returns <Complex128>
36-
*
37-
* var re = real( v );
38-
* // returns -1.0
39-
*
40-
* var im = imag( v );
41-
* // returns 2.0
33+
* // returns <Complex128>[ -1.0, 2.0 ]
4234
*/
4335
function cidentity( z ) {
4436
return z;

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

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -35,17 +35,9 @@ 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 = cidentity( new Complex128( -1.0, 2.0 ) );
42-
* // returns <Complex128>
43-
*
44-
* var re = real( v );
45-
* // returns -1.0
46-
*
47-
* var im = imag( v );
48-
* // returns 2.0
40+
* // returns <Complex128>[ -1.0, 2.0 ]
4941
*/
5042
function cidentity( z ) {
5143
var v = addon( z );

0 commit comments

Comments
 (0)