Skip to content

Files

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
Dec 17, 2024
Aug 19, 2023
Dec 17, 2024
Dec 17, 2024
Dec 17, 2024
Dec 17, 2024
Dec 17, 2024
Dec 17, 2024
Dec 17, 2024
Dec 17, 2024
Dec 17, 2024
Dec 17, 2024

Mode

Chi distribution mode.

The mode for a chi random variable is

mode ( X ) = k 1

for degrees of freedom k >= 1. For other values of k, the mode is not defined.

Usage

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

mode( k )

Returns the mode of a chi distribution with degrees of freedom k.

var v = mode( 9.0 );
// returns ~2.828

v = mode( 1.5 );
// returns ~0.707

If provided k < 1, the function returns NaN.

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

v = mode( 0.9 );
// returns NaN

Examples

var randu = require( '@stdlib/random/base/randu' );
var round = require( '@stdlib/math/base/special/round' );
var mode = require( '@stdlib/stats/base/dists/chi/mode' );

var k;
var v;
var i;

for ( i = 0; i < 10; i++ ) {
    k = randu() * 20.0;
    v = mode( k );
    console.log( 'k: %d, mode(X,k): %d', k.toFixed( 4 ), v.toFixed( 4 ) );
}

C APIs

Usage

#include "stdlib/stats/base/dists/chi/mode.h"

stdlib_base_dists_chi_mode( k )

Evaluates the mode of a chi distribution with degrees of freedom k.

double out = stdlib_base_dists_chi_mode( 9.0 );
// returns ~2.828

The function accepts the following arguments:

  • k: [in] double degrees of freedom.
double stdlib_base_dists_chi_mode( const double k );

Examples

#include "stdlib/stats/base/dists/chi/mode.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 k;
    double y;
    int i;
    
    for ( i = 0; i < 25; i++ ) {
        k = random_uniform( 0.0, 20.0 );
        y = stdlib_base_dists_chi_mode( k );
        printf( "k: %lf, mode(X;k): %lf\n", k, y );
    }
}