Categories &

Functions List

Class Definition: BurrDistribution

statistics: BurrDistribution

Burr probability distribution object.

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

The Burr distribution uses the following parameters.

ParameterDescriptionSupport
alphaShape-Inf < alpha < Inf
cScalec > 0
kLocation-Inf < k < Inf

There are several ways to create a BurrDistribution object.

  • Fit a distribution to data using the fitdist function.
  • Create a distribution with specified parameter values using the makedist function.
  • Use the constructor BurrDistribution (alpha, c) to create a generalized extreme value distribution with specified parameter values.
  • Use the static method BurrDistribution.fit (x, alpha, freq) to a distribution to data x.

It is highly recommended to use fitdist and makedist functions to create probability distribution objects, instead of the constructor and the aforementioned static method.

A BurrDistribution object contains the following properties, which can be accessed using dot notation.

DistributionNameDistributionCodeNumParametersParameterNames
ParameterDescriptionParameterValuesParameterValuesParameterCI
ParameterIsFixedTruncationIsTruncatedInputData

A BurrDistribution object contains the following methods: cdf, icdf, iqr, mean, median, negloglik, paramci, pdf, plot, proflik, random, std, truncate, var.

Further information about the Burr distribution can be found at https://en.wikipedia.org/wiki/Burr_distribution

See also: fitdist, makedist, burrcdf, burrinv, burrpdf, burrrnd, burrfit, burrlike, burrstat

Source Code: BurrDistribution

Method: cdf

BurrDistribution: p = icdf (pd, p)

Compute the inverse cumulative distribution function (iCDF).

p = icdf (pd, x) computes the quantile (the inverse of the CDF) of the probability distribution object, pd, evaluated at the values in x.

Method: icdf

BurrDistribution: p = icdf (pd, p)

Compute the inverse cumulative distribution function (iCDF).

p = icdf (pd, x) computes the quantile (the inverse of the CDF) of the probability distribution object, pd, evaluated at the values in x.

Method: iqr

BurrDistribution: r = iqr (pd)

Compute the interquartile range of a probability distribution.

r = iqr (pd) computes the interquartile range of the probability distribution object, pd.

Method: mean

BurrDistribution: m = mean (pd)

Compute the mean of a probability distribution.

m = mean (pd) computes the mean of the probability distribution object, pd.

Method: median

BurrDistribution: m = median (pd)

Compute the median of a probability distribution.

m = median (pd) computes the median of the probability distribution object, pd.

Method: negloglik

BurrDistribution: nlogL = negloglik (pd)

Compute the negative loglikelihood of a probability distribution.

m = negloglik (pd) computes the negative loglikelihood of the probability distribution object, pd.

Method: paramci

BurrDistribution: ci = paramci (pd)
BurrDistribution: ci = paramci (pd, Name, Value)

Compute the confidence intervals for probability distribution parameters.

ci = paramci (pd) computes the lower and upper boundaries of the 95% confidence interval for each parameter of the probability distribution object, pd.

ci = paramci (pd, Name, Value) computes the confidence intervals with additional options specified specified by Name-Value pair arguments listed below.

NameValue
"Alpha"A scalar value in the range (0,1) specifying the significance level for the confidence interval. The default value 0.05 corresponds to a 95% confidence interval.
"Parameter"A character vector or a cell array of character vectors specifying the parameter names for which to compute confidence intervals. By default, paramci computes confidence intervals for all distribution parameters.

paramci is meaningful only when pd is fitted to data, otherwise an empty array, [], is returned.

Method: pdf

BurrDistribution: y = pdf (pd, x)

Compute the probability distribution function (PDF).

y = pdf (pd, x) computes the PDF of the probability distribution object, pd, evaluated at the values in x.

Method: plot

BurrDistribution: plot (pd)
BurrDistribution: plot (pd, Name, Value)
BurrDistribution: h = plot (…)

Plot a probability distribution object.

plot (pd plots a probability density function (PDF) of the probability distribution object pd. If pd contains data, which have been fitted by fitdist, the PDF is superimposed over a histogram of the data.

plot (pd, Name, Value) specifies additional options with the Name-Value pair arguments listed below.

NameValue
"PlotType"A character vector specifying the plot type. "pdf" plots the probability density function (PDF). When pd is fit to data, the PDF is superimposed on a histogram of the data. "cdf" plots the cumulative density function (CDF). When pd is fit to data, the CDF is superimposed over an empirical CDF. "probability" plots a probability plot using a CDF of the data and a CDF of the fitted probability distribution. This option is available only when pd is fitted to data.
"Discrete"A logical scalar to specify whether to plot the PDF or CDF of a discrete distribution object as a line plot or a stem plot, by specifying false or true, respectively. By default, it is true for discrete distributions and false for continuous distributions. When pd is a continuous distribution object, option is ignored.
"Parent"An axes graphics object for plot. If not specified, the plot function plots into the current axes or creates a new axes object if one does not exist.

h = plot (…) returns a graphics handle to the plotted objects.

Method: proflik

BurrDistribution: [nlogL, param] = proflik (pd, pnum)
BurrDistribution: [nlogL, param] = proflik (pd, pnum, "Display", display)
BurrDistribution: [nlogL, param] = proflik (pd, pnum, setparam)
BurrDistribution: [nlogL, param] = proflik (pd, pnum, setparam, "Display", display)

Profile likelihood function for a probability distribution object.

[nlogL, param] = proflik (pd, pnum) returns a vector nlogL of negative loglikelihood values and a vector param of corresponding parameter values for the parameter in the position indicated by pnum. By default, proflik uses the lower and upper bounds of the 95% confidence interval and computes 100 equispaced values for the selected parameter. pd must be fitted to data.

[nlogL, param] = proflik (pd, pnum, "Display", "on") also plots the profile likelihood against the default range of the selected parameter.

[nlogL, param] = proflik (pd, pnum, setparam) defines a user-defined range of the selected parameter.

[nlogL, param] = proflik (pd, pnum, setparam, "Display", "on") also plots the profile likelihood against the user-defined range of the selected parameter.

For the generalized extreme value distribution, pnum = 1 selects the parameter alpha, pnum = 2 selects the parameter c, and pnum = 3 selects the parameter k.

When opted to display the profile likelihood plot, proflik also plots the baseline loglikelihood computed at the lower bound of the 95% confidence interval and estimated maximum likelihood. The latter might not be observable if it is outside of the used-defined range of parameter values.

Method: random

BurrDistribution: y = random (pd)
BurrDistribution: y = random (pd, rows)
BurrDistribution: y = random (pd, rows, cols, …)
BurrDistribution: y = random (pd, [sz])

Generate random arrays from the probability distribution object.

r = random (pd) returns a random number from the distribution object pd.

When called with a single size argument, betarnd returns a square matrix with the dimension specified. When called with more than one scalar argument, the first two arguments are taken as the number of rows and columns and any further arguments specify additional matrix dimensions. The size may also be specified with a row vector of dimensions, sz.

Method: std

BurrDistribution: s = std (pd)

Compute the standard deviation of a probability distribution.

s = std (pd) computes the standard deviation of the probability distribution object, pd.

Method: truncate

BurrDistribution: t = truncate (pd, lower, upper)

Truncate a probability distribution.

t = truncate (pd) returns a probability distribution t, which is the probability distribution pd truncated to the specified interval with lower limit, lower, and upper limit, upper. If pd is fitted to data with fitdist, the returned probability distribution t is not fitted, does not contain any data or estimated values, and it is as it has been created with the makedist function, but it includes the truncation interval.

Method: var

BurrDistribution: v = var (pd)

Compute the variance of a probability distribution.

v = var (pd) computes the standard deviation of the probability distribution object, pd.

Example: 1

 

 ## Generate a data set of 5000 random samples from a Burr type XII
 ## distribution with parameters alpha = 1, c = 2, and k = 1.  Fit a Burr type
 ## XII distribution to this data and plot a PDF of the fitted distribution
 ## superimposed on a histogram of the data

 pd = makedist ("Burr", "alpha", 1, "c", 2, "k", 1)
 rand ("seed", 21);
 data = random (pd, 5000, 1);
 pd = fitdist (data, "Burr")
 plot (pd)
 msg = strcat (["Fitted Burr type XII distribution with"], ...
                [" alpha = %0.2f, c =  %0.2f, and k = %0.2f"]);
 title (sprintf (msg, pd.alpha, pd.c, pd.k))

pd =
  BurrDistribution

  normal distribution
    alpha = 1
        c = 2
        k = 1

pd =
  BurrDistribution

  normal distribution
    alpha = 0.943213   [0.920634, 0.966345]
        c =  2.01899   [1.9726, 2.06648]
        k = 0.946371   [0.857098, 1.04494]

                    
plotted figure

Example: 2

 

 ## Plot the PDF of a Burr type XII distribution, with parameters alpha = 1,
 ## c = 2, and k = 1, truncated at [0, 2] intervals. Generate 10000 random
 ## samples from this truncated distribution and superimpose a histogram with
 ## 100 bins scaled accordingly

 pd = makedist ("Burr", "alpha", 1, "c", 2, "k", 1)
 t = truncate (pd, 0.5, 2.5)
 rand ("seed", 21);
 data = random (t, 10000, 1);
 plot (t)
 title ("Burr type XII distribution (alpha = 1, c = 2, k = 1) truncated at [0.5, 2.5]")
 hold on
 hist (data, 100, 50)
 hold off

pd =
  BurrDistribution

  normal distribution
    alpha = 1
        c = 2
        k = 1

t =
  BurrDistribution

  normal distribution
    alpha = 1
        c = 2
        k = 1
  Truncated to the interval [0.5, 2.5]

                    
plotted figure

Example: 3

 

 ## Generate a data set of 100 random samples from a Burr type XII
 ## distribution with parameters alpha = 1, c = 2, and k = 1.  Fit a Burr type
 ## XII  distribution to this data and plot its CDF superimposed over an
 ## empirical CDF of the data

 pd = makedist ("Burr", "alpha", 1, "c", 2, "k", 1)
 rand ("seed", 21);
 data = random (pd, 100, 1);
 pd = fitdist (data, "Burr")
 plot (pd, "plottype", "cdf")
 msg = strcat (["Fitted Burr type XII distribution with"], ...
                [" alpha = %0.2f, c =  %0.2f, and k = %0.2f"]);
 title (sprintf (msg, pd.alpha, pd.c, pd.k))
 legend ({"empirical CDF", "fitted CDF"}, "location", "east")

pd =
  BurrDistribution

  normal distribution
    alpha = 1
        c = 2
        k = 1

pd =
  BurrDistribution

  normal distribution
    alpha = 1.18986   [1.01271, 1.39799]
        c = 1.91252   [1.62314, 2.25348]
        k = 1.30385   [0.625566, 2.71757]

                    
plotted figure