@stdlib/stats-base-dists-negative-binomial-ctor/docs/types/index.d.ts

Negative binomial distribution constructor.

/*
* @license Apache-2.0
*
* Copyright (c) 2021 The Stdlib Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*    http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

// TypeScript Version: 4.1

/**
* Negative Binomial Distribution.
*/
declare class NegativeBinomial {
	/**
	* Negative binomial distribution constructor.
	*
	* @param r - number of successes until experiment is stopped (default: 1.0)
	* @param p - success probability (default: 0.5)
	* @throws `r` must be a positive number
	* @throws `p` must be a number between 0 and 1
	* @returns distribution instance
	*
	* @example
	* var nbinomial = new NegativeBinomial( 5.0, 0.1 );
	*
	* var y = nbinomial.cdf( 10.0 );
	* // returns ~0.013
	*
	* var v = nbinomial.mode;
	* // returns 36.0
	*/
	constructor( r: number, p: number );

	/**
	* Binomial distribution constructor.
	*
	* @returns distribution instance
	*
	* @example
	* var binomial = new Binomial();
	*
	* var y = binomial.cdf( 0.8 );
	* // returns ~0.9
	*
	* var v = binomial.mode;
	* // returns 0.0
	*/
	constructor();

	/**
	* Number of successes until experiment is stopped. If set, the value must be a positive number.
	*/
	r: number;

	/**
	* Success probability. If set, the value must be a number between 0 and 1.
	*/
	p: number;

	/**
	* Read-only property which returns the excess kurtosis.
	*/
	readonly kurtosis: number;

	/**
	* Read-only property which returns the expected value.
	*/
	readonly mean: number;

	/**
	* Read-only property which returns the median.
	*/
	readonly median: number;

	/**
	* Read-only property which returns the mode.
	*/
	readonly mode: number;

	/**
	* Read-only property which returns the skewness.
	*/
	readonly skewness: number;

	/**
	* Read-only property which returns the standard deviation.
	*/
	readonly stdev: number;

	/**
	* Read-only property which returns the variance.
	*/
	readonly variance: number;

	/**
	* Evaluates the cumulative distribution function (CDF).
	*
	* @param x - input value
	* @returns evaluated CDF
	*/
	cdf( x: number ): number;

	/**
	* Evaluates the natural logarithm of the probability mass function (PMF).
	*
	* @param x - input value
	* @returns evaluated logPMF
	*/
	logpmf( x: number ): number;

	/**
	* Evaluates the moment-generating function (MGF).
	*
	* @param x - input value
	* @returns evaluated MGF
	*/
	mgf( t: number ): number;

	/**
	* Evaluates the probability mass function (PMF).
	*
	* @param x - input value
	* @returns evaluated PMF
	*/
	pmf( x: number ): number;

	/**
	* Evaluates the quantile function at probability `p`.
	*
	* @param p - input probability
	* @returns evaluated quantile function
	*/
	quantile( p: number ): number;
}


// EXPORTS //

export = NegativeBinomial;