@stdlib/stats/base/maxsorted/lib/index.js

Standard library statistical functions.

/**
* @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';

/**
* Compute the maximum value of a sorted strided array.
*
* @module @stdlib/stats/base/maxsorted
*
* @example
* var maxsorted = require( '@stdlib/stats/base/maxsorted' );
*
* var x = [ 1.0, 2.0, 3.0 ];
* var N = x.length;
*
* var v = maxsorted( N, x, 1 );
* // returns 3.0
*
* @example
* var floor = require( '@stdlib/math/base/special/floor' );
* var maxsorted = require( '@stdlib/stats/base/maxsorted' );
*
* var x = [ 2.0, -3.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ];
* var N = floor( x.length / 2 );
*
* var v = maxsorted.ndarray( N, x, 2, 1 );
* // returns 4.0
*/

// MODULES //

var maxsorted = require( './main.js' );


// EXPORTS //

module.exports = maxsorted;

// exports: { "ndarray": "maxsorted.ndarray" }