File tree Expand file tree Collapse file tree 4 files changed +4
-28
lines changed
lib/node_modules/@stdlib/stats/base/dists/bernoulli/pmf Expand file tree Collapse file tree 4 files changed +4
-28
lines changed Original file line number Diff line number Diff line change @@ -171,7 +171,7 @@ double y = stdlib_base_dists_bernoulli_pmf( 0.5, 0.5 );
171171The function accepts the following arguments:
172172
173173- ** x** : ` [in] double ` input value.
174- - ** p** : ` [in] double ` success probability
174+ - ** p** : ` [in] double ` success probability.
175175
176176``` c
177177double stdlib_base_dists_bernoulli_pmf ( const double x, const double p );
Original file line number Diff line number Diff line change @@ -109,7 +109,7 @@ static double benchmark( void ) {
109109
110110 t = tic ();
111111 for ( i = 0 ; i < ITERATIONS ; i ++ ) {
112- y = stdlib_base_dists_bernoulli_pmf ( x [ i % 100 ], p [ i % 100 ] );
112+ y = stdlib_base_dists_bernoulli_pmf ( x [ i % 100 ], p [ i % 100 ] );
113113 if ( y != y ) {
114114 printf ( "should not return NaN\n" );
115115 break ;
Original file line number Diff line number Diff line change @@ -28,6 +28,7 @@ var addon = require( './../src/addon.node' );
2828/**
2929* Evaluates the moment-generating function (MGF) for a Bernoulli distribution with success probability `p` at a value `t`.
3030*
31+ * @private
3132* @param {number } x - input value
3233* @param {Probability } p - success probability
3334* @returns {Probability } evaluated PMF
Original file line number Diff line number Diff line change 2424*
2525* @param x input value
2626* @param p success probability
27- * @returns evaluated PMF
27+ * @returns expected value
2828*
2929* @example
3030* double y = stdlib_base_dists_bernoulli_pmf( 0.5, 0.5 );
3131* // returns ~0.5
32- *
33- * @example
34- * double y = stdlib_base_dists_bernoulli_pmf( 2.0, 0.1 );
35- * // returns ~1.0
36- *
37- * @example
38- * double y = stdlib_base_dists_bernoulli_pmf( -1.0, 0.3 );
39- * // returns ~0.0
40- *
41- * @example
42- * double y = stdlib_base_dists_bernoulli_pmf( NaN, 0.5 );
43- * // returns NaN
44- *
45- * @example
46- * double y = stdlib_base_dists_bernoulli_pmf( 0.0, NaN );
47- * // returns NaN
48- *
49- * @example
50- * double y = stdlib_base_dists_bernoulli_pmf( 0.0, NaN );
51- * // returns NaN
52- *
53- * @example
54- * // Invalid probability
55- * double y = stdlib_base_dists_bernoulli_pmf( 0.5, 1.4 );
56- * // returns NaN
5732*/
5833double stdlib_base_dists_bernoulli_pmf ( const double x , const double p ) {
5934 if (
You can’t perform that action at this time.
0 commit comments