Skip to content

Commit 177f0a0

Browse files
committed
chore: consistently use differential entropy for continuous distributions
--- 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: na - task: lint_package_json status: na - 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: na - task: lint_r status: na - task: lint_c_src status: passed - 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 ---
1 parent f75a0ce commit 177f0a0

File tree

17 files changed

+27
-27
lines changed

17 files changed

+27
-27
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ tape( 'if provided a degrees of freedom parameter `k` that is not a positive num
6262
t.end();
6363
});
6464

65-
tape( 'the function returns the entropy of a chi distribution', function test( t ) {
65+
tape( 'the function returns the differential entropy of a chi distribution', function test( t ) {
6666
var expected;
6767
var delta;
6868
var tol;

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ tape( 'if provided a degrees of freedom parameter `k` that is not a positive num
6262
t.end();
6363
});
6464

65-
tape( 'the function returns the entropy of a chi-squared distribution', function test( t ) {
65+
tape( 'the function returns the differential entropy of a chi-squared distribution', function test( t ) {
6666
var expected;
6767
var delta;
6868
var tol;

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ tape( 'if provided a degrees of freedom parameter `k` that is not a positive num
7171
t.end();
7272
});
7373

74-
tape( 'the function returns the entropy of a chi-squared distribution', opts, function test( t ) {
74+
tape( 'the function returns the differential entropy of a chi-squared distribution', opts, function test( t ) {
7575
var expected;
7676
var delta;
7777
var tol;

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -63,14 +63,14 @@ interface Namespace {
6363
Exponential: typeof Exponential;
6464

6565
/**
66-
* Returns the entropy of an exponential distribution.
66+
* Returns the differential entropy of an exponential distribution.
6767
*
6868
* ## Notes
6969
*
7070
* - If provided a negative value for `λ`, the function returns `NaN`.
7171
*
7272
* @param lambda - rate parameter
73-
* @returns entropy
73+
* @returns differential entropy
7474
*
7575
* @example
7676
* var v = ns.entropy( 9.0 );

lib/node_modules/@stdlib/stats/base/dists/exponential/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 an exponential distribution.
22+
* Returns the differential entropy of an exponential distribution.
2323
*
2424
* ## Notes
2525
*
2626
* - If provided a negative value for `λ`, the function returns `NaN`.
2727
*
2828
* @param lambda - rate parameter
29-
* @returns entropy
29+
* @returns differential entropy
3030
*
3131
* @example
3232
* var v = entropy( 9.0 );

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

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

2929
/**
30-
* Returns the entropy of an exponential distribution.
30+
* Returns the differential entropy of an exponential distribution.
3131
*
3232
* @param {NonNegativeNumber} lambda - rate parameter
33-
* @returns {number} entropy
33+
* @returns {number} differential entropy
3434
*
3535
* @example
3636
* var v = entropy( 9.0 );

lib/node_modules/@stdlib/stats/base/dists/levy/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}}( μ, c )
3-
Returns the entropy of a Lévy distribution with location parameter `μ` and
4-
scale parameter `c`.
3+
Returns the differential entropy of a Lévy distribution with location
4+
parameter `μ` and scale parameter `c`.
55

66
If provided `NaN` as any argument, the function returns `NaN`.
77

@@ -18,7 +18,7 @@
1818
Returns
1919
-------
2020
out: number
21-
Entropy.
21+
Differential entropy.
2222

2323
Examples
2424
--------

lib/node_modules/@stdlib/stats/base/dists/logistic/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}}( μ, s )
3-
Returns the entropy of a logistic distribution with location parameter `μ`
4-
and scale parameter `s`.
3+
Returns the differential entropy of a logistic distribution with location
4+
parameter `μ` and scale parameter `s`.
55

66
If provided `NaN` as any argument, the function returns `NaN`.
77

@@ -18,7 +18,7 @@
1818
Returns
1919
-------
2020
out: number
21-
Entropy.
21+
Differential entropy.
2222

2323
Examples
2424
--------

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
@@ -58,7 +58,7 @@ tape( 'if provided a shape parameter `lambda` which is nonpositive, the function
5858
t.end();
5959
});
6060

61-
tape( 'the function returns the entropy of a Planck distribution', function test( t ) {
61+
tape( 'the function returns the differential entropy of a Planck distribution', function test( t ) {
6262
var expected;
6363
var lambda;
6464
var delta;

lib/node_modules/@stdlib/stats/base/dists/triangular/entropy/include/stdlib/stats/base/dists/triangular/entropy.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-
* Returns the entropy of a triangular distribution.
30+
* Returns the differential entropy of a triangular distribution.
3131
*/
3232
double stdlib_base_dists_triangular_entropy( const double a, const double b, const double c );
3333

0 commit comments

Comments
 (0)