Skip to content

Commit 212d36e

Browse files
anandkaranubcanandkaranubc
authored
docs: improve doctests for complex number typed arrays in lapack/base/zrot
PR-URL: #12025 Reviewed-by: Athan Reines <kgryte@gmail.com> Ref: stdlib-js/metr-issue-tracker#522 Ref: #4833
1 parent 88fbe64 commit 212d36e

6 files changed

Lines changed: 46 additions & 103 deletions

File tree

‎lib/node_modules/@stdlib/lapack/base/zrot/README.md‎

Lines changed: 10 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -43,12 +43,8 @@ var zy = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
4343
var s = new Complex128( 0.0, 0.75 );
4444

4545
zrot( zx.length, zx, 1, zy, 1, 1.25, s );
46-
47-
var z = zy.get( 0 );
48-
// returns <Complex128>[ ~-1.5, ~0.75 ]
49-
50-
z = zx.get( 0 );
51-
// returns <Complex128>[ ~1.25, ~2.5 ]
46+
// zy => <Complex128Array>[ ~-1.5, ~0.75, ~-3.0, ~2.25, ~-4.5, ~3.75, ~-6.0, ~5.25 ]
47+
// zx => <Complex128Array>[ ~1.25, ~2.5, ~3.75, ~5.0, ~6.25, ~7.5, ~8.75, ~10.0 ]
5248
```
5349

5450
The function has the following parameters:
@@ -70,12 +66,8 @@ var zy = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
7066
var s = new Complex128( 0.0, 0.75 );
7167

7268
zrot( 2, zx, 2, zy, 2, 1.25, s );
73-
74-
var z = zy.get( 0 );
75-
// returns <Complex128>[ ~-1.5, ~0.75 ]
76-
77-
z = zx.get( 0 );
78-
// returns <Complex128>[ ~1.25, ~2.5 ]
69+
// zy => <Complex128Array>[ ~-1.5, ~0.75, 0.0, 0.0, ~-4.5, ~3.75, 0.0, 0.0 ]
70+
// zx => <Complex128Array>[ ~1.25, ~2.5, 3.0, 4.0, ~6.25, ~7.5, 7.0, 8.0 ]
7971
```
8072

8173
Note that indexing is relative to the first index. To introduce an offset, use [`typed array`][mdn-typed-array] views.
@@ -97,12 +89,8 @@ var zy1 = new Complex128Array( zy0.buffer, zy0.BYTES_PER_ELEMENT*2 ); // start a
9789
var s = new Complex128( 0.0, 0.75 );
9890

9991
zrot( 2, zx1, -2, zy1, 1, 1.25, s );
100-
101-
var z = zy0.get( 2 );
102-
// returns <Complex128>[ ~-6.0, ~5.25 ]
103-
104-
z = zx0.get( 3 );
105-
// returns <Complex128>[ ~8.75, ~10.0 ]
92+
// zy0 => <Complex128Array>[ 0.0, 0.0, 0.0, 0.0, ~-6.0, ~5.25, ~-3.0, ~2.25 ]
93+
// zx0 => <Complex128Array>[ 1.0, 2.0, ~3.75, ~5.0, 5.0, 6.0, ~8.75, ~10.0 ]
10694
```
10795

10896
#### zrot.ndarray( N, zx, strideX, offsetX, zy, strideY, offsetY, c, s )
@@ -118,12 +106,8 @@ var zy = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
118106
var s = new Complex128( 0.0, 0.75 );
119107

120108
zrot.ndarray( zx.length, zx, 1, 0, zy, 1, 0, 1.25, s );
121-
122-
var z = zy.get( 0 );
123-
// returns <Complex128>[ ~-1.5, ~0.75 ]
124-
125-
z = zx.get( 0 );
126-
// returns <Complex128>[ ~1.25, ~2.5 ]
109+
// zy => <Complex128Array>[ ~-1.5, ~0.75, ~-3.0, ~2.25, ~-4.5, ~3.75 ]
110+
// zx => <Complex128Array>[ ~1.25, ~2.5, ~3.75, ~5.0, ~6.25, ~7.5 ]
127111
```
128112

129113
The function has the following additional parameters:
@@ -142,12 +126,8 @@ var zy = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
142126
var s = new Complex128( 0.0, 0.75 );
143127

144128
zrot.ndarray( 2, zx, 2, 1, zy, 2, 1, 1.25, s );
145-
146-
var z = zy.get( 3 );
147-
// returns <Complex128>[ ~-6.0, ~5.25 ]
148-
149-
z = zx.get( 1 );
150-
// returns <Complex128>[ ~3.75, ~5.0 ]
129+
// zy => <Complex128Array>[ 0.0, 0.0, ~-3.0, ~2.25, 0.0, 0.0, ~-6.0, ~5.25 ]
130+
// zx => <Complex128Array>[ 1.0, 2.0, ~3.75, ~5.0, 5.0, 6.0, ~8.75, ~10.0 ]
151131
```
152132

153133
</section>

‎lib/node_modules/@stdlib/lapack/base/zrot/docs/repl.txt‎

Lines changed: 20 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -44,33 +44,30 @@
4444
> var zx = new {{alias:@stdlib/array/complex128}}( [ 1.0, 2.0, 3.0, 4.0 ] );
4545
> var zy = new {{alias:@stdlib/array/complex128}}( [ 0.0, 0.0, 0.0, 0.0 ] );
4646
> var s = new {{alias:@stdlib/complex/float64/ctor}}( 0.3, 0.4 );
47-
> {{alias}}( zx.length, zx, 1, zy, 1, 0.8, s );
48-
> var z = zy.get( 0 )
49-
<Complex128>[ ~-1.1, ~-0.2 ]
50-
> z = zx.get( 0 )
51-
<Complex128>[ ~0.8, ~1.6 ]
47+
> {{alias}}( zx.length, zx, 1, zy, 1, 0.8, s )
48+
<Complex128Array>[ ~-1.1, ~-0.2, ~-2.5, ~0.0 ]
49+
> zx
50+
<Complex128Array>[ ~0.8, ~1.6, ~2.4, ~3.2 ]
5251

5352
// Advanced indexing:
5453
> zx = new {{alias:@stdlib/array/complex128}}( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
5554
> zy = new {{alias:@stdlib/array/complex128}}( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
5655
> var s = new {{alias:@stdlib/complex/float64/ctor}}( 0.3, 0.4 );
57-
> {{alias}}( 2, zx, -2, zy, 1, 0.8, s );
58-
> z = zy.get( 0 )
59-
<Complex128>[ ~-3.9, ~0.2 ]
60-
> z = zx.get( 2 )
61-
<Complex128>[ ~4.0, ~4.8 ]
56+
> {{alias}}( 2, zx, -2, zy, 1, 0.8, s )
57+
<Complex128Array>[ ~-3.9, ~0.2, ~-1.1, ~-0.2, 0.0, 0.0, 0.0, 0.0 ]
58+
> zx
59+
<Complex128Array>[ ~0.8, ~1.6, 3.0, 4.0, ~4.0, ~4.8, 7.0, 8.0 ]
6260

6361
// Using typed array views:
6462
> var zx0 = new {{alias:@stdlib/array/complex128}}( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
6563
> var zy0 = new {{alias:@stdlib/array/complex128}}( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
6664
> var zx1 = new {{alias:@stdlib/array/complex128}}( zx0.buffer, zx0.BYTES_PER_ELEMENT*1 );
6765
> var zy1 = new {{alias:@stdlib/array/complex128}}( zy0.buffer, zy0.BYTES_PER_ELEMENT*2 );
6866
> var s = new {{alias:@stdlib/complex/float64/ctor}}( 0.3, 0.4 );
69-
> {{alias}}( 1, zx1, 1, zy1, 1, 0.8, s );
70-
> z = zy0.get( 2 )
71-
<Complex128>[ ~-2.5, ~0.0 ]
72-
> z = zx0.get( 1 )
73-
<Complex128>[ ~2.4, ~3.2 ]
67+
> {{alias}}( 1, zx1, 1, zy1, 1, 0.8, s )
68+
<Complex128Array>[ ~-2.5, ~0.0 ]
69+
> zx0
70+
<Complex128Array>[ 1.0, 2.0, ~2.4, ~3.2, 5.0, 6.0 ]
7471

7572

7673
{{alias}}.ndarray( N, zx, strideX, offsetX, zy, strideY, offsetY, c, s )
@@ -121,21 +118,19 @@
121118
> var zx = new {{alias:@stdlib/array/complex128}}( [ 1.0, 2.0, 3.0, 4.0 ] );
122119
> var zy = new {{alias:@stdlib/array/complex128}}( [ 0.0, 0.0, 0.0, 0.0 ] );
123120
> var s = new {{alias:@stdlib/complex/float64/ctor}}( 0.3, 0.4 );
124-
> {{alias}}.ndarray( zx.length, zx, 1, 0, zy, 1, 0, 0.8, s );
125-
> var z = zy.get( 0 )
126-
<Complex128>[ ~-1.1, ~-0.2 ]
127-
> z = zx.get( 0 )
128-
<Complex128>[ ~0.8, ~1.6 ]
121+
> {{alias}}.ndarray( zx.length, zx, 1, 0, zy, 1, 0, 0.8, s )
122+
<Complex128Array>[ ~-1.1, ~-0.2, ~-2.5, ~0.0 ]
123+
> zx
124+
<Complex128Array>[ ~0.8, ~1.6, ~2.4, ~3.2 ]
129125

130126
// Advanced indexing:
131127
> zx = new {{alias:@stdlib/array/complex128}}( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
132128
> zy = new {{alias:@stdlib/array/complex128}}( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
133129
> var s = new {{alias:@stdlib/complex/float64/ctor}}( 0.3, 0.4 );
134-
> {{alias}}.ndarray( 1, zx, 2, 1, zy, 2, 1, 0.8, s );
135-
> z = zy.get( 1 )
136-
<Complex128>[ ~-2.5, ~0.0 ]
137-
> z = zx.get( 1 )
138-
<Complex128>[ ~2.4, ~3.2 ]
130+
> {{alias}}.ndarray( 1, zx, 2, 1, zy, 2, 1, 0.8, s )
131+
<Complex128Array>[ 0.0, 0.0, ~-2.5, ~0.0, 0.0, 0.0 ]
132+
> zx
133+
<Complex128Array>[ 1.0, 2.0, ~2.4, ~3.2, 5.0, 6.0 ]
139134

140135
See Also
141136
--------

‎lib/node_modules/@stdlib/lapack/base/zrot/docs/types/index.d.ts‎

Lines changed: 8 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -48,12 +48,8 @@ interface Routine {
4848
* var s = new Complex128( 0.3, 0.4 );
4949
*
5050
* zrot( zx.length, zx, 1, zy, 1, 0.8, s );
51-
*
52-
* var z = zy.get( 0 );
53-
* // returns <Complex128>[ ~-1.1, ~-0.2 ]
54-
*
55-
* z = zx.get( 0 );
56-
* // returns <Complex128>[ ~0.8, ~1.6 ]
51+
* // zy => <Complex128Array>[ ~-1.1, ~-0.2, ~-2.5, ~0.0, ~-3.9, ~0.2, ~-5.3, ~0.4 ]
52+
* // zx => <Complex128Array>[ ~0.8, ~1.6, ~2.4, ~3.2, ~4.0, ~4.8, ~5.6, ~6.4 ]
5753
*/
5854
( N: number, zx: Complex128Array, strideX: number, zy: Complex128Array, strideY: number, c: number, s: Complex128 ): Complex128Array;
5955

@@ -80,12 +76,8 @@ interface Routine {
8076
* var s = new Complex128( 0.3, 0.4 );
8177
*
8278
* zrot.ndarray( zx.length, zx, 1, 0, zy, 1, 0, 0.8, s );
83-
*
84-
* var z = zy.get( 0 );
85-
* // returns <Complex128>[ ~-1.1, ~-0.2 ]
86-
*
87-
* z = zx.get( 0 );
88-
* // returns <Complex128>[ ~0.8, ~1.6 ]
79+
* // zy => <Complex128Array>[ ~-1.1, ~-0.2, ~-2.5, ~0.0, ~-3.9, ~0.2, ~-5.3, ~0.4 ]
80+
* // zx => <Complex128Array>[ ~0.8, ~1.6, ~2.4, ~3.2, ~4.0, ~4.8, ~5.6, ~6.4 ]
8981
*/
9082
ndarray( N: number, zx: Complex128Array, strideX: number, offsetX: number, zy: Complex128Array, strideY: number, offsetY: number, c: number, s: Complex128 ): Complex128Array;
9183
}
@@ -111,12 +103,8 @@ interface Routine {
111103
* var s = new Complex128( 0.3, 0.4 );
112104
*
113105
* zrot( 2, zx, 2, zy, 1, 0.8, s );
114-
*
115-
* var z = zy.get( 0 );
116-
* // returns <Complex128>[ ~-1.1, ~-0.2 ]
117-
*
118-
* z = zx.get( 0 );
119-
* // returns <Complex128>[ ~0.8, ~1.6 ]
106+
* // zy => <Complex128Array>[ ~-1.1, ~-0.2, ~-3.9, ~0.2, 0.0, 0.0, 0.0, 0.0 ]
107+
* // zx => <Complex128Array>[ ~0.8, ~1.6, 3.0, 4.0, 4.0, ~4.8, 7.0, 8.0 ]
120108
*
121109
* @example
122110
* var Complex128Array = require( '@stdlib/array/complex128' );
@@ -127,12 +115,8 @@ interface Routine {
127115
* var s = new Complex128( 0.3, 0.4 );
128116
*
129117
* zrot.ndarray( 2, zx, 2, 0, zy, 1, 0, 0.8, s );
130-
*
131-
* var z = zy.get( 0 );
132-
* // returns <Complex128>[ ~-1.1, ~-0.2 ]
133-
*
134-
* z = zx.get( 0 );
135-
* // returns <Complex128>[ ~0.8, ~1.6 ]
118+
* // zy => <Complex128Array>[ ~-1.1, ~-0.2, ~-3.9, ~0.2, 0.0, 0.0, 0.0, 0.0 ]
119+
* // zx => <Complex128Array>[ ~0.8, ~1.6, 3.0, 4.0, 4.0, ~4.8, 7.0, 8.0 ]
136120
*/
137121
declare var zrot: Routine;
138122

‎lib/node_modules/@stdlib/lapack/base/zrot/lib/index.js‎

Lines changed: 4 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -33,12 +33,8 @@
3333
* var s = new Complex128( 0.6, 0 );
3434
*
3535
* zrot( zx.length, zx, 1, zy, 1, 0.8, s );
36-
*
37-
* var z = zy.get( 0 );
38-
* // returns <Complex128>[ ~-0.6, ~-1.2 ]
39-
*
40-
* z = zx.get( 0 );
41-
* // returns <Complex128>[ ~0.8, ~1.6 ]
36+
* // zy => <Complex128Array>[ ~-0.6, ~-1.2, ~-1.8, ~-2.4, ~-3.0, ~-3.6, ~-4.2, ~-4.8 ]
37+
* // zx => <Complex128Array>[ ~0.8, ~1.6, ~2.4, ~3.2, ~4.0, ~4.8, ~5.6, ~6.4 ]
4238
*
4339
* @example
4440
* var Complex128Array = require( '@stdlib/array/complex128' );
@@ -50,12 +46,8 @@
5046
* var s = new Complex128( 0.6, 0 );
5147
*
5248
* zrot.ndarray( zx.length, zx, 1, 0, zy, 1, 0, 0.8, s );
53-
*
54-
* var z = zy.get( 0 );
55-
* // returns <Complex128>[ ~-0.6, ~-1.2 ]
56-
*
57-
* z = zx.get( 0 );
58-
* // returns <Complex128>[ ~0.8, ~1.6 ]
49+
* // zy => <Complex128Array>[ ~-0.6, ~-1.2, ~-1.8, ~-2.4, ~-3.0, ~-3.6, ~-4.2, ~-4.8 ]
50+
* // zx => <Complex128Array>[ ~0.8, ~1.6, ~2.4, ~3.2, ~4.0, ~4.8, ~5.6, ~6.4 ]
5951
*/
6052

6153
// MODULES //

‎lib/node_modules/@stdlib/lapack/base/zrot/lib/ndarray.js‎

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -50,12 +50,8 @@ var imag = require( '@stdlib/complex/float64/imag' );
5050
* var s = new Complex128( 0.3, 0.4 );
5151
*
5252
* zrot( zx.length, zx, 1, 0, zy, 1, 0, 0.8, s );
53-
*
54-
* var z = zy.get( 0 );
55-
* // returns <Complex128>[ ~-1.1, ~-0.2 ]
56-
*
57-
* z = zx.get( 0 );
58-
* // returns <Complex128>[ ~0.8, ~1.6 ]
53+
* // zy => <Complex128Array>[ ~-1.1, ~-0.2, ~-2.5, ~0.0, ~-3.9, ~0.2, ~-5.3, ~0.4 ]
54+
* // zx => <Complex128Array>[ ~0.8, ~1.6, ~2.4, ~3.2, ~4.0, ~4.8, ~5.6, ~6.4 ]
5955
*/
6056
function zrot( N, zx, strideX, offsetX, zy, strideY, offsetY, c, s ) {
6157
var viewX;

‎lib/node_modules/@stdlib/lapack/base/zrot/lib/zrot.js‎

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -47,12 +47,8 @@ var ndarray = require( './ndarray.js' );
4747
* var s = new Complex128( 0.3, 0.4 );
4848
*
4949
* zrot( zx.length, zx, 1, zy, 1, 0.8, s );
50-
*
51-
* var z = zy.get( 0 );
52-
* // returns <Complex128>[ ~-1.1, ~-0.2 ]
53-
*
54-
* z = zx.get( 0 );
55-
* // returns <Complex128>[ ~0.8, ~1.6 ]
50+
* // zy => <Complex128Array>[ ~-1.1, ~-0.2, ~-2.5, ~0.0, ~-3.9, ~0.2, ~-5.3, ~0.4 ]
51+
* // zx => <Complex128Array>[ ~0.8, ~1.6, ~2.4, ~3.2, ~4.0, ~4.8, ~5.6, ~6.4 ]
5652
*/
5753
function zrot( N, zx, strideX, zy, strideY, c, s ) {
5854
var ix = stride2offset( N, strideX );

0 commit comments

Comments
 (0)