About stdlib...

We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.

The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.

When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.

To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!

Mode

[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]

> [Beta][beta-distribution] distribution [mode][mode].

The [mode][mode] for a [beta][beta-distribution] random variable is

for α > 1 and β > 1. For other values of first shape parameter α and second shape parameter β, the mode is not defined.

Installation

``bash npm install @stdlib/stats-base-dists-beta-mode`

`Usage`

`javascript var mode = require( '@stdlib/stats-base-dists-beta-mode' );`

#### mode( alpha, beta )

Returns the [mode][mode] of a [beta][beta-distribution] distribution with parameters alpha (first shape parameter) and beta (second shape parameter).

`javascript var v = mode( 2.5, 1.5 ); // returns 0.75

v = mode( 4.0, 12.0 ); // returns ~0.214

v = mode( 8.0, 2.0 ); // returns 0.875`

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

`javascript var v = mode( NaN, 2.0 ); // returns NaN

v = mode( 2.0, NaN ); // returns NaN`

If provided alpha <= 1, the function returns NaN.

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

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

If provided beta <= 1, the function returns NaN.

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

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

`Examples`

`javascript var uniform = require( '@stdlib/random-array-uniform' ); var logEachMap = require( '@stdlib/console-log-each-map' ); var mode = require( '@stdlib/stats-base-dists-beta-mode' );

var opts = { 'dtype': 'float64' }; var alpha = uniform( 10, 1.0, 10.0, opts ); var beta = uniform( 10, 1.0, 10.0, opts );

logEachMap( 'α: %0.4f, β: %0.4f, mode(X;α,β): %0.4f', alpha, beta, mode );`

*

`C APIs`

`$3`

`c #include "stdlib/stats/base/dists/beta/mode.h"`

#### stdlib_base_dists_beta_mode( alpha, beta )

Returns the [mode][mode] of a [beta][beta-distribution] distribution with parameters alpha (first shape parameter) and beta (second shape parameter).

`c double out = stdlib_base_dists_beta_mode( 4.0, 12.0 ); // returns ~0.214`

The function accepts the following arguments:

- alpha: [in] doublefirst shape parameter. - beta:[in] double second shape parameter.

`c double stdlib_base_dists_beta_mode( const double alpha, const double beta );`

`$3`

`c #include "stdlib/stats/base/dists/beta/mode.h" #include #include

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 alpha; double beta; double y; int i; for ( i = 0; i < 25; i++ ) { alpha = random_uniform( 1.0, 11.0 ); beta = random_uniform( 1.0, 11.0 ); y = stdlib_base_dists_beta_mode( alpha, beta ); printf( "α: %lf, β: %lf, mode(X;α,β): %lf\n", alpha, beta, y ); } }`

*

`Notice`

This package is part of [stdlib][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][stdlib], see the main project [repository][stdlib].

#### Community

[![Chat][chat-image]][chat-url]

---

`License`

See [LICENSE][stdlib-license].

`Copyright`

[npm-image]: http://img.shields.io/npm/v/@stdlib/stats-base-dists-beta-mode.svg [npm-url]: https://npmjs.org/package/@stdlib/stats-base-dists-beta-mode

[test-image]: https://github.com/stdlib-js/stats-base-dists-beta-mode/actions/workflows/test.yml/badge.svg?branch=v0.3.1 [test-url]: https://github.com/stdlib-js/stats-base-dists-beta-mode/actions/workflows/test.yml?query=branch:v0.3.1

[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/stats-base-dists-beta-mode/main.svg [coverage-url]: https://codecov.io/github/stdlib-js/stats-base-dists-beta-mode?branch=main

[chat-image]: https://img.shields.io/badge/zulip-join_chat-brightgreen.svg [chat-url]: https://stdlib.zulipchat.com

[stdlib]: https://github.com/stdlib-js/stdlib

[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors

[umd]: https://github.com/umdjs/umd [es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules

[deno-url]: https://github.com/stdlib-js/stats-base-dists-beta-mode/tree/deno [deno-readme]: https://github.com/stdlib-js/stats-base-dists-beta-mode/blob/deno/README.md [umd-url]: https://github.com/stdlib-js/stats-base-dists-beta-mode/tree/umd [umd-readme]: https://github.com/stdlib-js/stats-base-dists-beta-mode/blob/umd/README.md [esm-url]: https://github.com/stdlib-js/stats-base-dists-beta-mode/tree/esm [esm-readme]: https://github.com/stdlib-js/stats-base-dists-beta-mode/blob/esm/README.md [branches-url]: https://github.com/stdlib-js/stats-base-dists-beta-mode/blob/main/branches.md

[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/stats-base-dists-beta-mode/main/LICENSE

[beta-distribution]: https://en.wikipedia.org/wiki/Beta_distribution

[mode]: https://en.wikipedia.org/wiki/Mode_%28statistics%29


  
    About stdlib...
  

  We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.

  The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.

  When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.

  To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!

`Mode`

[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]

> [Beta][beta-distribution] distribution [mode][mode].

The [mode][mode] for a [beta][beta-distribution] random variable is

for α > 1 and β > 1. For other values of first shape parameter α and second shape parameter β, the mode is not defined.

`Installation`

``bash npm install @stdlib/stats-base-dists-beta-mode `

`Usage`

`javascript var mode = require( '@stdlib/stats-base-dists-beta-mode' ); `

#### mode( alpha, beta )

Returns the [mode][mode] of a [beta][beta-distribution] distribution with parameters alpha (first shape parameter) and beta (second shape parameter).

`javascript var v = mode( 2.5, 1.5 ); // returns 0.75

v = mode( 4.0, 12.0 ); // returns ~0.214

v = mode( 8.0, 2.0 ); // returns 0.875 `

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

`javascript var v = mode( NaN, 2.0 ); // returns NaN

v = mode( 2.0, NaN ); // returns NaN `

If provided alpha <= 1, the function returns NaN.

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

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

If provided beta <= 1, the function returns NaN.

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

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

`Examples`

`javascript var uniform = require( '@stdlib/random-array-uniform' ); var logEachMap = require( '@stdlib/console-log-each-map' ); var mode = require( '@stdlib/stats-base-dists-beta-mode' );

var opts = { 'dtype': 'float64' }; var alpha = uniform( 10, 1.0, 10.0, opts ); var beta = uniform( 10, 1.0, 10.0, opts );

logEachMap( 'α: %0.4f, β: %0.4f, mode(X;α,β): %0.4f', alpha, beta, mode ); `

*

`C APIs`

`$3`

`c #include "stdlib/stats/base/dists/beta/mode.h" `

#### stdlib_base_dists_beta_mode( alpha, beta )

Returns the [mode][mode] of a [beta][beta-distribution] distribution with parameters alpha (first shape parameter) and beta (second shape parameter).

`c double out = stdlib_base_dists_beta_mode( 4.0, 12.0 ); // returns ~0.214 `

The function accepts the following arguments:

- alpha: [in] double first shape parameter. - beta: [in] double second shape parameter.

`c double stdlib_base_dists_beta_mode( const double alpha, const double beta ); `

`$3`

`c #include "stdlib/stats/base/dists/beta/mode.h" #include #include

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 alpha; double beta; double y; int i; for ( i = 0; i < 25; i++ ) { alpha = random_uniform( 1.0, 11.0 ); beta = random_uniform( 1.0, 11.0 ); y = stdlib_base_dists_beta_mode( alpha, beta ); printf( "α: %lf, β: %lf, mode(X;α,β): %lf\n", alpha, beta, y ); } } `

*

`Notice`

For more information on the project, filing bug reports and feature requests, and guidance on how to develop [stdlib][stdlib], see the main project [repository][stdlib].

#### Community

[![Chat][chat-image]][chat-url]

---

`License`

See [LICENSE][stdlib-license].

`Copyright`

[npm-image]: http://img.shields.io/npm/v/@stdlib/stats-base-dists-beta-mode.svg [npm-url]: https://npmjs.org/package/@stdlib/stats-base-dists-beta-mode

[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/stats-base-dists-beta-mode/main.svg [coverage-url]: https://codecov.io/github/stdlib-js/stats-base-dists-beta-mode?branch=main

[chat-image]: https://img.shields.io/badge/zulip-join_chat-brightgreen.svg [chat-url]: https://stdlib.zulipchat.com

[stdlib]: https://github.com/stdlib-js/stdlib

[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors

[umd]: https://github.com/umdjs/umd [es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules

[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/stats-base-dists-beta-mode/main/LICENSE

[beta-distribution]: https://en.wikipedia.org/wiki/Beta_distribution

[mode]: https://en.wikipedia.org/wiki/Mode_%28statistics%29