-
-
Notifications
You must be signed in to change notification settings - Fork 1.2k
feat: add blas/ext/base/ssort
#9697
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 4 commits
Commits
Show all changes
12 commits
Select commit
Hold shift + click to select a range
3a5d54f
feat: add blas/ext/base/ssort
headlessNode d3da8a4
Merge remote-tracking branch 'upstream/develop' into blas-ssort
stdlib-bot c76fe84
Apply suggestions from code review
kgryte 0fd55fc
Apply suggestions from code review
kgryte 0a0007e
Apply suggestions from code review
kgryte 941561f
Apply suggestions from code review
kgryte b215eb8
fix: apply suggestions from code review
headlessNode bb73131
fix: apply suggestions from code review
headlessNode 5c4bf52
Merge branch 'develop' into blas-ssort
headlessNode b9faa78
fix: apply suggestions from code review
headlessNode 93113be
fix: apply suggestions from code review
headlessNode 0d8c22f
Apply suggestions from code review
kgryte File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,300 @@ | ||
| <!-- | ||
|
|
||
| @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. | ||
|
|
||
| --> | ||
|
|
||
| # ssort | ||
|
|
||
| > Sort a single-precision floating-point strided array. | ||
|
|
||
| <section class="usage"> | ||
|
|
||
| ## Usage | ||
|
|
||
| ```javascript | ||
| var ssort = require( '@stdlib/blas/ext/base/ssort' ); | ||
| ``` | ||
|
|
||
| #### ssort( N, order, x, strideX ) | ||
|
|
||
| Sorts a single-precision floating-point strided array. | ||
|
|
||
| ```javascript | ||
| var Float32Array = require( '@stdlib/array/float32' ); | ||
|
|
||
| var x = new Float32Array( [ 1.0, -2.0, 3.0, -4.0 ] ); | ||
|
|
||
| ssort( x.length, 1.0, x, 1 ); | ||
| // x => <Float32Array>[ -4.0, -2.0, 1.0, 3.0 ] | ||
| ``` | ||
|
|
||
| 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 [`Float32Array`][@stdlib/array/float32]. | ||
| - **strideX**: stride length. | ||
|
|
||
| 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 Float32Array = require( '@stdlib/array/float32' ); | ||
|
|
||
| var x = new Float32Array( [ 1.0, -2.0, 3.0, -4.0 ] ); | ||
|
|
||
| ssort( 2, -1.0, x, 2 ); | ||
| // x => <Float32Array>[ 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 Float32Array = require( '@stdlib/array/float32' ); | ||
|
|
||
| // Initial array... | ||
| var x0 = new Float32Array( [ 1.0, 2.0, 3.0, 4.0 ] ); | ||
|
|
||
| // Create an offset view... | ||
| var x1 = new Float32Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element | ||
|
|
||
| // Sort every other element... | ||
| ssort( 2, -1.0, x1, 2 ); | ||
| // x0 => <Float32Array>[ 1.0, 4.0, 3.0, 2.0 ] | ||
| ``` | ||
|
|
||
| #### ssort.ndarray( N, order, x, strideX, offsetX ) | ||
|
|
||
| Sorts a single-precision floating-point strided array using alternative indexing semantics. | ||
|
|
||
| ```javascript | ||
| var Float32Array = require( '@stdlib/array/float32' ); | ||
|
|
||
| var x = new Float32Array( [ 1.0, -2.0, 3.0, -4.0 ] ); | ||
|
|
||
| ssort.ndarray( x.length, 1.0, x, 1, 0 ); | ||
| // x => <Float32Array>[ -4.0, -2.0, 1.0, 3.0 ] | ||
| ``` | ||
|
|
||
| The function has the following additional parameters: | ||
|
|
||
| - **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: | ||
|
|
||
| ```javascript | ||
| var Float32Array = require( '@stdlib/array/float32' ); | ||
|
|
||
| var x = new Float32Array( [ 1.0, -2.0, 3.0, -4.0, 5.0, -6.0 ] ); | ||
|
|
||
| ssort.ndarray( 3, 1.0, x, 1, 3 ); | ||
| // x => <Float32Array>[ 1.0, -2.0, 3.0, -6.0, -4.0, 5.0 ] | ||
| ``` | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.usage --> | ||
|
|
||
| <section class="notes"> | ||
|
|
||
| ## Notes | ||
|
|
||
| - If `N <= 0` or `order == 0.0`, both functions return `x` unchanged. | ||
| - 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)`. | ||
| - The input strided array is sorted **in-place** (i.e., the input strided array is **mutated**). | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.notes --> | ||
|
|
||
| <section class="examples"> | ||
|
|
||
| ## Examples | ||
|
|
||
| <!-- eslint no-undef: "error" --> | ||
|
|
||
| ```javascript | ||
| var discreteUniform = require( '@stdlib/random/array/discrete-uniform' ); | ||
| var ssort = require( '@stdlib/blas/ext/base/ssort' ); | ||
|
|
||
| var x = discreteUniform( 10, -100, 100, { | ||
| 'dtype': 'float32' | ||
| }); | ||
| console.log( x ); | ||
|
|
||
| ssort( x.length, 1.0, x, 1 ); | ||
| console.log( x ); | ||
| ``` | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.examples --> | ||
|
|
||
| <!-- C interface documentation. --> | ||
|
|
||
| * * * | ||
|
|
||
| <section class="c"> | ||
|
|
||
| ## C APIs | ||
|
|
||
| <!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. --> | ||
|
|
||
| <section class="intro"> | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.intro --> | ||
|
|
||
| <!-- C usage documentation. --> | ||
|
|
||
| <section class="usage"> | ||
|
|
||
| ### Usage | ||
|
|
||
| ```c | ||
| #include "stdlib/blas/ext/base/ssort.h" | ||
| ``` | ||
|
|
||
| #### stdlib_strided_ssort( N, order, \*X, strideX ) | ||
|
|
||
| Sorts a single-precision floating-point strided array. | ||
|
|
||
| ```c | ||
| const float x[] = { 1.0f, 2.0f, 3.0f, 4.0f }; | ||
|
|
||
| stdlib_strided_ssort( 4, 1.0f, x, 1 ); | ||
| ``` | ||
|
|
||
| The function accepts the following arguments: | ||
|
|
||
| - **N**: `[in] CBLAS_INT` number of indexed elements. | ||
| - **order**: `[in] float` 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**: `[inout] float*` input array. | ||
| - **strideX**: `[in] CBLAS_INT` stride length. | ||
|
|
||
| ```c | ||
| void stdlib_strided_ssort( const CBLAS_INT N, const float order, float *X, const CBLAS_INT strideX ); | ||
| ``` | ||
|
|
||
| <!--lint disable maximum-heading-length--> | ||
|
|
||
| #### stdlib_strided_ssort_ndarray( N, order, \*X, strideX, offsetX ) | ||
|
|
||
| <!--lint enable maximum-heading-length--> | ||
|
|
||
| Sorts a single-precision floating-point strided array using alternative indexing semantics. | ||
|
|
||
| ```c | ||
| const float x[] = { 1.0f, 2.0f, 3.0f, 4.0f }; | ||
|
|
||
| stdlib_strided_ssort_ndarray( 4, 1.0f, x, 1, 0 ); | ||
| ``` | ||
|
|
||
| The function accepts the following arguments: | ||
|
|
||
| - **N**: `[in] CBLAS_INT` number of indexed elements. | ||
| - **order**: `[in] float` 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**: `[inout] float*` input array. | ||
| - **strideX**: `[in] CBLAS_INT` stride length. | ||
| - **offsetX**: `[in] CBLAS_INT` starting index. | ||
|
|
||
| ```c | ||
| void stdlib_strided_ssort_ndarray( const CBLAS_INT N, const float order, float *X, const CBLAS_INT strideX, const CBLAS_INT offsetX ); | ||
| ``` | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.usage --> | ||
|
|
||
| <!-- C API usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. --> | ||
|
|
||
| <section class="notes"> | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.notes --> | ||
|
|
||
| <!-- C API usage examples. --> | ||
|
|
||
| <section class="examples"> | ||
|
|
||
| ### Examples | ||
|
|
||
| ```c | ||
| #include "stdlib/blas/ext/base/ssort.h" | ||
| #include <stdio.h> | ||
|
|
||
| int main( void ) { | ||
| // Create a strided array: | ||
| float x[] = { 1.0f, -2.0f, 3.0f, -4.0f, 5.0f, -6.0f, 7.0f, -8.0f }; | ||
|
|
||
| // Specify the number of elements: | ||
| const int N = 8; | ||
|
|
||
| // Specify the stride length: | ||
| const int strideX = 1; | ||
|
|
||
| // Sort the array: | ||
| stdlib_strided_ssort( N, 1.0f, x, strideX ); | ||
|
|
||
| // Print the result: | ||
| for ( int i = 0; i < 8; i++ ) { | ||
| printf( "x[ %i ] = %f\n", i, x[ i ] ); | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.examples --> | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.c --> | ||
|
|
||
| <section class="references"> | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.references --> | ||
|
|
||
| <!-- 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"> | ||
|
|
||
| [@stdlib/array/float32]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/float32 | ||
|
|
||
| [mdn-typed-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray | ||
|
|
||
| <!-- <related-links> --> | ||
|
|
||
| <!-- </related-links> --> | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.links --> | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.