Skip to content

Commit de74169

Browse files
headlessNodekgryte
headlessNode
and
kgryte
authored
feat: add blas/ext/base/ndarray/gsort
PR-URL: #9734 Closes: stdlib-js/metr-issue-tracker#158 Co-authored-by: Athan Reines <kgryte@gmail.com> Reviewed-by: Athan Reines <kgryte@gmail.com>
1 parent 839986d commit de74169

File tree

10 files changed

+692
-0
lines changed

10 files changed

+692
-0
lines changed

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

Lines changed: 124 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,124 @@
1+
<!--
2+
3+
@license Apache-2.0
4+
5+
Copyright (c) 2026 The Stdlib Authors.
6+
7+
Licensed under the Apache License, Version 2.0 (the "License");
8+
you may not use this file except in compliance with the License.
9+
You may obtain a copy of the License at
10+
11+
http://www.apache.org/licenses/LICENSE-2.0
12+
13+
Unless required by applicable law or agreed to in writing, software
14+
distributed under the License is distributed on an "AS IS" BASIS,
15+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16+
See the License for the specific language governing permissions and
17+
limitations under the License.
18+
19+
-->
20+
21+
# gsort
22+
23+
> Sort a one-dimensional ndarray.
24+
25+
<section class="intro">
26+
27+
</section>
28+
29+
<!-- /.intro -->
30+
31+
<section class="usage">
32+
33+
## Usage
34+
35+
```javascript
36+
var gsort = require( '@stdlib/blas/ext/base/ndarray/gsort' );
37+
```
38+
39+
#### gsort( arrays )
40+
41+
Sorts a one-dimensional ndarray.
42+
43+
```javascript
44+
var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
45+
var ndarray2array = require( '@stdlib/ndarray/to-array' );
46+
var array = require( '@stdlib/ndarray/array' );
47+
48+
var x = array( [ 1.0, -2.0, 3.0, -4.0 ], {
49+
'dtype': 'generic'
50+
});
51+
52+
var order = scalar2ndarray( 1.0, {
53+
'dtype': 'generic'
54+
});
55+
56+
var out = gsort( [ x, order ] );
57+
// returns <ndarray>[ -4.0, -2.0, 1.0, 3.0 ]
58+
```
59+
60+
The function has the following parameters:
61+
62+
- **arrays**: array-like object containing a one-dimensional input ndarray and a zero-dimensional ndarray specifying the sort order.
63+
64+
</section>
65+
66+
<!-- /.usage -->
67+
68+
<section class="notes">
69+
70+
## Notes
71+
72+
- The input ndarray is sorted **in-place** (i.e., the input ndarray is **mutated**).
73+
- When the sort order is less than zero, the input ndarray is sorted in **decreasing** order. When the sort order is greater than zero, the input ndarray is sorted in **increasing** order. When the sort order is equal to zero, the input ndarray is left unchanged.
74+
75+
</section>
76+
77+
<!-- /.notes -->
78+
79+
<section class="examples">
80+
81+
## Examples
82+
83+
<!-- eslint no-undef: "error" -->
84+
85+
```javascript
86+
var uniform = require( '@stdlib/random/uniform' );
87+
var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
88+
var ndarray2array = require( '@stdlib/ndarray/to-array' );
89+
var ndarraylike2scalar = require( '@stdlib/ndarray/base/ndarraylike2scalar' );
90+
var gsort = require( '@stdlib/blas/ext/base/ndarray/gsort' );
91+
92+
var x = uniform( [ 10 ], -100, 100, {
93+
'dtype': 'generic'
94+
});
95+
console.log( ndarray2array( x ) );
96+
97+
var order = scalar2ndarray( 1.0, {
98+
'dtype': 'generic'
99+
});
100+
console.log( 'Order:', ndarraylike2scalar( order ) );
101+
102+
gsort( [ x, order ] );
103+
console.log( ndarray2array( x ) );
104+
```
105+
106+
</section>
107+
108+
<!-- /.examples -->
109+
110+
<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
111+
112+
<section class="related">
113+
114+
</section>
115+
116+
<!-- /.related -->
117+
118+
<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
119+
120+
<section class="links">
121+
122+
</section>
123+
124+
<!-- /.links -->

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

Lines changed: 111 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,111 @@
1+
/**
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2026 The Stdlib Authors.
5+
*
6+
* Licensed under the Apache License, Version 2.0 (the "License");
7+
* you may not use this file except in compliance with the License.
8+
* You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing, software
13+
* distributed under the License is distributed on an "AS IS" BASIS,
14+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
* See the License for the specific language governing permissions and
16+
* limitations under the License.
17+
*/
18+
19+
'use strict';
20+
21+
// MODULES //
22+
23+
var bench = require( '@stdlib/bench' );
24+
var uniform = require( '@stdlib/random/array/uniform' );
25+
var pow = require( '@stdlib/math/base/special/pow' );
26+
var ndarray = require( '@stdlib/ndarray/base/ctor' );
27+
var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
28+
var format = require( '@stdlib/string/format' );
29+
var pkg = require( './../package.json' ).name;
30+
var gsort = require( './../lib' );
31+
32+
33+
// VARIABLES //
34+
35+
var options = {
36+
'dtype': 'generic'
37+
};
38+
39+
40+
// FUNCTIONS //
41+
42+
/**
43+
* Creates a benchmark function.
44+
*
45+
* @private
46+
* @param {PositiveInteger} len - array length
47+
* @returns {Function} benchmark function
48+
*/
49+
function createBenchmark( len ) {
50+
var order;
51+
var xbuf;
52+
var x;
53+
54+
xbuf = uniform( len, 0.0, 100.0, options );
55+
x = new ndarray( options.dtype, xbuf, [ len ], [ 1 ], 0, 'row-major' );
56+
order = scalar2ndarray( -1.0, options );
57+
58+
return benchmark;
59+
60+
/**
61+
* Benchmark function.
62+
*
63+
* @private
64+
* @param {Benchmark} b - benchmark instance
65+
*/
66+
function benchmark( b ) {
67+
var out;
68+
var i;
69+
70+
b.tic();
71+
for ( i = 0; i < b.iterations; i++ ) {
72+
out = gsort( [ x, order ] );
73+
if ( typeof out !== 'object' ) {
74+
b.fail( 'should return an ndarray' );
75+
}
76+
}
77+
b.toc();
78+
if ( xbuf[ i%len ] !== xbuf[ i%len ] ) {
79+
b.fail( 'should not return NaN' );
80+
}
81+
b.pass( 'benchmark finished' );
82+
b.end();
83+
}
84+
}
85+
86+
87+
// MAIN //
88+
89+
/**
90+
* Main execution sequence.
91+
*
92+
* @private
93+
*/
94+
function main() {
95+
var len;
96+
var min;
97+
var max;
98+
var f;
99+
var i;
100+
101+
min = 1; // 10^min
102+
max = 6; // 10^max
103+
104+
for ( i = min; i <= max; i++ ) {
105+
len = pow( 10, i );
106+
f = createBenchmark( len );
107+
bench( format( '%s:len=%d', pkg, len ), f );
108+
}
109+
}
110+
111+
main();

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

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
2+
{{alias}}( arrays )
3+
Sorts a one-dimensional ndarray.
4+
5+
When the sort order is less than zero, the input ndarray is sorted in
6+
decreasing order. When the sort order is greater than zero, the input
7+
ndarray is sorted in increasing order. When the sort order is equal to zero,
8+
the input ndarray is left unchanged.
9+
10+
The input ndarray is sorted in-place (i.e., the input ndarray is mutated).
11+
12+
Parameters
13+
----------
14+
arrays: ArrayLikeObject<ndarray>
15+
Array-like object containing a one-dimensional input ndarray and a
16+
zero-dimensional ndarray specifying the sort order.
17+
18+
Returns
19+
-------
20+
out: ndarray
21+
Input ndarray.
22+
23+
Examples
24+
--------
25+
> var x = new {{alias:@stdlib/ndarray/array}}( [ 1.0, -2.0, 3.0, -4.0 ], { 'dtype': 'generic' } );
26+
> var o = {{alias:@stdlib/ndarray/from-scalar}}( 1.0 );
27+
> {{alias}}( [ x, o ] )
28+
<ndarray>[ -4.0, -2.0, 1.0, 3.0 ]
29+
30+
See Also
31+
--------

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

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
/*
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2026 The Stdlib Authors.
5+
*
6+
* Licensed under the Apache License, Version 2.0 (the "License");
7+
* you may not use this file except in compliance with the License.
8+
* You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing, software
13+
* distributed under the License is distributed on an "AS IS" BASIS,
14+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
* See the License for the specific language governing permissions and
16+
* limitations under the License.
17+
*/
18+
19+
// TypeScript Version: 4.1
20+
21+
/// <reference types="@stdlib/types"/>
22+
23+
import { typedndarray, genericndarray } from '@stdlib/types/ndarray';
24+
25+
/**
26+
* Sorts a one-dimensional ndarray.
27+
*
28+
* ## Notes
29+
*
30+
* - When the sort order is less than zero, the input ndarray is sorted in **decreasing** order. When the sort order is greater than zero, the input ndarray is sorted in **increasing** order. When the sort order is equal to zero, the input ndarray is left unchanged.
31+
*
32+
* @param arrays - array-like object containing a one-dimensional input ndarray and a zero-dimensional ndarray specifying the sort order
33+
* @returns input ndarray
34+
*
35+
* @example
36+
* var array = require( '@stdlib/ndarray/array' );
37+
* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
38+
*
39+
* var x = array( [ 1.0, -2.0, 3.0, -4.0 ], {
40+
* 'dtype': 'generic'
41+
* });
42+
* // returns <ndarray>[ 1.0, -2.0, 3.0, -4.0 ]
43+
*
44+
* var ord = scalar2ndarray( 1.0, {
45+
* 'dtype': 'generic'
46+
* });
47+
* // returns <ndarray>[ 1.0 ]
48+
*
49+
* var out = gsort( [ x, ord ] );
50+
* // returns <ndarray>[ -4.0, -2.0, 1.0, 3.0 ]
51+
*/
52+
declare function gsort<T extends typedndarray<unknown> | genericndarray<unknown> = typedndarray<unknown>>( arrays: [ T, typedndarray<number> ] ): T;
53+
54+
55+
// EXPORTS //
56+
57+
export = gsort;

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

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
/*
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2026 The Stdlib Authors.
5+
*
6+
* Licensed under the Apache License, Version 2.0 (the "License");
7+
* you may not use this file except in compliance with the License.
8+
* You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing, software
13+
* distributed under the License is distributed on an "AS IS" BASIS,
14+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
* See the License for the specific language governing permissions and
16+
* limitations under the License.
17+
*/
18+
19+
/* eslint-disable space-in-parens */
20+
21+
import zeros = require( '@stdlib/ndarray/zeros' );
22+
import scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
23+
import gsort = require( './index' );
24+
25+
26+
// TESTS //
27+
28+
// The function returns an ndarray...
29+
{
30+
const x = zeros( [ 10 ], {
31+
'dtype': 'generic'
32+
});
33+
const order = scalar2ndarray( 1.0, {
34+
'dtype': 'generic'
35+
});
36+
37+
gsort( [ x, order ] ); // $ExpectType genericndarray<number>
38+
}
39+
40+
// The compiler throws an error if the function is provided a first argument which is not an array of ndarrays...
41+
{
42+
gsort( '10' ); // $ExpectError
43+
gsort( 10 ); // $ExpectError
44+
gsort( true ); // $ExpectError
45+
gsort( false ); // $ExpectError
46+
gsort( null ); // $ExpectError
47+
gsort( undefined ); // $ExpectError
48+
gsort( [] ); // $ExpectError
49+
gsort( {} ); // $ExpectError
50+
gsort( ( x: number ): number => x ); // $ExpectError
51+
}
52+
53+
// The compiler throws an error if the function is provided an unsupported number of arguments...
54+
{
55+
const x = zeros( [ 10 ], {
56+
'dtype': 'generic'
57+
});
58+
const order = scalar2ndarray( 1.0, {
59+
'dtype': 'generic'
60+
});
61+
62+
gsort(); // $ExpectError
63+
gsort( [ x, order ], {} ); // $ExpectError
64+
}

0 commit comments

Comments
 (0)