@stdlib/stats-base-dists-binomial-mean

<details> <summary> About stdlib... </summary> <p>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.</p> <p>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.</p> <p>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.</p> <p>To join us in bringing numerical computing to the web, get started by checking us out on <a href="https://github.com/stdlib-js/stdlib">GitHub</a>, and please consider <a href="https://opencollective.com/stdlib">financially supporting stdlib</a>. We greatly appreciate your continued support!</p> </details> # Mean [![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]  > [Binomial][binomial-distribution] distribution [expected value][expected-value].  <section class="intro"> The [expected value][expected-value] for a [binomial][binomial-distribution] random variable is  <div class="equation" align="center" data-raw-text="\mathbb{E}\left[ X \right] = n p" data-equation="eq:binomial_expectation"> <img src="https://cdn.jsdelivr.net/gh/stdlib-js/stdlib@51534079fef45e990850102147e8945fb023d1d0/lib/node_modules/@stdlib/stats/base/dists/binomial/mean/docs/img/equation_binomial_expectation.svg" alt="Expected value for a binomial distribution."> <br> </div>  where `n` is the number of trials and `p` is the success probability. </section>   <section class="installation"> ## Installation ```bash npm install @stdlib/stats-base-dists-binomial-mean ``` </section> <section class="usage"> ## Usage ```javascript var mean = require( '@stdlib/stats-base-dists-binomial-mean' ); ``` #### mean( n, p ) Returns the [expected value][expected-value] of a [binomial][binomial-distribution] distribution with number of trials `n` and success probability `p`. ```javascript var v = mean( 20, 0.1 ); // returns 2.0 v = mean( 50, 0.5 ); // returns 25.0 ``` If provided `NaN` as any argument, the function returns `NaN`. ```javascript var v = mean( NaN, 0.5 ); // returns NaN v = mean( 20, NaN ); // returns NaN ``` If provided a number of trials `n` which is not a nonnegative integer, the function returns `NaN`. ```javascript var v = mean( 1.5, 0.5 ); // returns NaN v = mean( -2.0, 0.5 ); // returns NaN ``` If provided a success probability `p` outside of `[0,1]`, the function returns `NaN`. ```javascript var v = mean( 20, -1.0 ); // returns NaN v = mean( 20, 1.5 ); // returns NaN ``` </section>   <section class="notes"> </section>   <section class="examples"> ## Examples  ```javascript var randu = require( '@stdlib/random-base-randu' ); var round = require( '@stdlib/math-base-special-round' ); var mean = require( '@stdlib/stats-base-dists-binomial-mean' ); var v; var i; var n; var p; for ( i = 0; i < 10; i++ ) { n = round( randu() * 100.0 ); p = randu(); v = mean( n, p ); console.log( 'n: %d, p: %d, E(X;n,p): %d', n, p.toFixed( 4 ), v.toFixed( 4 ) ); } ``` </section>   <section class="references"> </section>   <section class="related"> </section>   <section class="main-repo" > * * * ## 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]. </section>   <section class="links"> [npm-image]: http://img.shields.io/npm/v/@stdlib/stats-base-dists-binomial-mean.svg [npm-url]: https://npmjs.org/package/@stdlib/stats-base-dists-binomial-mean [test-image]: https://github.com/stdlib-js/stats-base-dists-binomial-mean/actions/workflows/test.yml/badge.svg?branch=v0.2.2 [test-url]: https://github.com/stdlib-js/stats-base-dists-binomial-mean/actions/workflows/test.yml?query=branch:v0.2.2 [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/stats-base-dists-binomial-mean/main.svg [coverage-url]: https://codecov.io/github/stdlib-js/stats-base-dists-binomial-mean?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-binomial-mean/tree/deno [deno-readme]: https://github.com/stdlib-js/stats-base-dists-binomial-mean/blob/deno/README.md [umd-url]: https://github.com/stdlib-js/stats-base-dists-binomial-mean/tree/umd [umd-readme]: https://github.com/stdlib-js/stats-base-dists-binomial-mean/blob/umd/README.md [esm-url]: https://github.com/stdlib-js/stats-base-dists-binomial-mean/tree/esm [esm-readme]: https://github.com/stdlib-js/stats-base-dists-binomial-mean/blob/esm/README.md [branches-url]: https://github.com/stdlib-js/stats-base-dists-binomial-mean/blob/main/branches.md [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/stats-base-dists-binomial-mean/main/LICENSE [binomial-distribution]: https://en.wikipedia.org/wiki/Binomial_distribution [expected-value]: https://en.wikipedia.org/wiki/Expected_value </section>