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

    0.0.6 • Public • Published

    Entropy

    NPM version Build Status Coverage Status dependencies

    Degenerate distribution entropy.

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

    Entropy for a degenerate distribution.

    where μ is the constant value of the distribution.

    Installation

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

    Usage

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

    entropy( mu )

    Returns the entropy of a degenerate distribution with constant value mu.

    var v = entropy( 10.0 );
    // returns 0.0
    
    v = entropy( -0.5 );
    // returns 0.0
    
    v = entropy( NaN );
    // returns NaN

    Examples

    var randu = require( '@stdlib/random-base-randu' );
    var entropy = require( '@stdlib/stats-base-dists-degenerate-entropy' );
    
    var mu;
    var v;
    var i;
    
    for ( i = 0; i < 10; i++ ) {
        mu = randu();
        v = entropy( mu );
        console.log( 'µ: %d, H(X;µ): %d', mu.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-degenerate-entropy

    Homepage

    stdlib.io

    DownloadsWeekly Downloads

    17

    Version

    0.0.6

    License

    Apache-2.0

    Unpacked Size

    40.7 kB

    Total Files

    10

    Last publish

    Collaborators

    • stdlib-bot
    • kgryte
    • planeshifter
    • rreusser