time-to-botec

Benchmark sampling in different programming languages
Log | Files | Refs | README

logcdf.js (2307B)

      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 var pow = require( '@stdlib/math/base/special/pow' );
     25 var ln = require( '@stdlib/math/base/special/ln' );
     26 var NINF = require( '@stdlib/constants/float64/ninf' );
     27 
     28 
     29 // MAIN //
     30 
     31 /**
     32 * Evaluates the natural logarithm of the cumulative distribution function (CDF) for a Kumaraswamy's double bounded distribution with first shape parameter `a` and second shape parameter `b` at a value `x`.
     33 *
     34 * @param {number} x - input value
     35 * @param {PositiveNumber} a - first shape parameter
     36 * @param {PositiveNumber} b - second shape parameter
     37 * @returns {number} evaluated logCDF
     38 *
     39 * @example
     40 * var y = logcdf( 0.5, 1.0, 1.0 );
     41 * // returns ~-0.693
     42 *
     43 * @example
     44 * var y = logcdf( 0.5, 2.0, 4.0 );
     45 * // returns ~-0.38
     46 *
     47 * @example
     48 * var y = logcdf( 0.2, 2.0, 2.0 );
     49 * // returns ~-2.546
     50 *
     51 * @example
     52 * var y = logcdf( 0.8, 4.0, 4.0 );
     53 * // returns ~-0.13
     54 *
     55 * @example
     56 * var y = logcdf( -0.5, 4.0, 2.0 );
     57 * // returns -Infinity
     58 *
     59 * @example
     60 * var y = logcdf( 1.5, 4.0, 2.0 );
     61 * // returns 0.0
     62 *
     63 * @example
     64 * var y = logcdf( 2.0, -1.0, 0.5 );
     65 * // returns NaN
     66 *
     67 * @example
     68 * var y = logcdf( 2.0, 0.5, -1.0 );
     69 * // returns NaN
     70 *
     71 * @example
     72 * var y = logcdf( NaN, 1.0, 1.0 );
     73 * // returns NaN
     74 *
     75 * @example
     76 * var y = logcdf( 0.0, NaN, 1.0 );
     77 * // returns NaN
     78 *
     79 * @example
     80 * var y = logcdf( 0.0, 1.0, NaN );
     81 * // returns NaN
     82 */
     83 function logcdf( x, a, b ) {
     84 	if (
     85 		isnan( x ) ||
     86 		isnan( a ) ||
     87 		isnan( b ) ||
     88 		a <= 0.0 ||
     89 		b <= 0.0
     90 	) {
     91 		return NaN;
     92 	}
     93 	if ( x <= 0.0 ) {
     94 		return NINF;
     95 	}
     96 	if ( x >= 1.0 ) {
     97 		return 0.0;
     98 	}
     99 	return ln( 1.0 - pow( 1.0 - pow( x, a ), b ) );
    100 }
    101 
    102 
    103 // EXPORTS //
    104 
    105 module.exports = logcdf;