Skip to content

Commit facb058

Browse files
chore: minor clean up
1 parent ca20636 commit facb058

File tree

6 files changed

+7
-28
lines changed

6 files changed

+7
-28
lines changed

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

Lines changed: 2 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -173,37 +173,16 @@ for ( i = 0; i < 10; i++ ) {
173173

174174
#### stdlib_base_dists_bernoulli_quantile( r , p )
175175

176-
Evaluates the quantile function for a Bernoulli distribution with success probability `p` at a probability `r`.
176+
Evaluates the quantile function for a Bernoulli distribution with success probability `p` at a value `r`.
177177

178178
```c
179179
double y = stdlib_base_dists_bernoulli_quantile( 0.8, 0.4 );
180180
// returns ~1.0
181-
182-
y = stdlib_base_dists_bernoulli_quantile( 0.5, 0.4 );
183-
// returns ~0.0
184-
185-
y = stdlib_base_dists_bernoulli_quantile( 0.8, 0.1 );
186-
// returns ~0.0
187-
188-
y = stdlib_base_dists_bernoulli_quantile( -0.2, 0.1 );
189-
// returns ~NaN
190-
191-
y = stdlib_base_dists_bernoulli_quantile( NaN, 0.8 );
192-
// returns ~NaN
193-
194-
y = stdlib_base_dists_bernoulli_quantile( 0.4, NaN );
195-
// returns ~NaN
196-
197-
y = stdlib_base_dists_bernoulli_quantile( 0.5, -1.0 );
198-
// returns ~NaN
199-
200-
y = stdlib_base_dists_bernoulli_quantile( 0.5, 1.5 );
201-
// returns ~NaN
202181
```
203182

204183
The function accepts the following arguments:
205184

206-
- **r**: `[in] double` probability.
185+
- **r**: `[in] double` input value.
207186
- **p**: `[in] double` success probability.
208187

209188
```c

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,12 +27,12 @@ extern "C" {
2727
#endif
2828

2929
/**
30-
* Returns the quantile of a Bernoulli distribution.
30+
* Evaluates the quantile function for a Bernoulli distribution with success probability `p` at a probability `r`.
3131
*/
3232
double stdlib_base_dists_bernoulli_quantile( const double r, const double p );
3333

3434
#ifdef __cplusplus
3535
}
3636
#endif
3737

38-
#endif // !STDLIB_STATS_BASE_DISTS_BERNOULLI_QUANTILE_H
38+
#endif // !STDLIB_STATS_BASE_DISTS_BERNOULLI_QUANTILE_H

lib/node_modules/@stdlib/stats/base/dists/bernoulli/quantile/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 quantile function for a Bernoulli distribution with success probability `p` at a probability `r`.
29+
* Evaluates the quantile function for a Bernoulli distribution with success probability `p` at a value `r`.
3030
*
3131
* @param {Probability} r - input value
3232
* @param {Probability} p - success probability

lib/node_modules/@stdlib/stats/base/dists/bernoulli/quantile/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 quantile function for a Bernoulli distribution with success probability `p` at a probability `r`.
29+
* Evaluates the quantile function for a Bernoulli distribution with success probability `p` at a value `r`.
3030
*
3131
* @param {Probability} r - input value
3232
* @param {Probability} p - success probability

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
#include "stdlib/math/base/assert/is_nan.h"
2121

2222
/**
23-
* Evaluates the quantile function for a Bernoulli distribution with success probability `p` at a probability `r`.
23+
* Evaluates the quantile function for a Bernoulli distribution with success probability `p` at a value `r`.
2424
*
2525
* @param r input value
2626
* @param p success probability

0 commit comments

Comments
 (0)