Skip to content

Commit d23c209

Browse files
prajjwalbajpaiprajjwalbajpai
committed
docs: improve doctests for complex number instances in lapack/base/crot
--- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: passed - task: lint_package_json status: na - task: lint_repl_help status: passed - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: passed - task: lint_license_headers status: passed ---
1 parent e57055b commit d23c209

File tree

6 files changed

+46
-232
lines changed

6 files changed

+46
-232
lines changed

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

Lines changed: 10 additions & 70 deletions
Original file line numberDiff line numberDiff line change
@@ -47,22 +47,10 @@ var s = new Complex64( 0.0, 0.75 );
4747
crot( cx.length, cx, 1, cy, 1, 1.25, s );
4848

4949
var z = cy.get( 0 );
50-
// returns <Complex64>
51-
52-
var re = realf( z );
53-
// returns ~-1.5
54-
55-
var im = imagf( z );
56-
// returns ~0.75
50+
// returns <Complex64>[ ~-1.5, ~0.75 ]
5751

5852
z = cx.get( 0 );
59-
// returns <Complex64>
60-
61-
re = realf( z );
62-
// returns ~1.25
63-
64-
im = imagf( z );
65-
// returns ~2.5
53+
// returns <Complex64>[ ~1.25, ~2.5 ]
6654
```
6755

6856
The function has the following parameters:
@@ -88,22 +76,10 @@ var s = new Complex64( 0.0, 0.75 );
8876
crot( 2, cx, 2, cy, 2, 1.25, s );
8977

9078
var z = cy.get( 0 );
91-
// returns <Complex64>
92-
93-
var re = realf( z );
94-
// returns ~-1.5
95-
96-
var im = imagf( z );
97-
// returns ~0.75
79+
// returns <Complex64>[ ~-1.5, ~0.75 ]
9880

9981
z = cx.get( 0 );
100-
// returns <Complex64>
101-
102-
re = realf( z );
103-
// returns ~1.25
104-
105-
im = imagf( z );
106-
// returns ~2.5
82+
// returns <Complex64>[ ~1.25, ~2.5 ]
10783
```
10884

10985
Note that indexing is relative to the first index. To introduce an offset, use [`typed array`][mdn-typed-array] views.
@@ -129,22 +105,10 @@ var s = new Complex64( 0.0, 0.75 );
129105
crot( 2, cx1, -2, cy1, 1, 1.25, s );
130106

131107
var z = cy0.get( 2 );
132-
// returns <Complex64>
133-
134-
var re = realf( z );
135-
// returns ~-6
136-
137-
var im = imagf( z );
138-
// returns ~5.25
108+
// returns <Complex64>[ ~-6, ~5.25 ]
139109

140110
z = cx0.get( 3 );
141-
// returns <Complex64>
142-
143-
re = realf( z );
144-
// returns ~8.75
145-
146-
im = imagf( z );
147-
// returns ~10
111+
// returns <Complex64>[ ~8.75, ~10 ]
148112
```
149113

150114
#### crot.ndarray( N, cx, strideCX, offsetCX, cy, strideCY, offsetCY, c, s )
@@ -164,22 +128,10 @@ var s = new Complex64( 0.0, 0.75 );
164128
crot.ndarray( cx.length, cx, 1, 0, cy, 1, 0, 1.25, s );
165129

166130
var z = cy.get( 0 );
167-
// returns <Complex64>
168-
169-
var re = realf( z );
170-
// returns ~-1.5
171-
172-
var im = imagf( z );
173-
// returns ~0.75
131+
// returns <Complex64>[ ~-1.5, ~0.75 ]
174132

175133
z = cx.get( 0 );
176-
// returns <Complex64>
177-
178-
re = realf( z );
179-
// returns ~1.25
180-
181-
im = imagf( z );
182-
// returns ~2.5
134+
// returns <Complex64>[ ~1.25, ~2.5 ]
183135
```
184136

185137
The function has the following additional parameters:
@@ -202,22 +154,10 @@ var s = new Complex64( 0.0, 0.75 );
202154
crot.ndarray( 2, cx, 2, 1, cy, 2, 1, 1.25, s );
203155

204156
var z = cy.get( 3 );
205-
// returns <Complex64>
206-
207-
var re = realf( z );
208-
// returns ~-6.0
209-
210-
var im = imagf( z );
211-
// returns ~5.25
157+
// returns <Complex64>[ ~-6.0, ~5.25 ]
212158

213159
z = cx.get( 1 );
214-
// returns <Complex64>
215-
216-
re = realf( z );
217-
// returns ~3.75
218-
219-
im = imagf( z );
220-
// returns ~5.0
160+
// returns <Complex64>[ ~3.75, ~5.0 ]
221161
```
222162

223163
</section>

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

Lines changed: 20 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -45,32 +45,20 @@
4545
> var cy = new {{alias:@stdlib/array/complex64}}( [ 0.0, 0.0, 0.0, 0.0 ] );
4646
> var s = new {{alias:@stdlib/complex/float32/ctor}}( 0.3, 0.4 );
4747
> {{alias}}( cx.length, cx, 1, cy, 1, 0.8, s );
48-
> var z = cy.get( 0 );
49-
> var re = {{alias:@stdlib/complex/float32/real}}( z )
50-
~-1.1
51-
> var im = {{alias:@stdlib/complex/float32/imag}}( z )
52-
~-0.2
53-
> z = cx.get( 0 );
54-
> re = {{alias:@stdlib/complex/float32/real}}( z )
55-
~0.8
56-
> im = {{alias:@stdlib/complex/float32/imag}}( z )
57-
~1.6
48+
> var z = cy.get( 0 )
49+
<Complex64>[ ~-1.1, ~-0.2 ]
50+
> z = cx.get( 0 )
51+
<Complex64>[ ~0.8, ~1.6 ]
5852

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

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

9375

9476
{{alias}}.ndarray( N, cx, strideCX, offsetCX, cy, strideCY, offsetCY, c, s )
@@ -140,32 +122,20 @@
140122
> var cy = new {{alias:@stdlib/array/complex64}}( [ 0.0, 0.0, 0.0, 0.0 ] );
141123
> var s = new {{alias:@stdlib/complex/float32/ctor}}( 0.3, 0.4 );
142124
> {{alias}}.ndarray( cx.length, cx, 1, 0, cy, 1, 0, 0.8, s );
143-
> var z = cy.get( 0 );
144-
> var re = {{alias:@stdlib/complex/float32/real}}( z )
145-
~-1.1
146-
> var im = {{alias:@stdlib/complex/float32/imag}}( z )
147-
~-0.2
148-
> z = cx.get( 0 );
149-
> re = {{alias:@stdlib/complex/float32/real}}( z )
150-
~0.8
151-
> im = {{alias:@stdlib/complex/float32/imag}}( z )
152-
~1.6
125+
> var z = cy.get( 0 )
126+
<Complex64>[ ~-1.1, ~-0.2 ]
127+
> z = cx.get( 0 )
128+
<Complex64>[ ~0.8, ~1.6 ]
153129

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

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

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

Lines changed: 8 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -52,22 +52,10 @@ interface Routine {
5252
* crot( cx.length, cx, 1, cy, 1, 0.8, s );
5353
*
5454
* var z = cy.get( 0 );
55-
* // returns <Complex64>
56-
*
57-
* var re = realf( z );
58-
* // returns ~-1.1
59-
*
60-
* var im = imagf( z );
61-
* // returns ~-0.2
55+
* // returns <Complex64>[ ~-1.1, ~-0.2 ]
6256
*
6357
* z = cx.get( 0 );
64-
* // returns <Complex64>
65-
*
66-
* re = realf( z );
67-
* // returns ~0.8
68-
*
69-
* im = imagf( z );
70-
* // returns ~1.6
58+
* // returns <Complex64>[ ~0.8, ~1.6 ]
7159
*/
7260
( N: number, cx: Complex64Array, strideCX: number, cy: Complex64Array, strideCY: number, c: number, s: Complex64 ): Complex64Array;
7361

@@ -98,22 +86,10 @@ interface Routine {
9886
* crot.ndarray( cx.length, cx, 1, 0, cy, 1, 0, 0.8, s );
9987
*
10088
* var z = cy.get( 0 );
101-
* // returns <Complex64>
102-
*
103-
* var re = realf( z );
104-
* // returns ~-1.1
105-
*
106-
* var im = imagf( z );
107-
* // returns ~-0.2
89+
* // returns <Complex64>[ ~-1.1, ~-0.2 ]
10890
*
10991
* z = cx.get( 0 );
110-
* // returns <Complex64>
111-
*
112-
* re = realf( z );
113-
* // returns ~0.8
114-
*
115-
* im = imagf( z );
116-
* // returns ~1.6
92+
* // returns <Complex64>[ ~0.8, ~1.6 ]
11793
*/
11894
ndarray( N: number, cx: Complex64Array, strideCX: number, offsetCX: number, cy: Complex64Array, strideCY: number, offsetCY: number, c: number, s: Complex64 ): Complex64Array;
11995
}
@@ -143,22 +119,10 @@ interface Routine {
143119
* crot( 2, cx, 2, cy, 1, 0.8, s );
144120
*
145121
* var z = cy.get( 0 );
146-
* // returns <Complex64>
147-
*
148-
* var re = realf( z );
149-
* // returns ~-1.1
150-
*
151-
* var im = imagf( z );
152-
* // returns ~-0.2
122+
* // returns <Complex64>[ ~-1.1, ~-0.2 ]
153123
*
154124
* z = cx.get( 0 );
155-
* // returns <Complex64>
156-
*
157-
* re = realf( z );
158-
* // returns ~0.8
159-
*
160-
* im = imagf( z );
161-
* // returns ~1.6
125+
* // returns <Complex64>[ ~0.8, ~1.6 ]
162126
*
163127
* @example
164128
* var Complex64Array = require( '@stdlib/array/complex64' );
@@ -173,22 +137,10 @@ interface Routine {
173137
* crot.ndarray( 2, cx, 2, 0, cy, 1, 0, 0.8, s );
174138
*
175139
* var z = cy.get( 0 );
176-
* // returns <Complex64>
177-
*
178-
* var re = realf( z );
179-
* // returns ~-1.1
180-
*
181-
* var im = imagf( z );
182-
* // returns ~-0.2
140+
* // returns <Complex64>[ ~-1.1, ~-0.2 ]
183141
*
184142
* z = cx.get( 0 );
185-
* // returns <Complex64>
186-
*
187-
* re = realf( z );
188-
* // returns ~0.8
189-
*
190-
* im = imagf( z );
191-
* // returns ~1.6
143+
* // returns <Complex64>[ ~0.8, ~1.6 ]
192144
*/
193145
declare var crot: Routine;
194146

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

Lines changed: 2 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -51,22 +51,10 @@ var ndarray = require( './ndarray.js' );
5151
* crot( cx.length, cx, 1, cy, 1, 0.8, s );
5252
*
5353
* var z = cy.get( 0 );
54-
* // returns <Complex64>
55-
*
56-
* var re = realf( z );
57-
* // returns ~-1.1
58-
*
59-
* var im = imagf( z );
60-
* // returns ~-0.2
54+
* // returns <Complex64>[ ~-1.1, ~-0.2 ]
6155
*
6256
* z = cx.get( 0 );
63-
* // returns <Complex64>
64-
*
65-
* re = realf( z );
66-
* // returns ~0.8
67-
*
68-
* im = imagf( z );
69-
* // returns ~1.6
57+
* // returns <Complex64>[ ~0.8, ~1.6 ]
7058
*/
7159
function crot( N, cx, strideCX, cy, strideCY, c, s ) {
7260
var ix = stride2offset( N, strideCX );

0 commit comments

Comments
 (0)