@@ -26,51 +26,38 @@ var addon = require( './../src/addon.node' );
2626// MAIN //
2727
2828/**
29- * Evaluates the cumulative distribution function (CDF) for an arcsine distribution with minimum support `a ` and maximum support `b` at a value `x `.
29+ * Returns the excess kurtosis for a lognormal distribution with location `mu ` and scale `sigma `.
3030*
3131* @private
32- * @param {number } x - input value
33- * @param {number } a - minimum support
34- * @param {number } b - maximum support
35- * @returns {Probability } evaluated CDF
32+ * @param {number } mu - location parameter
33+ * @param {PositiveNumber } sigma - scale parameter
34+ * @returns {number } excess kurtosis
3635*
3736* @example
38- * var y = cdf( 9.0, 0 .0, 10 .0 );
39- * // returns ~0.795
37+ * var y = kurtosis( 0 .0, 1 .0 );
38+ * // returns ~110.936
4039*
4140* @example
42- * var y = cdf( 0.5, 0 .0, 2.0 );
43- * // returns ~0.333
41+ * var y = kurtosis( 5 .0, 2.0 );
42+ * // returns ~9220556.977
4443*
4544* @example
46- * var y = cdf( +Infinity, 2.0, 4.0 );
47- * // returns 1.0
48- *
49- * @example
50- * var y = cdf( -Infinity, 2.0, 4.0 );
51- * // returns 0.0
52- *
53- * @example
54- * var y = cdf( NaN, 0.0, 1.0 );
55- * // returns NaN
56- *
57- * @example
58- * var y = cdf( 0.0, NaN, 1.0 );
45+ * var y = kurtosis( NaN, 1.0 );
5946* // returns NaN
6047*
6148* @example
62- * var y = cdf( 0.0, 0.0, NaN );
49+ * var y = kurtosis( 0.0, NaN );
6350* // returns NaN
6451*
6552* @example
66- * var y = cdf( 2.0, 1 .0, 0.0 );
53+ * var y = kurtosis( 0 .0, 0.0 );
6754* // returns NaN
6855*/
69- function cdf ( x , a , b ) {
70- return addon ( x , a , b ) ;
56+ function kurtosis ( mu , sigma ) {
57+ return addon ( mu , sigma ) ;
7158}
7259
7360
7461// EXPORTS //
7562
76- module . exports = cdf ;
63+ module . exports = kurtosis ;
0 commit comments