From 69899f78044205849258c3c8bdf3dad4f3d0f211 Mon Sep 17 00:00:00 2001 From: Kohantika Nath Date: Fri, 26 Jul 2024 22:55:11 +0530 Subject: [PATCH 1/2] Docs: improve README examples of stats/base/dists/cosine namespace --- .../@stdlib/stats/base/dists/cosine/README.md | 48 ++++++++++++++++++- 1 file changed, 46 insertions(+), 2 deletions(-) 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..cfe202f12f7 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,54 @@ 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.6123724356957945 + +console.log( 'Variance: %d', dist.variance ); +// => Variance: 0.375 + +// Evaluate the probability density function (PDF) +var x = 1.5; +console.log( 'PDF( %d ): %d', x, dist.pdf( x ) ); +// => PDF( 1.5 ): 0.2886751345948129 + +// Evaluate the cumulative distribution function (CDF) +console.log( 'CDF( %d ): %d', x, dist.cdf( x ) ); +// => CDF( 1.5 ): 0.21132486540518708 + +// Generate random samples +var samples = new Array( 5 ); +for ( var i = 0; i < 5; i++ ) { + samples[ i ] = dist.quantile( Math.random() ); +} +console.log( 'Samples: %s', samples.join( ', ' ) ); +// => Samples: 2.2642152512549444, 2.7489308009950834, 1.6391832278662363, 1.3555922486975812, 2.4894454832467757 + +// 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.5933333333333333 + ``` From bfd8480d6e32e0336ee42b56eb6f5b4da25b712c Mon Sep 17 00:00:00 2001 From: Philipp Burckhardt Date: Sun, 13 Oct 2024 17:02:42 -0400 Subject: [PATCH 2/2] chore: update examples --- .../@stdlib/stats/base/dists/cosine/README.md | 38 +++++++------------ .../stats/base/dists/cosine/examples/index.js | 38 ++++++++++++++++++- 2 files changed, 50 insertions(+), 26 deletions(-) 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 cfe202f12f7..279e9a5b9e7 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/cosine/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/cosine/README.md @@ -110,52 +110,42 @@ var y = dist.cdf( 0.5 ); ```javascript var cosine = require( '@stdlib/stats/base/dists/cosine' ); - -// Create a raised cosine distribution +// Create a raised cosine distribution: var mu = 2.0; var s = 1.5; var dist = new cosine.Cosine( mu, s ); -// Calculate various distribution properties +// Calculate various distribution properties: console.log( 'Mean: %d', dist.mean ); -// => Mean: 2 +// => 'Mean: 2' console.log( 'Median: %d', dist.median ); -// => Median: 2 +// => 'Median: 2' console.log( 'Mode: %d', dist.mode ); -// => Mode: 2 +// => 'Mode: 2' console.log( 'Standard Deviation: %d', dist.stdev ); -// => Standard Deviation: 0.6123724356957945 +// => 'Standard Deviation: 0.5422680827869919' console.log( 'Variance: %d', dist.variance ); -// => Variance: 0.375 +// => 'Variance: 0.29405467360947996' -// Evaluate the probability density function (PDF) +// Evaluate the probability density function (PDF): var x = 1.5; console.log( 'PDF( %d ): %d', x, dist.pdf( x ) ); -// => PDF( 1.5 ): 0.2886751345948129 +// => 'PDF( 1.5 ): 0.5' -// Evaluate the cumulative distribution function (CDF) +// Evaluate the cumulative distribution function (CDF): console.log( 'CDF( %d ): %d', x, dist.cdf( x ) ); -// => CDF( 1.5 ): 0.21132486540518708 - -// Generate random samples -var samples = new Array( 5 ); -for ( var i = 0; i < 5; i++ ) { - samples[ i ] = dist.quantile( Math.random() ); -} -console.log( 'Samples: %s', samples.join( ', ' ) ); -// => Samples: 2.2642152512549444, 2.7489308009950834, 1.6391832278662363, 1.3555922486975812, 2.4894454832467757 +// => 'CDF( 1.5 ): 0.19550110947788535' -// Calculate distribution moments +// Calculate distribution moments: console.log( 'Skewness: %d', cosine.skewness( mu, s ) ); -// => Skewness: 0 +// => 'Skewness: 0' console.log( 'Excess Kurtosis: %d', cosine.kurtosis( mu, s ) ); -// => Excess Kurtosis: -0.5933333333333333 - +// => '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'