@stdlib/stats-base-dists-laplace 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 +79 -7
  3. package/docs/types/index.d.ts +3 -3
  4. package/package.json +17 -17
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
@@ -132,10 +132,82 @@ var y = dist.cdf( 0.5 );
132
132
  <!-- eslint no-undef: "error" -->
133
133
 
134
134
  ```javascript
135
- var objectKeys = require( '@stdlib/utils-keys' );
136
135
  var laplace = require( '@stdlib/stats-base-dists-laplace' );
137
136
 
138
- console.log( objectKeys( laplace ) );
137
+ var dist = new laplace.Laplace( 4.0, 2.0 );
138
+
139
+ console.log( dist.mu );
140
+ // => 4.0
141
+
142
+ console.log( dist.b );
143
+ // => 2.0
144
+
145
+ dist.mu = 6.0;
146
+ dist.b = 3.0;
147
+
148
+ console.log( dist.mu );
149
+ // => 6.0
150
+
151
+ console.log( dist.b );
152
+ // => 3.0
153
+
154
+ console.log( dist.kurtosis );
155
+ // => 3.0
156
+
157
+ console.log( dist.median );
158
+ // => 6.0
159
+
160
+ console.log( dist.variance );
161
+ // => 18.0
162
+
163
+ var mu = 4.0;
164
+ var b = 2.0;
165
+
166
+ console.log( laplace.pdf( 2.0, mu, b ) );
167
+ // => ~0.092
168
+
169
+ console.log( laplace.cdf( 2.0, mu, b ) );
170
+ // => ~0.184
171
+
172
+ console.log( laplace.quantile( 0.5, mu, b ) );
173
+ // => 4.0
174
+
175
+ mu = 6.0;
176
+ b = 3.0;
177
+
178
+ console.log( laplace.entropy( mu, b ) );
179
+ // => ~ 2.7918
180
+
181
+ console.log( laplace.mean( mu, b ) );
182
+ // => 6.0
183
+
184
+ console.log( laplace.median( mu, b ) );
185
+ // => 6.0
186
+
187
+ console.log( laplace.mode( mu, b ) );
188
+ // => 6.0
189
+
190
+ console.log( laplace.variance( mu, b ) );
191
+ // => 18.0
192
+
193
+ console.log( laplace.skewness( mu, b ) );
194
+ // => 0.0
195
+
196
+ var myquantile = laplace.quantile.factory( 10.0, 2.0 );
197
+
198
+ console.log( myquantile( 0.2 ) );
199
+ // => ~8.167
200
+
201
+ console.log( myquantile( 0.8 ) );
202
+ // => ~11.833
203
+
204
+ var mylogpdf = laplace.logpdf.factory( 10.0, 2.0 );
205
+
206
+ console.log( mylogpdf( 10.0) );
207
+ // => ~-1.386
208
+
209
+ console.log( mylogpdf( 5.0 ) );
210
+ // => ~-3.886
139
211
  ```
140
212
 
141
213
  </section>
@@ -176,7 +248,7 @@ See [LICENSE][stdlib-license].
176
248
 
177
249
  ## Copyright
178
250
 
179
- Copyright &copy; 2016-2024. The Stdlib [Authors][stdlib-authors].
251
+ Copyright &copy; 2016-2026. The Stdlib [Authors][stdlib-authors].
180
252
 
181
253
  </section>
182
254
 
@@ -189,8 +261,8 @@ Copyright &copy; 2016-2024. The Stdlib [Authors][stdlib-authors].
189
261
  [npm-image]: http://img.shields.io/npm/v/@stdlib/stats-base-dists-laplace.svg
190
262
  [npm-url]: https://npmjs.org/package/@stdlib/stats-base-dists-laplace
191
263
 
192
- [test-image]: https://github.com/stdlib-js/stats-base-dists-laplace/actions/workflows/test.yml/badge.svg?branch=v0.2.1
193
- [test-url]: https://github.com/stdlib-js/stats-base-dists-laplace/actions/workflows/test.yml?query=branch:v0.2.1
264
+ [test-image]: https://github.com/stdlib-js/stats-base-dists-laplace/actions/workflows/test.yml/badge.svg?branch=v0.3.0
265
+ [test-url]: https://github.com/stdlib-js/stats-base-dists-laplace/actions/workflows/test.yml?query=branch:v0.3.0
194
266
 
195
267
  [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/stats-base-dists-laplace/main.svg
196
268
  [coverage-url]: https://codecov.io/github/stdlib-js/stats-base-dists-laplace?branch=main
@@ -202,8 +274,8 @@ Copyright &copy; 2016-2024. The Stdlib [Authors][stdlib-authors].
202
274
 
203
275
  -->
204
276
 
205
- [chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
206
- [chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im
277
+ [chat-image]: https://img.shields.io/badge/zulip-join_chat-brightgreen.svg
278
+ [chat-url]: https://stdlib.zulipchat.com
207
279
 
208
280
  [stdlib]: https://github.com/stdlib-js/stdlib
209
281
 
package/docs/types/index.d.ts CHANGED
@@ -152,7 +152,7 @@ interface Namespace {
152
152
  *
153
153
  * var mylogcdf = ns.logcdf.factory( 2.0, 3.0 );
154
154
  * y = mylogcdf( 10.0 );
155
- * // returns ~-0.036
155
+ * // returns ~-0.035
156
156
  *
157
157
  * y = mylogcdf( 2.0 );
158
158
  * // returns ~-0.693
@@ -169,11 +169,11 @@ interface Namespace {
169
169
  *
170
170
  * @example
171
171
  * var y = ns.logpdf( 2.0, 0.0, 1.0 );
172
- * // returns ~-2.688
172
+ * // returns ~-2.693
173
173
  *
174
174
  * var mylogpdf = ns.logpdf.factory( 10.0, 2.0 );
175
175
  * y = mylogpdf( 10.0 );
176
- * // returns -1.386
176
+ * // returns ~-1.386
177
177
  */
178
178
  logpdf: typeof logpdf;
179
179
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@stdlib/stats-base-dists-laplace",
3
- "version": "0.2.1",
3
+ "version": "0.3.0",
4
4
  "description": "Laplace distribution.",
5
5
  "license": "Apache-2.0",
6
6
  "author": {
@@ -30,22 +30,22 @@
30
30
  "url": "https://github.com/stdlib-js/stdlib/issues"
31
31
  },
32
32
  "dependencies": {
33
- "@stdlib/stats-base-dists-laplace-cdf": "^0.2.1",
34
- "@stdlib/stats-base-dists-laplace-ctor": "^0.2.1",
35
- "@stdlib/stats-base-dists-laplace-entropy": "^0.2.1",
36
- "@stdlib/stats-base-dists-laplace-kurtosis": "^0.2.1",
37
- "@stdlib/stats-base-dists-laplace-logcdf": "^0.2.1",
38
- "@stdlib/stats-base-dists-laplace-logpdf": "^0.2.1",
39
- "@stdlib/stats-base-dists-laplace-mean": "^0.2.1",
40
- "@stdlib/stats-base-dists-laplace-median": "^0.2.1",
41
- "@stdlib/stats-base-dists-laplace-mgf": "^0.2.1",
42
- "@stdlib/stats-base-dists-laplace-mode": "^0.2.1",
43
- "@stdlib/stats-base-dists-laplace-pdf": "^0.2.1",
44
- "@stdlib/stats-base-dists-laplace-quantile": "^0.2.1",
45
- "@stdlib/stats-base-dists-laplace-skewness": "^0.2.1",
46
- "@stdlib/stats-base-dists-laplace-stdev": "^0.2.1",
47
- "@stdlib/stats-base-dists-laplace-variance": "^0.2.1",
48
- "@stdlib/utils-define-read-only-property": "^0.2.1"
33
+ "@stdlib/stats-base-dists-laplace-cdf": "^0.2.2",
34
+ "@stdlib/stats-base-dists-laplace-ctor": "^0.2.2",
35
+ "@stdlib/stats-base-dists-laplace-entropy": "^0.3.0",
36
+ "@stdlib/stats-base-dists-laplace-kurtosis": "^0.3.0",
37
+ "@stdlib/stats-base-dists-laplace-logcdf": "^0.3.0",
38
+ "@stdlib/stats-base-dists-laplace-logpdf": "^0.3.0",
39
+ "@stdlib/stats-base-dists-laplace-mean": "^0.3.0",
40
+ "@stdlib/stats-base-dists-laplace-median": "^0.3.0",
41
+ "@stdlib/stats-base-dists-laplace-mgf": "^0.3.0",
42
+ "@stdlib/stats-base-dists-laplace-mode": "^0.3.0",
43
+ "@stdlib/stats-base-dists-laplace-pdf": "^0.3.0",
44
+ "@stdlib/stats-base-dists-laplace-quantile": "^0.3.0",
45
+ "@stdlib/stats-base-dists-laplace-skewness": "^0.3.0",
46
+ "@stdlib/stats-base-dists-laplace-stdev": "^0.3.0",
47
+ "@stdlib/stats-base-dists-laplace-variance": "^0.3.0",
48
+ "@stdlib/utils-define-read-only-property": "^0.2.2"
49
49
  },
50
50
  "devDependencies": {},
51
51
  "engines": {