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

ParameterDescriptionSupport
`R`Number of successes$R>0$
`P`Probability of success$0

## Creation

There are several ways to create a `NegativeBinomialDistribution` probability distribution object.

## Properties

expand all

### Distribution Parameters

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

Data Types: `single` | `double`

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

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`

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

Data Types: `double`

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 `i`th parameter and the `j`th parameter. The (`i`,`i`) element is the estimated variance of the `i`th 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`

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`

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

Data Types: `single` | `double`

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

Probability distribution name, specified as a character vector.

Data Types: `char`

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`

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

Data Types: `char`

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

collapse all

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