Skip to content

Commit db85f69

Browse files
aryan7071kgryte
andauthored
docs: improve doctests for complex number instances in array/base/at
PR-URL: #8654 Ref: #8641 Co-authored-by: Athan Reines <kgryte@gmail.com> Reviewed-by: Athan Reines <kgryte@gmail.com>
1 parent 767edc7 commit db85f69

File tree

1 file changed

+7
-23
lines changed
  • lib/node_modules/@stdlib/array/base/at/docs/types

1 file changed

+7
-23
lines changed

lib/node_modules/@stdlib/array/base/at/docs/types/index.d.ts

Lines changed: 7 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -32,25 +32,17 @@ import { Collection, AccessorArrayLike, Complex128Array, Complex64Array } from '
3232
*
3333
* @example
3434
* var Complex128Array = require( '@stdlib/array/complex128' );
35-
* var real = require( '@stdlib/complex/float64/real' );
36-
* var imag = require( '@stdlib/complex/float64/imag' );
3735
*
3836
* var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
3937
*
4038
* var v = at( x, 0 );
41-
* // returns <Complex128>
39+
* // returns <Complex128>[ 1.0, 2.0 ]
4240
*
4341
* v = at( x, 1 );
44-
* // returns <Complex128>
42+
* // returns <Complex128>[ 3.0, 4.0 ]
4543
*
4644
* v = at( x, -2 );
47-
* // returns <Complex128>
48-
*
49-
* var re = real( v );
50-
* // returns 5.0
51-
*
52-
* var im = imag( v );
53-
* // returns 6.0
45+
* // returns <Complex128>[ 5.0, 6.0 ]
5446
*/
5547
declare function at( x: Complex128Array, index: number ): Complex128 | void;
5648

@@ -62,26 +54,18 @@ declare function at( x: Complex128Array, index: number ): Complex128 | void;
6254
* @returns array element
6355
*
6456
* @example
65-
* var Complex128Array = require( '@stdlib/array/complex64' );
66-
* var realf = require( '@stdlib/complex/float32/real' );
67-
* var imagf = require( '@stdlib/complex/float32/imag' );
57+
* var Complex64Array = require( '@stdlib/array/complex64' );
6858
*
6959
* var x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
7060
*
7161
* var v = at( x, 0 );
72-
* // returns <Complex64>
62+
* // returns <Complex64>[ 1.0, 2.0 ]
7363
*
7464
* v = at( x, 1 );
75-
* // returns <Complex64>
65+
* // returns <Complex64>[ 3.0, 4.0 ]
7666
*
7767
* v = at( x, -2 );
78-
* // returns <Complex64>
79-
*
80-
* var re = realf( v );
81-
* // returns 5.0
82-
*
83-
* var im = imagf( v );
84-
* // returns 6.0
68+
* // returns <Complex64>[ 5.0, 6.0 ]
8569
*/
8670
declare function at( x: Complex64Array, index: number ): Complex64 | void;
8771

0 commit comments

Comments
 (0)