Skip to content

Commit 01e7bd4

Browse files
committed
docs: add missing requires and update example code in TSDoc declarations
--- 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: na - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: na - 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 5d41e02 commit 01e7bd4

File tree

3 files changed

+26
-94
lines changed

3 files changed

+26
-94
lines changed

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,7 @@ interface Routine {
9999
*
100100
* @example
101101
* var Complex64Array = require( '@stdlib/array/complex64' );
102+
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
102103
*
103104
* var A = new Complex64Array( 4 );
104105
*
@@ -110,6 +111,7 @@ interface Routine {
110111
*
111112
* @example
112113
* var Complex64Array = require( '@stdlib/array/complex64' );
114+
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
113115
*
114116
* var A = new Complex64Array( 5 );
115117
*

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

Lines changed: 22 additions & 94 deletions
Original file line numberDiff line numberDiff line change
@@ -63,39 +63,23 @@ interface Namespace {
6363
*
6464
* @example
6565
* var Complex64Array = require( '@stdlib/array/complex64' );
66-
* var realf = require( '@stdlib/complex/float32/real' );
67-
* var imagf = require( '@stdlib/complex/float32/imag' );
6866
*
6967
* var cx = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
7068
*
7169
* ns.clacgv( 3, cx, 1 );
7270
*
7371
* var z = cx.get( 1 );
74-
* // returns <Complex64>
75-
*
76-
* var re = realf( z );
77-
* // returns 3.0
78-
*
79-
* var im = imagf( z );
80-
* // returns -4.0
72+
* // returns <Complex64>[ 3.0, -4.0 ]
8173
*
8274
* @example
8375
* var Complex64Array = require( '@stdlib/array/complex64' );
84-
* var realf = require( '@stdlib/complex/float32/real' );
85-
* var imagf = require( '@stdlib/complex/float32/imag' );
8676
*
8777
* var cx = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
8878
*
8979
* ns.clacgv.ndarray( 2, cx, 1, 1 );
9080
*
9181
* var z = cx.get( 1 );
92-
* // returns <Complex64>
93-
*
94-
* var re = realf( z );
95-
* // returns 3.0
96-
*
97-
* var im = imagf( z );
98-
* // returns -4.0
82+
* // returns <Complex64>[ 3.0, -4.0 ]
9983
*/
10084
clacgv: typeof clacgv;
10185

@@ -114,41 +98,25 @@ interface Namespace {
11498
*
11599
* @example
116100
* var Complex64Array = require( '@stdlib/array/complex64' );
117-
* var realf = require( '@stdlib/complex/float32/real' );
118-
* var imagf = require( '@stdlib/complex/float32/imag' );
119101
*
120102
* var A = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0 ] );
121103
* var B = new Complex64Array( 4 );
122104
*
123105
* ns.clacpy( 'row-major', 'all', 2, 2, A, 2, B, 2 );
124106
*
125107
* var z = B.get( 0 );
126-
* // returns <Complex64>
127-
*
128-
* var v = realf( z );
129-
* // returns 1.0
130-
*
131-
* v = imagf( z );
132-
* // returns 2.0
108+
* // returns <Complex64>[ 1.0, 2.0 ]
133109
*
134110
* @example
135111
* var Complex64Array = require( '@stdlib/array/complex64' );
136-
* var realf = require( '@stdlib/complex/float32/real' );
137-
* var imagf = require( '@stdlib/complex/float32/imag' );
138112
*
139113
* var A = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0 ] );
140114
* var B = new Complex64Array( 12 );
141115
*
142116
* ns.clacpy.ndarray( 'all', 2, 2, A, 2, 1, 1, B, 2, 1, 2 );
143117
*
144118
* var z = B.get( 2 );
145-
* // returns <Complex64>
146-
*
147-
* var v = realf( z );
148-
* // returns 3.0
149-
*
150-
* v = imagf( z );
151-
* // returns 4.0
119+
* // returns <Complex64>[ 3.0, 4.0 ]
152120
*/
153121
clacpy: typeof clacpy;
154122

@@ -167,25 +135,27 @@ interface Namespace {
167135
*
168136
* @example
169137
* var Complex64Array = require( '@stdlib/array/complex64' );
138+
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
170139
*
171140
* var A = new Complex64Array( 4 );
172141
*
173142
* var alpha = new Complex64( 1.0, 2.0 );
174143
* var beta = new Complex64( 3.0, 4.0 );
175144
*
176145
* ns.claset( 'row-major', 'all', 2, 2, alpha, beta, A, 2 );
177-
* // A => <Complex64Array>[ 1.0, 2.0, 3.0, 4.0, 3.0, 4.0, 1.0, 2.0 ]
146+
* // A => <Complex64Array>[ 3.0, 4.0, 1.0, 2.0, 1.0, 2.0, 3.0, 4.0 ]
178147
*
179148
* @example
180149
* var Complex64Array = require( '@stdlib/array/complex64' );
150+
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
181151
*
182152
* var A = new Complex64Array( 5 );
183153
*
184154
* var alpha = new Complex64( 1.0, 2.0 );
185155
* var beta = new Complex64( 3.0, 4.0 );
186156
*
187-
* ns.claset.ndarray( 'all', 2, 2, A, 2, 1, 1 );
188-
* // A => <Complex64Array>[ 0.0, 0.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0, 1.0, 2.0 ]
157+
* ns.claset.ndarray( 'all', 2, 2, alpha, beta, A, 2, 1, 1 );
158+
* // A => <Complex64Array>[ 0.0, 0.0, 3.0, 4.0, 1.0, 2.0, 1.0, 2.0, 3.0, 4.0 ]
189159
*/
190160
claset: typeof claset;
191161

@@ -555,7 +525,7 @@ interface Namespace {
555525
* var V = new Float64Array( [ 0.5, 0.5, 0.5, 0.5 ] );
556526
* var work = new Float64Array( 3 );
557527
*
558-
* ns.dlarf1f( 'row-major', 'left', 4, 3, V, 1, 1.0, C, 3, work );
528+
* var out = ns.dlarf1f( 'row-major', 'left', 4, 3, V, 1, 1.0, C, 3, work );
559529
* // returns <Float64Array>[ -4.5, -10.5, -16.5, -0.75, -1.75, -2.75, 0.25, -0.75, -1.75, 1.25, 0.25, -0.75 ]
560530
*
561531
* @example
@@ -565,7 +535,7 @@ interface Namespace {
565535
* var V = new Float64Array( [ 0.5, 0.5, 0.5, 0.5 ] );
566536
* var work = new Float64Array( 3 );
567537
*
568-
* ns.dlarf1f.ndarray( 'left', 4, 3, V, 1, 0, 1.0, C, 3, 1, 0, work, 1, 0 );
538+
* var out = ns.dlarf1f.ndarray( 'left', 4, 3, V, 1, 0, 1.0, C, 3, 1, 0, work, 1, 0 );
569539
* // returns <Float64Array>[ -4.5, -10.5, -16.5, -0.75, -1.75, -2.75, 0.25, -0.75, -1.75, 1.25, 0.25, -0.75 ]
570540
*/
571541
dlarf1f: typeof dlarf1f;
@@ -899,39 +869,23 @@ interface Namespace {
899869
*
900870
* @example
901871
* var Complex128Array = require( '@stdlib/array/complex128' );
902-
* var real = require( '@stdlib/complex/float64/real' );
903-
* var imag = require( '@stdlib/complex/float64/imag' );
904872
*
905873
* var zx = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
906874
*
907875
* ns.zlacgv( 3, zx, 1 );
908876
*
909877
* var z = zx.get( 1 );
910-
* // returns <Complex128>
911-
*
912-
* var re = real( z );
913-
* // returns 3.0
914-
*
915-
* var im = imag( z );
916-
* // returns -4.0
878+
* // returns <Complex128>[ 3.0, -4.0 ]
917879
*
918880
* @example
919881
* var Complex128Array = require( '@stdlib/array/complex128' );
920-
* var real = require( '@stdlib/complex/float64/real' );
921-
* var imag = require( '@stdlib/complex/float64/imag' );
922882
*
923883
* var zx = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
924884
*
925885
* ns.zlacgv.ndarray( 2, zx, 1, 1 );
926886
*
927887
* var z = zx.get( 1 );
928-
* // returns <Complex128>
929-
*
930-
* var re = real( z );
931-
* // returns 3.0
932-
*
933-
* var im = imag( z );
934-
* // returns -4.0
888+
* // returns <Complex128>[ 3.0, -4.0 ]
935889
*/
936890
zlacgv: typeof zlacgv;
937891

@@ -1003,25 +957,27 @@ interface Namespace {
1003957
*
1004958
* @example
1005959
* var Complex128Array = require( '@stdlib/array/complex128' );
960+
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
1006961
*
1007962
* var A = new Complex128Array( 4 );
1008963
*
1009964
* var alpha = new Complex128( 1.0, 2.0 );
1010965
* var beta = new Complex128( 3.0, 4.0 );
1011966
*
1012967
* ns.zlaset( 'row-major', 'all', 2, 2, alpha, beta, A, 2 );
1013-
* // A => <Complex128Array>[ 1.0, 2.0, 3.0, 4.0, 3.0, 4.0, 1.0, 2.0 ]
968+
* // A => <Complex128Array>[ 3.0, 4.0, 1.0, 2.0, 1.0, 2.0, 3.0, 4.0 ]
1014969
*
1015970
* @example
1016971
* var Complex128Array = require( '@stdlib/array/complex128' );
972+
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
1017973
*
1018974
* var A = new Complex128Array( 5 );
1019975
*
1020976
* var alpha = new Complex128( 1.0, 2.0 );
1021977
* var beta = new Complex128( 3.0, 4.0 );
1022978
*
1023-
* ns.zlaset.ndarray( 'all', 2, 2, A, 2, 1, 1 );
1024-
* // A => <Complex128Array>[ 0.0, 0.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0, 1.0, 2.0 ]
979+
* ns.zlaset.ndarray( 'all', 2, 2, alpha, beta, A, 2, 1, 1 );
980+
* // A => <Complex128Array>[ 0.0, 0.0, 3.0, 4.0, 1.0, 2.0, 1.0, 2.0, 3.0, 4.0 ]
1025981
*/
1026982
zlaset: typeof zlaset;
1027983

@@ -1075,8 +1031,6 @@ interface Namespace {
10751031
* @example
10761032
* var Complex128Array = require( '@stdlib/array/complex128' );
10771033
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
1078-
* var real = require( '@stdlib/complex/float64/real' );
1079-
* var imag = require( '@stdlib/complex/float64/imag' );
10801034
*
10811035
* var zx = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
10821036
* var zy = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
@@ -1085,28 +1039,14 @@ interface Namespace {
10851039
* ns.zrot( 2, zx, 2, zy, 1, 0.8, s );
10861040
*
10871041
* var z = zy.get( 0 );
1088-
* // returns <Complex128>
1089-
*
1090-
* var re = real( z );
1091-
* // returns ~-1.1
1092-
*
1093-
* var im = imag( z );
1094-
* // returns ~-0.2
1042+
* // returns <Complex128>[ ~-1.1, ~-0.2 ]
10951043
*
10961044
* z = zx.get( 0 );
1097-
* // returns <Complex128>
1098-
*
1099-
* re = real( z );
1100-
* // returns ~0.8
1101-
*
1102-
* im = imag( z );
1103-
* // returns ~1.6
1045+
* // returns <Complex128>[ ~0.8, ~1.6 ]
11041046
*
11051047
* @example
11061048
* var Complex128Array = require( '@stdlib/array/complex128' );
11071049
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
1108-
* var real = require( '@stdlib/complex/float64/real' );
1109-
* var imag = require( '@stdlib/complex/float64/imag' );
11101050
*
11111051
* var zx = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
11121052
* var zy = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
@@ -1115,22 +1055,10 @@ interface Namespace {
11151055
* ns.zrot.ndarray( 2, zx, 2, 0, zy, 1, 0, 0.8, s );
11161056
*
11171057
* var z = zy.get( 0 );
1118-
* // returns <Complex128>
1119-
*
1120-
* var re = real( z );
1121-
* // returns ~-1.1
1122-
*
1123-
* var im = imag( z );
1124-
* // returns ~-0.2
1058+
* // returns <Complex128>[ ~-1.1, ~-0.2 ]
11251059
*
11261060
* z = zx.get( 0 );
1127-
* // returns <Complex128>
1128-
*
1129-
* re = real( z );
1130-
* // returns ~0.8
1131-
*
1132-
* im = imag( z );
1133-
* // returns ~1.6
1061+
* // returns <Complex128>[ ~0.8, ~1.6 ]
11341062
*/
11351063
zrot: typeof zrot;
11361064
}

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,7 @@ interface Routine {
9999
*
100100
* @example
101101
* var Complex128Array = require( '@stdlib/array/complex128' );
102+
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
102103
*
103104
* var A = new Complex128Array( 4 );
104105
*
@@ -110,6 +111,7 @@ interface Routine {
110111
*
111112
* @example
112113
* var Complex128Array = require( '@stdlib/array/complex128' );
114+
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
113115
*
114116
* var A = new Complex128Array( 5 );
115117
*

0 commit comments

Comments
 (0)