Skip to content

Commit

Permalink
documentation update
Browse files Browse the repository at this point in the history
---
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
---
  • Loading branch information
yuvi-mittal committed Feb 2, 2025
1 parent f809f17 commit 6751769
Show file tree
Hide file tree
Showing 4 changed files with 4 additions and 8 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ y = mylogpmf( 1.0 );

## Notes

- 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.
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.

</section>

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

#### stdlib_base_dists_planck_logpmf( x, lambda )

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

```c
double out = stdlib_base_dists_planck_logpmf( 4.0 , 0.3 );
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ extern "C" {
#endif

/**
* Evaluates the logpmf for an planck distribution.
* Evaluates the logarithm of the probability mass function (PMF) of a Planck distribution with shape parameter `lambda`.
*/
double stdlib_base_dists_planck_logpmf( const double x, const double lambda );

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,10 +42,8 @@
"@stdlib/math/base/assert/is-nan",
"@stdlib/math/base/assert/is-nonnegative-integer",
"@stdlib/math/base/special/expm1",
"@stdlib/constants/float64/pi",
"@stdlib/math/base/special/ln",
"@stdlib/constants/float64/ninf"

]
},
{
Expand All @@ -63,7 +61,6 @@
"@stdlib/math/base/assert/is-nan",
"@stdlib/math/base/assert/is-nonnegative-integer",
"@stdlib/math/base/special/expm1",
"@stdlib/constants/float64/pi",
"@stdlib/math/base/special/ln",
"@stdlib/constants/float64/ninf"
]
Expand All @@ -83,7 +80,6 @@
"@stdlib/math/base/assert/is-nan",
"@stdlib/math/base/assert/is-nonnegative-integer",
"@stdlib/math/base/special/expm1",
"@stdlib/constants/float64/pi",
"@stdlib/math/base/special/ln",
"@stdlib/constants/float64/ninf"
]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
#include "stdlib/constants/float64/ninf.h"

/**
* Evaluates the logarithm of the probability mass function (PMF) for a Planck distribution with shape parameter `lambda` at a value `x`.
* Evaluates the logarithm of the probability mass function (PMF) of a Planck distribution with shape parameter `lambda`.
*
* @param x input value
* @param lambda shape parameter
Expand Down

0 comments on commit 6751769

Please sign in to comment.