test: correct typos and errors in blas/ext/base/dediff

PR-URL: #12228
Reviewed-by: Athan Reines <kgryte@gmail.com>

Author: Planeshifter

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

@@ -59,8 +59,8 @@ The function has the following parameters:
 -   **prepend**: a [`Float64Array`][@stdlib/array/float64] containing values to prepend after computing differences.
 -   **strideP**: stride length for `prepend`.
 -   **N2**: number of indexed elements to `append`.
--   **append**: a [`Float64Array`][@stdlib/array/float64] containing values to append after computing differences..
--   **strideA**: strides length for `append`.
+-   **append**: a [`Float64Array`][@stdlib/array/float64] containing values to append after computing differences.
+-   **strideA**: stride length for `append`.
 -   **out**: output [`Float64Array`][@stdlib/array/float64]. Must have `N + N1 + N2 - 1` indexed elements.
 -   **strideOut**: stride length for `out`.
 
@@ -241,7 +241,7 @@ The function accepts the following arguments:
 -   **strideP**: `[in] CBLAS_INT` stride length for `Prepend`.
 -   **N2**: `[in] CBLAS_INT` number of indexed elements to append.
 -   **Append**: `[in] double` a [`Float64Array`][@stdlib/array/float64] containing values to append after computing differences.
--   **strideA**: `[in] CBLAS_INT` strides length for `Append`.
+-   **strideA**: `[in] CBLAS_INT` stride length for `Append`.
 -   **Out**: `[out] double` output [`Float64Array`][@stdlib/array/float64]. Must have `N + N1 + N2 - 1` indexed elements.
 -   **strideOut**: `[in] CBLAS_INT` stride length for `Out`.
 
@@ -263,7 +263,7 @@ const double p[] = { 1.0 };
 const double a[] = { 11.0 };
 double out[] = { 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 };
 
-stdlib_strided_dediff_ndarray( 5, 1, x, 1, 0, 1, p, 1, 0, 1, a, 1, 0, out, 1, 0 );
+stdlib_strided_dediff_ndarray( 5, x, 1, 0, 1, p, 1, 0, 1, a, 1, 0, out, 1, 0 );
 ```
 
 The function accepts the following arguments:
@@ -278,7 +278,7 @@ The function accepts the following arguments:
 -   **offsetP**: `[in] CBLAS_INT` starting index for `Prepend`.
 -   **N2**: `[in] CBLAS_INT` number of indexed elements to append.
 -   **Append**: `[in] double` a [`Float64Array`][@stdlib/array/float64] containing values to append after computing differences.
--   **strideA**: `[in] CBLAS_INT` strides length for `Append`.
+-   **strideA**: `[in] CBLAS_INT` stride length for `Append`.
 -   **offsetA**: `[in] CBLAS_INT` starting index for `Append`.
 -   **Out**: `[out] double` output [`Float64Array`][@stdlib/array/float64]. Must have `N + N1 + N2 - 1` indexed elements.
 -   **strideOut**: `[in] CBLAS_INT` stride length for `Out`.

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

@@ -132,7 +132,7 @@
         Stride length for `Out`.
 
     oo: integer
-        Stride length for `Out`.
+        Starting index for `Out`.
 
     Returns
     -------

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

@@ -82,7 +82,7 @@ interface Routine {
 	* dediff.ndarray( x.length, x, 1, 0, 1, p, 1, 0, 1, a, 1, 0, out, 1, 0 );
 	* // out => <Float64Array>[ 1.0, 2.0, 3.0, 4.0, 5.0, 22.0 ]
 	*/
-	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;
+	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;
 }
 
 /**

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

@@ -149,7 +149,7 @@ import dediff = require( './index' );
 	dediff( x.length, x, 1, 1, p, 1, ( x: number ): number => x, a, 1, out, 1 ); // $ExpectError
 }
 
-// The compiler throws an error if the function is provided an eigth argument which is not a Float64Array...
+// The compiler throws an error if the function is provided an eighth argument which is not a Float64Array...
 {
 	const x = new Float64Array( 10 );
 	const p = new Float64Array( 1 );
@@ -243,7 +243,7 @@ import dediff = require( './index' );
 	const a = new Float64Array( 1 );
 	const out = new Float64Array( 11 );
 
-	dediff.ndarray( x.length, x, 1, 0, 1, p, 1, 0, 1, a, 1, 0, out, 1 ); // $ExpectType Float64Array
+	dediff.ndarray( x.length, x, 1, 0, 1, p, 1, 0, 1, a, 1, 0, out, 1, 0 ); // $ExpectType Float64Array
 }
 
 // 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' );
 	dediff.ndarray( x.length, x, 1, 0, 1, p, ( x: number ): number => x, 0, 1, a, 1, 0, out, 1, 0 ); // $ExpectError
 }
 
-// The compiler throws an error if the `ndarray` method is provided an eigth argument which is not a number...
+// The compiler throws an error if the `ndarray` method is provided an eighth argument which is not a number...
 {
 	const x = new Float64Array( 10 );
 	const p = new Float64Array( 1 );
@@ -431,7 +431,7 @@ import dediff = require( './index' );
 	dediff.ndarray( x.length, x, 1, 0, 1, p, 1, 0, 1, a, ( x: number ): number => x, 0, out, 1, 0 ); // $ExpectError
 }
 
-// The compiler throws an error if the `ndarray` method is provided a twelveth argument which is not a number...
+// The compiler throws an error if the `ndarray` method is provided a twelfth argument which is not a number...
 {
 	const x = new Float64Array( 10 );
 	const p = new Float64Array( 1 );
@@ -509,15 +509,15 @@ import dediff = require( './index' );
 	dediff.ndarray( x.length ); // $ExpectError
 	dediff.ndarray( x.length, x ); // $ExpectError
 	dediff.ndarray( x.length, x, 1 ); // $ExpectError
-	dediff.ndarray( x.length, x, 1 ); // $ExpectError
+	dediff.ndarray( x.length, x, 1, 0 ); // $ExpectError
 	dediff.ndarray( x.length, x, 1, 0, 1 ); // $ExpectError
 	dediff.ndarray( x.length, x, 1, 0, 1, p ); // $ExpectError
 	dediff.ndarray( x.length, x, 1, 0, 1, p, 1 ); // $ExpectError
-	dediff.ndarray( x.length, x, 1, 0, 1, p, 1 ); // $ExpectError
+	dediff.ndarray( x.length, x, 1, 0, 1, p, 1, 0 ); // $ExpectError
 	dediff.ndarray( x.length, x, 1, 0, 1, p, 1, 0, 1 ); // $ExpectError
 	dediff.ndarray( x.length, x, 1, 0, 1, p, 1, 0, 1, a ); // $ExpectError
 	dediff.ndarray( x.length, x, 1, 0, 1, p, 1, 0, 1, a, 1 ); // $ExpectError
-	dediff.ndarray( x.length, x, 1, 0, 1, p, 1, 0, 1, a, 1 ); // $ExpectError
+	dediff.ndarray( x.length, x, 1, 0, 1, p, 1, 0, 1, a, 1, 0 ); // $ExpectError
 	dediff.ndarray( x.length, x, 1, 0, 1, p, 1, 0, 1, a, 1, 0, out ); // $ExpectError
 	dediff.ndarray( x.length, x, 1, 0, 1, p, 1, 0, 1, a, 1, 0, out, 1 ); // $ExpectError
 	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

@@ -38,7 +38,7 @@ tape( 'the function has an arity of 11', function test( t ) {
 	t.end();
 });
 
-tape( 'the function calculate differences between consecutive elements of a double-precision floating-point strided array', function test( t ) {
+tape( 'the function calculates differences between consecutive elements of a double-precision floating-point strided array', function test( t ) {
 	var expected;
 	var out;
 	var x;
@@ -63,7 +63,7 @@ tape( 'the function calculate differences between consecutive elements of a doub
 		35.0
 	]);
 	t.deepEqual( o, expected, 'returns expected value' );
-	t.strictEqual( out, o, 'return expected value' );
+	t.strictEqual( out, o, 'returns expected value' );
 
 	t.end();
 });
@@ -93,7 +93,7 @@ tape( 'if the sum of the `N`, `N1`, and `N2` parameters is less than or equal to
 		0.0
 	]);
 	t.deepEqual( o, expected, 'returns expected value' );
-	t.strictEqual( out, o, 'return expected value' );
+	t.strictEqual( out, o, 'returns expected value' );
 
 	t.end();
 });
@@ -126,7 +126,7 @@ tape( 'the function supports stride parameters', function test( t ) {
 		45.0
 	]);
 	t.deepEqual( o, expected, 'returns expected value' );
-	t.strictEqual( out, o, 'return expected value' );
+	t.strictEqual( out, o, 'returns expected value' );
 
 	t.end();
 });
@@ -159,7 +159,7 @@ tape( 'the function supports negative stride parameters', function test( t ) {
 		25.0
 	]);
 	t.deepEqual( o, expected, 'returns expected value' );
-	t.strictEqual( out, o, 'return expected value' );
+	t.strictEqual( out, o, 'returns expected value' );
 
 	t.end();
 });

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

@@ -47,7 +47,7 @@ tape( 'the function has an arity of 11', opts, function test( t ) {
 	t.end();
 });
 
-tape( 'the function calculate differences between consecutive elements of a double-precision floating-point strided array', opts, function test( t ) {
+tape( 'the function calculates differences between consecutive elements of a double-precision floating-point strided array', opts, function test( t ) {
 	var expected;
 	var out;
 	var x;
@@ -72,7 +72,7 @@ tape( 'the function calculate differences between consecutive elements of a doub
 		35.0
 	]);
 	t.deepEqual( o, expected, 'returns expected value' );
-	t.strictEqual( out, o, 'return expected value' );
+	t.strictEqual( out, o, 'returns expected value' );
 
 	t.end();
 });
@@ -102,7 +102,7 @@ tape( 'if the sum of the `N`, `N1`, and `N2` parameters is less than or equal to
 		0.0
 	]);
 	t.deepEqual( o, expected, 'returns expected value' );
-	t.strictEqual( out, o, 'return expected value' );
+	t.strictEqual( out, o, 'returns expected value' );
 
 	t.end();
 });
@@ -135,7 +135,7 @@ tape( 'the function supports stride parameters', opts, function test( t ) {
 		45.0
 	]);
 	t.deepEqual( o, expected, 'returns expected value' );
-	t.strictEqual( out, o, 'return expected value' );
+	t.strictEqual( out, o, 'returns expected value' );
 
 	t.end();
 });
@@ -168,7 +168,7 @@ tape( 'the function supports negative stride parameters', opts, function test( t
 		25.0
 	]);
 	t.deepEqual( o, expected, 'returns expected value' );
-	t.strictEqual( out, o, 'return expected value' );
+	t.strictEqual( out, o, 'returns expected value' );
 
 	t.end();
 });

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

@@ -38,7 +38,7 @@ tape( 'the function has an arity of 15', function test( t ) {
 	t.end();
 });
 
-tape( 'the function calculate differences between consecutive elements of a double-precision floating-point strided array', function test( t ) {
+tape( 'the function calculates differences between consecutive elements of a double-precision floating-point strided array', function test( t ) {
 	var expected;
 	var out;
 	var x;
@@ -63,7 +63,7 @@ tape( 'the function calculate differences between consecutive elements of a doub
 		35.0
 	]);
 	t.deepEqual( o, expected, 'returns expected value' );
-	t.strictEqual( out, o, 'return expected value' );
+	t.strictEqual( out, o, 'returns expected value' );
 
 	t.end();
 });
@@ -93,7 +93,7 @@ tape( 'if the sum of the `N`, `N1`, and `N2` parameters is less than or equal to
 		0.0
 	]);
 	t.deepEqual( o, expected, 'returns expected value' );
-	t.strictEqual( out, o, 'return expected value' );
+	t.strictEqual( out, o, 'returns expected value' );
 
 	t.end();
 });
@@ -126,7 +126,7 @@ tape( 'the function supports stride parameters', function test( t ) {
 		45.0
 	]);
 	t.deepEqual( o, expected, 'returns expected value' );
-	t.strictEqual( out, o, 'return expected value' );
+	t.strictEqual( out, o, 'returns expected value' );
 
 	t.end();
 });
@@ -159,7 +159,7 @@ tape( 'the function supports negative stride parameters', function test( t ) {
 		25.0
 	]);
 	t.deepEqual( o, expected, 'returns expected value' );
-	t.strictEqual( out, o, 'return expected value' );
+	t.strictEqual( out, o, 'returns expected value' );
 
 	t.end();
 });

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

@@ -47,7 +47,7 @@ tape( 'the function has an arity of 15', opts, function test( t ) {
 	t.end();
 });
 
-tape( 'the function calculate differences between consecutive elements of a double-precision floating-point strided array', opts, function test( t ) {
+tape( 'the function calculates differences between consecutive elements of a double-precision floating-point strided array', opts, function test( t ) {
 	var expected;
 	var out;
 	var x;
@@ -72,7 +72,7 @@ tape( 'the function calculate differences between consecutive elements of a doub
 		35.0
 	]);
 	t.deepEqual( o, expected, 'returns expected value' );
-	t.strictEqual( out, o, 'return expected value' );
+	t.strictEqual( out, o, 'returns expected value' );
 
 	t.end();
 });
@@ -102,7 +102,7 @@ tape( 'if the sum of the `N`, `N1`, and `N2` parameters is less than or equal to
 		0.0
 	]);
 	t.deepEqual( o, expected, 'returns expected value' );
-	t.strictEqual( out, o, 'return expected value' );
+	t.strictEqual( out, o, 'returns expected value' );
 
 	t.end();
 });
@@ -135,7 +135,7 @@ tape( 'the function supports stride parameters', opts, function test( t ) {
 		45.0
 	]);
 	t.deepEqual( o, expected, 'returns expected value' );
-	t.strictEqual( out, o, 'return expected value' );
+	t.strictEqual( out, o, 'returns expected value' );
 
 	t.end();
 });
@@ -168,7 +168,7 @@ tape( 'the function supports negative stride parameters', opts, function test( t
 		25.0
 	]);
 	t.deepEqual( o, expected, 'returns expected value' );
-	t.strictEqual( out, o, 'return expected value' );
+	t.strictEqual( out, o, 'returns expected value' );
 
 	t.end();
 });