docs: standardize parameter description and update docs

lib/node_modules/@stdlib/blas/base/ccopy/README.md

@@ -56,7 +56,7 @@ var im = imagf( z );
 
 The function has the following parameters:
 
--   **N**: number of values to copy.
+-   **N**: number of indexed elements.
 -   **x**: input [`Complex64Array`][@stdlib/array/complex64].
 -   **strideX**: index increment for `x`.
 -   **y**: destination [`Complex64Array`][@stdlib/array/complex64].

lib/node_modules/@stdlib/blas/base/ccopy/docs/repl.txt

@@ -14,7 +14,7 @@
     Parameters
     ----------
     N: integer
-        Number of values to copy.
+        Number of indexed elements.
 
     x: Complex64Array
         Input array.
@@ -80,7 +80,7 @@
     Parameters
     ----------
     N: integer
-        Number of values to copy.
+        Number of indexed elements.
 
     x: Complex64Array
         Input array.

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

@@ -29,7 +29,7 @@ interface Routine {
 	/**
 	* Copies values from one complex single-precision floating-point vector to another complex single-precision floating-point vector.
 	*
-	* @param N - number of values to copy
+	* @param N - number of indexed elements
 	* @param x - input array
 	* @param strideX - `x` stride length
 	* @param y - output array
@@ -60,7 +60,7 @@ interface Routine {
 	/**
 	* Copies values from one complex single-precision floating-point vector to another complex single-precision floating-point vector using alternative indexing semantics.
 	*
-	* @param N - number of values to copy
+	* @param N - number of indexed elements
 	* @param x - input array
 	* @param strideX - `x` stride length
 	* @param offsetX - starting index for `x`
@@ -94,7 +94,7 @@ interface Routine {
 /**
 * Copies values from one complex single-precision floating-point vector to another complex single-precision floating-point vector.
 *
-* @param N - number of values to copy
+* @param N - number of indexed elements
 * @param x - input array
 * @param strideX - `x` stride length
 * @param y - output array

lib/node_modules/@stdlib/blas/base/ccopy/lib/ccopy.js

@@ -28,7 +28,7 @@ var reinterpret = require( '@stdlib/strided/base/reinterpret-complex64' );
 /**
 * Copies values from one complex single-precision floating-point vector to another complex single-precision floating-point vector.
 *
-* @param {PositiveInteger} N - number of values to copy
+* @param {PositiveInteger} N - number of indexed elements
 * @param {Complex64Array} x - input array
 * @param {integer} strideX - `x` stride length
 * @param {Complex64Array} y - output array

lib/node_modules/@stdlib/blas/base/ccopy/lib/ccopy.native.js

@@ -29,7 +29,7 @@ var addon = require( './../src/addon.node' );
 /**
 * Copies values from one complex single-precision floating-point vector to another complex single-precision floating-point vector.
 *
-* @param {PositiveInteger} N - number of values to copy
+* @param {PositiveInteger} N - number of indexed elements
 * @param {Complex64Array} x - input array
 * @param {integer} strideX - `x` stride length
 * @param {Complex64Array} y - output array

lib/node_modules/@stdlib/blas/base/ccopy/lib/ndarray.js

@@ -28,7 +28,7 @@ var reinterpret = require( '@stdlib/strided/base/reinterpret-complex64' );
 /**
 * Copies values from one complex single-precision floating-point vector to another complex single-precision floating-point vector.
 *
-* @param {PositiveInteger} N - number of values to copy
+* @param {PositiveInteger} N - number of indexed elements
 * @param {Complex64Array} x - input array
 * @param {integer} strideX - `x` stride length
 * @param {NonNegativeInteger} offsetX - starting `x` index

lib/node_modules/@stdlib/blas/base/ccopy/lib/ndarray.native.js

@@ -30,7 +30,7 @@ var addon = require( './../src/addon.node' );
 /**
 * Copies values from one complex single-precision floating-point vector to another complex single-precision floating-point vector.
 *
-* @param {PositiveInteger} N - number of values to copy
+* @param {PositiveInteger} N - number of indexed elements
 * @param {Complex64Array} x - input array
 * @param {integer} strideX - `x` stride length
 * @param {NonNegativeInteger} offsetX - starting `x` index

lib/node_modules/@stdlib/blas/base/ccopy/src/ccopy.c

@@ -21,7 +21,7 @@
 /**
 * Copies values from one complex single-precision floating-point vector to another complex single-precision floating-point vector.
 *
-* @param N        number of elements to copy
+* @param N        number of indexed elements
 * @param X        input array
 * @param strideX  X stride length
 * @param Y        output array

lib/node_modules/@stdlib/blas/base/ccopy/src/ccopy.f

@@ -47,7 +47,7 @@
 ! >
 ! > * We will gladly answer any questions regarding the software. If a modification is done, however, it is the responsibility of the person who modified the routine to provide support.
 !
-! @param {integer} N - number of values to copy
+! @param {integer} N - number of indexed elements
 ! @param {Array<complex>} cx - input array
 ! @param {integer} strideX - `cx` stride length
 ! @param {Array<complex>} cy - output array

lib/node_modules/@stdlib/blas/base/ccopy/src/ccopy_cblas.c

@@ -22,7 +22,7 @@
 /**
 * Copies values from one complex single-precision floating-point vector to another complex single-precision floating-point vector.
 *
-* @param N        number of elements to copy
+* @param N        number of indexed elements
 * @param X        input array
 * @param strideX  X stride length
 * @param Y        output array

lib/node_modules/@stdlib/blas/base/ccopy/src/ccopy_f.c

@@ -22,7 +22,7 @@
 /**
 * Copies values from one complex single-precision floating-point vector to another complex single-precision floating-point vector.
 *
-* @param N        number of elements to copy
+* @param N        number of indexed elements
 * @param X        input array
 * @param strideX  X stride length
 * @param Y        output array

lib/node_modules/@stdlib/blas/base/cswap/README.md

@@ -65,7 +65,7 @@ im = imagf( z );
 
 The function has the following parameters:
 
--   **N**: number of values to swap.
+-   **N**: number of indexed elements.
 -   **x**: input [`Complex64Array`][@stdlib/array/complex64].
 -   **strideX**: index increment for `x`.
 -   **y**: destination [`Complex64Array`][@stdlib/array/complex64].

lib/node_modules/@stdlib/blas/base/cswap/docs/repl.txt

@@ -13,7 +13,7 @@
     Parameters
     ----------
     N: integer
-        Number of values to swap.
+        Number of indexed elements.
 
     x: Complex64Array
         First input array.
@@ -95,7 +95,7 @@
     Parameters
     ----------
     N: integer
-        Number of values to swap.
+        Number of indexed elements.
 
     x: Complex64Array
         First input array.

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

@@ -29,7 +29,7 @@ interface Routine {
 	/**
 	* Interchanges two complex single-precision floating-point vectors.
 	*
-	* @param N - number of values to copy
+	* @param N - number of indexed elements
 	* @param x - first input array
 	* @param strideX - `x` stride length
 	* @param y - second input array
@@ -69,7 +69,7 @@ interface Routine {
 	/**
 	* Interchanges two complex single-precision floating-point vectors using alternative indexing semantics.
 	*
-	* @param N - number of values to copy
+	* @param N - number of indexed elements
 	* @param x - first input array
 	* @param strideX - `x` stride length
 	* @param offsetX - starting index for `x`
@@ -112,7 +112,7 @@ interface Routine {
 /**
 * Interchanges two complex single-precision floating-point vectors.
 *
-* @param N - number of values to copy
+* @param N - number of indexed elements
 * @param x - first input array
 * @param strideX - `x` stride length
 * @param y - second input array

lib/node_modules/@stdlib/blas/base/cswap/lib/cswap.js

@@ -28,7 +28,7 @@ var Float32Array = require( '@stdlib/array/float32' );
 /**
 * Interchanges two complex single-precision floating-point vectors.
 *
-* @param {PositiveInteger} N - number of values to swap
+* @param {PositiveInteger} N - number of indexed elements
 * @param {Complex64Array} x - first input array
 * @param {integer} strideX - `x` stride length
 * @param {Complex64Array} y - second input array

lib/node_modules/@stdlib/blas/base/cswap/lib/cswap.native.js

@@ -29,7 +29,7 @@ var addon = require( './../src/addon.node' );
 /**
 * Interchanges two complex single-precision floating-point vectors.
 *
-* @param {PositiveInteger} N - number of values to swap
+* @param {PositiveInteger} N - number of indexed elements
 * @param {Complex64Array} x - first input array
 * @param {integer} strideX - `x` stride length
 * @param {Complex64Array} y - second input array

lib/node_modules/@stdlib/blas/base/cswap/lib/ndarray.js

@@ -28,7 +28,7 @@ var Float32Array = require( '@stdlib/array/float32' );
 /**
 * Interchanges two complex single-precision floating-point vectors.
 *
-* @param {PositiveInteger} N - number of values to swap
+* @param {PositiveInteger} N - number of indexed elements
 * @param {Complex64Array} x - first input array
 * @param {integer} strideX - `x` stride length
 * @param {NonNegativeInteger} offsetX - starting `x` index

lib/node_modules/@stdlib/blas/base/cswap/lib/ndarray.native.js

@@ -29,7 +29,7 @@ var addon = require( './../src/addon.node' );
 /**
 * Interchanges two complex single-precision floating-point vectors.
 *
-* @param {PositiveInteger} N - number of values to swap
+* @param {PositiveInteger} N - number of indexed elements
 * @param {Complex64Array} x - first input array
 * @param {integer} strideX - `x` stride length
 * @param {NonNegativeInteger} offsetX - starting `x` index

lib/node_modules/@stdlib/blas/base/cswap/src/cswap.c

@@ -21,7 +21,7 @@
 /**
 * Interchanges two complex single-precision floating-point vectors.
 *
-* @param N        number of elements to swap
+* @param N        number of indexed elements
 * @param X        first input array
 * @param strideX  X stride length
 * @param Y        second input array

lib/node_modules/@stdlib/blas/base/cswap/src/cswap.f

@@ -47,7 +47,7 @@
 ! >
 ! > * We will gladly answer any questions regarding the software. If a modification is done, however, it is the responsibility of the person who modified the routine to provide support.
 !
-! @param {integer} N - number of values to swap
+! @param {integer} N - number of indexed elements
 ! @param {Array<complex>} cx - first input array
 ! @param {integer} strideX - `cx` stride length
 ! @param {Array<complex>} cy - second input array

lib/node_modules/@stdlib/blas/base/cswap/src/cswap_cblas.c

@@ -22,7 +22,7 @@
 /**
 * Interchanges two complex single-precision floating-point vectors.
 *
-* @param N        number of elements to swap
+* @param N        number of indexed elements
 * @param X        first input array
 * @param strideX  X stride length
 * @param Y        second input array

lib/node_modules/@stdlib/blas/base/cswap/src/cswap_f.c

@@ -22,7 +22,7 @@
 /**
 * Interchanges two complex single-precision floating-point vectors.
 *
-* @param N        number of elements to swap
+* @param N        number of indexed elements
 * @param X        first input array
 * @param strideX  X stride length
 * @param Y        second input array

lib/node_modules/@stdlib/blas/base/dasum/README.md

@@ -62,7 +62,7 @@ var sum = dasum( x.length, x, 1 );
 
 The function has the following parameters:
 
--   **N**: number of elements to sum.
+-   **N**: number of indexed elements.
 -   **x**: input [`Float64Array`][mdn-float64array].
 -   **stride**: index increment.
 

lib/node_modules/@stdlib/blas/base/dasum/docs/repl.txt

@@ -15,7 +15,7 @@
     Parameters
     ----------
     N: integer
-        Number of elements to sum.
+        Number of indexed elements.
 
     x: Float64Array
         Input array.
@@ -32,20 +32,17 @@
     --------
     // Standard usage:
     > var x = new {{alias:@stdlib/array/float64}}( [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0 ] );
-    > var sum = {{alias}}( x.length, x, 1 )
+    > var s = {{alias}}( x.length, x, 1 )
     15.0
 
     // Sum every other value:
-    > var N = {{alias:@stdlib/math/base/special/floor}}( x.length / 2 );
-    > var stride = 2;
-    > sum = {{alias}}( N, x, stride )
+    > s = {{alias}}( 3, x, 2 )
     9.0
 
     // Use view offset; e.g., starting at 2nd element:
     > var x0 = new {{alias:@stdlib/array/float64}}( [ 1.0, -2.0, 3.0, -4.0, 5.0, -6.0 ] );
     > var x1 = new {{alias:@stdlib/array/float64}}( x0.buffer, x0.BYTES_PER_ELEMENT*1 );
-    > N = {{alias:@stdlib/math/base/special/floor}}( x0.length / 2 );
-    > sum = {{alias}}( N, x1, stride )
+    > s = {{alias}}( 3, x1, 2 )
     12.0
 
 
@@ -59,7 +56,7 @@
     Parameters
     ----------
     N: integer
-        Number of elements to sum.
+        Number of indexed elements.
 
     x: Float64Array
         Input array.
@@ -79,12 +76,12 @@
     --------
     // Standard usage:
     > var x = new {{alias:@stdlib/array/float64}}( [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0 ] );
-    > var sum = {{alias}}.ndarray( x.length, x, 1, 0 )
+    > var s = {{alias}}.ndarray( x.length, x, 1, 0 )
     15.0
 
     // Sum the last three elements:
     > x = new {{alias:@stdlib/array/float64}}( [ 1.0, -2.0, 3.0, -4.0, 5.0, -6.0 ] );
-    > sum = {{alias}}.ndarray( 3, x, -1, x.length-1 )
+    > s = {{alias}}.ndarray( 3, x, -1, x.length-1 )
     15.0
 
     See Also

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

@@ -25,7 +25,7 @@ interface Routine {
 	/**
 	* Computes the sum of the absolute values.
 	*
-	* @param N - number of values to sum
+	* @param N - number of indexed elements
 	* @param x - input array
 	* @param stride - stride length
 	* @returns sum of absolute values
@@ -43,7 +43,7 @@ interface Routine {
 	/**
 	* Computes the sum of the absolute values using alternative indexing semantics.
 	*
-	* @param N - number of values to sum
+	* @param N - number of indexed elements
 	* @param x - input array
 	* @param stride - stride length
 	* @param offset - starting index
@@ -63,7 +63,7 @@ interface Routine {
 /**
 * Computes the sum of the absolute values.
 *
-* @param N - number of values to sum
+* @param N - number of indexed elements
 * @param x - input array
 * @param stride - stride length
 * @returns sum of absolute values

lib/node_modules/@stdlib/blas/base/dasum/lib/dasum.js

@@ -33,7 +33,7 @@ var M = 6;
 /**
 * Computes the sum of absolute values.
 *
-* @param {PositiveInteger} N - number of values to sum
+* @param {PositiveInteger} N - number of indexed elements
 * @param {Float64Array} x - input array
 * @param {PositiveInteger} stride - `x` stride length
 * @returns {number} sum

lib/node_modules/@stdlib/blas/base/dasum/lib/dasum.native.js

@@ -28,7 +28,7 @@ var addon = require( './../src/addon.node' );
 /**
 * Computes the sum of absolute values.
 *
-* @param {PositiveInteger} N - number of values to sum
+* @param {PositiveInteger} N - number of indexed elements
 * @param {Float64Array} x - input array
 * @param {PositiveInteger} stride - `x` stride length
 * @returns {number} sum

lib/node_modules/@stdlib/blas/base/dasum/lib/ndarray.js

@@ -33,7 +33,7 @@ var M = 6;
 /**
 * Computes the sum of absolute values.
 *
-* @param {PositiveInteger} N - number of values to sum
+* @param {PositiveInteger} N - number of indexed elements
 * @param {Float64Array} x - input array
 * @param {integer} stride - `x` stride length
 * @param {NonNegativeInteger} offset - starting `x` index

lib/node_modules/@stdlib/blas/base/dasum/lib/ndarray.native.js

@@ -29,7 +29,7 @@ var addon = require( './dasum.native.js' );
 /**
 * Computes the sum of absolute values.
 *
-* @param {PositiveInteger} N - number of values to sum
+* @param {PositiveInteger} N - number of indexed elements
 * @param {Float64Array} x - input array
 * @param {integer} stride - `x` stride length
 * @param {NonNegativeInteger} offset - starting `x` index

lib/node_modules/@stdlib/blas/base/dasum/src/dasum.c

@@ -22,7 +22,7 @@
 /**
 * Computes the sum of absolute values.
 *
-* @param N       number of elements to sum
+* @param N       number of indexed elements
 * @param X       input array
 * @param stride  stride length
 * @return        sum of absolute values

lib/node_modules/@stdlib/blas/base/dasum/src/dasum.f

@@ -48,7 +48,7 @@
 ! >
 ! > * We will gladly answer any questions regarding the software. If a modification is done, however, it is the responsibility of the person who modified the routine to provide support.
 !
-! @param {integer} N - number of values to sum
+! @param {integer} N - number of indexed elements
 ! @param {Array<double>} dx - input array
 ! @param {integer} stride - stride length
 ! @returns {double} sum of absolute values