@stdlib/stats-base-dists-laplace-ctor
v0.2.3
Published
Laplace distribution constructor.
Downloads
135
Readme
Laplace
Laplace distribution constructor.
Installation
npm install @stdlib/stats-base-dists-laplace-ctorUsage
var Laplace = require( '@stdlib/stats-base-dists-laplace-ctor' );Laplace( [mu, b] )
Returns a Laplace distribution object.
var laplace = new Laplace();
var mu = laplace.mean;
// returns 0.0By default, mu = 0.0 and b = 1.0. To create a distribution having a different mu (location parameter) and b (scale parameter), provide the corresponding arguments.
var laplace = new Laplace( 2.0, 4.0 );
var mu = laplace.mean;
// returns 2.0laplace
A Laplace distribution object has the following properties and methods...
Writable Properties
laplace.mu
Location parameter of the distribution.
var laplace = new Laplace();
var mu = laplace.mu;
// returns 0.0
laplace.mu = 3.0;
mu = laplace.mu;
// returns 3.0laplace.b
Scale parameter of the distribution. b must be a positive number.
var laplace = new Laplace( 2.0, 4.0 );
var b = laplace.b;
// returns 4.0
laplace.b = 3.0;
b = laplace.b;
// returns 3.0Computed Properties
Laplace.prototype.entropy
Returns the differential entropy.
var laplace = new Laplace( 4.0, 12.0 );
var entropy = laplace.entropy;
// returns ~4.178Laplace.prototype.kurtosis
Returns the excess kurtosis.
var laplace = new Laplace( 4.0, 12.0 );
var kurtosis = laplace.kurtosis;
// returns 3.0Laplace.prototype.mean
Returns the expected value.
var laplace = new Laplace( 4.0, 12.0 );
var mu = laplace.mean;
// returns 4.0Laplace.prototype.median
Returns the median.
var laplace = new Laplace( 4.0, 12.0 );
var median = laplace.median;
// returns 4.0Laplace.prototype.mode
Returns the mode.
var laplace = new Laplace( 4.0, 12.0 );
var mode = laplace.mode;
// returns 4.0Laplace.prototype.skewness
Returns the skewness.
var laplace = new Laplace( 4.0, 12.0 );
var skewness = laplace.skewness;
// returns 0.0Laplace.prototype.stdev
Returns the standard deviation.
var laplace = new Laplace( 4.0, 12.0 );
var s = laplace.stdev;
// returns ~16.971Laplace.prototype.variance
Returns the variance.
var laplace = new Laplace( 4.0, 12.0 );
var s2 = laplace.variance;
// returns 288.0Methods
Laplace.prototype.cdf( x )
Evaluates the cumulative distribution function (CDF).
var laplace = new Laplace( 2.0, 4.0 );
var y = laplace.cdf( 0.5 );
// returns ~0.344Laplace.prototype.logcdf( x )
Evaluates the natural logarithm of the cumulative distribution function (CDF).
var laplace = new Laplace( 2.0, 4.0 );
var y = laplace.logcdf( 2.0 );
// returns ~-0.693Laplace.prototype.logpdf( x )
Evaluates the natural logarithm of the probability density function (PDF).
var laplace = new Laplace( 2.0, 4.0 );
var y = laplace.logpdf( 0.8 );
// returns ~-2.379Laplace.prototype.mgf( t )
Evaluates the moment-generating function (MGF).
var laplace = new Laplace( 2.0, 4.0 );
var y = laplace.mgf( 0.2 );
// returns ~4.144Laplace.prototype.pdf( x )
Evaluates the probability density function (PDF).
var laplace = new Laplace( 2.0, 4.0 );
var y = laplace.pdf( 2.0 );
// returns 0.125Laplace.prototype.quantile( p )
Evaluates the quantile function at probability p.
var laplace = new Laplace( 2.0, 4.0 );
var y = laplace.quantile( 0.5 );
// returns 2.0
y = laplace.quantile( 1.9 );
// returns NaNExamples
var Laplace = require( '@stdlib/stats-base-dists-laplace-ctor' );
var laplace = new Laplace( 2.0, 4.0 );
var mean = laplace.mean;
// returns 2.0
var median = laplace.median;
// returns 2.0
var s2 = laplace.variance;
// returns 32.0
var y = laplace.cdf( 0.8 );
// returns ~0.37Notice
This package is part of 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, see the main project repository.
Community
License
See LICENSE.
Copyright
Copyright © 2016-2026. The Stdlib Authors.
