Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/stdlib-js/blas-ext-base-dsortins

Sort a double-precision floating-point strided array using insertion sort.
https://github.com/stdlib-js/blas-ext-base-dsortins

arrange array blas double extended float64 float64array insertion javascript math mathematics ndarray node node-js nodejs order permute sort stdlib strided

Last synced: 20 days ago
JSON representation

Sort a double-precision floating-point strided array using insertion sort.

Awesome Lists containing this project

README 

        



  

    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!



# dsortins



[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] 



> Sort a double-precision floating-point strided array using insertion sort.



## Installation



```bash

npm install @stdlib/blas-ext-base-dsortins

```



Alternatively,



-   To load the package in a website via a `script` tag without installation and bundlers, use the [ES Module][es-module] available on the [`esm`][esm-url] branch (see [README][esm-readme]).

-   If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions).

-   For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [`umd`][umd-url] branch (see [README][umd-readme]).



The [branches.md][branches-url] file summarizes the available branches and displays a diagram illustrating their relationships.



To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.



## Usage



```javascript

var dsortins = require( '@stdlib/blas-ext-base-dsortins' );

```



#### dsortins( N, order, x, stride )



Sorts a double-precision floating-point strided array `x` using insertion sort.



```javascript

var Float64Array = require( '@stdlib/array-float64' );



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



dsortins( x.length, 1.0, x, 1 );

// x => [ -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 [`Float64Array`][@stdlib/array/float64].

-   **stride**: index increment.



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



```javascript

var Float64Array = require( '@stdlib/array-float64' );



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



dsortins( 2, -1.0, x, 2 );

// x => [ 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 Float64Array = require( '@stdlib/array-float64' );



// Initial array...

var x0 = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] );



// Create an offset view...

var x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element



// Sort every other element...

dsortins( 2, -1.0, x1, 2 );

// x0 => [ 1.0, 4.0, 3.0, 2.0 ]

```



#### dsortins.ndarray( N, order, x, stride, offset )



Sorts a double-precision floating-point strided array `x` using insertion sort and alternative indexing semantics.



```javascript

var Float64Array = require( '@stdlib/array-float64' );



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



dsortins.ndarray( x.length, 1.0, x, 1, 0 );

// x => [ -4.0, -2.0, 1.0, 3.0 ]

```



The function has the following additional parameters:



-   **offset**: 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 of `x`



```javascript

var Float64Array = require( '@stdlib/array-float64' );



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



dsortins.ndarray( 3, 1.0, x, 1, x.length-3 );

// x => [ 1.0, -2.0, 3.0, -6.0, -4.0, 5.0 ]

```



## 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 worst case time complexity `O(N^2)`.

-   The algorithm is efficient for **small** strided arrays (typically `N <= 20`) and is particularly efficient for sorting strided arrays which are already substantially sorted.

-   The algorithm is **stable**, meaning that the algorithm does **not** 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



```javascript

var filledarrayBy = require( '@stdlib/array-filled-by' );

var uniform = require( '@stdlib/random-base-uniform' ).factory;

var dsortins = require( '@stdlib/blas-ext-base-dsortins' );



var x = filledarrayBy( 100, 'float64', uniform( -100.0, 100.0 ) );

console.log( x );



dsortins( x.length, -1.0, x, -1 );

console.log( x );

```



* * *



## See Also



-   [`@stdlib/blas-ext/base/dsort2ins`][@stdlib/blas/ext/base/dsort2ins]: simultaneously sort two double-precision floating-point strided arrays based on the sort order of the first array using insertion sort.

-   [`@stdlib/blas-ext/base/gsortins`][@stdlib/blas/ext/base/gsortins]: sort a strided array using insertion sort.

-   [`@stdlib/blas-ext/base/ssortins`][@stdlib/blas/ext/base/ssortins]: sort a single-precision floating-point strided array using insertion sort.



* * *



## Notice



This package is part of [stdlib][stdlib], a standard library for JavaScript and Node.js, 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][stdlib], see the main project [repository][stdlib].



#### Community



[![Chat][chat-image]][chat-url]



---



## License



See [LICENSE][stdlib-license].



## Copyright



Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors].



[npm-image]: http://img.shields.io/npm/v/@stdlib/blas-ext-base-dsortins.svg

[npm-url]: https://npmjs.org/package/@stdlib/blas-ext-base-dsortins



[test-image]: https://github.com/stdlib-js/blas-ext-base-dsortins/actions/workflows/test.yml/badge.svg?branch=main

[test-url]: https://github.com/stdlib-js/blas-ext-base-dsortins/actions/workflows/test.yml?query=branch:main



[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/blas-ext-base-dsortins/main.svg

[coverage-url]: https://codecov.io/github/stdlib-js/blas-ext-base-dsortins?branch=main



[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg

[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im



[stdlib]: https://github.com/stdlib-js/stdlib



[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors



[umd]: https://github.com/umdjs/umd

[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules



[deno-url]: https://github.com/stdlib-js/blas-ext-base-dsortins/tree/deno

[deno-readme]: https://github.com/stdlib-js/blas-ext-base-dsortins/blob/deno/README.md

[umd-url]: https://github.com/stdlib-js/blas-ext-base-dsortins/tree/umd

[umd-readme]: https://github.com/stdlib-js/blas-ext-base-dsortins/blob/umd/README.md

[esm-url]: https://github.com/stdlib-js/blas-ext-base-dsortins/tree/esm

[esm-readme]: https://github.com/stdlib-js/blas-ext-base-dsortins/blob/esm/README.md

[branches-url]: https://github.com/stdlib-js/blas-ext-base-dsortins/blob/main/branches.md



[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/blas-ext-base-dsortins/main/LICENSE



[@stdlib/array/float64]: https://github.com/stdlib-js/array-float64



[mdn-typed-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray



[@stdlib/blas/ext/base/dsort2ins]: https://github.com/stdlib-js/blas-ext-base-dsort2ins



[@stdlib/blas/ext/base/gsortins]: https://github.com/stdlib-js/blas-ext-base-gsortins



[@stdlib/blas/ext/base/ssortins]: https://github.com/stdlib-js/blas-ext-base-ssortins