@stdlib/blas-ext-base-gsort2hp
Version:
Simultaneously sort two strided arrays based on the sort order of the first array using heapsort.
186 lines (163 loc) • 5.92 kB
JavaScript
/**
* @license Apache-2.0
*
* Copyright (c) 2025 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.
*/
;
// MODULES //
var isPositiveZero = require( '@stdlib/math-base-assert-is-positive-zero' );
var isnan = require( '@stdlib/math-base-assert-is-nan' );
var floor = require( '@stdlib/math-base-special-floor' );
// MAIN //
/**
* Simultaneously sorts two double-precision floating-point strided arrays based on the sort order of the first array using heapsort.
*
* ## Notes
*
* - This implementation uses an in-place algorithm derived from the work of Floyd (1964).
*
* ## 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](https://doi.org/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](https://doi.org/10.1145/355588.365103).
*
* @private
* @param {PositiveInteger} N - number of indexed elements
* @param {number} order - sort order
* @param {Object} x - first input array object
* @param {Collection} x.data - first input array data
* @param {Array<Function>} x.accessors - first input array element accessors
* @param {integer} strideX - stride length for `x`
* @param {NonNegativeInteger} offsetX - starting index for `x`
* @param {Object} y - second input array object
* @param {Collection} y.data - second input array data
* @param {Array<Function>} y.accessors - second input array element accessors
* @param {integer} strideY - stride length for `y`
* @param {NonNegativeInteger} offsetY - starting index for `y`
* @returns {Object} `x`
*
* @example
* var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' );
* var arraylike2object = require( '@stdlib/array-base-arraylike2object' );
*
* var x = [ 1.0, -2.0, 3.0, -4.0 ];
* var y = [ 0.0, 1.0, 2.0, 3.0 ];
*
* gsort2hp( x.length, 1.0, arraylike2object( toAccessorArray( x ) ), 1, 0, arraylike2object( toAccessorArray( 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 ]
*/
function gsort2hp( N, order, x, strideX, offsetX, y, strideY, offsetY ) {
var parent;
var child;
var xbuf;
var ybuf;
var xget;
var yget;
var xset;
var yset;
var v1;
var v2;
var tx;
var ty;
var ix;
var iy;
var n;
var j;
var k;
// Cache reference to array data:
xbuf = x.data;
ybuf = y.data;
// Cache reference to the element accessors:
xget = x.accessors[ 0 ];
xset = x.accessors[ 1 ];
yget = y.accessors[ 0 ];
yset = y.accessors[ 1 ];
// For a positive stride, sorting in decreasing order is equivalent to providing a negative stride and sorting in increasing order, and, for a negative stride, sorting in decreasing order is equivalent to providing a positive stride and sorting in increasing order...
if ( order < 0.0 ) {
strideX *= -1;
strideY *= -1;
offsetX -= (N-1) * strideX;
offsetY -= (N-1) * strideY;
}
// Set the initial heap size:
n = N;
// Specify an initial "parent" index for building the heap:
parent = floor( N / 2 );
// Continue looping until the array is sorted...
while ( true ) {
if ( parent > 0 ) {
// We need to build the heap...
parent -= 1;
tx = xget( xbuf, offsetX+(parent*strideX) );
ty = yget( ybuf, offsetY+(parent*strideY) );
} else {
// Reduce the heap size:
n -= 1;
// Check if the heap is empty, and, if so, we are finished sorting...
if ( n === 0 ) {
return x;
}
// Store the last heap value in a temporary variable in order to make room for the heap root being placed into its sorted position:
ix = offsetX + (n*strideX);
tx = xget( xbuf, ix );
iy = offsetY + (n*strideY);
ty = yget( ybuf, iy );
// Move the heap root to its sorted position:
xset( xbuf, ix, xget( xbuf, offsetX ) );
yset( ybuf, iy, yget( ybuf, offsetY ) );
}
// We need to "sift down", pushing `t` down the heap to in order to replace the parent and satisfy the heap property...
// Start at the parent index:
j = parent;
// Get the "left" child index:
child = (j*2) + 1;
while ( child < n ) {
// Find the largest child...
k = child + 1;
if ( k < n ) {
v1 = xget( xbuf, offsetX+(k*strideX) );
v2 = xget( xbuf, offsetX+(child*strideX) );
// Check if a "right" child exists and is "bigger"...
if ( v1 > v2 || isnan( v1 ) || (v1 === v2 && isPositiveZero( v1 ) ) ) { // eslint-disable-line max-len
child += 1;
}
}
// Check if the largest child is bigger than `t`...
v1 = xget( xbuf, offsetX+(child*strideX) );
if ( v1 > tx || isnan( v1 ) || ( v1 === tx && isPositiveZero( v1 ) ) ) { // eslint-disable-line max-len
// Insert the larger child value:
xset( xbuf, offsetX+(j*strideX), v1 );
yset( ybuf, offsetY+(j*strideY), yget( ybuf, offsetY+(child*strideY) ) ); // eslint-disable-line max-len
// Update `j` to point to the child index:
j = child;
// Get the "left" child index and repeat...
child = (j*2) + 1;
} else {
// We've found `t`'s place in the heap...
break;
}
}
// Insert `t` into the heap:
xset( xbuf, offsetX+(j*strideX), tx );
yset( ybuf, offsetY+(j*strideY), ty );
}
}
// EXPORTS //
module.exports = gsort2hp;