cdf.js (1425B)
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 * Evaluates the cumulative distribution function (CDF) for a degenerate distribution with mean value `mu`. 30 * 31 * @param {number} x - input value 32 * @param {number} mu - constant value of distribution 33 * @returns {Probability} evaluated cumulative distribution function 34 * 35 * @example 36 * var y = cdf( 2.0, 3.0 ); 37 * // returns 0.0 38 * 39 * @example 40 * var y = cdf( 4.0, 3.0 ); 41 * // returns 1.0 42 * 43 * @example 44 * var y = cdf( 3.0, 3.0 ); 45 * // returns 1.0 46 * 47 * @example 48 * var y = cdf( NaN, 0.0 ); 49 * // returns NaN 50 * 51 * @example 52 * var y = cdf( 0.0, NaN ); 53 * // returns NaN 54 */ 55 function cdf( x, mu ) { 56 if ( isnan( x ) || isnan( mu ) ) { 57 return NaN; 58 } 59 return (x < mu) ? 0.0 : 1.0; 60 } 61 62 63 // EXPORTS // 64 65 module.exports = cdf;