All files / base/gminheapify/lib accessors.js

78.94% Statements 60/76
100% Branches 1/1
0% Functions 0/1
78.94% Lines 60/76

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 771x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x                                 1x 1x 1x 1x 1x  
/**
* @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.
*/
 
'use strict';
 
// MODULES //
 
var siftDown = require( '@stdlib/blas/ext/base/gminheap-sift-down' ).ndarray;
var floor = require( '@stdlib/math/base/special/floor' );
 
 
// MAIN //
 
/**
* Converts a strided array to a min-heap.
*
* ## Notes
*
* -   The min-heap algorithm is sensitive to the presence of `NaN` values. Since `NaN` comparisons always return `false`, if `NaN` values are present in the input array, the results may be unpredictable.
*
* @private
* @param {PositiveInteger} N - number of indexed elements
* @param {Object} x - array object
* @param {Collection} x.data - array data
* @param {Array<Function>} x.accessors - array element accessors
* @param {integer} strideX - stride length
* @param {NonNegativeInteger} offsetX - starting index
* @returns {Object} array object
*
* @example
* var toAccessorArray = require( '@stdlib/array/base/to-accessor-array' );
* var arraylike2object = require( '@stdlib/array/base/arraylike2object' );
*
* var x = [ 7.0, 5.0, 3.0, 1.0, 9.0 ];
*
* gminheapify( 5, arraylike2object( toAccessorArray( x ) ), 1, 0 );
*
* console.log( x );
* // => [ 1.0, 5.0, 3.0, 7.0, 9.0 ]
*/
function gminheapify( N, x, strideX, offsetX ) {
	var xget;
	var xbuf;
	var i;

	// Cache reference to array data:
	xbuf = x.data;

	// Cache reference to getter:
	xget = x.accessors[ 0 ];

	for ( i = floor( (N-1)/2 ); i >= 0; i-- ) {
		siftDown( N, i, xget( xbuf, offsetX+(i*strideX) ), xbuf, strideX, offsetX ); // eslint-disable-line max-len
	}
	return x;
}
 
 
// EXPORTS //
 
module.exports = gminheapify;