https://github.com/stdlib-js/stats-base-dists-frechet
Fréchet distribution.
https://github.com/stdlib-js/stats-base-dists-frechet
continuous dist distribution extreme frechet inverse javascript lib library node node-js nodejs probability standard statistics stats stdlib univariate value weibull
Last synced: 4 months ago
JSON representation
Fréchet distribution.
- Host: GitHub
- URL: https://github.com/stdlib-js/stats-base-dists-frechet
- Owner: stdlib-js
- License: apache-2.0
- Created: 2021-06-15T17:29:52.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-12-16T01:48:40.000Z (about 1 year ago)
- Last Synced: 2025-01-17T00:02:16.341Z (about 1 year ago)
- Topics: continuous, dist, distribution, extreme, frechet, inverse, javascript, lib, library, node, node-js, nodejs, probability, standard, statistics, stats, stdlib, univariate, value, weibull
- Language: JavaScript
- Homepage: https://github.com/stdlib-js/stdlib
- Size: 2.18 MB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Citation: CITATION.cff
- Security: SECURITY.md
Awesome Lists containing this project
README
About stdlib...
We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.
The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.
When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.
To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!
# Fréchet
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> Fréchet distribution.
## Installation
```bash
npm install @stdlib/stats-base-dists-frechet
```
Alternatively,
- To load the package in a website via a `script` tag without installation and bundlers, use the [ES Module][es-module] available on the [`esm`][esm-url] branch (see [README][esm-readme]).
- If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions).
- For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [`umd`][umd-url] branch (see [README][umd-readme]).
The [branches.md][branches-url] file summarizes the available branches and displays a diagram illustrating their relationships.
To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.
## Usage
```javascript
var frechet = require( '@stdlib/stats-base-dists-frechet' );
```
#### frechet
Fréchet distribution.
```javascript
var dist = frechet;
// returns {...}
```
The namespace contains the following distribution functions:
- [`cdf( x, alpha, s, m )`][@stdlib/stats/base/dists/frechet/cdf]: Fréchet distribution cumulative distribution function.
- [`logcdf( x, alpha, s, m )`][@stdlib/stats/base/dists/frechet/logcdf]: Fréchet distribution logarithm of cumulative distribution function.
- [`logpdf( x, alpha, s, m )`][@stdlib/stats/base/dists/frechet/logpdf]: Fréchet distribution logarithm of probability density function.
- [`pdf( x, alpha, s, m )`][@stdlib/stats/base/dists/frechet/pdf]: Fréchet distribution probability density function.
- [`quantile( p, alpha, s, m )`][@stdlib/stats/base/dists/frechet/quantile]: Fréchet distribution quantile function.
The namespace contains the following functions for calculating distribution properties:
- [`entropy( alpha, s, m )`][@stdlib/stats/base/dists/frechet/entropy]: Fréchet distribution differential entropy.
- [`kurtosis( alpha, s, m )`][@stdlib/stats/base/dists/frechet/kurtosis]: Fréchet distribution kurtosis.
- [`mean( alpha, s, m )`][@stdlib/stats/base/dists/frechet/mean]: Fréchet distribution expected value.
- [`median( alpha, s, m )`][@stdlib/stats/base/dists/frechet/median]: Fréchet distribution median.
- [`mode( alpha, s, m )`][@stdlib/stats/base/dists/frechet/mode]: Fréchet distribution mode.
- [`skewness( alpha, s, m )`][@stdlib/stats/base/dists/frechet/skewness]: Fréchet distribution skewness.
- [`stdev( alpha, s, m )`][@stdlib/stats/base/dists/frechet/stdev]: Fréchet distribution standard deviation.
- [`variance( alpha, s, m )`][@stdlib/stats/base/dists/frechet/variance]: Fréchet distribution variance.
The namespace contains a constructor function for creating a [Fréchet][frechet-distribution] distribution object.
- [`Frechet( [alpha, s, m] )`][@stdlib/stats/base/dists/frechet/ctor]: Fréchet distribution constructor.
```javascript
var Frechet = require( '@stdlib/stats-base-dists-frechet' ).Frechet;
var dist = new Frechet( 2.0, 4.0, 3.0 );
var y = dist.pdf( 5.5 );
// returns ~0.158
```
## Examples
```javascript
var objectKeys = require( '@stdlib/utils-keys' );
var frechet = require( '@stdlib/stats-base-dists-frechet' );
console.log( objectKeys( frechet ) );
```
* * *
## Notice
This package is part of [stdlib][stdlib], a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.
For more information on the project, filing bug reports and feature requests, and guidance on how to develop [stdlib][stdlib], see the main project [repository][stdlib].
#### Community
[![Chat][chat-image]][chat-url]
---
## License
See [LICENSE][stdlib-license].
## Copyright
Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors].
[npm-image]: http://img.shields.io/npm/v/@stdlib/stats-base-dists-frechet.svg
[npm-url]: https://npmjs.org/package/@stdlib/stats-base-dists-frechet
[test-image]: https://github.com/stdlib-js/stats-base-dists-frechet/actions/workflows/test.yml/badge.svg?branch=main
[test-url]: https://github.com/stdlib-js/stats-base-dists-frechet/actions/workflows/test.yml?query=branch:main
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/stats-base-dists-frechet/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/stats-base-dists-frechet?branch=main
[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im
[stdlib]: https://github.com/stdlib-js/stdlib
[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
[umd]: https://github.com/umdjs/umd
[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
[deno-url]: https://github.com/stdlib-js/stats-base-dists-frechet/tree/deno
[deno-readme]: https://github.com/stdlib-js/stats-base-dists-frechet/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/stats-base-dists-frechet/tree/umd
[umd-readme]: https://github.com/stdlib-js/stats-base-dists-frechet/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/stats-base-dists-frechet/tree/esm
[esm-readme]: https://github.com/stdlib-js/stats-base-dists-frechet/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/stats-base-dists-frechet/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/stats-base-dists-frechet/main/LICENSE
[frechet-distribution]: https://en.wikipedia.org/wiki/Fr%C3%A9chet_distribution
[@stdlib/stats/base/dists/frechet/ctor]: https://github.com/stdlib-js/stats-base-dists-frechet-ctor
[@stdlib/stats/base/dists/frechet/entropy]: https://github.com/stdlib-js/stats-base-dists-frechet-entropy
[@stdlib/stats/base/dists/frechet/kurtosis]: https://github.com/stdlib-js/stats-base-dists-frechet-kurtosis
[@stdlib/stats/base/dists/frechet/mean]: https://github.com/stdlib-js/stats-base-dists-frechet-mean
[@stdlib/stats/base/dists/frechet/median]: https://github.com/stdlib-js/stats-base-dists-frechet-median
[@stdlib/stats/base/dists/frechet/mode]: https://github.com/stdlib-js/stats-base-dists-frechet-mode
[@stdlib/stats/base/dists/frechet/skewness]: https://github.com/stdlib-js/stats-base-dists-frechet-skewness
[@stdlib/stats/base/dists/frechet/stdev]: https://github.com/stdlib-js/stats-base-dists-frechet-stdev
[@stdlib/stats/base/dists/frechet/variance]: https://github.com/stdlib-js/stats-base-dists-frechet-variance
[@stdlib/stats/base/dists/frechet/cdf]: https://github.com/stdlib-js/stats-base-dists-frechet-cdf
[@stdlib/stats/base/dists/frechet/logcdf]: https://github.com/stdlib-js/stats-base-dists-frechet-logcdf
[@stdlib/stats/base/dists/frechet/logpdf]: https://github.com/stdlib-js/stats-base-dists-frechet-logpdf
[@stdlib/stats/base/dists/frechet/pdf]: https://github.com/stdlib-js/stats-base-dists-frechet-pdf
[@stdlib/stats/base/dists/frechet/quantile]: https://github.com/stdlib-js/stats-base-dists-frechet-quantile