Skip to content

Commit abc72da

Browse files
committed
docs: add examples and documentation for laplace distribution
1 parent e45ee33 commit abc72da

File tree

2 files changed

+167
-4
lines changed

2 files changed

+167
-4
lines changed

lib/node_modules/@stdlib/stats/base/dists/laplace/README.md

Lines changed: 84 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -109,11 +109,92 @@ var y = dist.cdf( 0.5 );
109109
<!-- eslint no-undef: "error" -->
110110

111111
```javascript
112+
112113
var objectKeys = require( '@stdlib/utils/keys' );
113-
var laplace = require( '@stdlib/stats/base/dists/laplace' );
114+
var laplace = require( './../lib' );
115+
var quantile = require('@stdlib/stats/base/dists/laplace/quantile');
116+
var logpdf = require('@stdlib/stats/base/dists/laplace/logpdf');
117+
var laplaceConstructor = require('@stdlib/stats/base/dists/laplace/ctor');
114118

115-
console.log( objectKeys( laplace ) );
116-
```
119+
console.log(objectKeys(laplace));
120+
121+
var laplaceDist = new laplaceConstructor(4.0, 2.0);
122+
123+
console.log(laplaceDist.mu);
124+
// => 4.0
125+
126+
console.log(laplaceDist.b);
127+
// => 2.0
128+
129+
laplaceDist.mu = 6.0;
130+
laplaceDist.b = 3.0;
131+
132+
console.log(laplaceDist.mu);
133+
// => 6.0
134+
135+
console.log(laplaceDist.b);
136+
// => 3.0
137+
138+
console.log(laplaceDist.kurtosis);
139+
// => 3.0
140+
141+
console.log(laplaceDist.median);
142+
// => 6.0
143+
144+
console.log(laplaceDist.variance);
145+
// => 18.0
146+
147+
var mu = 4.0;
148+
var b = 2.0;
149+
150+
console.log(laplace.pdf(2.0, mu, b));
151+
// => ~ 0.092
152+
153+
console.log(laplace.cdf(2.0, mu, b));
154+
// => ~ 0.184
155+
156+
console.log(laplace.quantile(0.5, mu, b));
157+
// => 4.0
158+
159+
console.log(laplace.mgf(0.5, mu, b));
160+
// => NaN
161+
162+
mu = 6.0;
163+
b = 3.0;
164+
165+
console.log(laplace.entropy(mu, b));
166+
// => ~ 2.7918
167+
168+
console.log(laplace.mean(mu, b));
169+
// => 6.0
170+
171+
console.log(laplace.median(mu, b));
172+
// => 6.0
173+
174+
console.log(laplace.mode(mu, b));
175+
// => 6.0
176+
177+
console.log(laplace.variance(mu, b));
178+
// => 18.0
179+
180+
console.log(laplace.skewness(mu, b));
181+
// => 0.0
182+
183+
var myquantile = quantile.factory(10.0, 2.0);
184+
185+
console.log(myquantile(0.2));
186+
// => ~ 8.167
187+
188+
console.log(myquantile(0.8));
189+
// => ~ 11.833
190+
191+
var mylogpdf = logpdf.factory(10.0, 2.0);
192+
193+
console.log(mylogpdf(10.0));
194+
// => ~ -1.386
195+
196+
console.log(mylogpdf(5.0));
197+
// => ~ -3.886
117198

118199
</section>
119200

lib/node_modules/@stdlib/stats/base/dists/laplace/examples/index.js

Lines changed: 83 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,5 +20,87 @@
2020

2121
var objectKeys = require( '@stdlib/utils/keys' );
2222
var laplace = require( './../lib' );
23+
var quantile = require('@stdlib/stats/base/dists/laplace/quantile');
24+
var logpdf = require('@stdlib/stats/base/dists/laplace/logpdf');
25+
var laplaceConstructor = require('@stdlib/stats/base/dists/laplace/ctor');
26+
27+
console.log(objectKeys(laplace));
28+
29+
var laplaceDist = new laplaceConstructor(4.0, 2.0);
30+
31+
console.log(laplaceDist.mu);
32+
// => 4.0
33+
34+
console.log(laplaceDist.b);
35+
// => 2.0
36+
37+
laplaceDist.mu = 6.0;
38+
laplaceDist.b = 3.0;
39+
40+
console.log(laplaceDist.mu);
41+
// => 6.0
42+
43+
console.log(laplaceDist.b);
44+
// => 3.0
45+
46+
console.log(laplaceDist.kurtosis);
47+
// => 3.0
48+
49+
console.log(laplaceDist.median);
50+
// => 6.0
51+
52+
console.log(laplaceDist.variance);
53+
// => 18.0
54+
55+
var mu = 4.0;
56+
var b = 2.0;
57+
58+
console.log(laplace.pdf(2.0, mu, b));
59+
// => ~ 0.092
60+
61+
console.log(laplace.cdf(2.0, mu, b));
62+
// => ~ 0.184
63+
64+
console.log(laplace.quantile(0.5, mu, b));
65+
// => 4.0
66+
67+
console.log(laplace.mgf(0.5, mu, b));
68+
// => NaN
69+
70+
mu = 6.0;
71+
b = 3.0;
72+
73+
console.log(laplace.entropy(mu, b));
74+
// => ~ 2.7918
75+
76+
console.log(laplace.mean(mu, b));
77+
// => 6.0
78+
79+
console.log(laplace.median(mu, b));
80+
// => 6.0
81+
82+
console.log(laplace.mode(mu, b));
83+
// => 6.0
84+
85+
console.log(laplace.variance(mu, b));
86+
// => 18.0
87+
88+
console.log(laplace.skewness(mu, b));
89+
// => 0.0
90+
91+
var myquantile = quantile.factory(10.0, 2.0);
92+
93+
console.log(myquantile(0.2));
94+
// => ~ 8.167
95+
96+
console.log(myquantile(0.8));
97+
// => ~ 11.833
98+
99+
var mylogpdf = logpdf.factory(10.0, 2.0);
100+
101+
console.log(mylogpdf(10.0));
102+
// => ~ -1.386
103+
104+
console.log(mylogpdf(5.0));
105+
// => ~ -3.886
23106

24-
console.log( objectKeys( laplace ) );

0 commit comments

Comments
 (0)