Skip to content

Commit 6f4927c

Browse files
DivyanshuVortexkgryte
DivyanshuVortex
and
kgryte
authored
docs: improve doctests for complex number instances in blas/ext/base/zfill
PR-URL: stdlib-js#8648 Ref: stdlib-js#8641 Co-authored-by: Athan Reines <[email protected]> Reviewed-by: Athan Reines <[email protected]>
1 parent 412d1de commit 6f4927c

File tree

7 files changed

+32
-176
lines changed

7 files changed

+32
-176
lines changed

‎lib/node_modules/@stdlib/blas/ext/base/zfill/README.md‎

Lines changed: 9 additions & 73 deletions
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,6 @@ Fills a double-precision complex floating-point strided array `x` with a specifi
3838
var Float64Array = require( '@stdlib/array/float64' );
3939
var Complex128Array = require( '@stdlib/array/complex128' );
4040
var Complex128 = require( '@stdlib/complex/float64/ctor' );
41-
var real = require( '@stdlib/complex/float64/real' );
42-
var imag = require( '@stdlib/complex/float64/imag' );
4341

4442
var arr = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
4543
var x = new Complex128Array( arr );
@@ -49,13 +47,7 @@ var alpha = new Complex128( 10.0, 10.0 );
4947
zfill( x.length, alpha, x, 1 );
5048

5149
var y = x.get( 0 );
52-
// returns <Complex128>
53-
54-
var re = real( y );
55-
// returns 10.0
56-
57-
var im = imag( y );
58-
// returns 10.0
50+
// returns <Complex128>[ 10.0, 10.0 ]
5951
```
6052

6153
The function has the following parameters:
@@ -71,8 +63,6 @@ The `N` and stride parameters determine which elements in the strided array are
7163
var Float64Array = require( '@stdlib/array/float64' );
7264
var Complex128Array = require( '@stdlib/array/complex128' );
7365
var Complex128 = require( '@stdlib/complex/float64/ctor' );
74-
var real = require( '@stdlib/complex/float64/real' );
75-
var imag = require( '@stdlib/complex/float64/imag' );
7666

7767
var arr = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
7868
var x = new Complex128Array( arr );
@@ -82,22 +72,10 @@ var alpha = new Complex128( 10.0, 10.0 );
8272
zfill( 2, alpha, x, 2 );
8373

8474
var y = x.get( 0 );
85-
// returns <Complex128>
86-
87-
var re = real( y );
88-
// returns 10.0
89-
90-
var im = imag( y );
91-
// returns 10.0
75+
// returns <Complex128>[ 10.0, 10.0 ]
9276

9377
y = x.get( 1 );
94-
// returns <Complex128>
95-
96-
re = real( y );
97-
// returns 3.0
98-
99-
im = imag( y );
100-
// returns 4.0
78+
// returns <Complex128>[ 3.0, 4.0 ]
10179
```
10280

10381
Note that indexing is relative to the first index. To introduce an offset, use [`typed array`][mdn-typed-array] views.
@@ -106,8 +84,6 @@ Note that indexing is relative to the first index. To introduce an offset, use [
10684
var Float64Array = require( '@stdlib/array/float64' );
10785
var Complex128Array = require( '@stdlib/array/complex128' );
10886
var Complex128 = require( '@stdlib/complex/float64/ctor' );
109-
var real = require( '@stdlib/complex/float64/real' );
110-
var imag = require( '@stdlib/complex/float64/imag' );
11187

11288
// Create the underlying floating-point array:
11389
var arr = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
@@ -125,22 +101,10 @@ var alpha = new Complex128( 10.0, 10.0 );
125101
zfill( 2, alpha, x1, 2 );
126102

127103
var y = x0.get( 0 );
128-
// returns <Complex128>
129-
130-
var re = real( y );
131-
// returns 1.0
132-
133-
var im = imag( y );
134-
// returns 2.0
104+
// returns <Complex128>[ 1.0, 2.0 ]
135105

136106
y = x0.get( 1 );
137-
// returns <Complex128>
138-
139-
re = real( y );
140-
// returns 10.0
141-
142-
im = imag( y );
143-
// returns 10.0
107+
// returns <Complex128>[ 10.0, 10.0 ]
144108
```
145109

146110
#### zfill.ndarray( N, alpha, x, strideX, offsetX )
@@ -151,8 +115,6 @@ Fills a double-precision complex floating-point strided array `x` with a specifi
151115
var Float64Array = require( '@stdlib/array/float64' );
152116
var Complex128Array = require( '@stdlib/array/complex128' );
153117
var Complex128 = require( '@stdlib/complex/float64/ctor' );
154-
var real = require( '@stdlib/complex/float64/real' );
155-
var imag = require( '@stdlib/complex/float64/imag' );
156118

157119
var arr = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
158120
var x = new Complex128Array( arr );
@@ -162,13 +124,7 @@ var alpha = new Complex128( 10.0, 10.0 );
162124
zfill.ndarray( x.length, alpha, x, 1, 0 );
163125

164126
var y = x.get( 0 );
165-
// returns <Complex128>
166-
167-
var re = real( y );
168-
// returns 10.0
169-
170-
var im = imag( y );
171-
// returns 10.0
127+
// returns <Complex128>[ 10.0, 10.0 ]
172128
```
173129

174130
The function has the following additional parameters:
@@ -181,8 +137,6 @@ While [`typed array`][mdn-typed-array] views mandate a view offset based on the
181137
var Float64Array = require( '@stdlib/array/float64' );
182138
var Complex128Array = require( '@stdlib/array/complex128' );
183139
var Complex128 = require( '@stdlib/complex/float64/ctor' );
184-
var real = require( '@stdlib/complex/float64/real' );
185-
var imag = require( '@stdlib/complex/float64/imag' );
186140

187141
var arr = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
188142
var x = new Complex128Array( arr );
@@ -192,31 +146,13 @@ var alpha = new Complex128( 10.0, 10.0 );
192146
zfill.ndarray( 2, alpha, x, 1, x.length-2 );
193147

194148
var y = x.get( 0 );
195-
// returns <Complex128>
196-
197-
var re = real( y );
198-
// returns 1.0
199-
200-
var im = imag( y );
201-
// returns 2.0
149+
// returns <Complex128>[ 1.0, 2.0]
202150

203151
y = x.get( 1 );
204-
// returns <Complex128>
205-
206-
re = real( y );
207-
// returns 10.0
208-
209-
im = imag( y );
210-
// returns 10.0
152+
// returns <Complex128>[ 10.0, 10.0 ]
211153

212154
y = x.get( 2 );
213-
// returns <Complex128>
214-
215-
re = real( y );
216-
// returns 10.0
217-
218-
im = imag( y );
219-
// returns 10.0
155+
// returns <Complex128>[ 10.0, 10.0 ]
220156
```
221157

222158
</section>

‎lib/node_modules/@stdlib/blas/ext/base/zfill/docs/repl.txt‎

Lines changed: 16 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -36,42 +36,27 @@
3636
> var x = new {{alias:@stdlib/array/complex128}}( [ 1.0, 2.0, 3.0, 4.0 ] );
3737
> var alpha = new {{alias:@stdlib/complex/float64/ctor}}( 5.0, -5.0 );
3838
> {{alias}}( x.length, alpha, x, 1 );
39-
> var z = x.get( 0 );
40-
> var re = {{alias:@stdlib/complex/float64/real}}( z )
41-
5.0
42-
> var im = {{alias:@stdlib/complex/float64/imag}}( z )
43-
-5.0
39+
> var z = x.get( 0 )
40+
<Complex128>[ 5.0, -5.0 ]
4441

4542
// Using `N` and stride parameters:
4643
> x = new {{alias:@stdlib/array/complex128}}( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
4744
> alpha = new {{alias:@stdlib/complex/float64/ctor}}( 5.0, -5.0 );
4845
> {{alias}}( 2, alpha, x, 2 );
49-
> z = x.get( 0 );
50-
> re = {{alias:@stdlib/complex/float64/real}}( z )
51-
5.0
52-
> im = {{alias:@stdlib/complex/float64/imag}}( z )
53-
-5.0
54-
> z = x.get( 1 );
55-
> re = {{alias:@stdlib/complex/float64/real}}( z )
56-
3.0
57-
> im = {{alias:@stdlib/complex/float64/imag}}( z )
58-
4.0
46+
> z = x.get( 0 )
47+
<Complex128>[ 5.0, -5.0 ]
48+
> z = x.get( 2 )
49+
<Complex128>[ 5.0, -5.0 ]
5950

6051
// Using view offsets:
6152
> var x0 = new {{alias:@stdlib/array/complex128}}( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
6253
> var x1 = new {{alias:@stdlib/array/complex128}}( x0.buffer, x0.BYTES_PER_ELEMENT*1 );
6354
> alpha = new {{alias:@stdlib/complex/float64/ctor}}( 5.0, -5.0 );
6455
> {{alias}}( 2, alpha, x1, 1 );
65-
> z = x0.get( 0 );
66-
> re = {{alias:@stdlib/complex/float64/real}}( z )
67-
1.0
68-
> im = {{alias:@stdlib/complex/float64/imag}}( z )
69-
2.0
70-
> z = x0.get( 1 );
71-
> re = {{alias:@stdlib/complex/float64/real}}( z )
72-
5.0
73-
> im = {{alias:@stdlib/complex/float64/imag}}( z )
74-
-5.0
56+
> z = x0.get( 0 )
57+
<Complex128>[ 1.0, 2.0 ]
58+
> z = x0.get( 1 )
59+
<Complex128>[ 5.0, -5.0 ]
7560

7661

7762
{{alias}}.ndarray( N, alpha, x, strideX, offsetX )
@@ -110,26 +95,17 @@
11095
> var x = new {{alias:@stdlib/array/complex128}}( [ 1.0, 2.0, 3.0, 4.0 ] );
11196
> var alpha = new {{alias:@stdlib/complex/float64/ctor}}( 2.0, 2.0 );
11297
> {{alias}}.ndarray( x.length, alpha, x, 1, 0 );
113-
> var z = x.get( 0 );
114-
> var re = {{alias:@stdlib/complex/float64/real}}( z )
115-
2.0
116-
> var im = {{alias:@stdlib/complex/float64/imag}}( z )
117-
2.0
98+
> var z = x.get( 0 )
99+
<Complex128>[ 2.0, 2.0 ]
118100

119101
// Using an index offset:
120102
> x = new {{alias:@stdlib/array/complex128}}( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
121103
> alpha = new {{alias:@stdlib/complex/float64/ctor}}( 5.0, -5.0 );
122104
> {{alias}}.ndarray( 2, alpha, x, 2, 1 );
123-
> z = x.get( 0 );
124-
> re = {{alias:@stdlib/complex/float64/real}}( z )
125-
1.0
126-
> im = {{alias:@stdlib/complex/float64/imag}}( z )
127-
2.0
128-
> z = x.get( 1 );
129-
> re = {{alias:@stdlib/complex/float64/real}}( z )
130-
5.0
131-
> im = {{alias:@stdlib/complex/float64/imag}}( z )
132-
-5.0
105+
> z = x.get( 0 )
106+
<Complex128>[ 1.0, 2.0 ]
107+
> z = x.get( 1 )
108+
<Complex128>[ 5.0, -5.0 ]
133109

134110
See Also
135111
--------

‎lib/node_modules/@stdlib/blas/ext/base/zfill/docs/types/index.d.ts‎

Lines changed: 3 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -40,8 +40,6 @@ interface Routine {
4040
* var Float64Array = require( '@stdlib/array/float64' );
4141
* var Complex128Array = require( '@stdlib/array/complex128' );
4242
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
43-
* var real = require( '@stdlib/complex/float64/real' );
44-
* var imag = require( '@stdlib/complex/float64/imag' );
4543
*
4644
* var arr = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
4745
* var x = new Complex128Array( arr );
@@ -51,13 +49,7 @@ interface Routine {
5149
* zfill( x.length, alpha, x, 1 );
5250
*
5351
* var y = x.get( 0 );
54-
* // returns <Complex128>
55-
*
56-
* var re = real( y );
57-
* // returns 10.0
58-
*
59-
* var im = imag( y );
60-
* // returns 10.0
52+
* // returns <Complex128>[ 10.0, 10.0 ]
6153
*/
6254
( N: number, alpha: Complex128, x: Complex128Array, strideX: number ): Complex128Array;
6355

@@ -75,8 +67,6 @@ interface Routine {
7567
* var Float64Array = require( '@stdlib/array/float64' );
7668
* var Complex128Array = require( '@stdlib/array/complex128' );
7769
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
78-
* var real = require( '@stdlib/complex/float64/real' );
79-
* var imag = require( '@stdlib/complex/float64/imag' );
8070
*
8171
* var arr = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
8272
* var x = new Complex128Array( arr );
@@ -86,13 +76,7 @@ interface Routine {
8676
* zfill( x.length, alpha, x, 1, 0 );
8777
*
8878
* var y = x.get( 0 );
89-
* // returns <Complex128>
90-
*
91-
* var re = real( y );
92-
* // returns 10.0
93-
*
94-
* var im = imag( y );
95-
* // returns 10.0
79+
* // returns <Complex128>[ 10.0, 10.0 ]
9680
*/
9781
ndarray( N: number, alpha: Complex128, x: Complex128Array, strideX: number, offsetX: number ): Complex128Array;
9882
}
@@ -110,8 +94,6 @@ interface Routine {
11094
* var Float64Array = require( '@stdlib/array/float64' );
11195
* var Complex128Array = require( '@stdlib/array/complex128' );
11296
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
113-
* var real = require( '@stdlib/complex/float64/real' );
114-
* var imag = require( '@stdlib/complex/float64/imag' );
11597
*
11698
* var arr = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
11799
* var x = new Complex128Array( arr );
@@ -121,13 +103,7 @@ interface Routine {
121103
* zfill( x.length, alpha, x, 1 );
122104
*
123105
* var y = x.get( 0 );
124-
* // returns <Complex128>
125-
*
126-
* var re = real( y );
127-
* // returns 10.0
128-
*
129-
* var im = imag( y );
130-
* // returns 10.0
106+
* // returns <Complex128>[ 10.0, 10.0 ]
131107
*/
132108
declare var zfill: Routine;
133109

‎lib/node_modules/@stdlib/blas/ext/base/zfill/lib/index.js‎

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,6 @@
2727
* var Float64Array = require( '@stdlib/array/float64' );
2828
* var Complex128Array = require( '@stdlib/array/complex128' );
2929
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
30-
* var real = require( '@stdlib/complex/float64/real' );
31-
* var imag = require( '@stdlib/complex/float64/imag' );
3230
* var zfill = require( '@stdlib/blas/ext/base/zfill' );
3331
*
3432
* var arr = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
@@ -39,13 +37,7 @@
3937
* zfill( x.length, alpha, x, 1 );
4038
*
4139
* var y = x.get( 0 );
42-
* // returns <Complex128>
43-
*
44-
* var re = real( y );
45-
* // returns 10.0
46-
*
47-
* var im = imag( y );
48-
* // returns 10.0
40+
* // returns <Complex128>[ 10.0, 10.0 ]
4941
*/
5042

5143
// MODULES //

‎lib/node_modules/@stdlib/blas/ext/base/zfill/lib/ndarray.native.js‎

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -40,8 +40,6 @@ var addon = require( './../src/addon.node' );
4040
* var Float64Array = require( '@stdlib/array/float64' );
4141
* var Complex128Array = require( '@stdlib/array/complex128' );
4242
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
43-
* var real = require( '@stdlib/complex/float64/real' );
44-
* var imag = require( '@stdlib/complex/float64/imag' );
4543
*
4644
* var arr = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
4745
* var x = new Complex128Array( arr );
@@ -51,13 +49,7 @@ var addon = require( './../src/addon.node' );
5149
* zfill( x.length, alpha, x, 1, 0 );
5250
*
5351
* var y = x.get( 0 );
54-
* // returns <Complex128>
55-
*
56-
* var re = real( y );
57-
* // returns 10.0
58-
*
59-
* var im = imag( y );
60-
* // returns 10.0
52+
* // returns <Complex128>[ 10.0, 10.0 ]
6153
*/
6254
function zfill( N, alpha, x, strideX, offsetX ) {
6355
var view = reinterpret( x, 0 );

‎lib/node_modules/@stdlib/blas/ext/base/zfill/lib/zfill.js‎

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -39,8 +39,6 @@ var ndarray = require( './ndarray.js' );
3939
* var Float64Array = require( '@stdlib/array/float64' );
4040
* var Complex128Array = require( '@stdlib/array/complex128' );
4141
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
42-
* var real = require( '@stdlib/complex/float64/real' );
43-
* var imag = require( '@stdlib/complex/float64/imag' );
4442
*
4543
* var arr = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
4644
* var x = new Complex128Array( arr );
@@ -50,13 +48,7 @@ var ndarray = require( './ndarray.js' );
5048
* zfill( x.length, alpha, x, 1 );
5149
*
5250
* var y = x.get( 0 );
53-
* // returns <Complex128>
54-
*
55-
* var re = real( y );
56-
* // returns 10.0
57-
*
58-
* var im = imag( y );
59-
* // returns 10.0
51+
* // returns <Complex128>[ 10.0, 10.0 ]
6052
*/
6153
function zfill( N, alpha, x, strideX ) {
6254
return ndarray( N, alpha, x, strideX, stride2offset( N, strideX ) );

0 commit comments

Comments
 (0)