Skip to content

Commit 969c1c2

Browse files
claudeclaude
committed
fix: correct typos and errors in blas/ext/base/dediff
Corrects documentation typos in the README and REPL help text, removes a stray argument from the C API usage example, removes an extraneous tab in the TypeScript declaration, fixes comment misspellings and a missing argument in the declaration tests, replaces duplicated argument-count test stubs, and fixes test description grammar.
1 parent e1dd43f commit 969c1c2

8 files changed

Lines changed: 34 additions & 34 deletions

File tree

‎lib/node_modules/@stdlib/blas/ext/base/dediff/README.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -59,8 +59,8 @@ The function has the following parameters:
5959
- **prepend**: a [`Float64Array`][@stdlib/array/float64] containing values to prepend after computing differences.
6060
- **strideP**: stride length for `prepend`.
6161
- **N2**: number of indexed elements to `append`.
62-
- **append**: a [`Float64Array`][@stdlib/array/float64] containing values to append after computing differences..
63-
- **strideA**: strides length for `append`.
62+
- **append**: a [`Float64Array`][@stdlib/array/float64] containing values to append after computing differences.
63+
- **strideA**: stride length for `append`.
6464
- **out**: output [`Float64Array`][@stdlib/array/float64]. Must have `N + N1 + N2 - 1` indexed elements.
6565
- **strideOut**: stride length for `out`.
6666

@@ -241,7 +241,7 @@ The function accepts the following arguments:
241241
- **strideP**: `[in] CBLAS_INT` stride length for `Prepend`.
242242
- **N2**: `[in] CBLAS_INT` number of indexed elements to append.
243243
- **Append**: `[in] double` a [`Float64Array`][@stdlib/array/float64] containing values to append after computing differences.
244-
- **strideA**: `[in] CBLAS_INT` strides length for `Append`.
244+
- **strideA**: `[in] CBLAS_INT` stride length for `Append`.
245245
- **Out**: `[out] double` output [`Float64Array`][@stdlib/array/float64]. Must have `N + N1 + N2 - 1` indexed elements.
246246
- **strideOut**: `[in] CBLAS_INT` stride length for `Out`.
247247
@@ -263,7 +263,7 @@ const double p[] = { 1.0 };
263263
const double a[] = { 11.0 };
264264
double out[] = { 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 };
265265

266-
stdlib_strided_dediff_ndarray( 5, 1, x, 1, 0, 1, p, 1, 0, 1, a, 1, 0, out, 1, 0 );
266+
stdlib_strided_dediff_ndarray( 5, x, 1, 0, 1, p, 1, 0, 1, a, 1, 0, out, 1, 0 );
267267
```
268268
269269
The function accepts the following arguments:
@@ -278,7 +278,7 @@ The function accepts the following arguments:
278278
- **offsetP**: `[in] CBLAS_INT` starting index for `Prepend`.
279279
- **N2**: `[in] CBLAS_INT` number of indexed elements to append.
280280
- **Append**: `[in] double` a [`Float64Array`][@stdlib/array/float64] containing values to append after computing differences.
281-
- **strideA**: `[in] CBLAS_INT` strides length for `Append`.
281+
- **strideA**: `[in] CBLAS_INT` stride length for `Append`.
282282
- **offsetA**: `[in] CBLAS_INT` starting index for `Append`.
283283
- **Out**: `[out] double` output [`Float64Array`][@stdlib/array/float64]. Must have `N + N1 + N2 - 1` indexed elements.
284284
- **strideOut**: `[in] CBLAS_INT` stride length for `Out`.

‎lib/node_modules/@stdlib/blas/ext/base/dediff/docs/repl.txt‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,7 @@
132132
Stride length for `Out`.
133133

134134
oo: integer
135-
Stride length for `Out`.
135+
Starting index for `Out`.
136136

137137
Returns
138138
-------

‎lib/node_modules/@stdlib/blas/ext/base/dediff/docs/types/index.d.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ interface Routine {
8282
* dediff.ndarray( x.length, x, 1, 0, 1, p, 1, 0, 1, a, 1, 0, out, 1, 0 );
8383
* // out => <Float64Array>[ 1.0, 2.0, 3.0, 4.0, 5.0, 22.0 ]
8484
*/
85-
ndarray ( N: number, x: Float64Array, strideX: number, offsetX: number, N1: number, prepend: Float64Array, strideP: number, offsetP: number, N2: number, append: Float64Array, strideA: number, offsetA: number, out: Float64Array, strideOut: number, offsetOut: number ): Float64Array;
85+
ndarray( N: number, x: Float64Array, strideX: number, offsetX: number, N1: number, prepend: Float64Array, strideP: number, offsetP: number, N2: number, append: Float64Array, strideA: number, offsetA: number, out: Float64Array, strideOut: number, offsetOut: number ): Float64Array;
8686
}
8787

8888
/**

‎lib/node_modules/@stdlib/blas/ext/base/dediff/docs/types/test.ts‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,7 @@ import dediff = require( './index' );
149149
dediff( x.length, x, 1, 1, p, 1, ( x: number ): number => x, a, 1, out, 1 ); // $ExpectError
150150
}
151151

152-
// The compiler throws an error if the function is provided an eigth argument which is not a Float64Array...
152+
// The compiler throws an error if the function is provided an eighth argument which is not a Float64Array...
153153
{
154154
const x = new Float64Array( 10 );
155155
const p = new Float64Array( 1 );
@@ -243,7 +243,7 @@ import dediff = require( './index' );
243243
const a = new Float64Array( 1 );
244244
const out = new Float64Array( 11 );
245245

246-
dediff.ndarray( x.length, x, 1, 0, 1, p, 1, 0, 1, a, 1, 0, out, 1 ); // $ExpectType Float64Array
246+
dediff.ndarray( x.length, x, 1, 0, 1, p, 1, 0, 1, a, 1, 0, out, 1, 0 ); // $ExpectType Float64Array
247247
}
248248

249249
// The compiler throws an error if the `ndarray` method is provided a first argument which is not a number...
@@ -364,7 +364,7 @@ import dediff = require( './index' );
364364
dediff.ndarray( x.length, x, 1, 0, 1, p, ( x: number ): number => x, 0, 1, a, 1, 0, out, 1, 0 ); // $ExpectError
365365
}
366366

367-
// The compiler throws an error if the `ndarray` method is provided an eigth argument which is not a number...
367+
// The compiler throws an error if the `ndarray` method is provided an eighth argument which is not a number...
368368
{
369369
const x = new Float64Array( 10 );
370370
const p = new Float64Array( 1 );
@@ -431,7 +431,7 @@ import dediff = require( './index' );
431431
dediff.ndarray( x.length, x, 1, 0, 1, p, 1, 0, 1, a, ( x: number ): number => x, 0, out, 1, 0 ); // $ExpectError
432432
}
433433

434-
// The compiler throws an error if the `ndarray` method is provided a twelveth argument which is not a number...
434+
// The compiler throws an error if the `ndarray` method is provided a twelfth argument which is not a number...
435435
{
436436
const x = new Float64Array( 10 );
437437
const p = new Float64Array( 1 );
@@ -509,15 +509,15 @@ import dediff = require( './index' );
509509
dediff.ndarray( x.length ); // $ExpectError
510510
dediff.ndarray( x.length, x ); // $ExpectError
511511
dediff.ndarray( x.length, x, 1 ); // $ExpectError
512-
dediff.ndarray( x.length, x, 1 ); // $ExpectError
512+
dediff.ndarray( x.length, x, 1, 0 ); // $ExpectError
513513
dediff.ndarray( x.length, x, 1, 0, 1 ); // $ExpectError
514514
dediff.ndarray( x.length, x, 1, 0, 1, p ); // $ExpectError
515515
dediff.ndarray( x.length, x, 1, 0, 1, p, 1 ); // $ExpectError
516-
dediff.ndarray( x.length, x, 1, 0, 1, p, 1 ); // $ExpectError
516+
dediff.ndarray( x.length, x, 1, 0, 1, p, 1, 0 ); // $ExpectError
517517
dediff.ndarray( x.length, x, 1, 0, 1, p, 1, 0, 1 ); // $ExpectError
518518
dediff.ndarray( x.length, x, 1, 0, 1, p, 1, 0, 1, a ); // $ExpectError
519519
dediff.ndarray( x.length, x, 1, 0, 1, p, 1, 0, 1, a, 1 ); // $ExpectError
520-
dediff.ndarray( x.length, x, 1, 0, 1, p, 1, 0, 1, a, 1 ); // $ExpectError
520+
dediff.ndarray( x.length, x, 1, 0, 1, p, 1, 0, 1, a, 1, 0 ); // $ExpectError
521521
dediff.ndarray( x.length, x, 1, 0, 1, p, 1, 0, 1, a, 1, 0, out ); // $ExpectError
522522
dediff.ndarray( x.length, x, 1, 0, 1, p, 1, 0, 1, a, 1, 0, out, 1 ); // $ExpectError
523523
dediff.ndarray( x.length, x, 1, 0, 1, p, 1, 0, 1, a, 1, 0, out, 1, 0, {} ); // $ExpectError

‎lib/node_modules/@stdlib/blas/ext/base/dediff/test/test.dediff.js‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ tape( 'the function has an arity of 11', function test( t ) {
3838
t.end();
3939
});
4040

41-
tape( 'the function calculate differences between consecutive elements of a double-precision floating-point strided array', function test( t ) {
41+
tape( 'the function calculates differences between consecutive elements of a double-precision floating-point strided array', function test( t ) {
4242
var expected;
4343
var out;
4444
var x;
@@ -63,7 +63,7 @@ tape( 'the function calculate differences between consecutive elements of a doub
6363
35.0
6464
]);
6565
t.deepEqual( o, expected, 'returns expected value' );
66-
t.strictEqual( out, o, 'return expected value' );
66+
t.strictEqual( out, o, 'returns expected value' );
6767

6868
t.end();
6969
});
@@ -93,7 +93,7 @@ tape( 'if the sum of the `N`, `N1`, and `N2` parameters is less than or equal to
9393
0.0
9494
]);
9595
t.deepEqual( o, expected, 'returns expected value' );
96-
t.strictEqual( out, o, 'return expected value' );
96+
t.strictEqual( out, o, 'returns expected value' );
9797

9898
t.end();
9999
});
@@ -126,7 +126,7 @@ tape( 'the function supports stride parameters', function test( t ) {
126126
45.0
127127
]);
128128
t.deepEqual( o, expected, 'returns expected value' );
129-
t.strictEqual( out, o, 'return expected value' );
129+
t.strictEqual( out, o, 'returns expected value' );
130130

131131
t.end();
132132
});
@@ -159,7 +159,7 @@ tape( 'the function supports negative stride parameters', function test( t ) {
159159
25.0
160160
]);
161161
t.deepEqual( o, expected, 'returns expected value' );
162-
t.strictEqual( out, o, 'return expected value' );
162+
t.strictEqual( out, o, 'returns expected value' );
163163

164164
t.end();
165165
});

‎lib/node_modules/@stdlib/blas/ext/base/dediff/test/test.dediff.native.js‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ tape( 'the function has an arity of 11', opts, function test( t ) {
4747
t.end();
4848
});
4949

50-
tape( 'the function calculate differences between consecutive elements of a double-precision floating-point strided array', opts, function test( t ) {
50+
tape( 'the function calculates differences between consecutive elements of a double-precision floating-point strided array', opts, function test( t ) {
5151
var expected;
5252
var out;
5353
var x;
@@ -72,7 +72,7 @@ tape( 'the function calculate differences between consecutive elements of a doub
7272
35.0
7373
]);
7474
t.deepEqual( o, expected, 'returns expected value' );
75-
t.strictEqual( out, o, 'return expected value' );
75+
t.strictEqual( out, o, 'returns expected value' );
7676

7777
t.end();
7878
});
@@ -102,7 +102,7 @@ tape( 'if the sum of the `N`, `N1`, and `N2` parameters is less than or equal to
102102
0.0
103103
]);
104104
t.deepEqual( o, expected, 'returns expected value' );
105-
t.strictEqual( out, o, 'return expected value' );
105+
t.strictEqual( out, o, 'returns expected value' );
106106

107107
t.end();
108108
});
@@ -135,7 +135,7 @@ tape( 'the function supports stride parameters', opts, function test( t ) {
135135
45.0
136136
]);
137137
t.deepEqual( o, expected, 'returns expected value' );
138-
t.strictEqual( out, o, 'return expected value' );
138+
t.strictEqual( out, o, 'returns expected value' );
139139

140140
t.end();
141141
});
@@ -168,7 +168,7 @@ tape( 'the function supports negative stride parameters', opts, function test( t
168168
25.0
169169
]);
170170
t.deepEqual( o, expected, 'returns expected value' );
171-
t.strictEqual( out, o, 'return expected value' );
171+
t.strictEqual( out, o, 'returns expected value' );
172172

173173
t.end();
174174
});

‎lib/node_modules/@stdlib/blas/ext/base/dediff/test/test.ndarray.js‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ tape( 'the function has an arity of 15', function test( t ) {
3838
t.end();
3939
});
4040

41-
tape( 'the function calculate differences between consecutive elements of a double-precision floating-point strided array', function test( t ) {
41+
tape( 'the function calculates differences between consecutive elements of a double-precision floating-point strided array', function test( t ) {
4242
var expected;
4343
var out;
4444
var x;
@@ -63,7 +63,7 @@ tape( 'the function calculate differences between consecutive elements of a doub
6363
35.0
6464
]);
6565
t.deepEqual( o, expected, 'returns expected value' );
66-
t.strictEqual( out, o, 'return expected value' );
66+
t.strictEqual( out, o, 'returns expected value' );
6767

6868
t.end();
6969
});
@@ -93,7 +93,7 @@ tape( 'if the sum of the `N`, `N1`, and `N2` parameters is less than or equal to
9393
0.0
9494
]);
9595
t.deepEqual( o, expected, 'returns expected value' );
96-
t.strictEqual( out, o, 'return expected value' );
96+
t.strictEqual( out, o, 'returns expected value' );
9797

9898
t.end();
9999
});
@@ -126,7 +126,7 @@ tape( 'the function supports stride parameters', function test( t ) {
126126
45.0
127127
]);
128128
t.deepEqual( o, expected, 'returns expected value' );
129-
t.strictEqual( out, o, 'return expected value' );
129+
t.strictEqual( out, o, 'returns expected value' );
130130

131131
t.end();
132132
});
@@ -159,7 +159,7 @@ tape( 'the function supports negative stride parameters', function test( t ) {
159159
25.0
160160
]);
161161
t.deepEqual( o, expected, 'returns expected value' );
162-
t.strictEqual( out, o, 'return expected value' );
162+
t.strictEqual( out, o, 'returns expected value' );
163163

164164
t.end();
165165
});

‎lib/node_modules/@stdlib/blas/ext/base/dediff/test/test.ndarray.native.js‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ tape( 'the function has an arity of 15', opts, function test( t ) {
4747
t.end();
4848
});
4949

50-
tape( 'the function calculate differences between consecutive elements of a double-precision floating-point strided array', opts, function test( t ) {
50+
tape( 'the function calculates differences between consecutive elements of a double-precision floating-point strided array', opts, function test( t ) {
5151
var expected;
5252
var out;
5353
var x;
@@ -72,7 +72,7 @@ tape( 'the function calculate differences between consecutive elements of a doub
7272
35.0
7373
]);
7474
t.deepEqual( o, expected, 'returns expected value' );
75-
t.strictEqual( out, o, 'return expected value' );
75+
t.strictEqual( out, o, 'returns expected value' );
7676

7777
t.end();
7878
});
@@ -102,7 +102,7 @@ tape( 'if the sum of the `N`, `N1`, and `N2` parameters is less than or equal to
102102
0.0
103103
]);
104104
t.deepEqual( o, expected, 'returns expected value' );
105-
t.strictEqual( out, o, 'return expected value' );
105+
t.strictEqual( out, o, 'returns expected value' );
106106

107107
t.end();
108108
});
@@ -135,7 +135,7 @@ tape( 'the function supports stride parameters', opts, function test( t ) {
135135
45.0
136136
]);
137137
t.deepEqual( o, expected, 'returns expected value' );
138-
t.strictEqual( out, o, 'return expected value' );
138+
t.strictEqual( out, o, 'returns expected value' );
139139

140140
t.end();
141141
});
@@ -168,7 +168,7 @@ tape( 'the function supports negative stride parameters', opts, function test( t
168168
25.0
169169
]);
170170
t.deepEqual( o, expected, 'returns expected value' );
171-
t.strictEqual( out, o, 'return expected value' );
171+
t.strictEqual( out, o, 'returns expected value' );
172172

173173
t.end();
174174
});

0 commit comments

Comments
 (0)