Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stdlib-js/stats-base-dists-betaprime-mode
Beta prime distribution mode.
https://github.com/stdlib-js/stats-base-dists-betaprime-mode
beta betaprime center continuous dist distribution inverted javascript location mode node node-js nodejs prime prob probability statistics stats stdlib univariate
Last synced: 13 days ago
JSON representation
Beta prime distribution mode.
- Host: GitHub
- URL: https://github.com/stdlib-js/stats-base-dists-betaprime-mode
- Owner: stdlib-js
- License: apache-2.0
- Created: 2021-06-07T13:20:18.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-01T01:14:56.000Z (about 1 month ago)
- Last Synced: 2024-10-05T20:44:20.119Z (about 1 month ago)
- Topics: beta, betaprime, center, continuous, dist, distribution, inverted, javascript, location, mode, node, node-js, nodejs, prime, prob, probability, statistics, stats, stdlib, univariate
- Language: JavaScript
- Homepage: https://github.com/stdlib-js/stdlib
- Size: 448 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Citation: CITATION.cff
- Security: SECURITY.md
Awesome Lists containing this project
README
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 prime][betaprime-distribution] distribution [mode][mode].
The [mode][mode] for a [beta prime][betaprime-distribution] random variable is
```math
\mathop{\mathrm{mode}}(X) = \begin{cases}\frac{\alpha-1}{\beta+1} & \text{ if } \alpha \ge 1 \\ 0 & \text{ otherwise }\end{cases}
```
where `α > 0` is the first shape parameter and `β > 0` is the second shape parameter.
## Installation
```bash
npm install @stdlib/stats-base-dists-betaprime-mode
```
Alternatively,
- To load the package in a website via a `script` tag without installation and bundlers, use the [ES Module][es-module] available on the [`esm`][esm-url] branch (see [README][esm-readme]).
- If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions).
- For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [`umd`][umd-url] branch (see [README][umd-readme]).
The [branches.md][branches-url] file summarizes the available branches and displays a diagram illustrating their relationships.
To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.
## Usage
```javascript
var mode = require( '@stdlib/stats-base-dists-betaprime-mode' );
```
#### mode( alpha, beta )
Returns the [mode][mode] of a [beta prime][betaprime-distribution] distribution with parameters `alpha` (first shape parameter) and `beta` (second shape parameter).
```javascript
var v = mode( 8.0, 2.0 );
// returns ~2.333
v = mode( 4.0, 12.0 );
// returns ~0.231
v = mode( 1.0, 2.0 );
// returns 0.0
```
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 <= 0`, the function returns `NaN`.
```javascript
var v = mode( 0.0, 1.0 );
// returns NaN
v = mode( -1.0, 1.0 );
// returns NaN
```
If provided `beta <= 0`, the function returns `NaN`.
```javascript
var v = mode( 1.0, 0.0 );
// returns NaN
v = mode( 1.0, -1.0 );
// returns NaN
```
## Examples
```javascript
var randu = require( '@stdlib/random-base-randu' );
var EPS = require( '@stdlib/constants-float64-eps' );
var mode = require( '@stdlib/stats-base-dists-betaprime-mode' );
var alpha;
var beta;
var v;
var i;
for ( i = 0; i < 10; i++ ) {
alpha = ( randu()*10.0 ) + EPS;
beta = ( randu()*10.0 ) + EPS;
v = mode( alpha, beta );
console.log( 'α: %d, β: %d, mode(X;α,β): %d', alpha.toFixed( 4 ), beta.toFixed( 4 ), v.toFixed( 4 ) );
}
```
* * *
## 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
Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors].
[npm-image]: http://img.shields.io/npm/v/@stdlib/stats-base-dists-betaprime-mode.svg
[npm-url]: https://npmjs.org/package/@stdlib/stats-base-dists-betaprime-mode
[test-image]: https://github.com/stdlib-js/stats-base-dists-betaprime-mode/actions/workflows/test.yml/badge.svg?branch=main
[test-url]: https://github.com/stdlib-js/stats-base-dists-betaprime-mode/actions/workflows/test.yml?query=branch:main
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/stats-base-dists-betaprime-mode/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/stats-base-dists-betaprime-mode?branch=main
[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im
[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-betaprime-mode/tree/deno
[deno-readme]: https://github.com/stdlib-js/stats-base-dists-betaprime-mode/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/stats-base-dists-betaprime-mode/tree/umd
[umd-readme]: https://github.com/stdlib-js/stats-base-dists-betaprime-mode/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/stats-base-dists-betaprime-mode/tree/esm
[esm-readme]: https://github.com/stdlib-js/stats-base-dists-betaprime-mode/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/stats-base-dists-betaprime-mode/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/stats-base-dists-betaprime-mode/main/LICENSE
[betaprime-distribution]: https://en.wikipedia.org/wiki/Beta_prime_distribution
[mode]: https://en.wikipedia.org/wiki/Mode_%28statistics%29