Skip to content

Commit 4825fb0

Browse files
rreusserrreusser
committed
Fix most remaining docs
1 parent 8d4e88a commit 4825fb0

File tree

9 files changed

+118
-114
lines changed

9 files changed

+118
-114
lines changed

‎lib/node_modules/@stdlib/lapack/base/zlacpy/benchmark/benchmark.js‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@
2121
// MODULES //
2222

2323
var bench = require( '@stdlib/bench' );
24+
var Complex128Array = require( '@stdlib/array/complex128' );
2425
var uniform = require( '@stdlib/random/array/uniform' );
2526
var isnan = require( '@stdlib/math/base/assert/is-nan' );
2627
var pow = require( '@stdlib/math/base/special/pow' );
@@ -44,11 +45,11 @@ function createBenchmark( N ) {
4445
var B;
4546

4647
opts = {
47-
'dtype': 'complex128'
48+
'dtype': 'float64'
4849
};
4950

50-
A = uniform( N*N, -10.0, 10.0, opts );
51-
B = uniform( N*N, -10.0, 10.0, opts );
51+
A = new Complex128Array( uniform( 2*N*N, -10.0, 10.0, opts ) );
52+
B = new Complex128Array( uniform( 2*N*N, -10.0, 10.0, opts ) );
5253
return benchmark;
5354

5455
/**

‎lib/node_modules/@stdlib/lapack/base/zlacpy/benchmark/benchmark.ndarray.js‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@
2121
// MODULES //
2222

2323
var bench = require( '@stdlib/bench' );
24+
var Complex128Array = require( '@stdlib/array/complex128' );
2425
var uniform = require( '@stdlib/random/array/uniform' );
2526
var isnan = require( '@stdlib/math/base/assert/is-nan' );
2627
var pow = require( '@stdlib/math/base/special/pow' );
@@ -44,11 +45,11 @@ function createBenchmark( N ) {
4445
var B;
4546

4647
opts = {
47-
'dtype': 'complex128'
48+
'dtype': 'float64'
4849
};
4950

50-
A = uniform( N*N, -10.0, 10.0, opts );
51-
B = uniform( N*N, -10.0, 10.0, opts );
51+
A = new Complex128Array( uniform( 2*N*N, -10.0, 10.0, opts ) );
52+
B = new Complex128Array( uniform( 2*N*N, -10.0, 10.0, opts ) );
5253
return benchmark;
5354

5455
/**

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

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@
2121
/// <reference types="@stdlib/types"/>
2222

2323
import { Layout } from '@stdlib/types/blas';
24+
import Complex128Array from '@stdlib/array/complex128';
2425

2526
/**
2627
* Interface describing `zlacpy`.
@@ -42,11 +43,11 @@ interface Routine {
4243
* @example
4344
* var Complex128Array = require( '@stdlib/array/complex128' );
4445
*
45-
* var A = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] );
46+
* var A = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
4647
* var B = new Complex128Array( 4 );
4748
*
4849
* zlacpy( 'row-major', 'all', 2, 2, A, 2, B, 2 );
49-
* // B => <Complex128Array>[ 1.0, 2.0, 3.0, 4.0 ]
50+
* // B => <Complex128Array>
5051
*/
5152
( order: Layout, uplo: string, M: number, N: number, A: Complex128Array, LDA: number, B: Complex128Array, LDB: number ): Complex128Array;
5253

@@ -69,11 +70,11 @@ interface Routine {
6970
* @example
7071
* var Complex128Array = require( '@stdlib/array/complex128' );
7172
*
72-
* var A = new Complex128Array( [ 0.0, 1.0, 2.0, 3.0, 4.0 ] );
73-
* var B = new Complex128Array( [ 0.0, 0.0, 11.0, 312.0, 53.0, 412.0 ] );
73+
* var A = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
74+
* var B = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 11.0, 312.0, 53.0, 412.0, 24.0, 58.0, 85.0, 74.0 ] );
7475
*
7576
* zlacpy.ndarray( 'all', 2, 2, A, 2, 1, 1, B, 2, 1, 2 );
76-
* // B => <Complex128Array>[ 0.0, 0.0, 1.0, 2.0, 3.0, 4.0 ]
77+
* // B => <Complex128Array>
7778
*/
7879
ndarray( uplo: string, M: number, N: number, A: Complex128Array, strideA1: number, strideA2: number, offsetA: number, B: Complex128Array, strideB1: number, strideB2: number, offsetB: number ): Complex128Array;
7980
}
@@ -98,16 +99,16 @@ interface Routine {
9899
* var B = new Complex128Array( 4 );
99100
*
100101
* zlacpy( 'row-major', 'all', 2, 2, A, 2, B, 2 );
101-
* // B => <Complex128Array>[ 1.0, 2.0, 3.0, 4.0 ]
102+
* // B => <Complex128Array>
102103
*
103104
* @example
104105
* var Complex128Array = require( '@stdlib/array/complex128' );
105106
*
106-
* var A = new Complex128Array( [ 0.0, 1.0, 2.0, 3.0, 4.0 ] );
107-
* var B = new Complex128Array( [ 0.0, 0.0, 11.0, 312.0, 53.0, 412.0 ] );
107+
* var A = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
108+
* var B = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 11.0, 312.0, 53.0, 412.0, 24.0, 58.0, 85.0, 74.0 ] );
108109
*
109110
* zlacpy.ndarray( 'all', 2, 2, A, 2, 1, 1, B, 2, 1, 2 );
110-
* // B => <Complex128Array>[ 0.0, 0.0, 1.0, 2.0, 3.0, 4.0 ]
111+
* // B => <Complex128Array>
111112
*/
112113
declare var zlacpy: Routine;
113114

‎lib/node_modules/@stdlib/lapack/base/zlacpy/docs/types/test.ts‎

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -24,15 +24,15 @@ import Complex128Array = require( '@stdlib/array/complex128' );
2424

2525
// The function returns a Complex128Array...
2626
{
27-
const A = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] );
27+
const A = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
2828
const B = new Complex128Array( 4 );
2929

3030
zlacpy( 'row-major', 'all', 2, 2, A, 2, B, 2 ); // $ExpectType Complex128Array
3131
}
3232

3333
// The compiler throws an error if the function is provided a first argument which is not a string...
3434
{
35-
const A = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] );
35+
const A = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
3636
const B = new Complex128Array( 4 );
3737

3838
zlacpy( 5, 'all', 2, 2, A, 2, B, 2 ); // $ExpectError
@@ -47,7 +47,7 @@ import Complex128Array = require( '@stdlib/array/complex128' );
4747

4848
// The compiler throws an error if the function is provided a second argument which is not a string...
4949
{
50-
const A = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] );
50+
const A = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
5151
const B = new Complex128Array( 4 );
5252

5353
zlacpy( 'row-major', 5, 2, 2, A, 2, B, 2 ); // $ExpectError
@@ -62,7 +62,7 @@ import Complex128Array = require( '@stdlib/array/complex128' );
6262

6363
// The compiler throws an error if the function is provided a third argument which is not a number...
6464
{
65-
const A = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] );
65+
const A = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
6666
const B = new Complex128Array( 4 );
6767

6868
zlacpy( 'row-major', 'all', '5', 2, A, 2, B, 2 ); // $ExpectError
@@ -77,7 +77,7 @@ import Complex128Array = require( '@stdlib/array/complex128' );
7777

7878
// The compiler throws an error if the function is provided a fourth argument which is not a number...
7979
{
80-
const A = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] );
80+
const A = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
8181
const B = new Complex128Array( 4 );
8282

8383
zlacpy( 'row-major', 'all', 2, '5', A, 2, B, 2 ); // $ExpectError
@@ -107,7 +107,7 @@ import Complex128Array = require( '@stdlib/array/complex128' );
107107

108108
// The compiler throws an error if the function is provided a sixth argument which is not a number...
109109
{
110-
const A = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] );
110+
const A = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
111111
const B = new Complex128Array( 4 );
112112

113113
zlacpy( 'row-major', 'all', 2, 2, A, '5', B, 2 ); // $ExpectError
@@ -122,7 +122,7 @@ import Complex128Array = require( '@stdlib/array/complex128' );
122122

123123
// The compiler throws an error if the function is provided a seventh argument which is not a Complex128Array...
124124
{
125-
const A = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] );
125+
const A = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
126126

127127
zlacpy( 'row-major', 'all', 2, 2, A, 2, '5', 2 ); // $ExpectError
128128
zlacpy( 'row-major', 'all', 2, 2, A, 2, 5, 2 ); // $ExpectError
@@ -137,7 +137,7 @@ import Complex128Array = require( '@stdlib/array/complex128' );
137137

138138
// The compiler throws an error if the function is provided an eighth argument which is not a number...
139139
{
140-
const A = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] );
140+
const A = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
141141
const B = new Complex128Array( 4 );
142142

143143
zlacpy( 'row-major', 'all', 2, 2, A, 2, B, '5' ); // $ExpectError
@@ -152,7 +152,7 @@ import Complex128Array = require( '@stdlib/array/complex128' );
152152

153153
// The compiler throws an error if the function is provided an unsupported number of arguments...
154154
{
155-
const A = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] );
155+
const A = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
156156
const B = new Complex128Array( 4 );
157157

158158
zlacpy(); // $ExpectError
@@ -168,15 +168,15 @@ import Complex128Array = require( '@stdlib/array/complex128' );
168168

169169
// Attached to main export is an `ndarray` method which returns a Complex128Array...
170170
{
171-
const A = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] );
171+
const A = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
172172
const B = new Complex128Array( 4 );
173173

174174
zlacpy.ndarray( 'all', 2, 2, A, 2, 1, 0, B, 2, 1, 0 ); // $ExpectType Complex128Array
175175
}
176176

177177
// The compiler throws an error if the function is provided a first argument which is not a string...
178178
{
179-
const A = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] );
179+
const A = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
180180
const B = new Complex128Array( 4 );
181181

182182
zlacpy.ndarray( 5, 2, 2, A, 2, 1, 0, B, 2, 1, 0 ); // $ExpectError
@@ -191,7 +191,7 @@ import Complex128Array = require( '@stdlib/array/complex128' );
191191

192192
// The compiler throws an error if the function is provided a second argument which is not a number...
193193
{
194-
const A = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] );
194+
const A = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
195195
const B = new Complex128Array( 4 );
196196

197197
zlacpy.ndarray( 'all', '5', 2, A, 2, 1, 0, B, 2, 1, 0 ); // $ExpectError
@@ -206,7 +206,7 @@ import Complex128Array = require( '@stdlib/array/complex128' );
206206

207207
// The compiler throws an error if the function is provided a third argument which is not a number...
208208
{
209-
const A = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] );
209+
const A = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
210210
const B = new Complex128Array( 4 );
211211

212212
zlacpy.ndarray( 'all', 2, '5', A, 2, 1, 0, B, 2, 1, 0 ); // $ExpectError
@@ -236,7 +236,7 @@ import Complex128Array = require( '@stdlib/array/complex128' );
236236

237237
// The compiler throws an error if the function is provided a fifth argument which is not a number...
238238
{
239-
const A = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] );
239+
const A = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
240240
const B = new Complex128Array( 4 );
241241

242242
zlacpy.ndarray( 'all', 2, 2, A, '5', 1, 0, B, 2, 1, 0 ); // $ExpectError
@@ -251,7 +251,7 @@ import Complex128Array = require( '@stdlib/array/complex128' );
251251

252252
// The compiler throws an error if the function is provided a sixth argument which is not a number...
253253
{
254-
const A = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] );
254+
const A = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
255255
const B = new Complex128Array( 4 );
256256

257257
zlacpy.ndarray( 'all', 2, 2, A, 2, '5', 0, B, 2, 1, 0 ); // $ExpectError
@@ -266,7 +266,7 @@ import Complex128Array = require( '@stdlib/array/complex128' );
266266

267267
// The compiler throws an error if the function is provided a seventh argument which is not a number...
268268
{
269-
const A = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] );
269+
const A = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
270270
const B = new Complex128Array( 4 );
271271

272272
zlacpy.ndarray( 'all', 2, 2, A, 2, 1, '5', B, 2, 1, 0 ); // $ExpectError
@@ -281,7 +281,7 @@ import Complex128Array = require( '@stdlib/array/complex128' );
281281

282282
// The compiler throws an error if the function is provided an eighth argument which is not a Complex128Array...
283283
{
284-
const A = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] );
284+
const A = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
285285

286286
zlacpy.ndarray( 'all', 2, 2, A, 2, 1, 0, '5', 2, 1, 0 ); // $ExpectError
287287
zlacpy.ndarray( 'all', 2, 2, A, 2, 1, 0, 5, 2, 1, 0 ); // $ExpectError
@@ -296,7 +296,7 @@ import Complex128Array = require( '@stdlib/array/complex128' );
296296

297297
// The compiler throws an error if the function is provided a ninth argument which is not a number...
298298
{
299-
const A = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] );
299+
const A = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
300300
const B = new Complex128Array( 4 );
301301

302302
zlacpy.ndarray( 'all', 2, 2, A, 2, 1, 0, B, '5', 1, 0 ); // $ExpectError
@@ -311,7 +311,7 @@ import Complex128Array = require( '@stdlib/array/complex128' );
311311

312312
// The compiler throws an error if the function is provided a tenth argument which is not a number...
313313
{
314-
const A = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] );
314+
const A = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
315315
const B = new Complex128Array( 4 );
316316

317317
zlacpy.ndarray( 'all', 2, 2, A, 2, 1, 0, B, 2, '5', 0 ); // $ExpectError
@@ -326,7 +326,7 @@ import Complex128Array = require( '@stdlib/array/complex128' );
326326

327327
// The compiler throws an error if the function is provided an eleventh argument which is not a number...
328328
{
329-
const A = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] );
329+
const A = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
330330
const B = new Complex128Array( 4 );
331331

332332
zlacpy.ndarray( 'all', 2, 2, A, 2, 1, 0, B, 2, 1, '5' ); // $ExpectError
@@ -341,7 +341,7 @@ import Complex128Array = require( '@stdlib/array/complex128' );
341341

342342
// The compiler throws an error if the `ndarray` method is provided an unsupported number of arguments...
343343
{
344-
const A = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] );
344+
const A = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
345345
const B = new Complex128Array( 4 );
346346

347347
zlacpy.ndarray(); // $ExpectError

‎lib/node_modules/@stdlib/lapack/base/zlacpy/examples/index.js‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@
1919
'use strict';
2020

2121
var ndarray2array = require( '@stdlib/ndarray/base/to-array' );
22+
var Complex128Array = require( '@stdlib/array/complex128' );
2223
var uniform = require( '@stdlib/random/array/discrete-uniform' );
2324
var numel = require( '@stdlib/ndarray/base/numel' );
2425
var shape2strides = require( '@stdlib/ndarray/base/shape2strides' );
@@ -30,14 +31,14 @@ var strides = shape2strides( shape, order );
3031

3132
var N = numel( shape );
3233

33-
var A = uniform( N, -10, 10, {
34+
var A = new Complex128Array( uniform( 2*N, -10, 10, {
3435
'dtype': 'float64'
35-
});
36+
}));
3637
console.log( ndarray2array( A, shape, strides, 0, order ) );
3738

38-
var B = uniform( N, -10, 10, {
39+
var B = new Complex128Array( uniform( 2*N, -10, 10, {
3940
'dtype': 'float64'
40-
});
41+
}));
4142
console.log( ndarray2array( B, shape, strides, 0, order ) );
4243

4344
dlacpy( order, 'all', shape[ 0 ], shape[ 1 ], A, strides[ 0 ], B, strides[ 0 ] );

0 commit comments

Comments
 (0)