Documentation Center

  • Trial Software
  • Product Updates

Contents

prob.LognormalDistribution class

Package: prob
Superclasses: prob.ToolboxFittableParametricDistribution

Lognormal probability distribution object

Description

prob.LognormalDistribution is an object consisting of parameters, a model description, and sample data for a lognormal probability distribution.

Create a probability distribution object with specified parameter values using makedist. Alternatively, fit a distribution to data using fitdist or the Distribution Fitting app.

Construction

pd = makedist('Lognormal') creates a lognormal probability distribution object using the default parameter values.

pd = makedist('Lognormal','mu',mu,'sigma',sigma) creates a lognormal probability distribution object using the specified parameter values.

Input Arguments

expand all

mu — Log mean0 (default) | scalar value

Log mean for the lognormal distribution, specified as a scalar value. mu is the mean of the log of x, when x has a lognormal distribution.

Data Types: single | double

sigma — Log standard deviation1 (default) | nonnegative scalar value

Log standard deviation for the lognormal distribution, specified as a nonnegative scalar value. sigma is the standard deviation of the log of x, when x has a lognormal distribution.

Data Types: single | double

Properties

expand all

mu — Log meanscalar value

Log mean for the lognormal distribution, stored as a scalar value.

Data Types: single | double

sigma — Log standard deviationnonnegative scalar value

Log standard deviation for the lognormal distribution, stored as a nonnegative scalar value.

Data Types: single | double

DistributionName — Probability distribution nameprobability distribution name string

Probability distribution name, stored as a valid probability distribution name string. This property is read-only.

Data Types: char

InputData — Data used for distribution fittingstructure

Data used for distribution fitting, stored as a structure containing the following:

  • data: Data vector used for distribution fitting.

  • cens: Censoring vector, or empty if none.

  • freq: Frequency vector, or empty if none.

This property is read-only.

Data Types: struct

IsTruncated — Logical flag for truncated distribution0 | 1

Logical flag for truncated distribution, stored as a logical value. If IsTruncated equals 0, the distribution is not truncated. If IsTruncated equals 1, the distribution is truncated. This property is read-only.

Data Types: logical

NumParameters — Number of parameterspositive integer value

Number of parameters for the probability distribution, stored as a positive integer value. This property is read-only.

Data Types: single | double

ParameterCovariance — Covariance matrix of the parameter estimatesmatrix of scalar values

Covariance matrix of the parameter estimates, stored as a p-by-p matrix, where p is the number of parameters in the distribution. The (i,j) element is the covariance between the estimates of the ith parameter and the jth parameter. The (i,i) element is the estimated variance of the ith parameter. If parameter i is fixed rather than estimated by fitting the distribution to data, then the (i,i) elements of the covariance matrix are 0. This property is read-only.

Data Types: single | double

ParameterDescription — Distribution parameter descriptionscell array of strings

Distribution parameter descriptions, stored as a cell array of strings. Each cell contains a short description of one distribution parameter. This property is read-only.

Data Types: char

ParameterIsFixed — Logical flag for fixed parametersarray of logical values

Logical flag for fixed parameters, stored as an array of logical values. If 0, the corresponding parameter in the ParameterNames array is not fixed. If 1, the corresponding parameter in the ParameterNames array is fixed. This property is read-only.

Data Types: logical

ParameterNames — Distribution parameter namescell array of strings

Distribution parameter names, stored as a cell array of strings. This property is read-only.

Data Types: char

ParameterValues — Distribution parameter valuesvector of scalar values

Distribution parameter values, stored as a vector. This property is read-only.

Data Types: single | double

Truncation — Truncation intervalvector of scalar values

Truncation interval for the probability distribution, stored as a vector containing the lower and upper truncation boundaries. This property is read-only.

Data Types: single | double

Methods

Inherited Methods

cdf Cumulative distribution function of probability distribution object
icdfInverse cumulative distribution function of probability distribution object
iqrInterquartile range of probability distribution object
median Median of probability distribution object
pdfProbability density function of probability distribution object
randomGenerate random numbers from probability distribution object
truncateTruncate probability distribution object
meanMean of probability distribution object
negloglikNegative loglikelihood of probability distribution object
paramciConfidence intervals for probability distribution parameters
proflikProfile likelihood function for probability distribution object
std Standard deviation of probability distribution object
varVariance of probability distribution object

Definitions

Lognormal Distribution

The lognormal distribution is closely related to the normal distribution. If x is distributed lognormally with parameters μ and σ, then log(x) is distributed normally with mean μ and standard deviation σ. The lognormal distribution is applicable when the quantity of interest must be positive, since log(x) exists only when x is positive.

The lognormal distribution uses the following parameters.

ParameterDescriptionSupport
muLog mean
sigmaLog standard deviation

The probability density function (pdf) of the lognormal distribution is

Examples

expand all

Create a Lognormal Distribution Object Using Default Parameters

Create a lognormal distribution object using the default parameter values.

pd = makedist('Lognormal')
pd = 

  LognormalDistribution

  Lognormal distribution
       mu = 0
    sigma = 1

Create a Lognormal Distribution Object Using Specified Parameters

Create a lognormal distribution object by specifying the parameter values.

pd = makedist('Lognormal','mu',5,'sigma',2)
pd = 

  LognormalDistribution

  Lognormal distribution
       mu = 5
    sigma = 2

Compute the mean of the lognormal distribution.

mean(pd)
ans =

   1.0966e+03

The mean of the lognormal distribution is not equal to the mu parameter.

Generate random numbers from the lognormal distribution and compute their log values.

rng(47);  % for reproducibility
x = random(pd,10000,1);
logx = log(x);

Compute the mean of the log values.

m = mean(logx)
m =

    4.9999

The mean of the log of x is equal to the mu parameter of x, since x has a lognormal distribution.

Plot logx.

hist(logx,50)

The plot shows that the log values of x are normally distributed with a mean equal to 5 and a standard deviation equal to 2.

See Also

| |

More About

Was this topic helpful?