Skip to content

Commit 039aa21

Browse files
committed
chore: clean-up
--- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: passed - task: lint_package_json status: passed - task: lint_repl_help status: passed - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: passed - task: lint_javascript_benchmarks status: na - task: lint_python status: missing_dependencies - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- 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 e930f84 commit 039aa21

File tree

8 files changed

+14
-14
lines changed

8 files changed

+14
-14
lines changed

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,13 +20,13 @@ limitations under the License.
2020

2121
# Entropy
2222

23-
> Planck (discrete exponential) distribution [entropy][entropy].
23+
> Planck (discrete exponential) distribution [differential entropy][entropy].
2424
2525
<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
2626

2727
<section class="intro">
2828

29-
The [entropy][entropy] (in [nats][nats]) for a Planck random variable is
29+
The [differential entropy][entropy] (in [nats][nats]) for a Planck random variable is
3030

3131
<!-- <equation class="equation" label="eq:planck_entropy" align="center" raw="H\left( X \right) = \frac{\lambda e^{-\lambda}}{1 - e^{-\lambda}} - \log\left( 1 - e^{-\lambda} \right)" alt="Differential entropy for a Planck distribution."> -->
3232

@@ -54,7 +54,7 @@ var entropy = require( '@stdlib/stats/base/dists/planck/entropy' );
5454

5555
#### entropy( lambda )
5656

57-
Returns the [entropy][entropy] of a Planck distribution with shape parameter `lambda` (in [nats][nats]).
57+
Returns the [differential entropy][entropy] of a Planck distribution with shape parameter `lambda` (in [nats][nats]).
5858

5959
```javascript
6060
var v = entropy( 0.1 );

lib/node_modules/@stdlib/stats/base/dists/planck/entropy/docs/repl.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

22
{{alias}}( λ )
3-
Returns the entropy of a Planck distribution with shape parameter `λ`
4-
(in nats).
3+
Returns the differential entropy of a Planck distribution with shape
4+
parameter `λ` (in nats).
55

66
If `λ <= 0`, the function returns `NaN`.
77

@@ -13,7 +13,7 @@
1313
Returns
1414
-------
1515
out: number
16-
Entropy.
16+
Differential entropy.
1717

1818
Examples
1919
--------

lib/node_modules/@stdlib/stats/base/dists/planck/entropy/docs/types/index.d.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,14 +19,14 @@
1919
// TypeScript Version: 4.1
2020

2121
/**
22-
* Returns the entropy of a Planck distribution.
22+
* Returns the differential entropy of a Planck distribution.
2323
*
2424
* ## Notes
2525
*
2626
* - If `lambda <= 0`, the function returns `NaN`.
2727
*
2828
* @param lambda - shape parameter
29-
* @returns entropy
29+
* @returns differential entropy
3030
*
3131
* @example
3232
* var v = entropy( 0.1 );

lib/node_modules/@stdlib/stats/base/dists/planck/entropy/lib/index.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
'use strict';
2020

2121
/**
22-
* Planck distribution entropy.
22+
* Planck distribution differential entropy.
2323
*
2424
* @module @stdlib/stats/base/dists/planck/entropy
2525
*

lib/node_modules/@stdlib/stats/base/dists/planck/entropy/lib/main.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,10 +29,10 @@ var ln = require( '@stdlib/math/base/special/ln' );
2929
// MAIN //
3030

3131
/**
32-
* Returns the entropy of a Planck distribution.
32+
* Returns the differential entropy of a Planck distribution.
3333
*
3434
* @param {PositiveNumber} lambda - shape parameter
35-
* @returns {PositiveNumber} entropy
35+
* @returns {PositiveNumber} differential entropy
3636
*
3737
* @example
3838
* var v = entropy( 0.1 );

lib/node_modules/@stdlib/stats/base/dists/planck/entropy/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "@stdlib/stats/base/dists/planck/entropy",
33
"version": "0.0.0",
4-
"description": "Planck (discrete exponential) distribution entropy.",
4+
"description": "Planck (discrete exponential) distribution differential entropy.",
55
"license": "Apache-2.0",
66
"author": {
77
"name": "The Stdlib Authors",

lib/node_modules/@stdlib/stats/base/dists/planck/entropy/test/fixtures/python/runner.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ def gen(lam, name):
4242
# Examples
4343
4444
```python
45-
python> lam = np.random.rand(1000) * 20
45+
python> lam = np.random.rand(1000) * 20.0
4646
python> gen(lam, "data.json")
4747
```
4848
"""

lib/node_modules/@stdlib/stats/base/dists/planck/entropy/test/test.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ tape( 'if provided `NaN` for `lambda`, the function returns `NaN`', function tes
4646
t.end();
4747
});
4848

49-
tape( 'if provided a success probability `lambda` which is nonpositive, the function returns `NaN`', function test( t ) {
49+
tape( 'if provided a shape parameter `lambda` which is nonpositive, the function returns `NaN`', function test( t ) {
5050
var v;
5151

5252
v = entropy( 0.0 );

0 commit comments

Comments
 (0)