feat: add blas/ext/base/ndarray/gsorthp

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

@@ -0,0 +1,127 @@
+<!--
+
+@license Apache-2.0
+
+Copyright (c) 2025 The Stdlib Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+-->
+
+# gsorthp
+
+> Sort a one-dimensional ndarray using heapsort.
+
+<section class="intro">
+
+</section>
+
+<!-- /.intro -->
+
+<section class="usage">
+
+## Usage
+
+```javascript
+var gsorthp = require( '@stdlib/blas/ext/base/ndarray/gsorthp' );
+```
+
+#### gsorthp( arrays )
+
+Sorts a one-dimensional ndarray using heapsort.
+
+```javascript
+var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
+var ndarray2array = require( '@stdlib/ndarray/to-array' );
+var ndarray = require( '@stdlib/ndarray/base/ctor' );
+
+var xbuf = [ 1.0, -2.0, 3.0, -4.0 ];
+var x = new ndarray( 'generic', xbuf, [ 4 ], [ 1 ], 0, 'row-major' );
+
+var order = scalar2ndarray( 1.0, {
+    'dtype': 'generic'
+});
+
+var out = gsorthp( [ x, order ] );
+// returns <ndarray>
+
+var arr = ndarray2array( out );
+// returns [ -4.0, -2.0, 1.0, 3.0 ]
+```
+
+The function has the following parameters:
+
+-   **arrays**: array-like object containing a one-dimensional input ndarray and a zero-dimensional ndarray specifying the sort order.
+
+</section>
+
+<!-- /.usage -->
+
+<section class="notes">
+
+## Notes
+
+-   The input ndarray is sorted **in-place** (i.e., the input ndarray is **mutated**).
+
+</section>
+
+<!-- /.notes -->
+
+<section class="examples">
+
+## Examples
+
+<!-- eslint no-undef: "error" -->
+
+```javascript
+var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
+var ndarray = require( '@stdlib/ndarray/base/ctor' );
+var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
+var ndarray2array = require( '@stdlib/ndarray/to-array' );
+var ndarraylike2scalar = require( '@stdlib/ndarray/base/ndarraylike2scalar' );
+var gsorthp = require( '@stdlib/blas/ext/base/ndarray/gsorthp' );
+
+var xbuf = discreteUniform( 10, -100, 100, {
+    'dtype': 'generic'
+});
+var x = new ndarray( 'generic', xbuf, [ xbuf.length ], [ 1 ], 0, 'row-major' );
+console.log( ndarray2array( x ) );
+
+var order = scalar2ndarray( 1.0, {
+    'dtype': 'generic'
+});
+console.log( 'Order:', ndarraylike2scalar( order ) );
+
+gsorthp( [ x, order ] );
+console.log( ndarray2array( x ) );
+```
+
+</section>
+
+<!-- /.examples -->
+
+<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
+
+<section class="related">
+
+</section>
+
+<!-- /.related -->
+
+<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="links">
+
+</section>
+
+<!-- /.links -->

lib/node_modules/@stdlib/blas/ext/base/ndarray/gsorthp/benchmark/benchmark.js

@@ -0,0 +1,105 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2025 The Stdlib Authors.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*    http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+'use strict';
+
+// MODULES //
+
+var bench = require( '@stdlib/bench' );
+var uniform = require( '@stdlib/random/array/uniform' );
+var pow = require( '@stdlib/math/base/special/pow' );
+var ndarray = require( '@stdlib/ndarray/base/ctor' );
+var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
+var pkg = require( './../package.json' ).name;
+var gsorthp = require( './../lib' );
+
+
+// VARIABLES //
+
+var options = {
+	'dtype': 'generic'
+};
+
+
+// FUNCTIONS //
+
+/**
+* Creates a benchmark function.
+*
+* @private
+* @param {PositiveInteger} len - array length
+* @returns {Function} benchmark function
+*/
+function createBenchmark( len ) {
+	var order;
+	var xbuf;
+	var x;
+
+	xbuf = uniform( len, 0.0, 100.0, options );
+	x = new ndarray( options.dtype, xbuf, [ len ], [ 1 ], 0, 'row-major' );
+
+	order = scalar2ndarray( -1.0, options );
+
+	return benchmark;
+
+	function benchmark( b ) {
+		var out;
+		var i;
+
+		b.tic();
+		for ( i = 0; i < b.iterations; i++ ) {
+			out = gsorthp( [ x, order ] );
+			if ( out !== out ) {
+				b.fail( 'should not return NaN' );
+			}
+		}
+		b.toc();
+		if ( out !== out ) {
+			b.fail( 'should not return NaN' );
+		}
+		b.pass( 'benchmark finished' );
+		b.end();
+	}
+}
+
+
+// MAIN //
+
+/**
+* Main execution sequence.
+*
+* @private
+*/
+function main() {
+	var len;
+	var min;
+	var max;
+	var f;
+	var i;
+
+	min = 1; // 10^min
+	max = 6; // 10^max
+
+	for ( i = min; i <= max; i++ ) {
+		len = pow( 10, i );
+		f = createBenchmark( len );
+		bench( pkg+':len='+len, f );
+	}
+}
+
+main();

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

@@ -0,0 +1,35 @@
+
+{{alias}}( arrays )
+    Sorts a one-dimensional ndarray using heapsort.
+
+    The input strided array is sorted *in-place* (i.e., the input strided array
+    is *mutated*).
+
+    Parameters
+    ----------
+    arrays: ArrayLikeObject<ndarray>
+        Array-like object containing a one-dimensional input ndarray and a
+        zero-dimensional ndarray specifying the sort order.
+
+    Returns
+    -------
+    out: ndarray
+        Input ndarray.
+
+    Examples
+    --------
+    > var xbuf = [ 1.0, -2.0, 3.0, -4.0 ];
+    > var dt = 'generic';
+    > var sh = [ xbuf.length ];
+    > var sx = [ 1 ];
+    > var ox = 0;
+    > var ord = 'row-major';
+    > var x = new {{alias:@stdlib/ndarray/ctor}}( dt, xbuf, sh, sx, ox, ord );
+    > var o = {{alias:@stdlib/ndarray/from-scalar}}( 1.0 );
+    > {{alias}}( [ x, o ] )
+    <ndarray>
+    > var data = x.data
+    [ -4.0, -2.0, 1.0, 3.0 ]
+
+    See Also
+    --------

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

@@ -0,0 +1,54 @@
+/*
+* @license Apache-2.0
+*
+* Copyright (c) 2025 The Stdlib Authors.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*    http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+// TypeScript Version: 4.1
+
+/// <reference types="@stdlib/types"/>
+
+import { typedndarray } from '@stdlib/types/ndarray';
+
+/**
+* Sorts a one-dimensional ndarray using heapsort.
+*
+* @param arrays - array-like object containing a one-dimensional input ndarray and a zero-dimensional ndarray containing the sort order
+* @returns input ndarray
+*
+* @example
+* var ndarray2array = require( '@stdlib/ndarray/base/to-array' );
+* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
+* var ndarray = require( '@stdlib/ndarray/base/ctor' );
+*
+* var xbuf = [ 1.0, -2.0, 3.0, -4.0 ];
+* var x = new ndarray( 'generic', xbuf, [ 4 ], [ 1 ], 0, 'row-major' );
+*
+* var ord = scalar2ndarray( 1.0, {
+*    'dtype': 'generic'
+* });
+*
+* var out = gsorthp( [ x, ord ] );
+* // returns <ndarray>
+*
+* var arr = ndarra2array( out );
+* // returns [ -4.0, -2.0, 1.0, 3.0 ]
+*/
+declare function gsorthp<T = unknown>( arrays: [ typedndarray<T>, typedndarray<number> ] ): typedndarray<T>;
+
+
+// EXPORTS //
+
+export = gsorthp;

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

@@ -0,0 +1,64 @@
+/*
+* @license Apache-2.0
+*
+* Copyright (c) 2025 The Stdlib Authors.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*    http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+/* eslint-disable space-in-parens */
+
+import zeros = require( '@stdlib/ndarray/zeros' );
+import scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
+import gsorthp = require( './index' );
+
+
+// TESTS //
+
+// The function returns an ndarray...
+{
+	const x = zeros( [ 10 ], {
+		'dtype': 'generic'
+	});
+	const order = scalar2ndarray( 1.0, {
+		'dtype': 'generic'
+	});
+
+	gsorthp( [ x, order ] ); // $ExpectType typedndarray<number>
+}
+
+// The compiler throws an error if the function is provided a first argument which is not an array of ndarrays...
+{
+	gsorthp( '10' ); // $ExpectError
+	gsorthp( 10 ); // $ExpectError
+	gsorthp( true ); // $ExpectError
+	gsorthp( false ); // $ExpectError
+	gsorthp( null ); // $ExpectError
+	gsorthp( undefined ); // $ExpectError
+	gsorthp( [] ); // $ExpectError
+	gsorthp( {} ); // $ExpectError
+	gsorthp( ( x: number ): number => x ); // $ExpectError
+}
+
+// The compiler throws an error if the function is provided an unsupported number of arguments...
+{
+	const x = zeros( [ 10 ], {
+		'dtype': 'generic'
+	});
+	const order = scalar2ndarray( 1.0, {
+		'dtype': 'generic'
+	});
+
+	gsorthp(); // $ExpectError
+	gsorthp( [ x, order ], {} ); // $ExpectError
+}