From adcb85b7e160ccf8d45e3296a9211267ac40bac5 Mon Sep 17 00:00:00 2001 From: sagar7162 Date: Mon, 12 Jan 2026 22:02:47 +0530 Subject: [PATCH 1/5] feat: add `blas/ext/base/ndarray/dsort` --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: passed - task: lint_package_json status: passed - task: lint_repl_help status: passed - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: passed - task: lint_javascript_tests status: passed - task: lint_javascript_benchmarks status: passed - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: passed - task: lint_license_headers status: passed --- --- .../blas/ext/base/ndarray/dsort/README.md | 130 ++++++++++++++++++ .../base/ndarray/dsort/benchmark/benchmark.js | 112 +++++++++++++++ .../blas/ext/base/ndarray/dsort/docs/repl.txt | 40 ++++++ .../base/ndarray/dsort/docs/types/index.d.ts | 55 ++++++++ .../ext/base/ndarray/dsort/docs/types/test.ts | 64 +++++++++ .../ext/base/ndarray/dsort/examples/index.js | 45 ++++++ .../blas/ext/base/ndarray/dsort/lib/index.js | 50 +++++++ .../blas/ext/base/ndarray/dsort/lib/main.js | 77 +++++++++++ .../blas/ext/base/ndarray/dsort/package.json | 66 +++++++++ .../blas/ext/base/ndarray/dsort/test/test.js | 83 +++++++++++ 10 files changed, 722 insertions(+) create mode 100644 lib/node_modules/@stdlib/blas/ext/base/ndarray/dsort/README.md create mode 100644 lib/node_modules/@stdlib/blas/ext/base/ndarray/dsort/benchmark/benchmark.js create mode 100644 lib/node_modules/@stdlib/blas/ext/base/ndarray/dsort/docs/repl.txt create mode 100644 lib/node_modules/@stdlib/blas/ext/base/ndarray/dsort/docs/types/index.d.ts create mode 100644 lib/node_modules/@stdlib/blas/ext/base/ndarray/dsort/docs/types/test.ts create mode 100644 lib/node_modules/@stdlib/blas/ext/base/ndarray/dsort/examples/index.js create mode 100644 lib/node_modules/@stdlib/blas/ext/base/ndarray/dsort/lib/index.js create mode 100644 lib/node_modules/@stdlib/blas/ext/base/ndarray/dsort/lib/main.js create mode 100644 lib/node_modules/@stdlib/blas/ext/base/ndarray/dsort/package.json create mode 100644 lib/node_modules/@stdlib/blas/ext/base/ndarray/dsort/test/test.js diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/dsort/README.md b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dsort/README.md new file mode 100644 index 000000000000..a9558b839a00 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dsort/README.md @@ -0,0 +1,130 @@ + + +# dsort + +> Sort a double-precision floating-point ndarray. + +
+ +
+ + + +
+ +## Usage + +```javascript +var dsort = require( '@stdlib/blas/ext/base/ndarray/dsort' ); +``` + +#### dsort( arrays ) + +Sorts a double-precision floating-point ndarray. + +```javascript +var Float64Array = require( '@stdlib/array/float64' ); +var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' ); +var ndarray = require( '@stdlib/ndarray/base/ctor' ); + +var xbuf = new Float64Array( [ 1.0, -2.0, 3.0, -4.0 ] ); +var x = new ndarray( 'float64', xbuf, [ 4 ], [ 1 ], 0, 'row-major' ); + +var order = scalar2ndarray( 1.0, { + 'dtype': 'generic' +}); + +var out = dsort( [ x, order ] ); +// 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. + +
+ + + +
+ +## Notes + +- The input ndarray is sorted **in-place** (i.e., the input ndarray is **mutated**). +- 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. + +
+ + + +
+ +## Examples + + + +```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 dsort = require( '@stdlib/blas/ext/base/ndarray/dsort' ); + +var xbuf = discreteUniform( 10, -100, 100, { + 'dtype': 'float64' +}); +var x = new ndarray( 'float64', xbuf, [ xbuf.length ], [ 1 ], 0, 'row-major' ); +console.log( ndarray2array( x ) ); + +var order = scalar2ndarray( 1.0, { + 'dtype': 'generic' +}); + +dsort( [ x, order ] ); +console.log( ndarray2array( x ) ); + +order = scalar2ndarray( -1.0, { + 'dtype': 'generic' +}); + +dsort( [ x, order ] ); +console.log( ndarray2array( x ) ); +``` + +
+ + + + + + + + + + + + + + diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/dsort/benchmark/benchmark.js b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dsort/benchmark/benchmark.js new file mode 100644 index 000000000000..ef83b27c8e55 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dsort/benchmark/benchmark.js @@ -0,0 +1,112 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2026 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 format = require( '@stdlib/string/format' ); +var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' ); +var pkg = require( './../package.json' ).name; +var dsort = require( './../lib' ); + + +// VARIABLES // + +var options = { + 'dtype': 'float64' +}; + + +// 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; + + /** + * Benchmark function. + * + * @private + * @param {Benchmark} b - benchmark instance + */ + function benchmark( b ) { + var out; + var i; + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + out = dsort( [ x, order ] ); + if ( typeof out !== 'object' ) { + b.fail( 'should return an ndarray' ); + } + } + b.toc(); + if ( xbuf[ i%len ] !== xbuf[ i%len ] ) { + 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( format( '%s:len=%d', pkg, len ), f ); + } +} + +main(); diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/dsort/docs/repl.txt b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dsort/docs/repl.txt new file mode 100644 index 000000000000..9c84a025a3d7 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dsort/docs/repl.txt @@ -0,0 +1,40 @@ + +{{alias}}( arrays ) + Sorts a double-precision floating-point ndarray. + + 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. + + The input ndarray is sorted *in-place* (i.e., the input strided array is + *mutated*). + + Parameters + ---------- + arrays: ArrayLikeObject + 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 = new {{alias:@stdlib/array/float64}}( [ 1.0, -2.0, 3.0, -4.0 ] ); + > var dt = 'float64'; + > 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, { 'dtype': dt } ); + > {{alias}}( [ x, o ] ) + + > var data = x.data + [ -4.0, -2.0, 1.0, 3.0 ] + + See Also + -------- diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/dsort/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dsort/docs/types/index.d.ts new file mode 100644 index 000000000000..fef2d49bc3f7 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dsort/docs/types/index.d.ts @@ -0,0 +1,55 @@ +/* +* @license Apache-2.0 +* +* Copyright (c) 2026 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 + +/// + +import { typedndarray, float64ndarray } from '@stdlib/types/ndarray'; + +/** +* Sorts a double-precision floating-point ndarray. +* +* ## Notes +* +* - 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. +* +* @param arrays - array-like object containing a one-dimensional input ndarray and a zero-dimensional ndarray specifying the sort order +* @returns input ndarray +* +* @example +* var Float64Array = require( '@stdlib/array/float64' ); +* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' ); +* var ndarray = require( '@stdlib/ndarray/base/ctor' ); +* +* var xbuf = new Float64Array( [ 1.0, -2.0, 3.0, -4.0 ] ); +* var x = new ndarray( 'float64', xbuf, [ 4 ], [ 1 ], 0, 'row-major' ); +* +* var ord = scalar2ndarray( 1.0, { +* 'dtype': 'generic' +* }); +* +* var out = dsort( [ x, ord ] ); +* // returns [ -4.0, -2.0, 1.0, 3.0 ] +*/ +declare function dsort( arrays: [ float64ndarray, typedndarray ] ): float64ndarray; + + +// EXPORTS // + +export = dsort; diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/dsort/docs/types/test.ts b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dsort/docs/types/test.ts new file mode 100644 index 000000000000..bd8703b93445 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dsort/docs/types/test.ts @@ -0,0 +1,64 @@ +/* +* @license Apache-2.0 +* +* Copyright (c) 2026 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 dsort = require( './index' ); + + +// TESTS // + +// The function returns an ndarray... +{ + const x = zeros( [ 10 ], { + 'dtype': 'float64' + }); + const order = scalar2ndarray( 1.0, { + 'dtype': 'generic' + }); + + dsort( [ x, order ] ); // $ExpectType float64ndarray +} + +// The compiler throws an error if the function is provided a first argument which is not an array of ndarrays... +{ + dsort( '10' ); // $ExpectError + dsort( 10 ); // $ExpectError + dsort( true ); // $ExpectError + dsort( false ); // $ExpectError + dsort( null ); // $ExpectError + dsort( undefined ); // $ExpectError + dsort( [] ); // $ExpectError + dsort( {} ); // $ExpectError + dsort( ( 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': 'float64' + }); + const order = scalar2ndarray( 1.0, { + 'dtype': 'generic' + }); + + dsort(); // $ExpectError + dsort( [ x, order ], {} ); // $ExpectError +} diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/dsort/examples/index.js b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dsort/examples/index.js new file mode 100644 index 000000000000..6d530f021457 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dsort/examples/index.js @@ -0,0 +1,45 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2026 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'; + +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 dsort = require( './../lib' ); + +var xbuf = discreteUniform( 10, -100, 100, { + 'dtype': 'float64' +}); +var x = new ndarray( 'float64', xbuf, [ xbuf.length ], [ 1 ], 0, 'row-major' ); +console.log( ndarray2array( x ) ); + +var order = scalar2ndarray( 1.0, { + 'dtype': 'generic' +}); + +dsort( [ x, order ] ); +console.log( ndarray2array( x ) ); + +order = scalar2ndarray( -1.0, { + 'dtype': 'generic' +}); + +dsort( [ x, order ] ); +console.log( ndarray2array( x ) ); diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/dsort/lib/index.js b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dsort/lib/index.js new file mode 100644 index 000000000000..27f37f32570e --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dsort/lib/index.js @@ -0,0 +1,50 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2026 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'; + +/** +* Sort a double-precision floating-point ndarray. +* +* @module @stdlib/blas/ext/base/ndarray/dsort +* +* @example +* var Float64Array = require( '@stdlib/array/float64' ); +* var ndarray = require( '@stdlib/ndarray/base/ctor' ); +* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' ); +* var dsort = require( '@stdlib/blas/ext/base/ndarray/dsort' ); +* +* var xbuf = new Float64Array( [ 1.0, -2.0, 3.0, -4.0 ] ); +* var x = new ndarray( 'float64', xbuf, [ 4 ], [ 1 ], 0, 'row-major' ); +* +* var order = scalar2ndarray( 1.0, { +* 'dtype': 'generic' +* }); +* +* var out = dsort( [ x, order ] ); +* // returns [ -4.0, -2.0, 1.0, 3.0 ] +*/ + +// MODULES // + +var main = require( './main.js' ); + + +// EXPORTS // + +module.exports = main; diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/dsort/lib/main.js b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dsort/lib/main.js new file mode 100644 index 000000000000..6f92117cd27e --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dsort/lib/main.js @@ -0,0 +1,77 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2026 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 ndarraylike2scalar = require( '@stdlib/ndarray/base/ndarraylike2scalar' ); +var numelDimension = require( '@stdlib/ndarray/base/numel-dimension' ); +var getStride = require( '@stdlib/ndarray/base/stride' ); +var getOffset = require( '@stdlib/ndarray/base/offset' ); +var getData = require( '@stdlib/ndarray/base/data-buffer' ); +var strided = require( '@stdlib/blas/ext/base/dsort' ).ndarray; + + +// MAIN // + +/** +* Sorts a double-precision floating-point ndarray. +* +* ## Notes +* +* - 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. +* +* @param {ArrayLikeObject} arrays - array-like object containing a one-dimensional input ndarray and a zero-dimensional ndarray specifying the sort order +* @returns {ndarray} input ndarray +* +* @example +* var Float64Array = require( '@stdlib/array/float64' ); +* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' ); +* var ndarray = require( '@stdlib/ndarray/base/ctor' ); +* +* var xbuf = new Float64Array( [ 1.0, -2.0, 3.0, -4.0 ] ); +* var x = new ndarray( 'float64', xbuf, [ 4 ], [ 1 ], 0, 'row-major' ); +* +* var order = scalar2ndarray( 1.0, { +* 'dtype': 'generic' +* }); +* +* var out = dsort( [ x, order ] ); +* // returns [ -4.0, -2.0, 1.0, 3.0 ] +*/ +function dsort( arrays ) { + var order; + var x; + var N; + + x = arrays[ 0 ]; + order = arrays[ 1 ]; + + N = numelDimension( x, 0 ); + if ( N === 0 ) { + return x; + } + strided( N, ndarraylike2scalar( order ), getData( x ), getStride( x, 0 ), getOffset( x ) ); // eslint-disable-line max-len + return x; +} + + +// EXPORTS // + +module.exports = dsort; diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/dsort/package.json b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dsort/package.json new file mode 100644 index 000000000000..48572dbb01f4 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dsort/package.json @@ -0,0 +1,66 @@ +{ + "name": "@stdlib/blas/ext/base/ndarray/dsort", + "version": "0.0.0", + "description": "Sort a double-precision floating-point ndarray.", + "license": "Apache-2.0", + "author": { + "name": "The Stdlib Authors", + "url": "https://github.com/stdlib-js/stdlib/graphs/contributors" + }, + "contributors": [ + { + "name": "The Stdlib Authors", + "url": "https://github.com/stdlib-js/stdlib/graphs/contributors" + } + ], + "main": "./lib", + "directories": { + "benchmark": "./benchmark", + "doc": "./docs", + "example": "./examples", + "lib": "./lib", + "test": "./test" + }, + "types": "./docs/types", + "scripts": {}, + "homepage": "https://github.com/stdlib-js/stdlib", + "repository": { + "type": "git", + "url": "git://github.com/stdlib-js/stdlib.git" + }, + "bugs": { + "url": "https://github.com/stdlib-js/stdlib/issues" + }, + "dependencies": {}, + "devDependencies": {}, + "engines": { + "node": ">=0.10.0", + "npm": ">2.7.0" + }, + "os": [ + "aix", + "darwin", + "freebsd", + "linux", + "macos", + "openbsd", + "sunos", + "win32", + "windows" + ], + "keywords": [ + "stdlib", + "stdmath", + "mathematics", + "math", + "blas", + "extended", + "sort", + "order", + "arrange", + "strided", + "array", + "ndarray" + ], + "__stdlib__": {} +} diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/dsort/test/test.js b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dsort/test/test.js new file mode 100644 index 000000000000..2823be504b08 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dsort/test/test.js @@ -0,0 +1,83 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2026 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 tape = require( 'tape' ); +var Float64Array = require( '@stdlib/array/float64' ); +var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' ); +var getData = require( '@stdlib/ndarray/data-buffer' ); +var getDtype = require( '@stdlib/ndarray/dtype' ); +var getStrides = require( '@stdlib/ndarray/strides' ); +var getOffset = require( '@stdlib/ndarray/offset' ); +var getShape = require( '@stdlib/ndarray/shape' ); +var ndarray = require( '@stdlib/ndarray/base/ctor' ); +var dsort = require( './../lib' ); + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof dsort, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function sorts a one-dimensional ndarray (increasing order)', function test( t ) { + var actual; + var order; + var x; + + x = ndarray( 'float64', new Float64Array( [ 3.0, 1.0, 2.0, 5.0, 4.0 ] ), [ 5 ], [ 1 ], 0, 'row-major' ); + order = scalar2ndarray( 1.0, { + 'dtype': 'generic' + }); + + actual = dsort( [ x, order ] ); + t.strictEqual( actual, x, 'returns expected value' ); + t.strictEqual( getDtype( actual ), 'float64', 'returns expected value' ); + t.deepEqual( getData( actual ), new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ), 'returns expected value' ); + t.deepEqual( getShape( actual ), [ 5 ], 'returns expected value' ); + t.deepEqual( getStrides( actual ), [ 1 ], 'returns expected value' ); + t.strictEqual( getOffset( actual ), 0, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function sorts a one-dimensional ndarray (decreasing order)', function test( t ) { + var actual; + var order; + var x; + + x = ndarray( 'float64', new Float64Array( [ 3.0, 1.0, 2.0, 5.0, 4.0 ] ), [ 5 ], [ 1 ], 0, 'row-major' ); + order = scalar2ndarray( -1.0, { + 'dtype': 'generic' + }); + + actual = dsort( [ x, order ] ); + t.strictEqual( actual, x, 'returns expected value' ); + t.strictEqual( getDtype( actual ), 'float64', 'returns expected value' ); + t.deepEqual( getData( actual ), new Float64Array( [ 5.0, 4.0, 3.0, 2.0, 1.0 ] ), 'returns expected value' ); + t.deepEqual( getShape( actual ), [ 5 ], 'returns expected value' ); + t.deepEqual( getStrides( actual ), [ 1 ], 'returns expected value' ); + t.strictEqual( getOffset( actual ), 0, 'returns expected value' ); + + t.end(); +}); From 6f6721b9537d0c0797d8cceeca4dd191e9d8ea5c Mon Sep 17 00:00:00 2001 From: sagar7162 Date: Tue, 13 Jan 2026 13:30:01 +0530 Subject: [PATCH 2/5] fix: implemented suggested changes except in example_index_js --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: na - task: lint_package_json status: na - task: lint_repl_help status: passed - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: passed - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- .../blas/ext/base/ndarray/dsort/benchmark/benchmark.js | 1 - .../@stdlib/blas/ext/base/ndarray/dsort/docs/repl.txt | 4 +--- .../@stdlib/blas/ext/base/ndarray/dsort/lib/main.js | 8 +------- 3 files changed, 2 insertions(+), 11 deletions(-) diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/dsort/benchmark/benchmark.js b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dsort/benchmark/benchmark.js index ef83b27c8e55..f063d20eca13 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/ndarray/dsort/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dsort/benchmark/benchmark.js @@ -53,7 +53,6 @@ function createBenchmark( len ) { 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; diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/dsort/docs/repl.txt b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dsort/docs/repl.txt index 9c84a025a3d7..4811393dd452 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/ndarray/dsort/docs/repl.txt +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dsort/docs/repl.txt @@ -32,9 +32,7 @@ > var x = new {{alias:@stdlib/ndarray/ctor}}( dt, xbuf, sh, sx, ox, ord ); > var o = {{alias:@stdlib/ndarray/from-scalar}}( 1.0, { 'dtype': dt } ); > {{alias}}( [ x, o ] ) - - > var data = x.data - [ -4.0, -2.0, 1.0, 3.0 ] + [ -4.0, -2.0, 1.0, 3.0 ] See Also -------- diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/dsort/lib/main.js b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dsort/lib/main.js index 6f92117cd27e..8e81f9598310 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/ndarray/dsort/lib/main.js +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dsort/lib/main.js @@ -58,16 +58,10 @@ var strided = require( '@stdlib/blas/ext/base/dsort' ).ndarray; function dsort( arrays ) { var order; var x; - var N; x = arrays[ 0 ]; order = arrays[ 1 ]; - - N = numelDimension( x, 0 ); - if ( N === 0 ) { - return x; - } - strided( N, ndarraylike2scalar( order ), getData( x ), getStride( x, 0 ), getOffset( x ) ); // eslint-disable-line max-len + strided( numelDimension( x, 0 ), ndarraylike2scalar( order ), getData( x ), getStride( x, 0 ), getOffset( x ) ); // eslint-disable-line max-len return x; } From 5f07aa61c06f86858bb3eaaadd1cfe8c1bd39086 Mon Sep 17 00:00:00 2001 From: sagar7162 Date: Thu, 15 Jan 2026 13:35:59 +0530 Subject: [PATCH 3/5] fix: add suggested changes --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: passed - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: passed - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: passed - task: lint_license_headers status: passed --- --- .../@stdlib/blas/ext/base/ndarray/dsort/README.md | 11 +++++------ .../blas/ext/base/ndarray/dsort/docs/types/index.d.ts | 3 +++ .../blas/ext/base/ndarray/dsort/examples/index.js | 11 +++++------ 3 files changed, 13 insertions(+), 12 deletions(-) diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/dsort/README.md b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dsort/README.md index a9558b839a00..9938cc671c02 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/ndarray/dsort/README.md +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dsort/README.md @@ -54,6 +54,9 @@ var order = scalar2ndarray( 1.0, { var out = dsort( [ x, order ] ); // returns [ -4.0, -2.0, 1.0, 3.0 ] + +var bool = ( out === x ); +// returns true ``` The function has the following parameters: @@ -82,16 +85,12 @@ The function has the following parameters: ```javascript -var discreteUniform = require( '@stdlib/random/array/discrete-uniform' ); -var ndarray = require( '@stdlib/ndarray/base/ctor' ); +var uniform = require( '@stdlib/random/array/uniform' ); var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' ); var ndarray2array = require( '@stdlib/ndarray/to-array' ); var dsort = require( '@stdlib/blas/ext/base/ndarray/dsort' ); -var xbuf = discreteUniform( 10, -100, 100, { - 'dtype': 'float64' -}); -var x = new ndarray( 'float64', xbuf, [ xbuf.length ], [ 1 ], 0, 'row-major' ); +var x = uniform( 10, -100, 100 ); console.log( ndarray2array( x ) ); var order = scalar2ndarray( 1.0, { diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/dsort/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dsort/docs/types/index.d.ts index fef2d49bc3f7..d83e196f60d8 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/ndarray/dsort/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dsort/docs/types/index.d.ts @@ -46,6 +46,9 @@ import { typedndarray, float64ndarray } from '@stdlib/types/ndarray'; * * var out = dsort( [ x, ord ] ); * // returns [ -4.0, -2.0, 1.0, 3.0 ] +* +* var bool = ( out === x ); +* // returns true */ declare function dsort( arrays: [ float64ndarray, typedndarray ] ): float64ndarray; diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/dsort/examples/index.js b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dsort/examples/index.js index 6d530f021457..a389442c6cb4 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/ndarray/dsort/examples/index.js +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dsort/examples/index.js @@ -18,21 +18,19 @@ 'use strict'; -var discreteUniform = require( '@stdlib/random/array/discrete-uniform' ); -var ndarray = require( '@stdlib/ndarray/base/ctor' ); +var uniform = require( '@stdlib/random/array/uniform' ); var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' ); var ndarray2array = require( '@stdlib/ndarray/to-array' ); +var ndarraylike2scalar = require( '@stdlib/ndarray/base/ndarraylike2scalar' ); var dsort = require( './../lib' ); -var xbuf = discreteUniform( 10, -100, 100, { - 'dtype': 'float64' -}); -var x = new ndarray( 'float64', xbuf, [ xbuf.length ], [ 1 ], 0, 'row-major' ); +var x = uniform( 10, -100, 100 ); console.log( ndarray2array( x ) ); var order = scalar2ndarray( 1.0, { 'dtype': 'generic' }); +console.log( 'Order:', ndarraylike2scalar( order ) ); dsort( [ x, order ] ); console.log( ndarray2array( x ) ); @@ -40,6 +38,7 @@ console.log( ndarray2array( x ) ); order = scalar2ndarray( -1.0, { 'dtype': 'generic' }); +console.log( 'Order:', ndarraylike2scalar( order ) ); dsort( [ x, order ] ); console.log( ndarray2array( x ) ); From 812230dcbcfc2348d702b01eadae7b9e92b0973c Mon Sep 17 00:00:00 2001 From: sagar7162 Date: Thu, 15 Jan 2026 14:11:28 +0530 Subject: [PATCH 4/5] fix: fixed examples --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: na - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: passed - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- .../@stdlib/blas/ext/base/ndarray/dsort/examples/index.js | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/dsort/examples/index.js b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dsort/examples/index.js index a389442c6cb4..77c560f4f41d 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/ndarray/dsort/examples/index.js +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dsort/examples/index.js @@ -18,13 +18,13 @@ 'use strict'; -var uniform = require( '@stdlib/random/array/uniform' ); +var uniform = require( '@stdlib/random/uniform' ); var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' ); var ndarray2array = require( '@stdlib/ndarray/to-array' ); var ndarraylike2scalar = require( '@stdlib/ndarray/base/ndarraylike2scalar' ); var dsort = require( './../lib' ); -var x = uniform( 10, -100, 100 ); +var x = uniform( [ 10 ], -100, 100 ); console.log( ndarray2array( x ) ); var order = scalar2ndarray( 1.0, { From 243e5b3b12b470f696fa4133544b69d2adb94f86 Mon Sep 17 00:00:00 2001 From: sagar7162 Date: Thu, 15 Jan 2026 14:41:45 +0530 Subject: [PATCH 5/5] fix: fixed readme examples --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: passed - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- .../@stdlib/blas/ext/base/ndarray/dsort/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/dsort/README.md b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dsort/README.md index 9938cc671c02..e9a68cbd8f04 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/ndarray/dsort/README.md +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dsort/README.md @@ -85,12 +85,12 @@ The function has the following parameters: ```javascript -var uniform = require( '@stdlib/random/array/uniform' ); +var uniform = require( '@stdlib/random/uniform' ); var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' ); var ndarray2array = require( '@stdlib/ndarray/to-array' ); var dsort = require( '@stdlib/blas/ext/base/ndarray/dsort' ); -var x = uniform( 10, -100, 100 ); +var x = uniform( [ 10 ], -100, 100 ); console.log( ndarray2array( x ) ); var order = scalar2ndarray( 1.0, {