diff --git a/lib/node_modules/@stdlib/stats/base/dists/cosine/README.md b/lib/node_modules/@stdlib/stats/base/dists/cosine/README.md index 0c3bbd1c508..279e9a5b9e7 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/cosine/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/cosine/README.md @@ -108,10 +108,44 @@ var y = dist.cdf( 0.5 ); ```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' ``` diff --git a/lib/node_modules/@stdlib/stats/base/dists/cosine/examples/index.js b/lib/node_modules/@stdlib/stats/base/dists/cosine/examples/index.js index 28c2d1289c3..a6fc9e9d6ab 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/cosine/examples/index.js +++ b/lib/node_modules/@stdlib/stats/base/dists/cosine/examples/index.js @@ -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'