@stdlib/stats-base-dists-t 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 +21 -8
  3. package/docs/types/index.d.ts +4 -4
  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
@@ -90,7 +90,7 @@ The namespace contains the following functions for calculating distribution prop
90
90
  - <span class="signature">[`median( v )`][@stdlib/stats/base/dists/t/median]</span><span class="delimiter">: </span><span class="description">Student's t distribution median.</span>
91
91
  - <span class="signature">[`mode( v )`][@stdlib/stats/base/dists/t/mode]</span><span class="delimiter">: </span><span class="description">Student's t distribution mode.</span>
92
92
  - <span class="signature">[`skewness( v )`][@stdlib/stats/base/dists/t/skewness]</span><span class="delimiter">: </span><span class="description">Student's t distribution skewness.</span>
93
- - <span class="signature">[`stdev( v )`][@stdlib/stats/base/dists/t/stdev]</span><span class="delimiter">: </span><span class="description">Student's t distribution variance.</span>
93
+ - <span class="signature">[`stdev( v )`][@stdlib/stats/base/dists/t/stdev]</span><span class="delimiter">: </span><span class="description">Student's t distribution standard deviation.</span>
94
94
  - <span class="signature">[`variance( v )`][@stdlib/stats/base/dists/t/variance]</span><span class="delimiter">: </span><span class="description">Student's t distribution variance.</span>
95
95
 
96
96
  </div>
@@ -131,10 +131,23 @@ var y = dist.cdf( 0.5 );
131
131
  <!-- eslint no-undef: "error" -->
132
132
 
133
133
  ```javascript
134
- var objectKeys = require( '@stdlib/utils-keys' );
135
134
  var t = require( '@stdlib/stats-base-dists-t' );
136
135
 
137
- console.log( objectKeys( t ) );
136
+ var dof = 3;
137
+ var x = 1.5;
138
+
139
+ // Evaluate the probability density function (PDF) at a specific value:
140
+ var res = t.pdf( x, dof );
141
+ console.log( 'PDF at x = ' + x + ': ' + res );
142
+
143
+ // Evaluate the cumulative distribution function (CDF) at a specific value:
144
+ res = t.cdf( x, dof );
145
+ console.log( 'CDF at x = ' + x + ': ' + res );
146
+
147
+ // Get the mean and variance of the t distribution:
148
+ var mu = t.mean( dof );
149
+ var v = t.variance( dof );
150
+ console.log( 'Mean: ' + mu + ', Variance: ' + v );
138
151
  ```
139
152
 
140
153
  </section>
@@ -175,7 +188,7 @@ See [LICENSE][stdlib-license].
175
188
 
176
189
  ## Copyright
177
190
 
178
- Copyright &copy; 2016-2024. The Stdlib [Authors][stdlib-authors].
191
+ Copyright &copy; 2016-2026. The Stdlib [Authors][stdlib-authors].
179
192
 
180
193
  </section>
181
194
 
@@ -188,8 +201,8 @@ Copyright &copy; 2016-2024. The Stdlib [Authors][stdlib-authors].
188
201
  [npm-image]: http://img.shields.io/npm/v/@stdlib/stats-base-dists-t.svg
189
202
  [npm-url]: https://npmjs.org/package/@stdlib/stats-base-dists-t
190
203
 
191
- [test-image]: https://github.com/stdlib-js/stats-base-dists-t/actions/workflows/test.yml/badge.svg?branch=v0.2.1
192
- [test-url]: https://github.com/stdlib-js/stats-base-dists-t/actions/workflows/test.yml?query=branch:v0.2.1
204
+ [test-image]: https://github.com/stdlib-js/stats-base-dists-t/actions/workflows/test.yml/badge.svg?branch=v0.3.0
205
+ [test-url]: https://github.com/stdlib-js/stats-base-dists-t/actions/workflows/test.yml?query=branch:v0.3.0
193
206
 
194
207
  [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/stats-base-dists-t/main.svg
195
208
  [coverage-url]: https://codecov.io/github/stdlib-js/stats-base-dists-t?branch=main
@@ -201,8 +214,8 @@ Copyright &copy; 2016-2024. The Stdlib [Authors][stdlib-authors].
201
214
 
202
215
  -->
203
216
 
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
217
+ [chat-image]: https://img.shields.io/badge/zulip-join_chat-brightgreen.svg
218
+ [chat-url]: https://stdlib.zulipchat.com
206
219
 
207
220
  [stdlib]: https://github.com/stdlib-js/stdlib
208
221
 
package/docs/types/index.d.ts CHANGED
@@ -167,11 +167,11 @@ interface Namespace {
167
167
  *
168
168
  * @example
169
169
  * var y = ns.logpdf( 3.0, 1.0 );
170
- * // returns ~-3.442
170
+ * // returns ~-3.447
171
171
  *
172
- * var mylogpdf = ns.logpdf.factory( 3.0 );
173
- * y = mylogpdf( 1.0 );
174
- * // returns ~-1.575
172
+ * var mylogPDF = ns.logpdf.factory( 3.0 );
173
+ * y = mylogPDF( 1.0 );
174
+ * // returns ~-1.576
175
175
  */
176
176
  logpdf: typeof logpdf;
177
177
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@stdlib/stats-base-dists-t",
3
- "version": "0.2.1",
3
+ "version": "0.3.0",
4
4
  "description": "Student's t 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-t-cdf": "^0.2.1",
34
- "@stdlib/stats-base-dists-t-ctor": "^0.2.1",
35
- "@stdlib/stats-base-dists-t-entropy": "^0.2.1",
36
- "@stdlib/stats-base-dists-t-kurtosis": "^0.2.1",
37
- "@stdlib/stats-base-dists-t-logcdf": "^0.2.1",
38
- "@stdlib/stats-base-dists-t-logpdf": "^0.2.1",
39
- "@stdlib/stats-base-dists-t-mean": "^0.2.1",
40
- "@stdlib/stats-base-dists-t-median": "^0.2.1",
41
- "@stdlib/stats-base-dists-t-mode": "^0.2.1",
42
- "@stdlib/stats-base-dists-t-pdf": "^0.2.1",
43
- "@stdlib/stats-base-dists-t-quantile": "^0.2.1",
44
- "@stdlib/stats-base-dists-t-skewness": "^0.2.1",
45
- "@stdlib/stats-base-dists-t-stdev": "^0.2.1",
46
- "@stdlib/stats-base-dists-t-variance": "^0.2.1",
47
- "@stdlib/utils-define-read-only-property": "^0.2.1"
33
+ "@stdlib/stats-base-dists-t-cdf": "^0.2.2",
34
+ "@stdlib/stats-base-dists-t-ctor": "^0.2.2",
35
+ "@stdlib/stats-base-dists-t-entropy": "^0.3.0",
36
+ "@stdlib/stats-base-dists-t-kurtosis": "^0.3.0",
37
+ "@stdlib/stats-base-dists-t-logcdf": "^0.2.2",
38
+ "@stdlib/stats-base-dists-t-logpdf": "^0.3.0",
39
+ "@stdlib/stats-base-dists-t-mean": "^0.3.0",
40
+ "@stdlib/stats-base-dists-t-median": "^0.3.0",
41
+ "@stdlib/stats-base-dists-t-mode": "^0.3.0",
42
+ "@stdlib/stats-base-dists-t-pdf": "^0.3.0",
43
+ "@stdlib/stats-base-dists-t-quantile": "^0.2.2",
44
+ "@stdlib/stats-base-dists-t-skewness": "^0.3.0",
45
+ "@stdlib/stats-base-dists-t-stdev": "^0.3.0",
46
+ "@stdlib/stats-base-dists-t-variance": "^0.3.0",
47
+ "@stdlib/utils-define-read-only-property": "^0.2.2"
48
48
  },
49
49
  "devDependencies": {},
50
50
  "engines": {