@stdlib/stats-base-dists-uniform 0.2.1 → 0.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. package/NOTICE +1 -1
  2. package/README.md +35 -7
  3. package/docs/types/index.d.ts +3 -3
  4. package/package.json +16 -16
package/NOTICE CHANGED
@@ -1 +1 @@
1
- Copyright (c) 2016-2024 The Stdlib Authors.
1
+ Copyright (c) 2016-2026 The Stdlib Authors.
package/README.md CHANGED
@@ -131,10 +131,38 @@ var y = dist.cdf( 2.5 );
131
131
  <!-- eslint no-undef: "error" -->
132
132
 
133
133
  ```javascript
134
- var objectKeys = require( '@stdlib/utils-keys' );
135
134
  var uniform = require( '@stdlib/stats-base-dists-uniform' );
136
135
 
137
- console.log( objectKeys( uniform ) );
136
+ /*
137
+ Let's consider an example where we are modeling the arrival times of guests
138
+ at a reception event that runs from 6:00 PM to 8:00 PM, where each arrival
139
+ within this 2-hour window is equally likely. We can model this scenario using a
140
+ continuous uniform distribution with a minimum value of 0 (6:00 PM) and
141
+ a maximum value of 120 (8:00 PM).
142
+ */
143
+
144
+ var min = 0.0; // 6:00 PM is 0 minutes after 6:00 PM.
145
+ var max = 120.0; // 8:00 PM is 120 minutes after 6:00 PM.
146
+
147
+ var mean = uniform.mean( min, max );
148
+ // returns 60.0
149
+
150
+ var variance = uniform.variance( min, max );
151
+ // returns 1200.0
152
+
153
+ var stdDev = uniform.stdev( min, max );
154
+ // returns ~34.641
155
+
156
+ var entropy = uniform.entropy( min, max );
157
+ // returns ~4.787
158
+
159
+ // Probability of arrival within 30 minutes after 6:00 PM:
160
+ var p = uniform.cdf( 30, min, max );
161
+ // returns 0.25
162
+
163
+ // Evaluate the PDF at 30 minutes after 6:00 PM:
164
+ var pdf = uniform.pdf( 30, min, max );
165
+ // returns ~0.0083
138
166
  ```
139
167
 
140
168
  </section>
@@ -175,7 +203,7 @@ See [LICENSE][stdlib-license].
175
203
 
176
204
  ## Copyright
177
205
 
178
- Copyright &copy; 2016-2024. The Stdlib [Authors][stdlib-authors].
206
+ Copyright &copy; 2016-2026. The Stdlib [Authors][stdlib-authors].
179
207
 
180
208
  </section>
181
209
 
@@ -188,8 +216,8 @@ Copyright &copy; 2016-2024. The Stdlib [Authors][stdlib-authors].
188
216
  [npm-image]: http://img.shields.io/npm/v/@stdlib/stats-base-dists-uniform.svg
189
217
  [npm-url]: https://npmjs.org/package/@stdlib/stats-base-dists-uniform
190
218
 
191
- [test-image]: https://github.com/stdlib-js/stats-base-dists-uniform/actions/workflows/test.yml/badge.svg?branch=v0.2.1
192
- [test-url]: https://github.com/stdlib-js/stats-base-dists-uniform/actions/workflows/test.yml?query=branch:v0.2.1
219
+ [test-image]: https://github.com/stdlib-js/stats-base-dists-uniform/actions/workflows/test.yml/badge.svg?branch=v0.3.0
220
+ [test-url]: https://github.com/stdlib-js/stats-base-dists-uniform/actions/workflows/test.yml?query=branch:v0.3.0
193
221
 
194
222
  [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/stats-base-dists-uniform/main.svg
195
223
  [coverage-url]: https://codecov.io/github/stdlib-js/stats-base-dists-uniform?branch=main
@@ -201,8 +229,8 @@ Copyright &copy; 2016-2024. The Stdlib [Authors][stdlib-authors].
201
229
 
202
230
  -->
203
231
 
204
- [chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
205
- [chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im
232
+ [chat-image]: https://img.shields.io/badge/zulip-join_chat-brightgreen.svg
233
+ [chat-url]: https://stdlib.zulipchat.com
206
234
 
207
235
  [stdlib]: https://github.com/stdlib-js/stdlib
208
236
 
package/docs/types/index.d.ts CHANGED
@@ -172,11 +172,11 @@ interface Namespace {
172
172
  * var y = ns.logpdf( 3.0, 2.0, 6.0 );
173
173
  * // returns ~-1.386
174
174
  *
175
- * var mylogpdf = ns.logpdf.factory( 6.0, 7.0 );
176
- * y = mylogpdf( 7.0 );
175
+ * var mylogPDF = ns.logpdf.factory( 6.0, 7.0 );
176
+ * y = mylogPDF( 7.0 );
177
177
  * // returns 0.0
178
178
  *
179
- * y = mylogpdf( 5.0 );
179
+ * y = mylogPDF( 5.0 );
180
180
  * // returns -Infinity
181
181
  */
182
182
  logpdf: typeof logpdf;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@stdlib/stats-base-dists-uniform",
3
- "version": "0.2.1",
3
+ "version": "0.3.0",
4
4
  "description": "Uniform distribution.",
5
5
  "license": "Apache-2.0",
6
6
  "author": {
@@ -30,21 +30,21 @@
30
30
  "url": "https://github.com/stdlib-js/stdlib/issues"
31
31
  },
32
32
  "dependencies": {
33
- "@stdlib/stats-base-dists-uniform-cdf": "^0.2.1",
34
- "@stdlib/stats-base-dists-uniform-ctor": "^0.2.1",
35
- "@stdlib/stats-base-dists-uniform-entropy": "^0.2.1",
36
- "@stdlib/stats-base-dists-uniform-kurtosis": "^0.2.1",
37
- "@stdlib/stats-base-dists-uniform-logcdf": "^0.2.1",
38
- "@stdlib/stats-base-dists-uniform-logpdf": "^0.2.1",
39
- "@stdlib/stats-base-dists-uniform-mean": "^0.2.1",
40
- "@stdlib/stats-base-dists-uniform-median": "^0.2.1",
41
- "@stdlib/stats-base-dists-uniform-mgf": "^0.2.1",
42
- "@stdlib/stats-base-dists-uniform-pdf": "^0.2.1",
43
- "@stdlib/stats-base-dists-uniform-quantile": "^0.2.1",
44
- "@stdlib/stats-base-dists-uniform-skewness": "^0.2.1",
45
- "@stdlib/stats-base-dists-uniform-stdev": "^0.2.1",
46
- "@stdlib/stats-base-dists-uniform-variance": "^0.2.1",
47
- "@stdlib/utils-define-read-only-property": "^0.2.1"
33
+ "@stdlib/stats-base-dists-uniform-cdf": "^0.3.0",
34
+ "@stdlib/stats-base-dists-uniform-ctor": "^0.2.2",
35
+ "@stdlib/stats-base-dists-uniform-entropy": "^0.3.0",
36
+ "@stdlib/stats-base-dists-uniform-kurtosis": "^0.3.0",
37
+ "@stdlib/stats-base-dists-uniform-logcdf": "^0.3.0",
38
+ "@stdlib/stats-base-dists-uniform-logpdf": "^0.3.0",
39
+ "@stdlib/stats-base-dists-uniform-mean": "^0.3.0",
40
+ "@stdlib/stats-base-dists-uniform-median": "^0.3.0",
41
+ "@stdlib/stats-base-dists-uniform-mgf": "^0.2.2",
42
+ "@stdlib/stats-base-dists-uniform-pdf": "^0.3.0",
43
+ "@stdlib/stats-base-dists-uniform-quantile": "^0.3.0",
44
+ "@stdlib/stats-base-dists-uniform-skewness": "^0.3.0",
45
+ "@stdlib/stats-base-dists-uniform-stdev": "^0.3.0",
46
+ "@stdlib/stats-base-dists-uniform-variance": "^0.3.0",
47
+ "@stdlib/utils-define-read-only-property": "^0.2.2"
48
48
  },
49
49
  "devDependencies": {},
50
50
  "engines": {