feat: add accessor arrays support and refactor blas/ext/base/gsorthp

PR-URL: #5117
Reviewed-by: Athan Reines <[email protected]>

Author: headlessNode

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

@@ -30,9 +30,9 @@ limitations under the License.
 var gsorthp = require( '@stdlib/blas/ext/base/gsorthp' );
 ```
 
-#### gsorthp( N, order, x, stride )
+#### gsorthp( N, order, x, strideX )
 
-Sorts a strided array `x` using heapsort.
+Sorts a strided array using heapsort.
 
 ```javascript
 var x = [ 1.0, -2.0, 3.0, -4.0 ];
@@ -46,41 +46,36 @@ The function has the following parameters:
 -   **N**: number of indexed elements.
 -   **order**: sort order. If `order < 0.0`, the input strided array is sorted in **decreasing** order. If `order > 0.0`, the input strided array is sorted in **increasing** order. If `order == 0.0`, the input strided array is left unchanged.
 -   **x**: input [`Array`][mdn-array] or [`typed array`][mdn-typed-array].
--   **stride**: index increment.
+-   **strideX**: stride length.
 
-The `N` and `stride` parameters determine which elements in `x` are accessed at runtime. For example, to sort every other element
+The `N` and stride parameters determine which elements in the strided array are accessed at runtime. For example, to sort every other element:
 
 ```javascript
-var floor = require( '@stdlib/math/base/special/floor' );
-
 var x = [ 1.0, -2.0, 3.0, -4.0 ];
-var N = floor( x.length / 2 );
 
-gsorthp( N, -1.0, x, 2 );
+gsorthp( 2, -1.0, x, 2 );
 // x => [ 3.0, -2.0, 1.0, -4.0 ]
 ```
 
 Note that indexing is relative to the first index. To introduce an offset, use [`typed array`][mdn-typed-array] views.
 
 ```javascript
 var Float64Array = require( '@stdlib/array/float64' );
-var floor = require( '@stdlib/math/base/special/floor' );
 
 // Initial array...
 var x0 = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] );
 
 // Create an offset view...
 var x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element
-var N = floor( x0.length/2 );
 
 // Sort every other element...
-gsorthp( N, -1.0, x1, 2 );
+gsorthp( 2, -1.0, x1, 2 );
 // x0 => <Float64Array>[ 1.0, 4.0, 3.0, 2.0 ]
 ```
 
-#### gsorthp.ndarray( N, order, x, stride, offset )
+#### gsorthp.ndarray( N, order, x, strideX, offsetX )
 
-Sorts a strided array `x` using heapsort and alternative indexing semantics.
+Sorts a strided array using heapsort and alternative indexing semantics.
 
 ```javascript
 var x = [ 1.0, -2.0, 3.0, -4.0 ];
@@ -91,9 +86,9 @@ gsorthp.ndarray( x.length, 1.0, x, 1, 0 );
 
 The function has the following additional parameters:
 
--   **offset**: starting index.
+-   **offsetX**: starting index.
 
-While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying `buffer`, the `offset` parameter supports indexing semantics based on a starting index. For example, to access only the last three elements of `x`
+While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying buffer, the offset parameter supports indexing semantics based on a starting index. For example, to access only the last three elements:
 
 ```javascript
 var x = [ 1.0, -2.0, 3.0, -4.0, 5.0, -6.0 ];
@@ -111,6 +106,7 @@ gsorthp.ndarray( 3, 1.0, x, 1, x.length-3 );
 ## Notes
 
 -   If `N <= 0` or `order == 0.0`, both functions return `x` unchanged.
+-   Both functions support array-like objects having getter and setter accessors for array element access (e.g., [`@stdlib/array/base/accessor`][@stdlib/array/base/accessor])
 -   The algorithm distinguishes between `-0` and `+0`. When sorted in increasing order, `-0` is sorted before `+0`. When sorted in decreasing order, `-0` is sorted after `+0`.
 -   The algorithm sorts `NaN` values to the end. When sorted in increasing order, `NaN` values are sorted last. When sorted in decreasing order, `NaN` values are sorted first.
 -   The algorithm has space complexity `O(1)` and time complexity `O(N log2 N)`.
@@ -129,27 +125,12 @@ gsorthp.ndarray( 3, 1.0, x, 1, x.length-3 );
 <!-- eslint no-undef: "error" -->
 
 ```javascript
-var round = require( '@stdlib/math/base/special/round' );
-var randu = require( '@stdlib/random/base/randu' );
-var Float64Array = require( '@stdlib/array/float64' );
+var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
 var gsorthp = require( '@stdlib/blas/ext/base/gsorthp' );
 
-var rand;
-var sign;
-var x;
-var i;
-
-x = new Float64Array( 10 );
-for ( i = 0; i < x.length; i++ ) {
-    rand = round( randu()*100.0 );
-    sign = randu();
-    if ( sign < 0.5 ) {
-        sign = -1.0;
-    } else {
-        sign = 1.0;
-    }
-    x[ i ] = sign * rand;
-}
+var x = discreteUniform( 10, -100, 100, {
+    'dtype': 'float64'
+});
 console.log( x );
 
 gsorthp( x.length, -1.0, x, -1 );
@@ -197,6 +178,8 @@ console.log( x );
 
 [mdn-typed-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray
 
+[@stdlib/array/base/accessor]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/accessor
+
 [@williams:1964a]: https://doi.org/10.1145/512274.512284
 
 [@floyd:1964a]: https://doi.org/10.1145/355588.365103

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

@@ -1,9 +1,9 @@
 
-{{alias}}( N, order, x, stride )
+{{alias}}( N, order, x, strideX )
     Sorts a strided array using heapsort.
 
-    The `N` and `stride` parameters determine which elements in `x` are accessed
-    at runtime.
+    The `N` and stride parameters determine which elements in the strided array
+    are accessed at runtime.
 
     Indexing is relative to the first index. To introduce an offset, use typed
     array views.
@@ -39,8 +39,8 @@
     x: Array<number>|TypedArray
         Input array.
 
-    stride: integer
-        Index increment for `x`.
+    strideX: integer
+        Stride length.
 
     Returns
     -------
@@ -54,27 +54,26 @@
     > {{alias}}( x.length, 1, x, 1 )
     [ -4.0, -2.0, 1.0, 3.0 ]
 
-    // Using `N` and `stride` parameters:
+    // Using `N` and stride parameters:
     > x = [ 1.0, -2.0, 3.0, -4.0 ];
-    > var N = {{alias:@stdlib/math/base/special/floor}}( x.length / 2 );
-    > {{alias}}( N, -1, x, 2 )
+    > {{alias}}( 2, -1, x, 2 )
     [ 3.0, -2.0, 1.0, -4.0 ]
 
     // Using view offsets:
     > var x0 = new {{alias:@stdlib/array/float64}}( [ 1.0, -2.0, 3.0, -4.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 );
-    > {{alias}}( N, 1, x1, 2 )
+    > {{alias}}( 2, 1, x1, 2 )
     <Float64Array>[ -4.0, 3.0, -2.0 ]
     > x0
     <Float64Array>[ 1.0, -4.0, 3.0, -2.0 ]
 
-{{alias}}.ndarray( N, order, x, stride, offset )
+
+{{alias}}.ndarray( N, order, x, strideX, offsetX )
     Sorts a strided array using heapsort and alternative indexing semantics.
 
     While typed array views mandate a view offset based on the underlying
-    buffer, the `offset` parameter supports indexing semantics based on a
-    starting index.
+    buffer, the offset parameter supports indexing semantics based on a starting
+    index.
 
     Parameters
     ----------
@@ -88,11 +87,11 @@
     x: Array<number>|TypedArray
         Input array.
 
-    stride: integer
-        Index increment for `x`.
+    strideX: integer
+        Stride length.
 
-    offset: integer
-        Starting index of `x`.
+    offsetX: integer
+        Starting index.
 
     Returns
     -------
@@ -108,8 +107,7 @@
 
     // Using an index offset:
     > x = [ 1.0, -2.0, 3.0, -4.0 ];
-    > var N = {{alias:@stdlib/math/base/special/floor}}( x.length / 2 );
-    > {{alias}}.ndarray( N, 1, x, 2, 1 )
+    > {{alias}}.ndarray( 2, 1, x, 2, 1 )
     [ 1.0, -4.0, 3.0, -2.0 ]
 
     See Also

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

@@ -20,7 +20,12 @@
 
 /// <reference types="@stdlib/types"/>
 
-import { NumericArray } from '@stdlib/types/array';
+import { NumericArray, Collection, AccessorArrayLike } from '@stdlib/types/array';
+
+/**
+* Input array.
+*/
+type InputArray = NumericArray | Collection<number> | AccessorArrayLike<number>;
 
 /**
 * Interface describing `gsorthp`.
@@ -32,7 +37,7 @@ interface Routine {
 	* @param N - number of indexed elements
 	* @param order - sort order
 	* @param x - input array
-	* @param stride - stride length
+	* @param strideX - stride length
 	* @returns `x`
 	*
 	* @example
@@ -41,16 +46,16 @@ interface Routine {
 	* gsorthp( x.length, 1, x, 1 );
 	* // x => [ -4.0, -2.0, 1.0, 3.0 ]
 	*/
-	( N: number, order: number, x: NumericArray, stride: number ): NumericArray;
+	<T extends InputArray>( N: number, order: number, x: T, stride: number ): T;
 
 	/**
 	* Sorts a strided array using heapsort and alternative indexing semantics.
 	*
 	* @param N - number of indexed elements
 	* @param order - sort order
 	* @param x - input array
-	* @param stride - stride length
-	* @param offset - starting index
+	* @param strideX - stride length
+	* @param offsetX - starting index
 	* @returns `x`
 	*
 	* @example
@@ -59,7 +64,7 @@ interface Routine {
 	* gsorthp.ndarray( x.length, 1, x, 1, 0 );
 	* // x => [ -4.0, -2.0, 1.0, 3.0 ]
 	*/
-	ndarray( N: number, order: number, x: NumericArray, stride: number, offset: number ): NumericArray;
+	ndarray<T extends InputArray>( N: number, order: number, x: T, stride: number, offset: number ): T;
 }
 
 /**
@@ -68,7 +73,7 @@ interface Routine {
 * @param N - number of indexed elements
 * @param order - sort order
 * @param x - input array
-* @param stride - stride length
+* @param strideX - stride length
 * @returns `x`
 *
 * @example

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

@@ -16,6 +16,7 @@
 * limitations under the License.
 */
 
+import AccessorArray = require( '@stdlib/array/base/accessor' );
 import gsorthp = require( './index' );
 
 
@@ -25,7 +26,8 @@ import gsorthp = require( './index' );
 {
 	const x = new Float64Array( 10 );
 
-	gsorthp( x.length, 1, x, 1 ); // $ExpectType NumericArray
+	gsorthp( x.length, 1, x, 1 ); // $ExpectType Float64Array
+	gsorthp( x.length, 1, new AccessorArray( x ), 1 ); // $ExpectType AccessorArray<number>
 }
 
 // The compiler throws an error if the function is provided a first argument which is not a number...
@@ -100,7 +102,8 @@ import gsorthp = require( './index' );
 {
 	const x = new Float64Array( 10 );
 
-	gsorthp.ndarray( x.length, 1, x, 1, 0 ); // $ExpectType NumericArray
+	gsorthp.ndarray( x.length, 1, x, 1, 0 ); // $ExpectType Float64Array
+	gsorthp.ndarray( x.length, 1, new AccessorArray( x ), 1, 0 ); // $ExpectType AccessorArray<number>
 }
 
 // The compiler throws an error if the `ndarray` method is provided a first argument which is not a number...

lib/node_modules/@stdlib/blas/ext/base/gsorthp/examples/index.js

@@ -18,31 +18,12 @@
 
 'use strict';
 
-var round = require( '@stdlib/math/base/special/round' );
-var randu = require( '@stdlib/random/base/randu' );
-var Float64Array = require( '@stdlib/array/float64' );
+var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
 var gsorthp = require( './../lib' );
 
-var rand;
-var sign;
-var x;
-var i;
-
-x = new Float64Array( 10 );
-for ( i = 0; i < x.length; i++ ) {
-	if ( randu() < 0.2 ) {
-		x[ i ] = NaN;
-	} else {
-		rand = round( randu()*100.0 );
-		sign = randu();
-		if ( sign < 0.5 ) {
-			sign = -1.0;
-		} else {
-			sign = 1.0;
-		}
-		x[ i ] = sign * rand;
-	}
-}
+var x = discreteUniform( 10, -100, 100, {
+	'dtype': 'float64'
+});
 console.log( x );
 
 gsorthp( x.length, -1.0, x, -1 );