Narcissistic Passion Minified

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

    0.0.6 • Public • Published

    Mode

    NPM version Build Status Coverage Status dependencies

    F distribution mode.

    The mode for a F random variable with numerator degrees of freedom d1 and denominator degrees of freedom d2 is

    Mode for an F distribution.

    for d1 > 2 and d2 > 0. Otherwise, the mode is not defined.

    Installation

    npm install @stdlib/stats-base-dists-f-mode

    Usage

    var mode = require( '@stdlib/stats-base-dists-f-mode' );

    mode( d1, d2 )

    Returns the mode of a F distribution with parameters d1 (numerator degrees of freedom) and d2 (denominator degrees of freedom).

    var v = mode( 4.0, 5.0 );
    // returns ~0.357
    
    v = mode( 4.0, 12.0 );
    // returns ~0.429
    
    v = mode( 8.0, 4.0 );
    // returns 0.5

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

    var v = mode( NaN, 3.0 );
    // returns NaN
    
    v = mode( 3.0, NaN );
    // returns NaN

    If provided d1 <= 2, the function returns NaN.

    var v = mode( 1.0, 3.0 );
    // returns NaN
    
    v = mode( -1.0, 3.0 );
    // returns NaN

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

    var v = mode( 3.0, 0.0 );
    // returns NaN
    
    v = mode( 3.0, -1.0 );
    // returns NaN

    Examples

    var randu = require( '@stdlib/random-base-randu' );
    var EPS = require( '@stdlib/constants-float64-eps' );
    var mode = require( '@stdlib/stats-base-dists-f-mode' );
    
    var d1;
    var d2;
    var v;
    var i;
    
    for ( i = 0; i < 10; i++ ) {
        d1 = ( randu()*10.0 ) + EPS;
        d2 = ( randu()*10.0 ) + EPS;
        v = mode( d1, d2 );
        console.log( 'd1: %d, d2: %d, mode(X;d1,d2): %d', d1.toFixed( 4 ), d2.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-f-mode

    Homepage

    stdlib.io

    DownloadsWeekly Downloads

    7

    Version

    0.0.6

    License

    Apache-2.0

    Unpacked Size

    46.4 kB

    Total Files

    10

    Last publish

    Collaborators

    • stdlib-bot
    • kgryte
    • planeshifter
    • rreusser