Mode

Raised cosine distribution mode.

The mode for a raised cosine random variable with location parameter mu and scale parameter s is

Installation

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

Usage

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

mode( mu, s )

Returns the mode for a raised cosine distribution with location parameter mu and scale parameter s.

var y = mode( 2.0, 1.0 );
// returns 2.0

y = mode( 0.0, 1.0 );
// returns 0.0

y = mode( -1.0, 4.0 );
// returns -1.0

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

var y = mode( NaN, 1.0 );
// returns NaN

y = mode( 0.0, NaN );
// returns NaN

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

var y = mode( 0.0, 0.0 );
// returns NaN

y = mode( 0.0, -1.0 );
// returns NaN

Examples

var randu = require( '@stdlib/random-base-randu' );
var mode = require( '@stdlib/stats-base-dists-cosine-mode' );

var mu;
var s;
var y;
var i;

for ( i = 0; i < 10; i++ ) {
    mu = ( randu()*10.0 ) - 5.0;
    s = randu() * 20.0;
    y = mode( mu, s );
    console.log( 'µ: %d, s: %d, mode(X;µ,s): %d', mu.toFixed( 4 ), s.toFixed( 4 ), y.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

License

See LICENSE.

Copyright

Copyright © 2016-2024. The Stdlib Authors.