[#mp_units-negative_binomial_distribution-09]
= xref:mp_units.adoc[mp_units]::negative_binomial_distribution
:relfileprefix: ../
:mrdocs:

== Synopsis

Declared in `<mp‐units/random.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<xref:mp_units/Quantity.adoc[Quantity] Q>
requires std::integral<typename Q::rep>
struct negative_binomial_distribution
    : std::negative_binomial_distribution<Q::rep>
----

== Base Classes

[cols="1,4"]
|===
| Name| Description
| `std::negative_binomial_distribution<Q::rep>`
| A negative_binomial_distribution random number distribution.
|===

== Types

[cols="1,4"]
|===
| Name| Description
| xref:mp_units/negative_binomial_distribution-09/param_type.adoc[`param_type`] 
| Parameter type.
|===


== Type Aliases

[cols="1,4"]
|===
| Name| Description
| xref:mp_units/negative_binomial_distribution-09/result_type.adoc[`result_type`] 
| The type of the range of the distribution.
|===


== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:mp_units/negative_binomial_distribution-09/__generate-0a.adoc[`__generate`] 
| 
| xref:mp_units/negative_binomial_distribution-09/k.adoc[`k`] 
| Return the
| xref:mp_units/negative_binomial_distribution-09/max.adoc[`max`] 
| Returns the least upper bound value of the distribution.
| xref:mp_units/negative_binomial_distribution-09/min.adoc[`min`] 
| Returns the greatest lower bound value of the distribution.
| xref:mp_units/negative_binomial_distribution-09/operator_call-06.adoc[`operator()`] 
| Generating functions.
| xref:mp_units/negative_binomial_distribution-09/p.adoc[`p`] 
| Return the
| xref:mp_units/negative_binomial_distribution-09/param-09.adoc[`param`] 
| `param` overloads
| xref:mp_units/negative_binomial_distribution-09/reset.adoc[`reset`] 
| Resets the distribution state.
|===



[.small]#Created with https://www.mrdocs.com[MrDocs]#