time-to-botec/squiggle/node_modules/@stdlib/stats/base/dmin/lib/dmin.js

81 lines
1.7 KiB
JavaScript
Raw Normal View History

/**
* @license Apache-2.0
*
* Copyright (c) 2020 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 isnan = require( '@stdlib/math/base/assert/is-nan' );
var isNegativeZero = require( '@stdlib/math/base/assert/is-negative-zero' );
// MAIN //
/**
* Computes the minimum value of a double-precision floating-point strided array.
*
* @param {PositiveInteger} N - number of indexed elements
* @param {Float64Array} x - input array
* @param {integer} stride - stride length
* @returns {number} minimum value
*
* @example
* var Float64Array = require( '@stdlib/array/float64' );
*
* var x = new Float64Array( [ 1.0, -2.0, 2.0 ] );
* var N = x.length;
*
* var v = dmin( N, x, 1 );
* // returns -2.0
*/
function dmin( N, x, stride ) {
var min;
var ix;
var v;
var i;
if ( N <= 0 ) {
return NaN;
}
if ( N === 1 || stride === 0 ) {
return x[ 0 ];
}
if ( stride < 0 ) {
ix = (1-N) * stride;
} else {
ix = 0;
}
min = x[ ix ];
for ( i = 1; i < N; i++ ) {
ix += stride;
v = x[ ix ];
if ( isnan( v ) ) {
return v;
}
if ( v < min || ( v === min && isNegativeZero( v ) ) ) {
min = v;
}
}
return min;
}
// EXPORTS //
module.exports = dmin;