median.js (1246B)
1 /** 2 * @license Apache-2.0 3 * 4 * Copyright (c) 2018 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 // MODULES // 22 23 var isnan = require( '@stdlib/math/base/assert/is-nan' ); 24 25 26 // MAIN // 27 28 /** 29 * Returns the median of a Cauchy distribution. 30 * 31 * @param {number} x0 - location parameter 32 * @param {PositiveNumber} gamma - scale parameter 33 * @returns {number} median 34 * 35 * @example 36 * var v = median( 10.0, 5.0 ); 37 * // returns 10.0 38 * 39 * @example 40 * var v = median( 7.0, 0.1 ); 41 * // returns 7.0 42 * 43 * @example 44 * var v = median( 10.0, -0.5 ); 45 * // returns NaN 46 */ 47 function median( x0, gamma ) { 48 if ( 49 isnan( gamma ) || 50 isnan( x0 ) || 51 gamma <= 0.0 52 ) { 53 return NaN; 54 } 55 return x0; 56 } 57 58 59 // EXPORTS // 60 61 module.exports = median;