index.js (1240B)
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 * Compute the maximum value of a strided array. 23 * 24 * @module @stdlib/stats/base/max 25 * 26 * @example 27 * var max = require( '@stdlib/stats/base/max' ); 28 * 29 * var x = [ 1.0, -2.0, 2.0 ]; 30 * var N = x.length; 31 * 32 * var v = max( N, x, 1 ); 33 * // returns 2.0 34 * 35 * @example 36 * var floor = require( '@stdlib/math/base/special/floor' ); 37 * var max = require( '@stdlib/stats/base/max' ); 38 * 39 * var x = [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ]; 40 * var N = floor( x.length / 2 ); 41 * 42 * var v = max.ndarray( N, x, 2, 1 ); 43 * // returns 4.0 44 */ 45 46 // MODULES // 47 48 var max = require( './main.js' ); 49 50 51 // EXPORTS // 52 53 module.exports = max;