npm.io
0.2.3 • Published 9 months ago

@stdlib/stats-base-dists-pareto-type1-kurtosis

Licence
Apache-2.0
Version
0.2.3
Deps
4
Size
46 kB
Vulns
0
Weekly
0
Stars
2
About stdlib...

We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.

The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.

When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.

To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!

Kurtosis

NPM version Build Status Coverage Status

Pareto (Type I) distribution excess kurtosis.

The excess kurtosis for a Pareto (Type I) random variable with shape parameter α and scale parameter β is

Excess kurtosis for a Pareto (Type I) distribution.

for α > 4 and β > 0. Otherwise, the kurtosis is not defined.

Installation

npm install @stdlib/stats-base-dists-pareto-type1-kurtosis

Usage

var kurtosis = require( '@stdlib/stats-base-dists-pareto-type1-kurtosis' );
kurtosis( alpha, beta )

Returns the excess kurtosis of a Pareto (Type I) distribution with parameters alpha (shape parameter) and beta (scale parameter).

var v = kurtosis( 5.0, 1.0 );
// returns ~70.8

v = kurtosis( 4.5, 12.0 );
// returns ~146.444

v = kurtosis( 8.0, 2.0 );
// returns ~19.725

If provided NaN as any argument, the function returns NaN.

var v = kurtosis( NaN, 2.0 );
// returns NaN

v = kurtosis( 2.0, NaN );
// returns NaN

If provided alpha <= 4, the function returns NaN.

var v = kurtosis( 0.0, 1.0 );
// returns NaN

v = kurtosis( 3.0, 1.0 );
// returns NaN

v = kurtosis( 4.0, 2.0 );
// returns NaN

v = kurtosis( -1.0, 1.0 );
// returns NaN

If provided beta <= 0, the function returns NaN.

var v = kurtosis( 1.0, 0.0 );
// returns NaN

v = kurtosis( 1.0, -1.0 );
// returns NaN

Examples

var uniform = require( '@stdlib/random-array-uniform' );
var EPS = require( '@stdlib/constants-float64-eps' );
var logEachMap = require( '@stdlib/console-log-each-map' );
var kurtosis = require( '@stdlib/stats-base-dists-pareto-type1-kurtosis' );

var opts = {
    'dtype': 'float64'
};
var alpha = uniform( 10, EPS + 4.0, 10.0, opts );
var beta = uniform( 10, EPS, 10.0, opts );

logEachMap( 'α: %0.4f, β: %0.4f, Kurt(X;α,β): %0.4f', alpha, beta, kurtosis );

C APIs

Usage
#include "stdlib/stats/base/dists/pareto-type1/kurtosis.h"
stdlib_base_dists_pareto_type1_kurtosis( alpha, beta )

Returns the excess kurtosis of a Pareto (Type I) distribution.

double out = stdlib_base_dists_pareto_type1_kurtosis( 5.0, 1.0 );
// returns ~70.8

The function accepts the following arguments:

  • alpha: [in] double shape parameter.
  • beta: [in] double scale parameter.
double stdlib_base_dists_pareto_type1_kurtosis( const double alpha, const double beta );
Examples
#include "stdlib/stats/base/dists/pareto-type1/kurtosis.h"
#include <stdlib.h>
#include <stdio.h>

static double random_uniform( const double min, const double max ) {
    double v = (double)rand() / ( (double)RAND_MAX + 1.0 );
    return min + ( v*(max-min) );
}

int main( void ) {
    double alpha;
    double beta;
    double y;
    int i;

    for ( i = 0; i < 25; i++ ) {
        alpha = random_uniform( 0.0, 10.0 ) + 4.0;
        beta = random_uniform( 0.0, 10.0 );
        y = stdlib_base_dists_pareto_type1_kurtosis( alpha, beta );
        printf( "α: %lf, β: %lf, kurtosis(X;α,β): %lf\n", alpha, beta, y );
    }
}

Notice

This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.

Community

Chat


License

See LICENSE.

Copyright 2016-2026. The Stdlib Authors.

Keywords