Skip to content

Commit bcdee7b

Browse files
docs: improve doctests for complex number typed arrays in blas/ext/base/zfill
PR-URL: #11977 Reviewed-by: Athan Reines <kgryte@gmail.com> Closes: stdlib-js/metr-issue-tracker#518 Ref: #4833
1 parent 6c6ac62 commit bcdee7b

8 files changed

Lines changed: 39 additions & 122 deletions

File tree

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

Lines changed: 10 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -35,19 +35,15 @@ var zfill = require( '@stdlib/blas/ext/base/zfill' );
3535
Fills a double-precision complex floating-point strided array `x` with a specified scalar constant `alpha`.
3636

3737
```javascript
38-
var Float64Array = require( '@stdlib/array/float64' );
3938
var Complex128Array = require( '@stdlib/array/complex128' );
4039
var Complex128 = require( '@stdlib/complex/float64/ctor' );
4140

42-
var arr = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
43-
var x = new Complex128Array( arr );
41+
var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
4442

4543
var alpha = new Complex128( 10.0, 10.0 );
4644

4745
zfill( x.length, alpha, x, 1 );
48-
49-
var y = x.get( 0 );
50-
// returns <Complex128>[ 10.0, 10.0 ]
46+
// x => <Complex128Array>[ 10.0, 10.0, 10.0, 10.0, 10.0, 10.0, 10.0, 10.0 ]
5147
```
5248

5349
The function has the following parameters:
@@ -60,36 +56,25 @@ The function has the following parameters:
6056
The `N` and stride parameters determine which elements in the strided array are accessed at runtime. For example, to fill every other element
6157

6258
```javascript
63-
var Float64Array = require( '@stdlib/array/float64' );
6459
var Complex128Array = require( '@stdlib/array/complex128' );
6560
var Complex128 = require( '@stdlib/complex/float64/ctor' );
6661

67-
var arr = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
68-
var x = new Complex128Array( arr );
62+
var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
6963

7064
var alpha = new Complex128( 10.0, 10.0 );
7165

7266
zfill( 2, alpha, x, 2 );
73-
74-
var y = x.get( 0 );
75-
// returns <Complex128>[ 10.0, 10.0 ]
76-
77-
y = x.get( 1 );
78-
// returns <Complex128>[ 3.0, 4.0 ]
67+
// x => <Complex128Array>[ 10.0, 10.0, 3.0, 4.0, 10.0, 10.0, 7.0, 8.0 ]
7968
```
8069

8170
Note that indexing is relative to the first index. To introduce an offset, use [`typed array`][mdn-typed-array] views.
8271

8372
```javascript
84-
var Float64Array = require( '@stdlib/array/float64' );
8573
var Complex128Array = require( '@stdlib/array/complex128' );
8674
var Complex128 = require( '@stdlib/complex/float64/ctor' );
8775

88-
// Create the underlying floating-point array:
89-
var arr = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
90-
9176
// Initial array:
92-
var x0 = new Complex128Array( arr );
77+
var x0 = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
9378

9479
// Create an offset view:
9580
var x1 = new Complex128Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element
@@ -99,32 +84,23 @@ var alpha = new Complex128( 10.0, 10.0 );
9984

10085
// Fill every other element:
10186
zfill( 2, alpha, x1, 2 );
102-
103-
var y = x0.get( 0 );
104-
// returns <Complex128>[ 1.0, 2.0 ]
105-
106-
y = x0.get( 1 );
107-
// returns <Complex128>[ 10.0, 10.0 ]
87+
// x0 => <Complex128Array>[ 1.0, 2.0, 10.0, 10.0, 5.0, 6.0, 10.0, 10.0 ]
10888
```
10989

11090
#### zfill.ndarray( N, alpha, x, strideX, offsetX )
11191

11292
Fills a double-precision complex floating-point strided array `x` with a specified scalar constant `alpha` using alternative indexing semantics.
11393

11494
```javascript
115-
var Float64Array = require( '@stdlib/array/float64' );
11695
var Complex128Array = require( '@stdlib/array/complex128' );
11796
var Complex128 = require( '@stdlib/complex/float64/ctor' );
11897

119-
var arr = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
120-
var x = new Complex128Array( arr );
98+
var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
12199

122100
var alpha = new Complex128( 10.0, 10.0 );
123101

124102
zfill.ndarray( x.length, alpha, x, 1, 0 );
125-
126-
var y = x.get( 0 );
127-
// returns <Complex128>[ 10.0, 10.0 ]
103+
// x => <Complex128Array>[ 10.0, 10.0, 10.0, 10.0, 10.0, 10.0, 10.0, 10.0 ]
128104
```
129105

130106
The function has the following additional parameters:
@@ -134,25 +110,15 @@ The function has the following additional parameters:
134110
While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying buffer, the offset parameter supports indexing semantics based on a starting index. For example, to access only the last two elements of the strided array
135111

136112
```javascript
137-
var Float64Array = require( '@stdlib/array/float64' );
138113
var Complex128Array = require( '@stdlib/array/complex128' );
139114
var Complex128 = require( '@stdlib/complex/float64/ctor' );
140115

141-
var arr = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
142-
var x = new Complex128Array( arr );
116+
var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
143117

144118
var alpha = new Complex128( 10.0, 10.0 );
145119

146120
zfill.ndarray( 2, alpha, x, 1, x.length-2 );
147-
148-
var y = x.get( 0 );
149-
// returns <Complex128>[ 1.0, 2.0 ]
150-
151-
y = x.get( 1 );
152-
// returns <Complex128>[ 10.0, 10.0 ]
153-
154-
y = x.get( 2 );
155-
// returns <Complex128>[ 10.0, 10.0 ]
121+
// x => <Complex128Array>[ 1.0, 2.0, 10.0, 10.0, 10.0, 10.0 ]
156122
```
157123

158124
</section>

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

Lines changed: 12 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -35,28 +35,23 @@
3535
// Standard Usage:
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 );
38-
> {{alias}}( x.length, alpha, x, 1 );
39-
> var z = x.get( 0 )
40-
<Complex128>[ 5.0, -5.0 ]
38+
> {{alias}}( x.length, alpha, x, 1 )
39+
<Complex128Array>[ 5.0, -5.0, 5.0, -5.0 ]
4140

4241
// Using `N` and stride parameters:
4342
> x = new {{alias:@stdlib/array/complex128}}( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
4443
> alpha = new {{alias:@stdlib/complex/float64/ctor}}( 5.0, -5.0 );
45-
> {{alias}}( 2, alpha, x, 2 );
46-
> z = x.get( 0 )
47-
<Complex128>[ 5.0, -5.0 ]
48-
> z = x.get( 2 )
49-
<Complex128>[ 5.0, -5.0 ]
44+
> {{alias}}( 2, alpha, x, 2 )
45+
<Complex128Array>[ 5.0, -5.0, 3.0, 4.0, 5.0, -5.0 ]
5046

5147
// Using view offsets:
5248
> var x0 = new {{alias:@stdlib/array/complex128}}( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
5349
> var x1 = new {{alias:@stdlib/array/complex128}}( x0.buffer, x0.BYTES_PER_ELEMENT*1 );
5450
> alpha = new {{alias:@stdlib/complex/float64/ctor}}( 5.0, -5.0 );
55-
> {{alias}}( 2, alpha, x1, 1 );
56-
> z = x0.get( 0 )
57-
<Complex128>[ 1.0, 2.0 ]
58-
> z = x0.get( 1 )
59-
<Complex128>[ 5.0, -5.0 ]
51+
> {{alias}}( 2, alpha, x1, 1 )
52+
<Complex128Array>[ 5.0, -5.0, 5.0, -5.0 ]
53+
> x0
54+
<Complex128Array>[ 1.0, 2.0, 5.0, -5.0, 5.0, -5.0 ]
6055

6156

6257
{{alias}}.ndarray( N, alpha, x, strideX, offsetX )
@@ -94,18 +89,14 @@
9489
// Standard Usage:
9590
> var x = new {{alias:@stdlib/array/complex128}}( [ 1.0, 2.0, 3.0, 4.0 ] );
9691
> var alpha = new {{alias:@stdlib/complex/float64/ctor}}( 2.0, 2.0 );
97-
> {{alias}}.ndarray( x.length, alpha, x, 1, 0 );
98-
> var z = x.get( 0 )
99-
<Complex128>[ 2.0, 2.0 ]
92+
> {{alias}}.ndarray( x.length, alpha, x, 1, 0 )
93+
<Complex128Array>[ 2.0, 2.0, 2.0, 2.0 ]
10094

10195
// Using an index offset:
10296
> x = new {{alias:@stdlib/array/complex128}}( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
10397
> alpha = new {{alias:@stdlib/complex/float64/ctor}}( 5.0, -5.0 );
104-
> {{alias}}.ndarray( 2, alpha, x, 2, 1 );
105-
> z = x.get( 0 )
106-
<Complex128>[ 1.0, 2.0 ]
107-
> z = x.get( 1 )
108-
<Complex128>[ 5.0, -5.0 ]
98+
> {{alias}}.ndarray( 2, alpha, x, 2, 1 )
99+
<Complex128Array>[ 1.0, 2.0, 5.0, -5.0, 5.0, 6.0, 5.0, -5.0 ]
109100

110101
See Also
111102
--------

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

Lines changed: 7 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -37,19 +37,15 @@ interface Routine {
3737
* @returns input array
3838
*
3939
* @example
40-
* var Float64Array = require( '@stdlib/array/float64' );
4140
* var Complex128Array = require( '@stdlib/array/complex128' );
4241
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
4342
*
44-
* var arr = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
45-
* var x = new Complex128Array( arr );
43+
* var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
4644
*
4745
* var alpha = new Complex128( 10.0, 10.0 );
4846
*
4947
* zfill( x.length, alpha, x, 1 );
50-
*
51-
* var y = x.get( 0 );
52-
* // returns <Complex128>[ 10.0, 10.0 ]
48+
* // x => <Complex128Array>[ 10.0, 10.0, 10.0, 10.0, 10.0, 10.0, 10.0, 10.0 ]
5349
*/
5450
( N: number, alpha: Complex128, x: Complex128Array, strideX: number ): Complex128Array;
5551

@@ -64,19 +60,15 @@ interface Routine {
6460
* @returns input array
6561
*
6662
* @example
67-
* var Float64Array = require( '@stdlib/array/float64' );
6863
* var Complex128Array = require( '@stdlib/array/complex128' );
6964
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
7065
*
71-
* var arr = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
72-
* var x = new Complex128Array( arr );
66+
* var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
7367
*
7468
* var alpha = new Complex128( 10.0, 10.0 );
7569
*
76-
* zfill( x.length, alpha, x, 1, 0 );
77-
*
78-
* var y = x.get( 0 );
79-
* // returns <Complex128>[ 10.0, 10.0 ]
70+
* zfill.ndarray( x.length, alpha, x, 1, 0 );
71+
* // x => <Complex128Array>[ 10.0, 10.0, 10.0, 10.0, 10.0, 10.0, 10.0, 10.0 ]
8072
*/
8173
ndarray( N: number, alpha: Complex128, x: Complex128Array, strideX: number, offsetX: number ): Complex128Array;
8274
}
@@ -91,19 +83,15 @@ interface Routine {
9183
* @returns input array
9284
*
9385
* @example
94-
* var Float64Array = require( '@stdlib/array/float64' );
9586
* var Complex128Array = require( '@stdlib/array/complex128' );
9687
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
9788
*
98-
* var arr = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
99-
* var x = new Complex128Array( arr );
89+
* var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
10090
*
10191
* var alpha = new Complex128( 10.0, 10.0 );
10292
*
10393
* zfill( x.length, alpha, x, 1 );
104-
*
105-
* var y = x.get( 0 );
106-
* // returns <Complex128>[ 10.0, 10.0 ]
94+
* // x => <Complex128Array>[ 10.0, 10.0, 10.0, 10.0, 10.0, 10.0, 10.0, 10.0 ]
10795
*/
10896
declare var zfill: Routine;
10997

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

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -24,20 +24,16 @@
2424
* @module @stdlib/blas/ext/base/zfill
2525
*
2626
* @example
27-
* var Float64Array = require( '@stdlib/array/float64' );
2827
* var Complex128Array = require( '@stdlib/array/complex128' );
2928
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
3029
* var zfill = require( '@stdlib/blas/ext/base/zfill' );
3130
*
32-
* var arr = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
33-
* var x = new Complex128Array( arr );
31+
* var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
3432
*
3533
* var alpha = new Complex128( 10.0, 10.0 );
3634
*
3735
* zfill( x.length, alpha, x, 1 );
38-
*
39-
* var y = x.get( 0 );
40-
* // returns <Complex128>[ 10.0, 10.0 ]
36+
* // x => <Complex128Array>[ 10.0, 10.0, 10.0, 10.0, 10.0, 10.0, 10.0, 10.0 ]
4137
*/
4238

4339
// MODULES //

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

Lines changed: 2 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -43,27 +43,15 @@ var M = 8;
4343
* @returns {Complex128Array} input array
4444
*
4545
* @example
46-
* var Float64Array = require( '@stdlib/array/float64' );
4746
* var Complex128Array = require( '@stdlib/array/complex128' );
4847
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
49-
* var real = require( '@stdlib/complex/float64/real' );
50-
* var imag = require( '@stdlib/complex/float64/imag' );
5148
*
52-
* var arr = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
53-
* var x = new Complex128Array( arr );
49+
* var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
5450
*
5551
* var alpha = new Complex128( 10.0, 10.0 );
5652
*
5753
* zfill( x.length, alpha, x, 1, 0 );
58-
*
59-
* var y = x.get( 0 );
60-
* // returns <Complex128>
61-
*
62-
* var re = real( y );
63-
* // returns 10.0
64-
*
65-
* var im = imag( y );
66-
* // returns 10.0
54+
* // x => <Complex128Array>[ 10.0, 10.0, 10.0, 10.0, 10.0, 10.0, 10.0, 10.0 ]
6755
*/
6856
function zfill( N, alpha, x, strideX, offsetX ) {
6957
var view;

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

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -37,19 +37,15 @@ var addon = require( './../src/addon.node' );
3737
* @returns {Complex128Array} input array
3838
*
3939
* @example
40-
* var Float64Array = require( '@stdlib/array/float64' );
4140
* var Complex128Array = require( '@stdlib/array/complex128' );
4241
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
4342
*
44-
* var arr = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
45-
* var x = new Complex128Array( arr );
43+
* var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
4644
*
4745
* var alpha = new Complex128( 10.0, 10.0 );
4846
*
4947
* zfill( x.length, alpha, x, 1, 0 );
50-
*
51-
* var y = x.get( 0 );
52-
* // returns <Complex128>[ 10.0, 10.0 ]
48+
* // x => <Complex128Array>[ 10.0, 10.0, 10.0, 10.0, 10.0, 10.0, 10.0, 10.0 ]
5349
*/
5450
function zfill( N, alpha, x, strideX, offsetX ) {
5551
var view = reinterpret( x, 0 );

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

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -36,19 +36,15 @@ var ndarray = require( './ndarray.js' );
3636
* @returns {Complex128Array} input array
3737
*
3838
* @example
39-
* var Float64Array = require( '@stdlib/array/float64' );
4039
* var Complex128Array = require( '@stdlib/array/complex128' );
4140
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
4241
*
43-
* var arr = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
44-
* var x = new Complex128Array( arr );
42+
* var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
4543
*
4644
* var alpha = new Complex128( 10.0, 10.0 );
4745
*
4846
* zfill( x.length, alpha, x, 1 );
49-
*
50-
* var y = x.get( 0 );
51-
* // returns <Complex128>[ 10.0, 10.0 ]
47+
* // x => <Complex128Array>[ 10.0, 10.0, 10.0, 10.0, 10.0, 10.0, 10.0, 10.0 ]
5248
*/
5349
function zfill( N, alpha, x, strideX ) {
5450
return ndarray( N, alpha, x, strideX, stride2offset( N, strideX ) );

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

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -36,19 +36,15 @@ var addon = require( './../src/addon.node' );
3636
* @returns {Complex128Array} input array
3737
*
3838
* @example
39-
* var Float64Array = require( '@stdlib/array/float64' );
4039
* var Complex128Array = require( '@stdlib/array/complex128' );
4140
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
4241
*
43-
* var arr = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
44-
* var x = new Complex128Array( arr );
42+
* var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
4543
*
4644
* var alpha = new Complex128( 10.0, 10.0 );
4745
*
4846
* zfill( x.length, alpha, x, 1 );
49-
*
50-
* var y = x.get( 0 );
51-
* // returns <Complex128>[ 10.0, 10.0 ]
47+
* // x => <Complex128Array>[ 10.0, 10.0, 10.0, 10.0, 10.0, 10.0, 10.0, 10.0 ]
5248
*/
5349
function zfill( N, alpha, x, strideX ) {
5450
var view = reinterpret( x, 0 );

0 commit comments

Comments
 (0)