LognormalDistribution

Lognormal probability distribution object

Description

A LognormalDistribution object consists of parameters, a model description, and sample data for a lognormal probability distribution.

The lognormal distribution, sometimes called the Galton distribution, is a probability distribution whose logarithm has a normal distribution. The lognormal distribution is applicable when the quantity of interest must be positive, because log(x) exists only when x is positive.

The lognormal distribution uses the following parameters.

Parameter	Description	Support
mu (μ)	Mean of logarithmic values	$$-\infty <\mu <\infty$$
sigma (σ)	Standard deviation of logarithmic values	$$\sigma \ge 0$$

Creation

There are several ways to create a LognormalDistribution probability distribution object.

• Create a distribution with specified parameter values using makedist.

• Fit a distribution to data using fitdist.

• Interactively fit a distribution to data using the Distribution Fitter app.

Properties

Distribution Parameters

mu — Mean of logarithmic values

scalar value

Mean of logarithmic values for the lognormal distribution, specified as a scalar value.

Data Types: single | double

sigma — Standard deviation of logarithmic values

nonnegative scalar value

Standard deviation of logarithmic values for the lognormal distribution, specified as a nonnegative scalar value.

You can specify sigma to be zero when you create an object by using makedist. Some object functions support an object pd with zero standard deviation. For example, random(pd) always returns exp(mu).

Data Types: single | double

Distribution Characteristics

IsTruncated — Logical flag for truncated distribution

Read-only: 0 | 1

This property is read-only.

Logical flag for truncated distribution, specified as a logical value. If IsTruncated equals 0, the distribution is not truncated. If IsTruncated equals 1, the distribution is truncated.

Data Types: logical

NumParameters — Number of parameters

Read-only: positive integer value

This property is read-only.

Number of parameters for the probability distribution, specified as a positive integer value.

Data Types: double

ParameterCovariance — Covariance matrix of the parameter estimates

Read-only: matrix of scalar values

This property is read-only.

Covariance matrix of the parameter estimates, specified 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.

Data Types: double

ParameterIsFixed — Logical flag for fixed parameters

Read-only: array of logical values

This property is read-only.

Logical flag for fixed parameters, specified 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.

Data Types: logical

ParameterValues — Distribution parameter values

Read-only: vector of scalar values

This property is read-only.

Distribution parameter values, specified as a vector of scalar values.

Data Types: single | double

Truncation — Truncation interval

Read-only: vector of scalar values

This property is read-only.

Truncation interval for the probability distribution, specified as a vector of scalar values containing the lower and upper truncation boundaries.

Data Types: single | double

Other Object Properties

DistributionName — Probability distribution name

Read-only: character vector

This property is read-only.

Probability distribution name, specified as a character vector.

Data Types: char

InputData — Data used for distribution fitting

Read-only: structure

This property is read-only.

Data used for distribution fitting, specified 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.

Data Types: struct

ParameterDescription — Distribution parameter descriptions

Read-only: cell array of character vectors

This property is read-only.

Distribution parameter descriptions, specified as a cell array of character vectors. Each cell contains a short description of one distribution parameter.

Data Types: char

ParameterNames — Distribution parameter names

Read-only: cell array of character vectors

This property is read-only.

Distribution parameter names, specified as a cell array of character vectors.

Data Types: char

Object Functions

cdf	Cumulative distribution function
gather	Gather properties of Statistics and Machine Learning Toolbox object from GPU
icdf	Inverse cumulative distribution function
iqr	Interquartile range of probability distribution
mean	Mean of probability distribution
median	Median of probability distribution
negloglik	Negative loglikelihood of probability distribution
paramci	Confidence intervals for probability distribution parameters
pdf	Probability density function
plot	Plot probability distribution object
proflik	Profile likelihood function for probability distribution
random	Random numbers
std	Standard deviation of probability distribution
truncate	Truncate probability distribution object
var	Variance of probability distribution

Examples

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 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

Extended Capabilities

C/C++ Code Generation

Generate C and C++ code using MATLAB® Coder™.

Usage notes and limitations:

• You must create a probability distribution object by fitting a probability distribution to sample data from the fitdist function. For the usage notes and limitations of fitdist, see Code Generation of fitdist.

• These object functions support code generation: cdf, icdf, iqr, mean, median, pdf, std, truncate, and var.

For more information on code generation, see Introduction to Code Generation and Code Generation for Probability Distribution Objects.

GPU Arrays

Accelerate code by running on a graphics processing unit (GPU) using Parallel Computing Toolbox™.

Usage notes and limitations:

• LognormalDistribution can be a probability distribution object fitted by using fitdist with GPU array input arguments.

• The object functions of LognormalDistribution fully support GPU arrays.

For more information, see Run MATLAB Functions on a GPU (Parallel Computing Toolbox).

Version History

Introduced in R2013a