math-php
Public Member Functions | Public Attributes | Protected Attributes | List of all members
MathPHP\Probability\Distribution\Continuous\LogNormal Class Reference
Inheritance diagram for MathPHP\Probability\Distribution\Continuous\LogNormal:
Inheritance graph
[legend]
Collaboration diagram for MathPHP\Probability\Distribution\Continuous\LogNormal:
Collaboration graph
[legend]

Public Member Functions

 __construct (float $μ, float $λ)
 Constructor. More...
 
 pdf (float $x)
 Log normal distribution - probability density function. More...
 
 cdf (float $x)
 Log normal distribution - cumulative distribution function. More...
 
 inverse (float $p)
 Inverse of CDF (quantile) More...
 
 mean ()
 Mean of the distribution. More...
 
 median ()
 Median of the distribution. More...
 
 mode ()
 Mode of the distribution. More...
 
 variance ()
 Variance of the distribution. More...
 
- Public Member Functions inherited from MathPHP\Probability\Distribution\Continuous\Continuous
 inverse (float $target)
 The Inverse CDF of the distribution. More...
 
 between (float $x₁, float $x₂)
 CDF between - probability of being between two points, x₁ and x₂ The area under a continuous distribution, that lies between two specified points. More...
 
 outside (float $x₁, float $x₂)
 CDF outside - Probability of being below x₁ and above x₂. More...
 
 above (float $x)
 CDF above - Probability of being above x to ∞ Area under a continuous distribution, that lies above a specified point. More...
 
 rand ()
 Produce a random number with a particular distribution. More...
 
- Public Member Functions inherited from MathPHP\Probability\Distribution\Distribution
 __construct (... $params)
 Constructor. More...
 

Public Attributes

const PARAMETER_LIMITS
 
const SUPPORT_LIMITS
 
- Public Attributes inherited from MathPHP\Probability\Distribution\Continuous\Continuous
const GUESS_THRESHOLD = 10
 
const GUESS_ALLOWANCE = 8
 

Protected Attributes

 
 
 
 

Constructor & Destructor Documentation

◆ __construct()

MathPHP\Probability\Distribution\Continuous\LogNormal::__construct ( float  ,
float   
)

Constructor.

Parameters
floatlocation parameter
floatscale parameter > 0

Member Function Documentation

◆ cdf()

MathPHP\Probability\Distribution\Continuous\LogNormal::cdf ( float  $x)

Log normal distribution - cumulative distribution function.

https://en.wikipedia.org/wiki/Log-normal_distribution

  1   1      / ln x - μ \

cdf = - + - erf | -----— | 2 2 \ √2σ /

Parameters
float$x> 0
Returns
float

Implements MathPHP\Probability\Distribution\Continuous\ContinuousDistribution.

◆ inverse()

MathPHP\Probability\Distribution\Continuous\LogNormal::inverse ( float  $p)

Inverse of CDF (quantile)

exp(μ + σ * normal-inverse(p))

Parameters
float$p
Returns
float

◆ mean()

MathPHP\Probability\Distribution\Continuous\LogNormal::mean ( )

Mean of the distribution.

μ = exp(μ + σ²/2)

Returns
float

Implements MathPHP\Probability\Distribution\Continuous\ContinuousDistribution.

◆ median()

MathPHP\Probability\Distribution\Continuous\LogNormal::median ( )

Median of the distribution.

median = exp(μ)

Returns
float

◆ mode()

MathPHP\Probability\Distribution\Continuous\LogNormal::mode ( )

Mode of the distribution.

mode = exp(μ - σ²)

Returns
float

◆ pdf()

MathPHP\Probability\Distribution\Continuous\LogNormal::pdf ( float  $x)

Log normal distribution - probability density function.

https://en.wikipedia.org/wiki/Log-normal_distribution

            (ln x - μ)²
    1     - ----------

pdf = --— ℯ 2σ² xσ√2π

Parameters
float$x> 0
Returns
float

Implements MathPHP\Probability\Distribution\Continuous\ContinuousDistribution.

◆ variance()

MathPHP\Probability\Distribution\Continuous\LogNormal::variance ( )

Variance of the distribution.

var[X] = [exp(σ²) - 1][exp(2μ + σ²)]

Returns
float

Member Data Documentation

◆ PARAMETER_LIMITS

const MathPHP\Probability\Distribution\Continuous\LogNormal::PARAMETER_LIMITS
Initial value:
= [
'μ' => '(-∞,∞)'

◆ SUPPORT_LIMITS

const MathPHP\Probability\Distribution\Continuous\LogNormal::SUPPORT_LIMITS
Initial value:
= [
'x' => '(0,∞)'

The documentation for this class was generated from the following file: