All files main.js

100% Statements 61/61
100% Branches 2/2
100% Functions 1/1
100% Lines 61/61

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 622x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 15x 15x 15x 2x 2x 2x 2x 2x  
/**
* @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 stride2offset = require( '@stdlib/strided/base/stride2offset' );
var ndarray = require( './ndarray.js' );
 
 
// MAIN //
 
/**
* Computes the `k` maximum values of a strided array.
*
* ## Notes
*
* -   If `N <= 0`, the function fills the output array with `NaN`.
* -   If `k <= 0`, the function returns the output array unchanged.
* -   The function distinguishes between positive zero (`+0`) and negative zero (`-0`), treating positive zero as greater than negative zero when values are otherwise equal.
* -   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 will be unpredictable.
*
* @param {PositiveInteger} N - number of indexed elements
* @param {PositiveInteger} k - number of maximum values to return
* @param {NumericArray} x - input array
* @param {integer} strideX - stride length for `x`
* @param {NumericArray} out - output array
* @param {integer} strideOut - stride length for `out`
* @returns {NumericArray} output array
*
* @example
* var x = [ 1.0, 2.0, 3.0, 4.0, 5.0 ];
* var out = [ 0.0, 0.0, 0.0 ];
*
* maxk( x.length, 3, x, 1, out, 1 );
* // out => [ 3.0, 4.0, 5.0 ]
*/
function maxk( N, k, x, strideX, out, strideOut ) {
	return ndarray( N, k, x, strideX, stride2offset( N, strideX ), out, strideOut, stride2offset( k, strideOut ) ); // eslint-disable-line max-len
}
 
 
// EXPORTS //
 
module.exports = maxk;