Skip to content

Commit 0009cc7

Browse files
chore: stuff from code review
1 parent 5a4ed12 commit 0009cc7

File tree

10 files changed

+19
-54
lines changed

10 files changed

+19
-54
lines changed

lib/node_modules/@stdlib/stats/base/dists/bernoulli/pmf/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -156,16 +156,16 @@ for ( i = 0; i < 10; i++ ) {
156156
### Usage
157157

158158
```c
159-
#include "stdlib/stats/base/dists/bernoulli/cdf.h"
159+
#include "stdlib/stats/base/dists/bernoulli/pmf.h"
160160
```
161161

162162
#### stdlib_base_dists_bernoulli_pmf( x, p )
163163

164164
Returns a function for evaluating the [probability mass function][pmf] (PMF) of a [Bernoulli][bernoulli-distribution] distribution with success probability `0 <= p <= 1`.
165165

166166
```c
167-
double y = stdlib_base_dists_bernoulli_pmf( 0.5, 0.5 );
168-
// returns 0.5
167+
double y = stdlib_base_dists_bernoulli_pmf( 1.0, 0.3 );
168+
// returns 0.3
169169
```
170170

171171
The function accepts the following arguments:

lib/node_modules/@stdlib/stats/base/dists/bernoulli/pmf/benchmark/benchmark.js

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@
2222

2323
var bench = require( '@stdlib/bench' );
2424
var uniform = require( '@stdlib/random/base/uniform' );
25+
var discreteUniform = require( '@stdlib/random/base/discrete-uniform' );
2526
var Float64Array = require( '@stdlib/array/float64' );
2627
var round = require( '@stdlib/math/base/special/round' );
2728
var isnan = require( '@stdlib/math/base/assert/is-nan' );
@@ -42,7 +43,7 @@ bench( pkg, function benchmark( b ) {
4243
x = new Float64Array( len );
4344
p = new Float64Array( len );
4445
for ( i = 0; i < len; i++ ) {
45-
x[ i ] = round( uniform( 0.0, 3.0 ) );
46+
x[ i ] = discreteUniform( 0.0, 3.0 );
4647
p[ i ] = uniform( 0.0, 1.0 );
4748
}
4849

@@ -75,7 +76,7 @@ bench( pkg+':factory', function benchmark( b ) {
7576
len = 100;
7677
x = new Float64Array( len );
7778
for ( i = 0; i < len; i++ ) {
78-
x[ i ] = round( uniform( 0.0, 3.0 ) );
79+
x[ i ] = discreteUniform( 0.0, 3.0 );
7980
}
8081

8182
b.tic();

lib/node_modules/@stdlib/stats/base/dists/bernoulli/pmf/benchmark/benchmark.native.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ bench( pkg+'::native', opts, function benchmark( b ) {
5151
x = new Float64Array( len );
5252
p = new Float64Array( len );
5353
for ( i = 0; i < len; i++ ) {
54-
x[ i ] = round( uniform( 0.0, 3.0 ) );
54+
x[ i ] = discreteUniform( 0.0, 3.0 );
5555
p[ i ] = uniform( 0.0, 1.0 );
5656
}
5757

lib/node_modules/@stdlib/stats/base/dists/bernoulli/pmf/docs/types/index.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ type Unary = ( x: number ) => number;
3131
*/
3232
interface PMF {
3333
/**
34-
* Evaluates the probability mass function (PMF) for a Bernoulli distribution with success probability `0 <= p <= 1`.
34+
* Evaluates the probability mass function (PMF) for a Bernoulli distribution with success probability `p` at a value `x`.
3535
*
3636
* ## Notes
3737
*

lib/node_modules/@stdlib/stats/base/dists/bernoulli/pmf/include/stdlib/stats/base/dists/bernoulli/pmf.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ extern "C" {
2727
#endif
2828

2929
/**
30-
* Evaluates the probability mass function (PMF) for a Bernoulli distribution with success probability `0 <= p <= 1`.
30+
* * Evaluates the probability mass function (PMF) for a Bernoulli distribution with success probability `p` at a value `x`.
3131
*/
3232
double stdlib_base_dists_bernoulli_pmf( const double x, const double p );
3333

lib/node_modules/@stdlib/stats/base/dists/bernoulli/pmf/lib/main.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ var isnan = require( '@stdlib/math/base/assert/is-nan' );
2626
// MAIN //
2727

2828
/**
29-
* Evaluates the moment-generating function (MGF) for a Bernoulli distribution with success probability `p` at a value `t`.
29+
* Evaluates the probability mass function (PMF) for a Bernoulli distribution with success probability `p` at a value `x`.
3030
*
3131
* @param {number} x - input value
3232
* @param {Probability} p - success probability

lib/node_modules/@stdlib/stats/base/dists/bernoulli/pmf/lib/native.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ var addon = require( './../src/addon.node' );
2626
// MAIN //
2727

2828
/**
29-
* Evaluates the moment-generating function (MGF) for a Bernoulli distribution with success probability `p` at a value `t`.
29+
* Evaluates the probability mass function (PMF) for a Bernoulli distribution with success probability `p` at a value `x`.
3030
*
3131
* @private
3232
* @param {number} x - input value

lib/node_modules/@stdlib/stats/base/dists/bernoulli/pmf/src/main.c

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,15 +20,15 @@
2020
#include "stdlib/math/base/assert/is_nan.h"
2121

2222
/**
23-
* Evaluates the probability mass function (PMF) for a Bernoulli distribution with success probability `0 <= p <= 1`.
23+
* Evaluates the probability mass function (PMF) for a Bernoulli distribution with success probability `p` at a value `x`.
2424
*
2525
* @param x input value
2626
* @param p success probability
2727
* @return evaluated PMF
2828
*
2929
* @example
30-
* double y = stdlib_base_dists_bernoulli_pmf( 0.5, 0.5 );
31-
* // returns 0.5
30+
* double y = stdlib_base_dists_bernoulli_pmf( 1.0, 0.3 );
31+
* // returns 0.3
3232
*/
3333
double stdlib_base_dists_bernoulli_pmf( const double x, const double p ) {
3434
if (
@@ -45,5 +45,5 @@ double stdlib_base_dists_bernoulli_pmf( const double x, const double p ) {
4545
if ( x == 1.0 ) {
4646
return p;
4747
}
48-
return 0.0 ;
48+
return 0.0;
4949
}

lib/node_modules/@stdlib/stats/base/dists/bernoulli/pmf/test/test.native.js

Lines changed: 2 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,7 @@ var resolve = require( 'path' ).resolve;
2424
var tape = require( 'tape' );
2525
var isnan = require( '@stdlib/math/base/assert/is-nan' );
2626
var tryRequire = require( '@stdlib/utils/try-require' );
27-
var abs = require( '@stdlib/math/base/special/abs' );
2827
var PINF = require( '@stdlib/constants/float64/pinf' );
29-
var EPS = require( '@stdlib/constants/float64/eps' );
3028

3129

3230
// FIXTURES //
@@ -105,8 +103,6 @@ tape( 'if provided a success probability `p` outside of `[0,1]`, the function al
105103

106104
tape( 'the function evaluates the pmf for `x` given small parameter `p`', opts, function test( t ) {
107105
var expected;
108-
var delta;
109-
var tol;
110106
var x;
111107
var p;
112108
var y;
@@ -117,21 +113,13 @@ tape( 'the function evaluates the pmf for `x` given small parameter `p`', opts,
117113
p = smallP.p;
118114
for ( i = 0; i < x.length; i++ ) {
119115
y = pmf( x[i], p[i] );
120-
if ( y === expected[i] ) {
121-
t.equal( y, expected[i], 'x: '+x[i]+'. p:'+p[i]+', y: '+y+', expected: '+expected[i] );
122-
} else {
123-
delta = abs( y - expected[ i ] );
124-
tol = 2.0 * EPS * abs( expected[ i ] );
125-
t.ok( delta <= tol, 'within tolerance. x: '+x[ i ]+'. p: '+p[i]+'. y: '+y+'. E: '+expected[ i ]+'. Δ: '+delta+'. tol: '+tol+'.' );
126-
}
116+
t.equal( y, expected[i], 'x: '+x[i]+'. p:'+p[i]+', y: '+y+', expected: '+expected[i] );
127117
}
128118
t.end();
129119
});
130120

131121
tape( 'the function evaluates the pmf for `x` given large parameter `p`', opts, function test( t ) {
132122
var expected;
133-
var delta;
134-
var tol;
135123
var x;
136124
var p;
137125
var y;
@@ -142,13 +130,7 @@ tape( 'the function evaluates the pmf for `x` given large parameter `p`', opts,
142130
p = largeP.p;
143131
for ( i = 0; i < x.length; i++ ) {
144132
y = pmf( x[i], p[i] );
145-
if ( y === expected[i] ) {
146-
t.equal( y, expected[i], 'x: '+x[i]+'. p: '+p[i]+', y: '+y+', expected: '+expected[i] );
147-
} else {
148-
delta = abs( y - expected[ i ] );
149-
tol = 1.5 * EPS * abs( expected[ i ] );
150-
t.ok( delta <= tol, 'within tolerance. x: '+x[ i ]+'. p: '+p[i]+'. y: '+y+'. E: '+expected[ i ]+'. Δ: '+delta+'. tol: '+tol+'.' );
151-
}
133+
t.equal( y, expected[i], 'x: '+x[i]+'. p: '+p[i]+', y: '+y+', expected: '+expected[i] );
152134
}
153135
t.end();
154136
});

lib/node_modules/@stdlib/stats/base/dists/bernoulli/pmf/test/test.pmf.js

Lines changed: 2 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,7 @@
2222

2323
var tape = require( 'tape' );
2424
var isnan = require( '@stdlib/math/base/assert/is-nan' );
25-
var abs = require( '@stdlib/math/base/special/abs' );
2625
var PINF = require( '@stdlib/constants/float64/pinf' );
27-
var EPS = require( '@stdlib/constants/float64/eps' );
2826
var pmf = require( './../lib' );
2927

3028

@@ -96,8 +94,6 @@ tape( 'if provided a success probability `p` outside of `[0,1]`, the function al
9694

9795
tape( 'the function evaluates the pmf for `x` given small parameter `p`', function test( t ) {
9896
var expected;
99-
var delta;
100-
var tol;
10197
var x;
10298
var p;
10399
var y;
@@ -108,21 +104,13 @@ tape( 'the function evaluates the pmf for `x` given small parameter `p`', functi
108104
p = smallP.p;
109105
for ( i = 0; i < x.length; i++ ) {
110106
y = pmf( x[i], p[i] );
111-
if ( y === expected[i] ) {
112-
t.equal( y, expected[i], 'x: '+x[i]+'. p:'+p[i]+', y: '+y+', expected: '+expected[i] );
113-
} else {
114-
delta = abs( y - expected[ i ] );
115-
tol = 2.0 * EPS * abs( expected[ i ] );
116-
t.ok( delta <= tol, 'within tolerance. x: '+x[ i ]+'. p: '+p[i]+'. y: '+y+'. E: '+expected[ i ]+'. Δ: '+delta+'. tol: '+tol+'.' );
117-
}
107+
t.equal( y, expected[i], 'x: '+x[i]+'. p:'+p[i]+', y: '+y+', expected: '+expected[i] );
118108
}
119109
t.end();
120110
});
121111

122112
tape( 'the function evaluates the pmf for `x` given large parameter `p`', function test( t ) {
123113
var expected;
124-
var delta;
125-
var tol;
126114
var x;
127115
var p;
128116
var y;
@@ -133,13 +121,7 @@ tape( 'the function evaluates the pmf for `x` given large parameter `p`', functi
133121
p = largeP.p;
134122
for ( i = 0; i < x.length; i++ ) {
135123
y = pmf( x[i], p[i] );
136-
if ( y === expected[i] ) {
137-
t.equal( y, expected[i], 'x: '+x[i]+'. p: '+p[i]+', y: '+y+', expected: '+expected[i] );
138-
} else {
139-
delta = abs( y - expected[ i ] );
140-
tol = 1.5 * EPS * abs( expected[ i ] );
141-
t.ok( delta <= tol, 'within tolerance. x: '+x[ i ]+'. p: '+p[i]+'. y: '+y+'. E: '+expected[ i ]+'. Δ: '+delta+'. tol: '+tol+'.' );
142-
}
124+
t.equal( y, expected[i], 'x: '+x[i]+'. p: '+p[i]+', y: '+y+', expected: '+expected[i] );
143125
}
144126
t.end();
145127
});

0 commit comments

Comments
 (0)