Skip to content

Commit 8f8680e

Browse files
DivyanshuVortexDivyanshuVortex
authored
docs: improve doctests for complex number instances in lapack/base/zrot
PR-URL: #8697 Ref: #8641 Reviewed-by: Athan Reines <kgryte@gmail.com>
1 parent 7267554 commit 8f8680e

File tree

6 files changed

+46
-258
lines changed

6 files changed

+46
-258
lines changed

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

Lines changed: 10 additions & 80 deletions
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,6 @@ Applies a plane rotation with real cosine and complex sine.
3737
```javascript
3838
var Complex128Array = require( '@stdlib/array/complex128' );
3939
var Complex128 = require( '@stdlib/complex/float64/ctor' );
40-
var real = require( '@stdlib/complex/float64/real' );
41-
var imag = require( '@stdlib/complex/float64/imag' );
4240

4341
var zx = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
4442
var zy = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
@@ -47,22 +45,10 @@ var s = new Complex128( 0.0, 0.75 );
4745
zrot( zx.length, zx, 1, zy, 1, 1.25, s );
4846

4947
var z = zy.get( 0 );
50-
// returns <Complex128>
51-
52-
var re = real( z );
53-
// returns ~-1.5
54-
55-
var im = imag( z );
56-
// returns ~0.75
48+
// returns <Complex128>[ ~-1.5, ~0.75 ]
5749

5850
z = zx.get( 0 );
59-
// returns <Complex128>
60-
61-
re = real( z );
62-
// returns ~1.25
63-
64-
im = imag( z );
65-
// returns ~2.5
51+
// returns <Complex128>[ ~1.25, ~2.5 ]
6652
```
6753

6854
The function has the following parameters:
@@ -78,8 +64,6 @@ The `N` and stride parameters determine how values from `zx` and `zy` are access
7864
```javascript
7965
var Complex128Array = require( '@stdlib/array/complex128' );
8066
var Complex128 = require( '@stdlib/complex/float64/ctor' );
81-
var real = require( '@stdlib/complex/float64/real' );
82-
var imag = require( '@stdlib/complex/float64/imag' );
8367

8468
var zx = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
8569
var zy = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
@@ -88,22 +72,10 @@ var s = new Complex128( 0.0, 0.75 );
8872
zrot( 2, zx, 2, zy, 2, 1.25, s );
8973

9074
var z = zy.get( 0 );
91-
// returns <Complex128>
92-
93-
var re = real( z );
94-
// returns ~-1.5
95-
96-
var im = imag( z );
97-
// returns ~0.75
75+
// returns <Complex128>[ ~-1.5, ~0.75 ]
9876

9977
z = zx.get( 0 );
100-
// returns <Complex128>
101-
102-
re = real( z );
103-
// returns ~1.25
104-
105-
im = imag( z );
106-
// returns ~2.5
78+
// returns <Complex128>[ ~1.25, ~2.5 ]
10779
```
10880

10981
Note that indexing is relative to the first index. To introduce an offset, use [`typed array`][mdn-typed-array] views.
@@ -113,8 +85,6 @@ Note that indexing is relative to the first index. To introduce an offset, use [
11385
```javascript
11486
var Complex128Array = require( '@stdlib/array/complex128' );
11587
var Complex128 = require( '@stdlib/complex/float64/ctor' );
116-
var real = require( '@stdlib/complex/float64/real' );
117-
var imag = require( '@stdlib/complex/float64/imag' );
11888

11989
// Initial arrays...
12090
var zx0 = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
@@ -129,22 +99,10 @@ var s = new Complex128( 0.0, 0.75 );
12999
zrot( 2, zx1, -2, zy1, 1, 1.25, s );
130100

131101
var z = zy0.get( 2 );
132-
// returns <Complex128>
133-
134-
var re = real( z );
135-
// returns ~-6
136-
137-
var im = imag( z );
138-
// returns ~5.25
102+
// returns <Complex128>[ ~-6.0, ~5.25 ]
139103

140104
z = zx0.get( 3 );
141-
// returns <Complex128>
142-
143-
re = real( z );
144-
// returns ~8.75
145-
146-
im = imag( z );
147-
// returns ~10
105+
// returns <Complex128>[ ~8.75, ~10.0 ]
148106
```
149107

150108
#### zrot.ndarray( N, zx, strideX, offsetX, zy, strideY, offsetY, c, s )
@@ -154,8 +112,6 @@ Applies a plane rotation with real cosine and complex sine using alternative ind
154112
```javascript
155113
var Complex128Array = require( '@stdlib/array/complex128' );
156114
var Complex128 = require( '@stdlib/complex/float64/ctor' );
157-
var real = require( '@stdlib/complex/float64/real' );
158-
var imag = require( '@stdlib/complex/float64/imag' );
159115

160116
var zx = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
161117
var zy = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
@@ -164,22 +120,10 @@ var s = new Complex128( 0.0, 0.75 );
164120
zrot.ndarray( zx.length, zx, 1, 0, zy, 1, 0, 1.25, s );
165121

166122
var z = zy.get( 0 );
167-
// returns <Complex128>
168-
169-
var re = real( z );
170-
// returns ~-1.5
171-
172-
var im = imag( z );
173-
// returns ~0.75
123+
// returns <Complex128>[ ~-1.5, ~0.75 ]
174124

175125
z = zx.get( 0 );
176-
// returns <Complex128>
177-
178-
re = real( z );
179-
// returns ~1.25
180-
181-
im = imag( z );
182-
// returns ~2.5
126+
// returns <Complex128>[ ~1.25, ~2.5 ]
183127
```
184128

185129
The function has the following additional parameters:
@@ -192,8 +136,6 @@ While [`typed array`][mdn-typed-array] views mandate a view offset based on the
192136
```javascript
193137
var Complex128Array = require( '@stdlib/array/complex128' );
194138
var Complex128 = require( '@stdlib/complex/float64/ctor' );
195-
var real = require( '@stdlib/complex/float64/real' );
196-
var imag = require( '@stdlib/complex/float64/imag' );
197139

198140
var zx = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
199141
var zy = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
@@ -202,22 +144,10 @@ var s = new Complex128( 0.0, 0.75 );
202144
zrot.ndarray( 2, zx, 2, 1, zy, 2, 1, 1.25, s );
203145

204146
var z = zy.get( 3 );
205-
// returns <Complex128>
206-
207-
var re = real( z );
208-
// returns ~-6.0
209-
210-
var im = imag( z );
211-
// returns ~5.25
147+
// returns <Complex128>[ ~-6.0, ~5.25 ]
212148

213149
z = zx.get( 1 );
214-
// returns <Complex128>
215-
216-
re = real( z );
217-
// returns ~3.75
218-
219-
im = imag( z );
220-
// returns ~5.0
150+
// returns <Complex128>[ ~3.75, ~5.0 ]
221151
```
222152

223153
</section>

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

Lines changed: 20 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -45,32 +45,20 @@
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 );
4747
> {{alias}}( zx.length, zx, 1, zy, 1, 0.8, s );
48-
> var z = zy.get( 0 );
49-
> var re = {{alias:@stdlib/complex/float64/real}}( z )
50-
~-1.1
51-
> var im = {{alias:@stdlib/complex/float64/imag}}( z )
52-
~-0.2
53-
> z = zx.get( 0 );
54-
> re = {{alias:@stdlib/complex/float64/real}}( z )
55-
~0.8
56-
> im = {{alias:@stdlib/complex/float64/imag}}( z )
57-
~1.6
48+
> var z = zy.get( 0 )
49+
<Complex128>[ ~-1.1, ~-0.2 ]
50+
> z = zx.get( 0 )
51+
<Complex128>[ ~0.8, ~1.6 ]
5852

5953
// Advanced indexing:
6054
> zx = new {{alias:@stdlib/array/complex128}}( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
6155
> zy = new {{alias:@stdlib/array/complex128}}( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
6256
> var s = new {{alias:@stdlib/complex/float64/ctor}}( 0.3, 0.4 );
6357
> {{alias}}( 2, zx, -2, zy, 1, 0.8, s );
64-
> z = zy.get( 0 );
65-
> re = {{alias:@stdlib/complex/float64/real}}( z )
66-
~-3.9
67-
> im = {{alias:@stdlib/complex/float64/imag}}( z )
68-
~0.2
69-
> z = zx.get( 2 );
70-
> re = {{alias:@stdlib/complex/float64/real}}( z )
71-
~4.0
72-
> im = {{alias:@stdlib/complex/float64/imag}}( z )
73-
~4.8
58+
> z = zy.get( 0 )
59+
<Complex128>[ ~-3.9, ~0.2 ]
60+
> z = zx.get( 2 )
61+
<Complex128>[ ~4.0, ~4.8 ]
7462

7563
// Using typed array views:
7664
> var zx0 = new {{alias:@stdlib/array/complex128}}( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
@@ -79,16 +67,10 @@
7967
> var zy1 = new {{alias:@stdlib/array/complex128}}( zy0.buffer, zy0.BYTES_PER_ELEMENT*2 );
8068
> var s = new {{alias:@stdlib/complex/float64/ctor}}( 0.3, 0.4 );
8169
> {{alias}}( 1, zx1, 1, zy1, 1, 0.8, s );
82-
> z = zy0.get( 2 );
83-
> re = {{alias:@stdlib/complex/float64/real}}( z )
84-
~-2.5
85-
> im = {{alias:@stdlib/complex/float64/imag}}( z )
86-
~0.0
87-
> z = zx0.get( 1 );
88-
> re = {{alias:@stdlib/complex/float64/real}}( z )
89-
~2.4
90-
> im = {{alias:@stdlib/complex/float64/imag}}( z )
91-
~3.2
70+
> z = zy0.get( 2 )
71+
<Complex128>[ ~-2.5, ~0.0 ]
72+
> z = zx0.get( 1 )
73+
<Complex128>[ ~2.4, ~3.2 ]
9274

9375

9476
{{alias}}.ndarray( N, zx, strideX, offsetX, zy, strideY, offsetY, c, s )
@@ -140,32 +122,20 @@
140122
> var zy = new {{alias:@stdlib/array/complex128}}( [ 0.0, 0.0, 0.0, 0.0 ] );
141123
> var s = new {{alias:@stdlib/complex/float64/ctor}}( 0.3, 0.4 );
142124
> {{alias}}.ndarray( zx.length, zx, 1, 0, zy, 1, 0, 0.8, s );
143-
> var z = zy.get( 0 );
144-
> var re = {{alias:@stdlib/complex/float64/real}}( z )
145-
~-1.1
146-
> var im = {{alias:@stdlib/complex/float64/imag}}( z )
147-
~-0.2
148-
> z = zx.get( 0 );
149-
> re = {{alias:@stdlib/complex/float64/real}}( z )
150-
~0.8
151-
> im = {{alias:@stdlib/complex/float64/imag}}( z )
152-
~1.6
125+
> var z = zy.get( 0 )
126+
<Complex128>[ ~-1.1, ~-0.2 ]
127+
> z = zx.get( 0 )
128+
<Complex128>[ ~0.8, ~1.6 ]
153129

154130
// Advanced indexing:
155131
> zx = new {{alias:@stdlib/array/complex128}}( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
156132
> zy = new {{alias:@stdlib/array/complex128}}( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
157133
> var s = new {{alias:@stdlib/complex/float64/ctor}}( 0.3, 0.4 );
158134
> {{alias}}.ndarray( 1, zx, 2, 1, zy, 2, 1, 0.8, s );
159-
> z = zy.get( 1 );
160-
> re = {{alias:@stdlib/complex/float64/real}}( z )
161-
~-2.5
162-
> im = {{alias:@stdlib/complex/float64/imag}}( z )
163-
~0.0
164-
> z = zx.get( 1 );
165-
> re = {{alias:@stdlib/complex/float64/real}}( z )
166-
~2.4
167-
> im = {{alias:@stdlib/complex/float64/imag}}( z )
168-
~3.2
135+
> z = zy.get( 1 )
136+
<Complex128>[ ~-2.5, ~0.0 ]
137+
> z = zx.get( 1 )
138+
<Complex128>[ ~2.4, ~3.2 ]
169139

170140
See Also
171141
--------

0 commit comments

Comments
 (0)