NegativeBinomialDistribution

Negative binomial distribution object

Description

A NegativeBinomialDistribution object consists of parameters, a model description, and sample data for a negative binomial probability distribution.

The negative binomial distribution models the number of failures x before a specified number of successes, R, is reached in a series of independent, identical trials. This distribution can also model count data, in which case R does not need to be an integer value.

The negative binomial distribution uses the following parameters.

Parameter	Description	Support
R	Number of successes	$$R>0$$
P	Probability of success	$$0<P\le 1$$

Creation

There are several ways to create a NegativeBinomialDistribution 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

R — Number of successes

positive scalar value

Number of successes for the negative binomial distribution, specified as a positive scalar value.

Data Types: single | double

P — Probability of success

positive scalar value in the range (0,1]

Probability of success of any individual trial for the negative binomial distribution, specified as a positive scalar value in the range (0,1].

Data Types: single | double

Distribution Characteristics

IsTruncated — Logical flag for truncated distribution

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

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

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

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

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

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

character vector

This property is read-only.

Probability distribution name, specified as a character vector.

Data Types: char

InputData — Data used for distribution fitting

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

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

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 Negative Binomial Distribution Object Using Default Parameters

Create a negative binomial distribution object using the default parameter values.

pd = makedist('NegativeBinomial')

pd = 
  NegativeBinomialDistribution

  Negative Binomial distribution
    R =   1
    P = 0.5

Create Negative Binomial Distribution Object Using Specified Parameters

Create a negative binomial distribution object by specifying the parameter values.

pd = makedist('NegativeBinomial','R',5,'P',.1)

pd = 
  NegativeBinomialDistribution

  Negative Binomial distribution
    R =   5
    P = 0.1

Compute the mean of the distribution.

m = mean(pd)

m = 
45

Extended Capabilities

GPU Arrays

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

Usage notes and limitations:

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

• The object functions of NegativeBinomialDistribution fully support GPU arrays.

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

Version History

Introduced in R2013a