time-to-botec/js/node_modules/@stdlib/stats/base/max/lib/max.js
NunoSempere b6addc7f05 feat: add the node modules
Necessary in order to clearly see the squiggle hotwiring.
2022-12-03 12:44:49 +00:00

79 lines
1.6 KiB
JavaScript

/**
* @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 isPositiveZero = require( '@stdlib/math/base/assert/is-positive-zero' );
// MAIN //
/**
* Computes the maximum value of a strided array.
*
* @param {PositiveInteger} N - number of indexed elements
* @param {NumericArray} x - input array
* @param {integer} stride - stride length
* @returns {number} maximum value
*
* @example
* var x = [ 1.0, -2.0, 2.0 ];
* var N = x.length;
*
* var v = max( N, x, 1 );
* // returns 2.0
*/
function max( N, x, stride ) {
var max;
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;
}
max = x[ ix ];
for ( i = 1; i < N; i++ ) {
ix += stride;
v = x[ ix ];
if ( isnan( v ) ) {
return v;
}
if ( v > max || ( v === max && isPositiveZero( v ) ) ) {
max = v;
}
}
return max;
}
// EXPORTS //
module.exports = max;