Skip to content

Commit 6751769

Browse files
committed
documentation update
--- type: pre_push_report description: Results of running various checks prior to pushing changes. report: - task: run_javascript_examples status: na - task: run_c_examples status: na - task: run_cpp_examples status: na - task: run_javascript_readme_examples status: na - task: run_c_benchmarks status: na - task: run_cpp_benchmarks status: na - task: run_fortran_benchmarks status: na - task: run_javascript_benchmarks status: na - task: run_julia_benchmarks status: na - task: run_python_benchmarks status: na - task: run_r_benchmarks status: na - task: run_javascript_tests status: na ---
1 parent f809f17 commit 6751769

File tree

4 files changed

+4
-8
lines changed

4 files changed

+4
-8
lines changed

lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ y = mylogpmf( 1.0 );
101101

102102
## Notes
103103

104-
- In virtually all cases, using the `logpmf` or `loglogpmf` functions is preferable to manually computing the logarithm of the `pmf` or `logpmf`, respectively, since the latter is prone to overflow and underflow.
104+
In virtually all cases, using the `logpmf` or `logcdf` functions is preferable to manually computing the logarithm of the `pmf` or `cdf`, respectively, since the latter is prone to overflow and underflow.
105105

106106
</section>
107107

@@ -161,7 +161,7 @@ for ( i = 0; i < lambda.length; i++ ) {
161161

162162
#### stdlib_base_dists_planck_logpmf( x, lambda )
163163

164-
Evaluates the logarithm of the [probability mass function][pmf] (PMF) of a Planck (discrete exponential) distribution with shape parameter `lambda`.
164+
Evaluates the logarithm of the probability mass function (PMF) of a Planck distribution with shape parameter `lambda`.
165165

166166
```c
167167
double out = stdlib_base_dists_planck_logpmf( 4.0 , 0.3 );

lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/include/stdlib/stats/base/dists/planck/logpmf.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 logpmf for an planck distribution.
30+
* Evaluates the logarithm of the probability mass function (PMF) of a Planck distribution with shape parameter `lambda`.
3131
*/
3232
double stdlib_base_dists_planck_logpmf( const double x, const double lambda );
3333

lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/manifest.json

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -42,10 +42,8 @@
4242
"@stdlib/math/base/assert/is-nan",
4343
"@stdlib/math/base/assert/is-nonnegative-integer",
4444
"@stdlib/math/base/special/expm1",
45-
"@stdlib/constants/float64/pi",
4645
"@stdlib/math/base/special/ln",
4746
"@stdlib/constants/float64/ninf"
48-
4947
]
5048
},
5149
{
@@ -63,7 +61,6 @@
6361
"@stdlib/math/base/assert/is-nan",
6462
"@stdlib/math/base/assert/is-nonnegative-integer",
6563
"@stdlib/math/base/special/expm1",
66-
"@stdlib/constants/float64/pi",
6764
"@stdlib/math/base/special/ln",
6865
"@stdlib/constants/float64/ninf"
6966
]
@@ -83,7 +80,6 @@
8380
"@stdlib/math/base/assert/is-nan",
8481
"@stdlib/math/base/assert/is-nonnegative-integer",
8582
"@stdlib/math/base/special/expm1",
86-
"@stdlib/constants/float64/pi",
8783
"@stdlib/math/base/special/ln",
8884
"@stdlib/constants/float64/ninf"
8985
]

lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/src/main.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
#include "stdlib/constants/float64/ninf.h"
2525

2626
/**
27-
* Evaluates the logarithm of the probability mass function (PMF) for a Planck distribution with shape parameter `lambda` at a value `x`.
27+
* Evaluates the logarithm of the probability mass function (PMF) of a Planck distribution with shape parameter `lambda`.
2828
*
2929
* @param x input value
3030
* @param lambda shape parameter

0 commit comments

Comments
 (0)