@stdlib/blas-ext-base-dsort2hp

Simultaneously sort two double-precision floating-point strided arrays based on the sort order of the first array using heapsort.

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

Science Score: 57.0%

This score indicates how likely this project is to be science-related based on various indicators:

✓
CITATION.cff file
Found CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
✓
DOI references
Found 6 DOI reference(s) in README
○
Academic publication links
○
Committers with academic emails
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (15.2%) to scientific vocabulary

Keywords

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

Last synced: 4 months ago · JSON representation ·

Repository

Simultaneously sort two double-precision floating-point strided arrays based on the sort order of the first array using heapsort.

Basic Info

Host: GitHub
Owner: stdlib-js
License: apache-2.0
Language: JavaScript
Default Branch: main
Homepage: https://github.com/stdlib-js/stdlib
Size: 597 KB

Statistics

Stars: 1
Watchers: 3
Forks: 0
Open Issues: 0
Releases: 0

Topics

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

Created over 4 years ago · Last pushed 4 months ago

Metadata Files

Readme Changelog Contributing License Code of conduct Citation Security Notice

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!

dsort2hp

Simultaneously sort two double-precision floating-point strided arrays based on the sort order of the first array using heapsort.

## Installation ```bash npm install @stdlib/blas-ext-base-dsort2hp ``` 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 dsort2hp = require( '@stdlib/blas-ext-base-dsort2hp' ); ``` #### dsort2hp( N, order, x, strideX, y, strideY ) Simultaneously sorts two double-precision floating-point strided arrays based on the sort order of the first array `x` using heapsort. ```javascript var Float64Array = require( '@stdlib/array-float64' ); var x = new Float64Array( [ 1.0, -2.0, 3.0, -4.0 ] ); var y = new Float64Array( [ 0.0, 1.0, 2.0, 3.0 ] ); dsort2hp( x.length, 1.0, x, 1, y, 1 ); console.log( x ); // => [ -4.0, -2.0, 1.0, 3.0 ] console.log( y ); // => [ 3.0, 1.0, 0.0, 2.0 ] ``` The function has the following parameters: - **N**: number of indexed elements. - **order**: sort order. If `order < 0.0`, the input strided array `x` is sorted in **decreasing** order. If `order > 0.0`, the input strided array `x` is sorted in **increasing** order. If `order == 0.0`, the input strided arrays are left unchanged. - **x**: first input [`Float64Array`][@stdlib/array/float64]. - **strideX**: `x` index increment. - **y**: second input [`Float64Array`][@stdlib/array/float64]. - **strideY**: `y` index increment. The `N` and `stride` parameters determine which elements in `x` and `y` are accessed at runtime. For example, to sort every other element ```javascript var Float64Array = require( '@stdlib/array-float64' ); var floor = require( '@stdlib/math-base-special-floor' ); var x = new Float64Array( [ 1.0, -2.0, 3.0, -4.0 ] ); var y = new Float64Array( [ 0.0, 1.0, 2.0, 3.0 ] ); var N = floor( x.length / 2 ); dsort2hp( N, -1.0, x, 2, y, 2 ); console.log( x ); // => [ 3.0, -2.0, 1.0, -4.0 ] console.log( y ); // => [ 2.0, 1.0, 0.0, 3.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' ); var floor = require( '@stdlib/math-base-special-floor' ); // Initial arrays... var x0 = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); var y0 = new Float64Array( [ 0.0, 1.0, 2.0, 3.0 ] ); // Create offset views... var x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element var y1 = new Float64Array( y0.buffer, y0.BYTES_PER_ELEMENT*1 ); // start at 2nd element var N = floor( x0.length/2 ); // Sort every other element... dsort2hp( N, -1.0, x1, 2, y1, 2 ); console.log( x0 ); // => [ 1.0, 4.0, 3.0, 2.0 ] console.log( y0 ); // => [ 0.0, 3.0, 2.0, 1.0 ] ``` #### dsort2hp.ndarray( N, order, x, strideX, offsetX, y, strideY, offsetY ) Simultaneously sorts two double-precision floating-point strided arrays based on the sort order of the first array `x` using heapsort and alternative indexing semantics. ```javascript var Float64Array = require( '@stdlib/array-float64' ); var x = new Float64Array( [ 1.0, -2.0, 3.0, -4.0 ] ); var y = new Float64Array( [ 0.0, 1.0, 2.0, 3.0 ] ); dsort2hp.ndarray( x.length, 1.0, x, 1, 0, y, 1, 0 ); console.log( x ); // => [ -4.0, -2.0, 1.0, 3.0 ] console.log( y ); // => [ 3.0, 1.0, 0.0, 2.0 ] ``` The function has the following additional parameters: - **offsetX**: `x` starting index. - **offsetY**: `y` 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 ] ); var y = new Float64Array( [ 0.0, 1.0, 2.0, 3.0, 4.0, 5.0 ] ); dsort2hp.ndarray( 3, 1.0, x, 1, x.length-3, y, 1, y.length-3 ); console.log( x ); // => [ 1.0, -2.0, 3.0, -6.0, -4.0, 5.0 ] console.log( y ); // => [ 0.0, 1.0, 2.0, 5.0, 3.0, 4.0 ] ```

## Notes - If `N <= 0` or `order == 0.0`, both functions leave `x` and `y` 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 arrays are sorted **in-place** (i.e., the input strided arrays are **mutated**).

## Examples ```javascript var round = require( '@stdlib/math-base-special-round' ); var randu = require( '@stdlib/random-base-randu' ); var Float64Array = require( '@stdlib/array-float64' ); var dsort2hp = require( '@stdlib/blas-ext-base-dsort2hp' ); var rand; var sign; var x; var y; var i; x = new Float64Array( 10 ); y = new Float64Array( 10 ); // index array for ( i = 0; i < x.length; i++ ) { rand = round( randu()*100.0 ); sign = randu(); if ( sign < 0.5 ) { sign = -1.0; } else { sign = 1.0; } x[ i ] = sign * rand; y[ i ] = i; } console.log( x ); console.log( y ); dsort2hp( x.length, -1.0, x, -1, y, -1 ); console.log( x ); console.log( y ); ```

## 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][@williams:1964a]. - 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][@floyd:1964a].

* * * ## 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-2025. The Stdlib [Authors][stdlib-authors].

Owner

Name: stdlib
Login: stdlib-js
Kind: organization

Website: https://stdlib.io
Twitter: stdlibjs
Repositories: 3,692
Profile: https://github.com/stdlib-js

Standard library for JavaScript.

Citation (CITATION.cff)

cff-version: 1.2.0
title: stdlib
message: >-
  If you use this software, please cite it using the
  metadata from this file.

type: software

authors:
  - name: The Stdlib Authors
    url: https://github.com/stdlib-js/stdlib/graphs/contributors

repository-code: https://github.com/stdlib-js/stdlib
url: https://stdlib.io

abstract: |
  Standard library for JavaScript and Node.js.

keywords:
  - JavaScript
  - Node.js
  - TypeScript
  - standard library
  - scientific computing
  - numerical computing
  - statistical computing

license: Apache-2.0 AND BSL-1.0

date-released: 2016

GitHub Events

Total

Push event: 23

Last Year

Push event: 23

Committers

Last synced: almost 2 years ago

All Time

Total Commits: 58
Total Committers: 1
Avg Commits per committer: 58.0
Development Distribution Score (DDS): 0.0

Past Year

Commits: 18
Committers: 1
Avg Commits per committer: 18.0
Development Distribution Score (DDS): 0.0

Top Committers

Name	Email	Commits
stdlib-bot	n**y@s**o	58

Committer Domains (Top 20 + Academic)

stdlib.io: 1

Issues and Pull Requests

Last synced: 4 months ago

All Time

Total issues: 0
Total pull requests: 0
Average time to close issues: N/A
Average time to close pull requests: N/A
Total issue authors: 0
Total pull request authors: 0
Average comments per issue: 0
Average comments per pull request: 0
Merged pull requests: 0
Bot issues: 0
Bot pull requests: 0

Past Year

Issues: 0
Pull requests: 0
Average time to close issues: N/A
Average time to close pull requests: N/A
Issue authors: 0
Pull request authors: 0
Average comments per issue: 0
Average comments per pull request: 0
Merged pull requests: 0
Bot issues: 0
Bot pull requests: 0

View more stats

Top Authors

Issue Authors

Pull Request Authors

Top Labels

Issue Labels

Pull Request Labels

Packages

Total packages: 1
Total downloads:
- npm 25 last-month

Total dependent packages: 3
Total dependent repositories: 2
Total versions: 14
Total maintainers: 4

npmjs.org: @stdlib/blas-ext-base-dsort2hp

Simultaneously sort two double-precision floating-point strided arrays based on the sort order of the first array using heapsort.

Homepage: https://stdlib.io
License: Apache-2.0
Latest release: 0.2.2
published over 1 year ago

Versions: 14
Dependent Packages: 3
Dependent Repositories: 2
Downloads: 25 Last month

Rankings

Dependent packages count: 5.9%

Dependent repos count: 7.6%

Average: 11.8%

Downloads: 13.4%

Forks count: 15.4%

Stargazers count: 16.7%

Maintainers (4)

planeshifter rreusser stdlib-bot kgryte

Funding

type: opencollective
url: https://opencollective.com/stdlib

Last synced: 4 months ago

Dependencies

package.json npm

@stdlib/array-float64 ^0.0.x development
@stdlib/assert-is-browser ^0.0.x development
@stdlib/bench ^0.0.x development
@stdlib/blas-base-dcopy ^0.0.x development
@stdlib/math-base-assert-is-negative-zero ^0.0.x development
@stdlib/math-base-special-pow ^0.0.x development
@stdlib/math-base-special-round ^0.0.x development
@stdlib/random-base-discrete-uniform ^0.0.x development
@stdlib/random-base-randu ^0.0.x development
@stdlib/random-base-uniform ^0.0.x development
istanbul ^0.4.1 development
proxyquire ^2.0.0 development
tap-spec 5.x.x development
tape git+https://github.com/kgryte/tape.git#fix/globby development
@stdlib/math-base-assert-is-nan ^0.0.x
@stdlib/math-base-assert-is-positive-zero ^0.0.x
@stdlib/math-base-special-floor ^0.0.x
@stdlib/utils-define-nonenumerable-read-only-property ^0.0.x
@stdlib/utils-library-manifest ^0.0.x
@stdlib/utils-try-require ^0.0.x

.github/workflows/benchmark.yml actions

actions/checkout v3 composite
actions/setup-node v3 composite

.github/workflows/cancel.yml actions

styfle/cancel-workflow-action 0.11.0 composite

.github/workflows/close_pull_requests.yml actions

superbrothers/close-pull-request v3 composite

.github/workflows/examples.yml actions

actions/checkout v3 composite
actions/setup-node v3 composite

.github/workflows/npm_downloads.yml actions

actions/checkout v3 composite
actions/setup-node v3 composite
actions/upload-artifact v3 composite
distributhor/workflow-webhook v3 composite

.github/workflows/productionize.yml actions

act10ns/slack v1 composite
actions/checkout v3 composite
actions/setup-node v3 composite
stdlib-js/bundle-action main composite
stdlib-js/transform-errors-action main composite

.github/workflows/publish.yml actions

JS-DevTools/npm-publish v1 composite
act10ns/slack v1 composite
actions/checkout v3 composite
actions/setup-node v3 composite
styfle/cancel-workflow-action 0.11.0 composite

.github/workflows/test.yml actions

act10ns/slack v1 composite
actions/checkout v3 composite
actions/setup-node v3 composite

.github/workflows/test_bundles.yml actions

act10ns/slack v1 composite
actions/checkout v3 composite
actions/setup-node v3 composite
denoland/setup-deno v1 composite

.github/workflows/test_coverage.yml actions

act10ns/slack v1 composite
actions/checkout v3 composite
actions/setup-node v3 composite
codecov/codecov-action v3 composite
distributhor/workflow-webhook v3 composite

.github/workflows/test_install.yml actions

act10ns/slack v1 composite
actions/checkout v3 composite
actions/setup-node v3 composite

@stdlib/blas-ext-base-dsort2hp

Science Score: 57.0%

Keywords

Repository

Basic Info

Statistics

Topics

Metadata Files

README.md

dsort2hp

Owner

Citation (CITATION.cff)

GitHub Events

Total

Last Year

Committers

All Time

Past Year

Top Committers

Committer Domains (Top 20 + Academic)

Issues and Pull Requests

All Time

Past Year

Top Authors

Issue Authors

Pull Request Authors

Top Labels

Issue Labels

Pull Request Labels

Packages

npmjs.org: @stdlib/blas-ext-base-dsort2hp

Rankings

Maintainers (4)

Funding

Dependencies