FDistribution





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 F distribution object (Continuous Distribution).

The F distribution is the distribution of the ratio of two independent chi-square random variables divided by their respective degrees of freedom.

We suppose that U and V are independently distributed with chi-square distributions with m and n degree of freedom respectively.

The order in which the degrees of freedom are given is important since the density of the F distribution is not symmetrical in m and n. Thus if we let U be a chi-squared random variable with m degrees of freedom and let V be a chi-squared random variable with n degrees of freedom, and let U and V be independent, then the random variable X=(U/m)/(V/n) is distributed as an F distribution with m and n degrees of freedom.

The mean of an F distribution is (n)/(n-2) and the variance of an F distribution is (2*n^2*(m+n-2))/(m*((n-2)^2)*(n-4)).

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 : CDistributionMean(), CDistributionVar(), CDistributionSTD(), CDistributionPDF(), CDistributionCDF(), CDistributionICDF() or CDistHazard(). 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 PGFDistribution(). A process generator object allows you to generate large amounts of random numbers based on this distribution.

Even though PGFDistribution() is the process generator object, the function RandomF() 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 : "FDist"



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




High level graphic of FDistribution() 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. df1 parameter

    degrees of freedom (numerator) (m).
  4. df2 parameter

    degrees of freedom (denominator) (n).


Extended information

Function Syntax

VB Syntax


String CTStatDistributions.FDistribution( _
String Key, _
Long Reload, _
Long df1, _
Long df2)


Excel Spreadsheet Syntax


=CT.STAT.FDistribution(
Excel String Cell Key,
Excel Numeric Cell Reload,
Excel Numeric Cell df1,
Excel Numeric Cell df2)


C++ Syntax


static std::string FDistribution(
std::string Key,
long Reload,
long df1,
long df2);


DotNET Syntax


System.String CTStatDistributionsSA.FDistribution(
System.String Key,
System.Int32 Reload,
System.Int32 df1,
System.Int32 df2);

Parameter data types

ArgNameArgTypeIsKey
KeyStringFALSE
ReloadLongFALSE
df1LongFALSE
df2LongFALSE


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
KeyFALSEMyFDistribution
ReloadFALSE1
df1FALSE4
df2FALSE4


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 FDistribution() 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 FDistribution() function call


MyFDistribution_16.FDist.0

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