index.js (1411B)
1 /** 2 * @license Apache-2.0 3 * 4 * Copyright (c) 2020 The Stdlib Authors. 5 * 6 * Licensed under the Apache License, Version 2.0 (the "License"); 7 * you may not use this file except in compliance with the License. 8 * You may obtain a copy of the License at 9 * 10 * http://www.apache.org/licenses/LICENSE-2.0 11 * 12 * Unless required by applicable law or agreed to in writing, software 13 * distributed under the License is distributed on an "AS IS" BASIS, 14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 * See the License for the specific language governing permissions and 16 * limitations under the License. 17 */ 18 19 'use strict'; 20 21 /** 22 * Calculate the maximum value of a strided array via a callback function and ignoring `NaN` values. 23 * 24 * @module @stdlib/stats/base/nanmax-by 25 * 26 * @example 27 * var nanmaxBy = require( '@stdlib/stats/base/nanmax-by' ); 28 * 29 * function accessor( v ) { 30 * return v * 2.0; 31 * } 32 * 33 * var x = [ -2.0, 1.0, 3.0, -5.0, 4.0, NaN, 0.0, -1.0, -3.0 ]; 34 * 35 * var v = nanmaxBy( x.length, x, 1, accessor ); 36 * // returns 8.0 37 * 38 * @example 39 * var nanmaxBy = require( '@stdlib/stats/base/nanmax-by' ); 40 * 41 * function accessor( v ) { 42 * return v * 2.0; 43 * } 44 * 45 * var x = [ -2.0, 1.0, 3.0, -5.0, 4.0, NaN, 0.0, -1.0, -3.0 ]; 46 * 47 * var v = nanmaxBy.ndarray( x.length, x, 1, 0, accessor ); 48 * // returns 8.0 49 */ 50 51 // MODULES // 52 53 var nanmaxBy = require( './main.js' ); 54 55 56 // EXPORTS // 57 58 module.exports = nanmaxBy;