Skip to content

Commit e5b993a

Browse files
docs: improve README examples of stats/base/dists/cosine namespace
PR-URL: #2669 Closes: #1620 Co-authored-by: Kohantika Nath <[email protected]> Co-authored-by: Philipp Burckhardt <[email protected]> Reviewed-by: Philipp Burckhardt <[email protected]>
1 parent 0c4f656 commit e5b993a

File tree

2 files changed

+72
-4
lines changed

2 files changed

+72
-4
lines changed

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

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

110110
```javascript
111-
var objectKeys = require( '@stdlib/utils/keys' );
112111
var cosine = require( '@stdlib/stats/base/dists/cosine' );
113112

114-
console.log( objectKeys( cosine ) );
113+
// Create a raised cosine distribution:
114+
var mu = 2.0;
115+
var s = 1.5;
116+
var dist = new cosine.Cosine( mu, s );
117+
118+
// Calculate various distribution properties:
119+
console.log( 'Mean: %d', dist.mean );
120+
// => 'Mean: 2'
121+
122+
console.log( 'Median: %d', dist.median );
123+
// => 'Median: 2'
124+
125+
console.log( 'Mode: %d', dist.mode );
126+
// => 'Mode: 2'
127+
128+
console.log( 'Standard Deviation: %d', dist.stdev );
129+
// => 'Standard Deviation: 0.5422680827869919'
130+
131+
console.log( 'Variance: %d', dist.variance );
132+
// => 'Variance: 0.29405467360947996'
133+
134+
// Evaluate the probability density function (PDF):
135+
var x = 1.5;
136+
console.log( 'PDF( %d ): %d', x, dist.pdf( x ) );
137+
// => 'PDF( 1.5 ): 0.5'
138+
139+
// Evaluate the cumulative distribution function (CDF):
140+
console.log( 'CDF( %d ): %d', x, dist.cdf( x ) );
141+
// => 'CDF( 1.5 ): 0.19550110947788535'
142+
143+
// Calculate distribution moments:
144+
console.log( 'Skewness: %d', cosine.skewness( mu, s ) );
145+
// => 'Skewness: 0'
146+
147+
console.log( 'Excess Kurtosis: %d', cosine.kurtosis( mu, s ) );
148+
// => 'Excess Kurtosis: -0.5937628755982807'
115149
```
116150

117151
</section>

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

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

1919
'use strict';
2020

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

24-
console.log( objectKeys( cosine ) );
23+
// Create a raised cosine distribution:
24+
var mu = 2.0;
25+
var s = 1.5;
26+
var dist = new cosine.Cosine( mu, s );
27+
28+
// Calculate various distribution properties:
29+
console.log( 'Mean: %d', dist.mean );
30+
// => 'Mean: 2'
31+
32+
console.log( 'Median: %d', dist.median );
33+
// => 'Median: 2'
34+
35+
console.log( 'Mode: %d', dist.mode );
36+
// => 'Mode: 2'
37+
38+
console.log( 'Standard Deviation: %d', dist.stdev );
39+
// => 'Standard Deviation: 0.5422680827869919'
40+
41+
console.log( 'Variance: %d', dist.variance );
42+
// => 'Variance: 0.29405467360947996'
43+
44+
// Evaluate the probability density function (PDF):
45+
var x = 1.5;
46+
console.log( 'PDF( %d ): %d', x, dist.pdf( x ) );
47+
// => 'PDF( 1.5 ): 0.5'
48+
49+
// Evaluate the cumulative distribution function (CDF):
50+
console.log( 'CDF( %d ): %d', x, dist.cdf( x ) );
51+
// => 'CDF( 1.5 ): 0.19550110947788535'
52+
53+
// Calculate distribution moments:
54+
console.log( 'Skewness: %d', cosine.skewness( mu, s ) );
55+
// => 'Skewness: 0'
56+
57+
console.log( 'Excess Kurtosis: %d', cosine.kurtosis( mu, s ) );
58+
// => 'Excess Kurtosis: -0.5937628755982807'

0 commit comments

Comments
 (0)