factory.js (2102B)
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 constantFunction = require( '@stdlib/utils/constant-function' ); 24 var degenerate = require( './../../../../../base/dists/degenerate/cdf' ).factory; 25 var isnan = require( '@stdlib/math/base/assert/is-nan' ); 26 var sinpi = require( '@stdlib/math/base/special/sinpi' ); 27 var PI = require( '@stdlib/constants/float64/pi' ); 28 29 30 // MAIN // 31 32 /** 33 * Returns a function for evaluating the cumulative distribution function (CDF) for a raised cosine distribution with location parameter `mu` and scale parameter `s`. 34 * 35 * @param {number} mu - location parameter 36 * @param {NonNegativeNumber} s - scale parameter 37 * @returns {Function} CDF 38 * 39 * @example 40 * var cdf = factory( 3.0, 1.5 ); 41 * 42 * var y = cdf( 1.9 ); 43 * // returns ~0.015 44 * 45 * y = cdf( 4.0 ); 46 * // returns ~0.971 47 */ 48 function factory( mu, s ) { 49 if ( isnan( mu ) || isnan( s ) || s < 0.0 ) { 50 return constantFunction( NaN ); 51 } 52 if ( s === 0.0 ) { 53 return degenerate( mu ); 54 } 55 return cdf; 56 57 /** 58 * Evaluates the cumulative distribution function (CDF) for a raised cosine distribution. 59 * 60 * @private 61 * @param {number} x - input value 62 * @returns {Probability} evaluated CDF 63 * 64 * @example 65 * var y = cdf( 2.0 ); 66 * // returns <number> 67 */ 68 function cdf( x ) { 69 var z; 70 if ( isnan( x ) ) { 71 return NaN; 72 } 73 if ( x < mu - s ) { 74 return 0.0; 75 } 76 if ( x > mu + s ) { 77 return 1.0; 78 } 79 z = ( x - mu ) / s; 80 return ( 1.0 + z + ( sinpi( z ) / PI ) ) / 2.0; 81 } 82 } 83 84 85 // EXPORTS // 86 87 module.exports = factory;