Skip to content

Latest commit

 

History

History
287 lines (173 loc) · 10.8 KB

README.md

File metadata and controls

287 lines (173 loc) · 10.8 KB
About stdlib...

We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.

The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.

When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.

To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!

ssorthp

NPM version Build Status Coverage Status

Sort a single-precision floating-point strided array using heapsort.

Usage

import ssorthp from 'https://cdn.jsdelivr.net/gh/stdlib-js/blas-ext-base-ssorthp@deno/mod.js';

ssorthp( N, order, x, stride )

Sorts a single-precision floating-point strided array using heapsort.

import Float32Array from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-float32@deno/mod.js';

var x = new Float32Array( [ 1.0, -2.0, 3.0, -4.0 ] );

ssorthp( 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.
  • stride: index increment.

The N and stride parameters determine which elements in the strided arrays are accessed at runtime. For example, to sort every other element

import Float32Array from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-float32@deno/mod.js';

var x = new Float32Array( [ 1.0, -2.0, 3.0, -4.0 ] );

ssorthp( 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 views.

import Float32Array from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-float32@deno/mod.js';

// 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 );

// Sort every other element...
ssorthp( 2, -1.0, x1, 2 );
// x0 => <Float32Array>[ 1.0, 4.0, 3.0, 2.0 ]

ssorthp.ndarray( N, order, x, stride, offset )

Sorts a single-precision floating-point strided array using heapsort and alternative indexing semantics.

import Float32Array from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-float32@deno/mod.js';

var x = new Float32Array( [ 1.0, -2.0, 3.0, -4.0 ] );

ssorthp.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:

  • offset: starting index.

While 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 the strided array

import Float32Array from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-float32@deno/mod.js';

var x = new Float32Array( [ 1.0, -2.0, 3.0, -4.0, 5.0, -6.0 ] );

ssorthp.ndarray( 3, 1.0, x, 1, x.length-3 );
// x => <Float32Array>[ 1.0, -2.0, 3.0, -6.0, -4.0, 5.0 ]

Notes

  • If N <= 0 or order == 0.0, both functions return the strided array 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 algorithm is unstable, meaning that the algorithm may change the order of strided array elements which are equal or equivalent (e.g., NaN values).
  • The input strided array is sorted in-place (i.e., the input strided array is mutated).

Examples

var discreteUniform = require( 'https://cdn.jsdelivr.net/gh/stdlib-js/random-base-discrete-uniform' ).factory;
import filledarrayBy from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-filled-by@deno/mod.js';
import ssorthp from 'https://cdn.jsdelivr.net/gh/stdlib-js/blas-ext-base-ssorthp@deno/mod.js';

var rand = discreteUniform( -100, 100 );
var x = filledarrayBy( 10, 'float32', rand );

console.log( x );

ssorthp( x.length, -1.0, x, -1 );
console.log( x );

References

  • Williams, John William Joseph. 1964. "Algorithm 232: Heapsort." Communications of the ACM 7 (6). New York, NY, USA: Association for Computing Machinery: 347–49. doi:10.1145/512274.512284.
  • Floyd, Robert W. 1964. "Algorithm 245: Treesort." Communications of the ACM 7 (12). New York, NY, USA: Association for Computing Machinery: 701. doi:10.1145/355588.365103.

See Also

Notice

This package is part of stdlib, a standard library with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.

Community

Chat

License

See LICENSE.

Copyright

Copyright © 2016-2024. The Stdlib Authors.