HypergDistribution





http://www.QuantTools.com
CapeTools Statistical Distributions function list

Welcome | Documentation format | QuantTools Groups | QuantTools Categories | Licence

Key TAGs | Excel Index | API Index



Creates a Hypergeometric distribution object (Discrete Distribution).

A random variable X is defined to have a Hypergeometric distribution if the discrete density function of X is given by pf= [(Combination(K, x)*Combination(M-K, n-x))/Combination(M, n) , for x=1,2,...,N] or 0 otherwise.

M is a positive integer, K is a nonnegative integer that is at most M, and n is a positive integer that is at most M. The mean of a Hypergeometric distribution is n*(K/M) and the variance n*(K/M)*((M-K)/M)*((M-n)/(M-1)).

Let X denote the number of defectives in a sample of size n, when sampling is done without replacement from an urn containing M balls, K of which are defective.

Then X has a Hypergeometric distribution.

The string 'Key' resulting from a successful construction of this distribution object can be passed to the following functions in order to query (mean, std deviation and variance) or execute functions (probability function, cumulative density function etc...) based on this distribution object : DDistributionMean(), DDistributionVar(), DDistributionSTD(), DDistributionPF() or DDistributionCDF(). In addition, the string 'Key' resulting from a successful construction of this distribution object will also allow you to construct a process generator object via a call to PGHypergDistribution(). A process generator object allows you to generate large amounts of random numbers based on this distribution.

Even though PGHypergDistribution() is the process generator object, the function RandomHyperg() is the actual function that obtains the random numbers given a count parameter and the process generator string 'key'.



This function creates an object and returns a string-key value to represent this created object.
The TAG value of the string-key returned (second part of the key) is : "Hyperg"



Note: Within Excel, the function is named - CT.STAT.HypergDistribution




High level graphic of HypergDistribution() function with parameters. Blue square node is the actual function with the parameters ordered.



Parameter Description


  1. Key parameter

    Key value to use as a handle for the created object
  2. Reload parameter

    When creating this object for the first time, set this parameter to a positive value. Within Excel, when re-computing a worksheet where you do not wish to recreate the object, set this parameter to zero (0).
  3. ndef parameter

    number of defectives in the lot.
  4. nSize parameter

    sample size.
  5. nLotSize parameter

    lot size.


Extended information

Function Syntax

VB Syntax


String CTStatDistributions.HypergDistribution( _
String Key, _
Long Reload, _
Long ndef, _
Long nSize, _
Long nLotSize)


Excel Spreadsheet Syntax


=CT.STAT.HypergDistribution(
Excel String Cell Key,
Excel Numeric Cell Reload,
Excel Numeric Cell ndef,
Excel Numeric Cell nSize,
Excel Numeric Cell nLotSize)


C++ Syntax


static std::string HypergDistribution(
std::string Key,
long Reload,
long ndef,
long nSize,
long nLotSize);


DotNET Syntax


System.String CTStatDistributionsSA.HypergDistribution(
System.String Key,
System.Int32 Reload,
System.Int32 ndef,
System.Int32 nSize,
System.Int32 nLotSize);

Parameter data types

ArgNameArgTypeIsKey
KeyStringFALSE
ReloadLongFALSE
ndefLongFALSE
nSizeLongFALSE
nLotSizeLongFALSE


Example Inputs

The first column represents the name of the parameters. The second column specifies whether the parameters are optional or not. Finally the last column provides some sample input data.
Function call input string-keys are always in the format : "NAME.EXTTAG.TICKER" The "EXTTAG.TICKER" part is determined from the output of other, capetools, object creation functions.


ArgNameIsOptional (Excel only)Example
KeyFALSEMyHypergDistribution
ReloadFALSE1
ndefFALSE1
nSizeFALSE2
nLotSizeFALSE3


Example function usage


The C# example below contains all the sub-function calls leading up to this function call. As a result, the example can contain a lot of code.

The VB.NET, J#, C++.NET, Java, Excel VBA, Visual Basic 6 (via COM) and C++ examples below contain function code stubs for the calls leading up to this function call. However, the function call for this function is displayed.
You can easily reproduce the stub functions code from the C# example.


If you are accessing this functrion via the MiniXL libraries, this function is present within the CT.QL.Statistics20 MiniXL Excel Addin.

Within our Excel Example Addin Generator, we have used the following QuantTools sub-functions in order to prepare the arguments needed to call the HypergDistribution() function. If you are executing this function via the MiniXL libraries, the module addin name, (in brackets, to the right of the sub-functions listed below), indicates the MiniXL library in which the sub-function is held. You will need to load this library into your Excel session (along with any other libraries that the sub-function call within the addin requires (ie - CT.QT.Utils20 addin in almost all cases) in order for the example to compute successfully.


The following four examples demostrate calling this function within a Microsoft .NET environment

The following four examples demostrate calling this function within a non .NET environment

The following is a sample output from executing the HypergDistribution() function call


MyHypergDistribution_11.Hyperg.0

Copyright (c) 2003-2007 CapeTools - All Rights Reserved.