Skip to content
Closed
Changes from 1 commit
Commits
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
65 changes: 65 additions & 0 deletions lib/node_modules/@stdlib/stats/base/dists/arcsine/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,13 +106,78 @@ var mu = dist.mean;

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


#### Display Available Functions

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

console.log( objectKeys( arcsine ) );
```

#### Calculate the Median

```javascript
var arcsine = require( '@stdlib/stats/base/dists/arcsine' );

// Calculate the median for the arcsine distribution in the range [0, 1]
var medianValue = arcsine.median(0, 1);
console.log('The median of the distribution is', medianValue);
```

#### Calculate the Mode

```javascript
var arcsine = require( '@stdlib/stats/base/dists/arcsine' );

// Calculate the mode for the arcsine distribution in the range [0, 1]
var modeValue = arcsine.mode(0, 1);
console.log('The mode of the distribution is', modeValue);
```

#### Calculate the Entropy

```javascript
var arcsine = require( '@stdlib/stats/base/dists/arcsine' );
var log = require( '@stdlib/math/base/special/log' );

// Calculate the entropy for the arcsine distribution in the range [0, 1]
var entropy = arcsine.entropy(0, 1);
console.log('Entropy:', entropy);
```

#### Calculate the Cumulative Distribution Function (CDF)

```javascript
var arcsine = require( '@stdlib/stats/base/dists/arcsine' );

// Calculate the CDF for value 0.5 in the range [0, 1]
var cdfValue = arcsine.cdf(0.5, 0, 1);
console.log('The CDF value at 0.5 is', cdfValue);
```

#### Calculate the Probability Density Function (PDF)

```javascript
var arcsine = require( '@stdlib/stats/base/dists/arcsine' );

// Calculate the PDF for value 0.5 in the range [0, 1]
var pdfValue = arcsine.pdf(0.5, 0, 1);
console.log('The PDF value at 0.5 is', pdfValue);
```

#### Use the Mean and Variance

```javascript
var arcsine = require( '@stdlib/stats/base/dists/arcsine' );

// Calculate the mean and variance for the arcsine distribution in the range [0, 1]
var mean = arcsine.mean(0, 1);
var variance = arcsine.variance(0, 1);
console.log('Mean:', mean, 'Variance:', variance);
```

</section>

<!-- /.examples -->
Expand Down