Mode

Binomial distribution mode.

The mode for a binomial random variable is

where n is the number of trials, p is the success probability, and ⌊x⌋ is the floor function.

Usage

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

mode( n, p )

Returns the mode of a binomial distribution with number of trials n and success probability p.

var v = mode( 20, 0.1 );
// returns 2

v = mode( 50, 0.5 );
// returns 25

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

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

v = mode( 20, NaN );
// returns NaN

If provided a number of trials n which is not a nonnegative integer, the function returns NaN.

var v = mode( 1.5, 0.5 );
// returns NaN

v = mode( -2.0, 0.5 );
// returns NaN

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

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

v = mode( 20, 1.5 );
// 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/binomial/mode' );

var v;
var i;
var n;
var p;

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

C APIs

Usage

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

stdlib_base_dists_binomial_mode( n, p )

Returns the mode of a binomial distribution with number of trials n and success probability p.

double out = stdlib_base_dists_binomial_mode( 100, 0.1 );
// returns 10

The function accepts the following arguments:

n: [in] int32_t number of trials.
p: [in] double success probability.

double stdlib_base_dists_binomial_mode( const int32_t n, const double p );

Examples

#include "stdlib/stats/base/dists/binomial/mode.h"
#include "stdlib/math/base/special/ceil.h"
#include <stdlib.h>
#include <stdint.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 ) {
    int32_t n;
    double p;
    double y;
    int i;

    for ( i = 0; i < 25; i++ ) {
        n = stdlib_base_ceil( random_uniform( 0.0, 100.0 ) );
        p = random_uniform( 0.0, 1.0 );
        y = stdlib_base_dists_binomial_mode( n, p );
        printf( "n: %d, p: %lf, mode(X;n,p): %lf\n", n, p, y );
    }

    return 0;
}