refactor: add workspace

Author: headlessNode

lib/node_modules/@stdlib/blas/ext/base/glast-index-of-row/README.md

@@ -36,7 +36,7 @@ limitations under the License.
 var glastIndexOfRow = require( '@stdlib/blas/ext/base/glast-index-of-row' );
 ```
 
-#### glastIndexOfRow( order, M, N, A, LDA, x, strideX )
+#### glastIndexOfRow( order, M, N, A, LDA, x, strideX, workspace, strideW )
 
 Returns the index of the last row in an input matrix which has the same elements as a provided search vector.
 
@@ -51,7 +51,8 @@ Returns the index of the last row in an input matrix which has the same elements
 var A = [ 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ];
 
 var x = [ 3.0, 4.0 ];
-var out = glastIndexOfRow( 'row-major', 3, 2, A, 2, x, 1 );
+var workspace = [ 0, 0, 0 ];
+var out = glastIndexOfRow( 'row-major', 3, 2, A, 2, x, 1, workspace, 1 );
 // returns 2
 ```
 
@@ -64,14 +65,35 @@ The function has the following parameters:
 -   **LDA**: stride length for the first dimension of `A` (a.k.a., leading dimension of the matrix `A`).
 -   **x**: search vector.
 -   **strideX**: stride length for `x`.
+-   **workspace**: workspace array for tracking row match candidates. This parameter is ignored if the input matrix is stored in row-major order.
+-   **strideW**: stride length for `workspace`.
+
+When an input matrix is stored in row-major order, the workspace parameter is ignored, and, thus, one may provide an empty workspace array.
+
+```javascript
+/*
+    A = [
+        [ 1.0, 2.0 ],
+        [ 3.0, 4.0 ],
+        [ 3.0, 4.0 ]
+    ]
+*/
+var A = [ 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ];
+
+var x = [ 3.0, 4.0 ];
+var workspace = [];
+var out = glastIndexOfRow( 'row-major', 3, 2, A, 2, x, 1, workspace, 1 );
+// returns 2
+```
 
 If the function is unable to find a matching row, the function returns `-1`.
 
 ```javascript
 var A = [ 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ];
 
 var x = [ -3.0, -4.0 ];
-var out = glastIndexOfRow( 'row-major', 3, 2, A, 2, x, 1 );
+var workspace = [ 0, 0, 0 ];
+var out = glastIndexOfRow( 'row-major', 3, 2, A, 2, x, 1, workspace, 1 );
 // returns -1
 ```
 
@@ -90,13 +112,14 @@ var x0 = new Float64Array( [ 9999.0, 3.0, 4.0 ] );
 var A1 = new Float64Array( A0.buffer, A0.BYTES_PER_ELEMENT*1 ); // start at 2nd element
 var x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element
 
-var out = glastIndexOfRow( 'row-major', 3, 2, A1, 2, x1, 1 );
+var workspace = [ 0, 0, 0 ];
+var out = glastIndexOfRow( 'row-major', 3, 2, A1, 2, x1, 1, workspace, 1 );
 // returns 1
 ```
 
 <!-- lint disable maximum-heading-length -->
 
-#### glastIndexOfRow.ndarray( M, N, A, strideA1, strideA2, offsetA, x, strideX, offsetX )
+#### glastIndexOfRow.ndarray( M, N, A, strideA1, strideA2, offsetA, x, strideX, offsetX, workspace, strideW, offsetW )
 
 <!-- lint enable maximum-heading-length -->
 
@@ -113,7 +136,8 @@ Returns the index of the last row in an input matrix which has the same elements
 var A = [ 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ];
 
 var x = [ 3.0, 4.0 ];
-var out = glastIndexOfRow.ndarray( 3, 2, A, 2, 1, 0, x, 1, 0 );
+var workspace = [ 0, 0, 0 ];
+var out = glastIndexOfRow.ndarray( 3, 2, A, 2, 1, 0, x, 1, 0, workspace, 1, 0 );
 // returns 2
 ```
 
@@ -128,6 +152,27 @@ The function has the following parameters:
 -   **x**: search vector.
 -   **strideX**: stride length for `x`.
 -   **offsetX**: starting index for `x`.
+-   **workspace**: workspace array for tracking row match candidates. This parameter is ignored if the input matrix is stored in row-major order.
+-   **strideW**: stride length for `workspace`.
+-   **offsetW**: starting index for `workspace`.
+
+When an input matrix is stored in row-major order, the workspace parameter is ignored, and, thus, one may provide an empty workspace array.
+
+```javascript
+/*
+    A = [
+        [ 1.0, 2.0 ],
+        [ 3.0, 4.0 ],
+        [ 3.0, 4.0 ]
+    ]
+*/
+var A = [ 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ];
+
+var x = [ 3.0, 4.0 ];
+var workspace = [];
+var out = glastIndexOfRow.ndarray( 3, 2, A, 2, 1, 0, x, 1, 0, workspace, 1, 0 );
+// returns 2
+```
 
 While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying buffer, offset parameters support indexing semantics based on starting indices. For example,
 
@@ -142,7 +187,8 @@ While [`typed array`][mdn-typed-array] views mandate a view offset based on the
 var A = [ 9999.0, 1.0, 2.0, 3.0, 4.0, 0.0, 0.0 ];
 
 var x = [ 9999.0, 3.0, 4.0 ];
-var out = glastIndexOfRow.ndarray( 3, 2, A, 2, 1, 1, x, 1, 1 );
+var workspace = [ 0, 0, 0 ];
+var out = glastIndexOfRow.ndarray( 3, 2, A, 2, 1, 1, x, 1, 1, workspace, 1, 0 );
 // returns 1
 ```
 
@@ -185,7 +231,9 @@ console.log( ndarray2array( A, shape, strides, 0, order ) );
 var x = [ 4.0, 5.0, 6.0 ];
 console.log( x );
 
-var out = glastIndexOfRow( order, shape[ 0 ], shape[ 1 ], A, strides[ 0 ], x, 1 );
+var workspace = [ 0, 0, 0 ];
+
+var out = glastIndexOfRow( order, shape[ 0 ], shape[ 1 ], A, strides[ 0 ], x, 1, workspace, 1 );
 console.log( out );
 ```
 

lib/node_modules/@stdlib/blas/ext/base/glast-index-of-row/benchmark/benchmark.js

@@ -49,6 +49,7 @@ var LAYOUTS = [
 * @returns {Function} benchmark function
 */
 function createBenchmark( order, N ) {
+	var workspace = zeros( N, 'generic' );
 	var A = zeros( N*N, 'generic' );
 	var x = zeros( N, 'generic' );
 	return benchmark;
@@ -66,7 +67,7 @@ function createBenchmark( order, N ) {
 		b.tic();
 		for ( i = 0; i < b.iterations; i++ ) {
 			x[ N-1 ] += 1;
-			z = glastIndexOfRow( order, N, N, A, N, x, 1 );
+			z = glastIndexOfRow( order, N, N, A, N, x, 1, workspace, 1 );
 			if ( isnan( z ) ) {
 				b.fail( 'should not return NaN' );
 			}

lib/node_modules/@stdlib/blas/ext/base/glast-index-of-row/benchmark/benchmark.ndarray.js

@@ -50,6 +50,7 @@ var LAYOUTS = [
 * @returns {Function} benchmark function
 */
 function createBenchmark( order, N ) {
+	var workspace = zeros( N, 'generic' );
 	var A = zeros( N*N, 'generic' );
 	var x = zeros( N, 'generic' );
 	return benchmark;
@@ -77,7 +78,7 @@ function createBenchmark( order, N ) {
 		b.tic();
 		for ( i = 0; i < b.iterations; i++ ) {
 			x[ N-1 ] += 1;
-			z = glastIndexOfRow( N, N, A, sa1, sa2, 0, x, 1, 0 );
+			z = glastIndexOfRow( N, N, A, sa1, sa2, 0, x, 1, 0, workspace, 1, 0 );
 			if ( isnan( z ) ) {
 				b.fail( 'should not return NaN' );
 			}

lib/node_modules/@stdlib/blas/ext/base/glast-index-of-row/docs/repl.txt

@@ -1,5 +1,5 @@
 
-{{alias}}( order, M, N, A, LDA, x, strideX )
+{{alias}}( order, M, N, A, LDA, x, strideX, workspace, strideW )
     Returns the index of the last row in an input matrix which has the same
     elements as a provided search vector.
 
@@ -34,6 +34,13 @@
     strideX: integer
         Stride length for `x`.
 
+    workspace: Array|TypedArray
+        Workspace array for tracking row match candidates. This parameter is
+        ignored if the input matrix is stored in row-major order.
+
+    strideW: integer
+        Stride length for `workspace`.
+
     Returns
     -------
     out: integer
@@ -43,11 +50,12 @@
     --------
     > var A = [ 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ];
     > var x = [ 3.0, 4.0 ];
-    > {{alias}}( 'row-major', 3, 2, A, 2, x, 1 )
+    > var w = [ 0, 0, 0 ];
+    > {{alias}}( 'row-major', 3, 2, A, 2, x, 1, w, 1 )
     2
 
 
-{{alias}}.ndarray( M, N, A, strideA1, strideA2, offsetA, x, strideX, offsetX )
+{{alias}}.ndarray( M, N, A, sa1, sa2, oa, x, sx, ox, w, sw, ow )
     Returns the index of the last row in an input matrix which has the same
     elements as a provided search vector using alternative indexing semantics.
 
@@ -69,24 +77,34 @@
     A: Array|TypedArray
         Input matrix `A`.
 
-    strideA1: integer
+    sa1: integer
         Stride length for the first dimension of `A`.
 
-    strideA2: integer
+    sa2: integer
         Stride length for the second dimension of `A`.
 
-    offsetA: integer
+    oa: integer
         Starting index for `A`.
 
     x: Array|TypedArray
         Search vector.
 
-    strideX: integer
+    sx: integer
         Stride length for `x`.
 
-    offsetX: integer
+    ox: integer
         Starting index for `x`.
 
+    w: Array|TypedArray
+        Workspace array for tracking row match candidates. This parameter is
+        ignored if the input matrix is stored in row-major order.
+
+    sw: integer
+        Stride length for `w`.
+
+    ow: integer
+        Starting index for `w`.
+
     Returns
     -------
     out: integer
@@ -96,7 +114,8 @@
     --------
     > var A = [ 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ];
     > var x = [ 3.0, 4.0 ];
-    > {{alias}}.ndarray( 3, 2, A, 2, 1, 0, x, 1, 0 )
+    > var w = [ 0, 0, 0 ];
+    > {{alias}}.ndarray( 3, 2, A, 2, 1, 0, x, 1, 0, w, 1, 0 )
     2
 
     See Also

lib/node_modules/@stdlib/blas/ext/base/glast-index-of-row/docs/types/index.d.ts

@@ -28,6 +28,11 @@ import { Layout } from '@stdlib/types/blas';
 */
 type InputArray = Collection<unknown> | AccessorArrayLike<unknown>;
 
+/**
+* Workspace array.
+*/
+type WorkspaceArray = Collection<unknown> | AccessorArrayLike<unknown>;
+
 /**
 * Interface describing `glastIndexOfRow`.
 */
@@ -38,6 +43,7 @@ interface Routine {
 	* ## Notes
 	*
 	* -   If the function is provided an empty matrix or if the function is unable to find a search vector, the function returns `-1` (i.e., an invalid index).
+	* -   The `workspace` array is only applicable when an input matrix is stored in column-major order. When the matrix is stored in row-major order, the workspace array is ignored.
 	*
 	* @param order - storage layout
 	* @param M - number of rows in `A`
@@ -46,23 +52,27 @@ interface Routine {
 	* @param LDA - stride length for the first dimension of `A` (a.k.a., leading dimension of the matrix `A`)
 	* @param x - search vector
 	* @param strideX - stride length for `x`
+	* @param workspace - workspace array for tracking row match candidates
+	* @param strideW - stride length for `workspace`
 	* @returns row index
 	*
 	* @example
 	* var A = [ 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]; // => [ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 3.0, 4.0 ] ]
 	* var x = [ 3.0, 4.0 ];
+	* var workspace = [ 0, 0, 0 ];
 	*
-	* var out = glastIndexOfRow( 'row-major', 3, 2, A, 2, x, 1 );
+	* var out = glastIndexOfRow( 'row-major', 3, 2, A, 2, x, 1, workspace, 1 );
 	* // returns 2
 	*/
-	( order: Layout, M: number, N: number, A: InputArray, LDA: number, x: InputArray, strideX: number ): number;
+	( order: Layout, M: number, N: number, A: InputArray, LDA: number, x: InputArray, strideX: number, workspace: WorkspaceArray, strideW: number ): number;
 
 	/**
 	* Returns the index of the last row in an input matrix which has the same elements as a provided search vector using alternative indexing semantics.
 	*
 	* ## Notes
 	*
 	* -   If the function is provided an empty matrix or if the function is unable to find a search vector, the function returns `-1` (i.e., an invalid index).
+	* -   The `workspace` array is only applicable when an input matrix is stored in column-major order. When the matrix is stored in row-major order, the workspace array is ignored.
 	*
 	* @param M - number of rows in `A`
 	* @param N - number of columns in `A`
@@ -73,16 +83,20 @@ interface Routine {
 	* @param x - search vector
 	* @param strideX - stride length for `x`
 	* @param offsetX - starting index for `x`
+	* @param workspace - workspace array for tracking row match candidates
+	* @param strideW - stride length for `workspace`
+	* @param offsetW - starting index for `workspace`
 	* @returns row index
 	*
 	* @example
 	* var A = [ 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]; // => [ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 3.0, 4.0 ] ]
 	* var x = [ 3.0, 4.0 ];
+	* var workspace = [ 0, 0, 0 ];
 	*
-	* var out = glastIndexOfRow.ndarray( 3, 2, A, 2, 1, 0, x, 1, 0 );
+	* var out = glastIndexOfRow.ndarray( 3, 2, A, 2, 1, 0, x, 1, 0, workspace, 1, 0 );
 	* // returns 2
 	*/
-	ndarray( M: number, N: number, A: InputArray, strideA1: number, strideA2: number, offsetA: number, x: InputArray, strideX: number, offsetX: number ): number;
+	ndarray( M: number, N: number, A: InputArray, strideA1: number, strideA2: number, offsetA: number, x: InputArray, strideX: number, offsetX: number, workspace: WorkspaceArray, strideW: number, offsetW: number ): number;
 }
 
 /**
@@ -91,6 +105,7 @@ interface Routine {
 * ## Notes
 *
 * -   If the function is provided an empty matrix or if the function is unable to find a search vector, the function returns `-1` (i.e., an invalid index).
+* -   The `workspace` array is only applicable when an input matrix is stored in column-major order. When the matrix is stored in row-major order, the workspace array is ignored.
 *
 * @param order - storage layout
 * @param M - number of rows in `A`
@@ -99,20 +114,24 @@ interface Routine {
 * @param LDA - stride length for the first dimension of `A` (a.k.a., leading dimension of the matrix `A`)
 * @param x - search vector
 * @param strideX - stride length for `x`
+* @param workspace - workspace array for tracking row match candidates
+* @param strideW - stride length for `workspace`
 * @returns row index
 *
 * @example
 * var A = [ 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]; // => [ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 3.0, 4.0 ] ]
 * var x = [ 3.0, 4.0 ];
+* var workspace = [ 0, 0, 0 ];
 *
-* var out = glastIndexOfRow( 'row-major', 3, 2, A, 2, x, 1 );
+* var out = glastIndexOfRow( 'row-major', 3, 2, A, 2, x, 1, workspace, 1 );
 * // returns 2
 *
 * @example
 * var A = [ 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]; // => [ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 3.0, 4.0 ] ]
 * var x = [ 3.0, 4.0 ];
+* var workspace = [ 0, 0, 0 ];
 *
-* var out = glastIndexOfRow.ndarray( 3, 2, A, 2, 1, 0, x, 1, 0 );
+* var out = glastIndexOfRow.ndarray( 3, 2, A, 2, 1, 0, x, 1, 0, workspace, 1, 0 );
 * // returns 2
 */
 declare var glastIndexOfRow: Routine;