Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: improve README examples of stats/base/dists/cosine namespace #2669

Merged
merged 2 commits into from
Oct 13, 2024
Merged

docs: improve README examples of stats/base/dists/cosine namespace #2669

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
69899f7
Docs: improve README examples of stats/base/dists/cosine namespace
kohantikanath Jul 26, 2024
bfd8480
chore: update examples
Planeshifter Oct 13, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 36 additions & 2 deletions lib/node_modules/@stdlib/stats/base/dists/cosine/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,10 +108,44 @@ var y = dist.cdf( 0.5 );
<!-- eslint no-undef: "error" -->

```javascript
var objectKeys = require( '@stdlib/utils/keys' );
var cosine = require( '@stdlib/stats/base/dists/cosine' );

console.log( objectKeys( cosine ) );
// Create a raised cosine distribution:
var mu = 2.0;
var s = 1.5;
var dist = new cosine.Cosine( mu, s );

// Calculate various distribution properties:
console.log( 'Mean: %d', dist.mean );
// => 'Mean: 2'

console.log( 'Median: %d', dist.median );
// => 'Median: 2'

console.log( 'Mode: %d', dist.mode );
// => 'Mode: 2'

console.log( 'Standard Deviation: %d', dist.stdev );
// => 'Standard Deviation: 0.5422680827869919'

console.log( 'Variance: %d', dist.variance );
// => 'Variance: 0.29405467360947996'

// Evaluate the probability density function (PDF):
var x = 1.5;
console.log( 'PDF( %d ): %d', x, dist.pdf( x ) );
// => 'PDF( 1.5 ): 0.5'

// Evaluate the cumulative distribution function (CDF):
console.log( 'CDF( %d ): %d', x, dist.cdf( x ) );
// => 'CDF( 1.5 ): 0.19550110947788535'

// Calculate distribution moments:
console.log( 'Skewness: %d', cosine.skewness( mu, s ) );
// => 'Skewness: 0'

console.log( 'Excess Kurtosis: %d', cosine.kurtosis( mu, s ) );
// => 'Excess Kurtosis: -0.5937628755982807'
```

</section>
Expand Down
38 changes: 36 additions & 2 deletions lib/node_modules/@stdlib/stats/base/dists/cosine/examples/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,41 @@

'use strict';

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

console.log( objectKeys( cosine ) );
// Create a raised cosine distribution:
var mu = 2.0;
var s = 1.5;
var dist = new cosine.Cosine( mu, s );

// Calculate various distribution properties:
console.log( 'Mean: %d', dist.mean );
// => 'Mean: 2'

console.log( 'Median: %d', dist.median );
// => 'Median: 2'

console.log( 'Mode: %d', dist.mode );
// => 'Mode: 2'

console.log( 'Standard Deviation: %d', dist.stdev );
// => 'Standard Deviation: 0.5422680827869919'

console.log( 'Variance: %d', dist.variance );
// => 'Variance: 0.29405467360947996'

// Evaluate the probability density function (PDF):
var x = 1.5;
console.log( 'PDF( %d ): %d', x, dist.pdf( x ) );
// => 'PDF( 1.5 ): 0.5'

// Evaluate the cumulative distribution function (CDF):
console.log( 'CDF( %d ): %d', x, dist.cdf( x ) );
// => 'CDF( 1.5 ): 0.19550110947788535'

// Calculate distribution moments:
console.log( 'Skewness: %d', cosine.skewness( mu, s ) );
// => 'Skewness: 0'

console.log( 'Excess Kurtosis: %d', cosine.kurtosis( mu, s ) );
// => 'Excess Kurtosis: -0.5937628755982807'
Loading