UNPKG

@stdlib/stats

Version:

Standard library statistical functions.

79 lines (69 loc) 1.56 kB
/** * @license Apache-2.0 * * Copyright (c) 2018 The Stdlib Authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ 'use strict'; // MODULES // var isnan = require( '@stdlib/math/base/assert/is-nan' ); // MAIN // /** * Returns the excess kurtosis of a gamma distribution. * * @param {PositiveNumber} alpha - shape parameter * @param {PositiveNumber} beta - rate parameter * @returns {PositiveNumber} kurtosis * * @example * var v = kurtosis( 1.0, 1.0 ); * // returns 6.0 * * @example * var v = kurtosis( 4.0, 12.0 ); * // returns 1.5 * * @example * var v = kurtosis( 8.0, 2.0 ); * // returns 0.75 * * @example * var v = kurtosis( 1.0, -0.1 ); * // returns NaN * * @example * var v = kurtosis( -0.1, 1.0 ); * // returns NaN * * @example * var v = kurtosis( 2.0, NaN ); * // returns NaN * * @example * var v = kurtosis( NaN, 2.0 ); * // returns NaN */ function kurtosis( alpha, beta ) { if ( isnan( alpha ) || isnan( beta ) || alpha <= 0.0 || beta <= 0.0 ) { return NaN; } return 6.0 / alpha; } // EXPORTS // module.exports = kurtosis;