Skip to content

Commit 19c8688

Browse files
docs: improve README examples of stats/base/dists/laplace namespace
PR-URL: #1875 Closes: #1633 Co-authored-by: Philipp Burckhardt <[email protected]> Reviewed-by: Philipp Burckhardt <[email protected]>
1 parent 951fbd2 commit 19c8688

File tree

2 files changed

+148
-4
lines changed

2 files changed

+148
-4
lines changed

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

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

111111
```javascript
112-
var objectKeys = require( '@stdlib/utils/keys' );
113112
var laplace = require( '@stdlib/stats/base/dists/laplace' );
114113

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

118190
</section>

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

Lines changed: 74 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,79 @@
1818

1919
'use strict';
2020

21-
var objectKeys = require( '@stdlib/utils/keys' );
2221
var laplace = require( './../lib' );
2322

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

0 commit comments

Comments
 (0)