Skip to content

docs: improve example code of stats/base/dists/triangular namespace #1952

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

Merged
merged 2 commits into from
Sep 7, 2024
Merged

docs: improve example code of stats/base/dists/triangular namespace #1952

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0be9c8c
docs: improve README examples of stats/base/dists/triangular namespace
Mar 19, 2024
7bc8b6c
docs: update examples for `stats/base/dists/triangular`
Planeshifter Sep 7, 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
29 changes: 29 additions & 0 deletions lib/node_modules/@stdlib/stats/base/dists/triangular/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,8 @@ var y = dist.quantile( 0.5 );

y = dist.quantile( 1.9 );
// returns NaN


```

</section>
Expand All @@ -109,13 +111,40 @@ y = dist.quantile( 1.9 );

<!-- TODO: better examples -->


<!-- eslint no-undef: "error" -->

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

console.log( objectKeys( triangular ) );


// Basic Usage: Calculate and print the mean, median, and mode
console.log('Mean:', dist.mean());
// returns Mean: 3.0

console.log('Median:', dist.median());
// returns Median: 3.0

console.log('Mode:', dist.mode());
// returns Mode: 3.0

// Probability Density Function (PDF): Calculate the PDF at x=3.5
var pdfValue = dist.pdf(3.5);
console.log('PDF at x=3.5:', pdfValue);
// returns PDF at x=3.5: 0.4

// Cumulative Distribution Function (CDF): Calculate the CDF at x=3.5
var cdfValue = dist.cdf(3.5);
console.log('CDF at x=3.5:', cdfValue);
// returns CDF at x=3.5: 0.5

// Quantile Function: Find the quantile for p=0.5
var quantileValue = dist.quantile(0.5);
console.log('Quantile for p=0.5:', quantileValue);
// returns Quantile for p=0.5: 3.0
```

</section>
Expand Down