Skip to content

Commit 48cbb5c

Browse files
PlaneshifterPlaneshifter
committed
feat: add bradford distribution namespace
--- 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: na - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: passed - 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: 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 ---
1 parent 379cdb9 commit 48cbb5c

File tree

7 files changed

+860
-0
lines changed

7 files changed

+860
-0
lines changed

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

Lines changed: 178 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,178 @@
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+
# Bradford
22+
23+
> Bradford distribution.
24+
25+
<section class="usage">
26+
27+
## Usage
28+
29+
```javascript
30+
var bradford = require( '@stdlib/stats/base/dists/bradford' );
31+
```
32+
33+
#### bradford
34+
35+
[Bradford][bradford-distribution] distribution.
36+
37+
```javascript
38+
var dist = bradford;
39+
// returns {...}
40+
```
41+
42+
The namespace contains the following distribution functions:
43+
44+
<!-- <toc pattern="*+(cdf|pdf|mgf|quantile)*"> -->
45+
46+
<div class="namespace-toc">
47+
48+
- <span class="signature">[`cdf( x, c )`][@stdlib/stats/base/dists/bradford/cdf]</span><span class="delimiter">: </span><span class="description">Bradford distribution cumulative distribution function.</span>
49+
- <span class="signature">[`pdf( x, c )`][@stdlib/stats/base/dists/bradford/pdf]</span><span class="delimiter">: </span><span class="description">Bradford distribution probability density function (PDF).</span>
50+
- <span class="signature">[`quantile( p, c )`][@stdlib/stats/base/dists/bradford/quantile]</span><span class="delimiter">: </span><span class="description">Bradford distribution quantile function.</span>
51+
52+
</div>
53+
54+
<!-- </toc> -->
55+
56+
The namespace contains the following functions for calculating distribution properties:
57+
58+
<!-- <toc pattern="*+(entropy|mean|median|mode|skewness|stdev|variance)*"> -->
59+
60+
<div class="namespace-toc">
61+
62+
- <span class="signature">[`entropy( c )`][@stdlib/stats/base/dists/bradford/entropy]</span><span class="delimiter">: </span><span class="description">Bradford distribution differential entropy.</span>
63+
- <span class="signature">[`mean( c )`][@stdlib/stats/base/dists/bradford/mean]</span><span class="delimiter">: </span><span class="description">Bradford distribution expected value.</span>
64+
- <span class="signature">[`median( c )`][@stdlib/stats/base/dists/bradford/median]</span><span class="delimiter">: </span><span class="description">Bradford distribution median.</span>
65+
- <span class="signature">[`mode( c )`][@stdlib/stats/base/dists/bradford/mode]</span><span class="delimiter">: </span><span class="description">Bradford distribution mode.</span>
66+
- <span class="signature">[`skewness( c )`][@stdlib/stats/base/dists/bradford/skewness]</span><span class="delimiter">: </span><span class="description">Bradford distribution skewness.</span>
67+
- <span class="signature">[`stdev( c )`][@stdlib/stats/base/dists/bradford/stdev]</span><span class="delimiter">: </span><span class="description">Bradford distribution standard deviation.</span>
68+
- <span class="signature">[`variance( c )`][@stdlib/stats/base/dists/bradford/variance]</span><span class="delimiter">: </span><span class="description">Bradford distribution variance.</span>
69+
70+
</div>
71+
72+
<!-- </toc> -->
73+
74+
</section>
75+
76+
<!-- /.usage -->
77+
78+
<section class="examples">
79+
80+
## Examples
81+
82+
<!-- eslint no-undef: "error" -->
83+
84+
```javascript
85+
var bradford = require( '@stdlib/stats/base/dists/bradford' );
86+
87+
/*
88+
* The Bradford distribution is defined over [0,1] with shape parameter c.
89+
*/
90+
91+
var c = 2.0;
92+
93+
// Compute the mean:
94+
var mu = bradford.mean( c );
95+
// returns ~0.410
96+
97+
// Compute the median:
98+
var median = bradford.median( c );
99+
// returns ~0.366
100+
101+
// Compute the variance:
102+
var s2 = bradford.variance( c );
103+
// returns ~0.082
104+
105+
// Compute the standard deviation:
106+
var sigma = bradford.stdev( c );
107+
// returns ~0.286
108+
109+
// Evaluate the PDF at x = 0.5:
110+
var y = bradford.pdf( 0.5, c );
111+
// returns ~0.910
112+
113+
// Evaluate the CDF at x = 0.5:
114+
var p = bradford.cdf( 0.5, c );
115+
// returns ~0.631
116+
117+
// Compute the 50th percentile (median):
118+
var q = bradford.quantile( 0.5, c );
119+
// returns ~0.366
120+
121+
// Compute the entropy:
122+
var h = bradford.entropy( c );
123+
// returns ~-0.050
124+
125+
// Compute the skewness:
126+
var skew = bradford.skewness( c );
127+
// returns ~0.378
128+
129+
// Compute the mode:
130+
var mode = bradford.mode( c );
131+
// returns 0.0
132+
```
133+
134+
</section>
135+
136+
<!-- /.examples -->
137+
138+
<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
139+
140+
<section class="related">
141+
142+
</section>
143+
144+
<!-- /.related -->
145+
146+
<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
147+
148+
<section class="links">
149+
150+
[bradford-distribution]: https://en.wikipedia.org/wiki/Bradford_distribution
151+
152+
<!-- <toc-links> -->
153+
154+
[@stdlib/stats/base/dists/bradford/cdf]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/dists/bradford/cdf
155+
156+
[@stdlib/stats/base/dists/bradford/entropy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/dists/bradford/entropy
157+
158+
[@stdlib/stats/base/dists/bradford/mean]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/dists/bradford/mean
159+
160+
[@stdlib/stats/base/dists/bradford/median]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/dists/bradford/median
161+
162+
[@stdlib/stats/base/dists/bradford/mode]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/dists/bradford/mode
163+
164+
[@stdlib/stats/base/dists/bradford/pdf]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/dists/bradford/pdf
165+
166+
[@stdlib/stats/base/dists/bradford/quantile]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/dists/bradford/quantile
167+
168+
[@stdlib/stats/base/dists/bradford/skewness]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/dists/bradford/skewness
169+
170+
[@stdlib/stats/base/dists/bradford/stdev]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/dists/bradford/stdev
171+
172+
[@stdlib/stats/base/dists/bradford/variance]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/dists/bradford/variance
173+
174+
<!-- </toc-links> -->
175+
176+
</section>
177+
178+
<!-- /.links -->

0 commit comments

Comments
 (0)