Skip to content

Commit afbbf93

Browse files
anandkaranubcanandkaranubc
committed
feat: add docs, benchmarks and examples
--- 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: passed - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: passed - task: lint_python status: na - 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: passed - 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 0187fd6 commit afbbf93

File tree

9 files changed

+497
-1
lines changed

9 files changed

+497
-1
lines changed

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

Lines changed: 143 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,143 @@
1+
<!--
2+
3+
@license Apache-2.0
4+
5+
Copyright (c) 2025 The Stdlib Authors.
6+
7+
Licensed under the Apache License, Version 2.0 (the "License");
8+
you may not use this file except in compliance with the License.
9+
You may obtain a copy of the License at
10+
11+
http://www.apache.org/licenses/LICENSE-2.0
12+
13+
Unless required by applicable law or agreed to in writing, software
14+
distributed under the License is distributed on an "AS IS" BASIS,
15+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16+
See the License for the specific language governing permissions and
17+
limitations under the License.
18+
19+
-->
20+
21+
# Mean
22+
23+
> [Bradford][bradford-distribution] distribution [differential entropy][entropy].
24+
25+
<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
26+
27+
<section class="intro">
28+
29+
The [differential entropy][entropy] (in [nats][nats]) for a [Bradford][bradford-distribution] random variable is
30+
31+
<!-- <equation class="equation" label="eq:bradford_entropy" align="center" raw="h\left( X \right) = \frac{1}{2}\ln(1+c) - \ln\left(\frac{c}{\ln(1+c)}\right)" alt="Differential entropy for a Bradford distribution."> -->
32+
33+
```math
34+
h\left( X \right) = \frac{1}{2}\ln(1+c) - \ln\left(\frac{c}{\ln(1+c)}\right)
35+
```
36+
37+
<!-- <div class="equation" align="center" data-raw-text="h\left( X \right) = \frac{1}{2}\ln(1+c) - \ln\left(\frac{c}{\ln(1+c)}\right)" data-equation="eq:bradford_entropy">
38+
<img src="https://cdn.jsdelivr.net/gh/stdlib-js/stdlib@591cf9d5c3a0cd3c1ceec961e5c49d73a68374cb/lib/node_modules/@stdlib/stats/base/dists/bradford/entropy/docs/img/equation_bradford_entropy.svg" alt="Differential entropy for a Bradford distribution.">
39+
<br>
40+
</div> -->
41+
42+
<!-- </equation> -->
43+
44+
where `c` is the shape parameter.
45+
46+
</section>
47+
48+
<!-- /.intro -->
49+
50+
<!-- Package usage documentation. -->
51+
52+
<section class="usage">
53+
54+
## Usage
55+
56+
```javascript
57+
var entropy = require( '@stdlib/stats/base/dists/bradford/entropy' );
58+
```
59+
60+
#### entropy( c )
61+
62+
Returns the [differential entropy][entropy] of a [Bradford][bradford-distribution] distribution with shape parameter `c` (in [nats][nats]).
63+
64+
```javascript
65+
var v = entropy( 0.2 );
66+
// returns ~-0.001
67+
68+
v = entropy( 10.0 );
69+
// returns ~-0.229
70+
```
71+
72+
If `c <= 0`, the function returns `NaN`.
73+
74+
```javascript
75+
var v = entropy( NaN );
76+
// returns NaN
77+
78+
v = entropy( 0.0 );
79+
// returns NaN
80+
81+
v = entropy( -1.5 );
82+
// returns NaN
83+
```
84+
85+
</section>
86+
87+
<!-- /.usage -->
88+
89+
<!-- Package usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
90+
91+
<section class="notes">
92+
93+
</section>
94+
95+
<!-- /.notes -->
96+
97+
<!-- Package usage examples. -->
98+
99+
<section class="examples">
100+
101+
## Examples
102+
103+
<!-- eslint no-undef: "error" -->
104+
105+
```javascript
106+
var uniform = require( '@stdlib/random/array/uniform' );
107+
var entropy = require( '@stdlib/stats/base/dists/bradford/entropy' );
108+
109+
var c = uniform( 10, 0.1, 10.0 );
110+
111+
var v;
112+
var i;
113+
for ( i = 0; i < c.length; i++ ) {
114+
v = entropy( c[ i ] );
115+
console.log( 'c: %d, h(X;c): %d', c[ i ].toFixed( 4 ), v.toFixed( 4 ) );
116+
}
117+
```
118+
119+
</section>
120+
121+
<!-- /.examples -->
122+
123+
<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
124+
125+
<section class="related">
126+
127+
</section>
128+
129+
<!-- /.related -->
130+
131+
<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
132+
133+
<section class="links">
134+
135+
[bradford-distribution]: https://en.wikipedia.org/wiki/Bradford%27s_law
136+
137+
[entropy]: https://en.wikipedia.org/wiki/Entropy_%28information_theory%29
138+
139+
[nats]: https://en.wikipedia.org/wiki/Nat_%28unit%29
140+
141+
</section>
142+
143+
<!-- /.links -->

‎lib/node_modules/@stdlib/stats/base/dists/bradford/entropy/benchmark/benchmark.js‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
/**
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2025 The Stdlib Authors.
5+
*
6+
* Licensed under the Apache License, Version 2.0 (the "License");
7+
* you may not use this file except in compliance with the License.
8+
* You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing, software
13+
* distributed under the License is distributed on an "AS IS" BASIS,
14+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
* See the License for the specific language governing permissions and
16+
* limitations under the License.
17+
*/
18+
19+
'use strict';
20+
21+
// MODULES //
22+
23+
var bench = require( '@stdlib/bench' );
24+
var uniform = require( '@stdlib/random/array/uniform' );
25+
var isnan = require( '@stdlib/math/base/assert/is-nan' );
26+
var pkg = require( './../package.json' ).name;
27+
var entropy = require( './../lib' );
28+
29+
30+
// MAIN //
31+
32+
bench( pkg, function benchmark( b ) {
33+
var c;
34+
var y;
35+
var i;
36+
37+
c = uniform( 100, 0.1, 10.0 );
38+
39+
b.tic();
40+
for ( i = 0; i < b.iterations; i++ ) {
41+
y = entropy( c[ i % c.length ] );
42+
if ( isnan( y ) ) {
43+
b.fail( 'should not return NaN' );
44+
}
45+
}
46+
b.toc();
47+
if ( isnan( y ) ) {
48+
b.fail( 'should not return NaN' );
49+
}
50+
b.pass( 'benchmark finished' );
51+
b.end();
52+
});

‎lib/node_modules/@stdlib/stats/base/dists/bradford/entropy/docs/img/equation_bradford_entropy.svg‎

Lines changed: 68 additions & 0 deletions
Loading

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

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
2+
{{alias}}( c )
3+
Returns the differential entropy of a Bradford distribution with shape
4+
parameter `c`.
5+
6+
If `c <= 0`, the function returns `NaN`.
7+
8+
Parameters
9+
----------
10+
c: number
11+
Shape parameter.
12+
13+
Returns
14+
-------
15+
out: number
16+
Entropy.
17+
18+
Examples
19+
--------
20+
> var v = {{alias}}( 0.2 )
21+
~-0.001
22+
> v = {{alias}}( 0.5 )
23+
~-0.007
24+
> v = {{alias}}( 10.0 )
25+
~-0.229
26+
27+
See Also
28+
--------
29+

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

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
/*
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2025 The Stdlib Authors.
5+
*
6+
* Licensed under the Apache License, Version 2.0 (the "License");
7+
* you may not use this file except in compliance with the License.
8+
* You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing, software
13+
* distributed under the License is distributed on an "AS IS" BASIS,
14+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
* See the License for the specific language governing permissions and
16+
* limitations under the License.
17+
*/
18+
19+
// TypeScript Version: 4.1
20+
21+
/**
22+
* Returns the differential entropy of a Bradford distribution.
23+
*
24+
* ## Notes
25+
*
26+
* - If `c <= 0`, the function returns `NaN`.
27+
*
28+
* @param c - shape parameter
29+
* @returns differential entropy
30+
*
31+
* @example
32+
* var v = entropy( 0.2 );
33+
* // returns ~-0.001
34+
*
35+
* @example
36+
* var v = entropy( 0.5 );
37+
* // returns ~-0.007
38+
*
39+
* @example
40+
* var v = entropy( 10.0 );
41+
* // returns ~-0.229
42+
*
43+
* @example
44+
* var v = entropy( 0.0 );
45+
* // returns NaN
46+
*
47+
* @example
48+
* var v = entropy( -1.0 );
49+
* // returns NaN
50+
*
51+
* @example
52+
* var v = entropy( NaN );
53+
* // returns NaN
54+
*/
55+
declare function entropy( c: number ): number;
56+
57+
58+
// EXPORTS //
59+
60+
export = entropy;

0 commit comments

Comments
 (0)