@stdlib/stats-base-dists-geometric-entropy
    TypeScript icon, indicating that this package has built-in type declarations

    0.0.5 • Public • Published

    Entropy

    NPM version Build Status Coverage Status dependencies

    Geometric distribution entropy.

    The entropy (in nats) for a geometric random variable is

    Differential entropy for a geometric distribution.

    where p is the success probability.

    Installation

    npm install @stdlib/stats-base-dists-geometric-entropy

    Usage

    var entropy = require( '@stdlib/stats-base-dists-geometric-entropy' );

    entropy( p )

    Returns the entropy of a geometric distribution with success probability p (in nats).

    var v = entropy( 0.1 );
    // returns ~3.251
    
    v = entropy( 0.5 );
    // returns ~1.386

    If provided a success probability p outside of [0,1], the function returns NaN.

    var v = entropy( NaN );
    // returns NaN
    
    v = entropy( 1.5 );
    // returns NaN
    
    v = entropy( -1.0 );
    // returns NaN

    Examples

    var randu = require( '@stdlib/random-base-randu' );
    var round = require( '@stdlib/math-base-special-round' );
    var entropy = require( '@stdlib/stats-base-dists-geometric-entropy' );
    
    var v;
    var i;
    var p;
    
    for ( i = 0; i < 10; i++ ) {
        p = randu();
        v = entropy( p );
        console.log( 'p: %d, H(X;p): %d', p.toFixed( 4 ), v.toFixed( 4 ) );
    }

    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

    Copyright © 2016-2021. The Stdlib Authors.

    Install

    npm i @stdlib/stats-base-dists-geometric-entropy

    Homepage

    stdlib.io

    DownloadsWeekly Downloads

    13

    Version

    0.0.5

    License

    Apache-2.0

    Unpacked Size

    45.6 kB

    Total Files

    10

    Last publish

    Collaborators

    • stdlib-bot
    • kgryte
    • planeshifter
    • rreusser