CUniformDistribution





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

If the probability density function of a random variable X is given by pf=[1/(b-a), x greater than or equal to a and x less than or equal to b ] 0 otherwise and the parameters a and b can take any number, however, with b has to be greater than a, then the random variable X is defined to be uniformally distributed over the interval [a, b]. The mean of a Continuous Uniform distribution is (a+b)/2, the variance is pow((b-a), 2)/12. The uniform distribution gets its name from the fact that its density is uniform over the interval [a, b]. It provides a useful model for a few random phenomena.

For instance, if it is known that the values of some random variable X can only be in a finite interval, say [a, b], and if one assumes that any two subintervals of [a, b] of equal length have the same probability of containing X, then X has a uniform distribution over the interval [a, b]. 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 PGCUniformDistribution(). A process generator object allows you to generate large amounts of random numbers based on this distribution.

Even though PGCUniformDistribution() is the process generator object, the function RandomCUniform() 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 : "CUniform"



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




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

    lower end of the distribution.
  4. maxval parameter

    upper end of the distribution.


Extended information

Function Syntax

VB Syntax


String CTStatDistributions.CUniformDistribution( _
String Key, _
Long Reload, _
Double minval, _
Double maxval)


Excel Spreadsheet Syntax


=CT.STAT.CUniformDistribution(
Excel String Cell Key,
Excel Numeric Cell Reload,
Excel Numeric Cell minval,
Excel Numeric Cell maxval)


C++ Syntax


static std::string CUniformDistribution(
std::string Key,
long Reload,
double minval,
double maxval);


DotNET Syntax


System.String CTStatDistributionsSA.CUniformDistribution(
System.String Key,
System.Int32 Reload,
System.Double minval,
System.Double maxval);

Parameter data types

ArgNameArgTypeIsKey
KeyStringFALSE
ReloadLongFALSE
minvalDoubleFALSE
maxvalDoubleFALSE


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
KeyFALSEMyCUniformDistribution
ReloadFALSE1
minvalFALSE0.0
maxvalFALSE1.0


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


MyCUniformDistribution_7.CUniform.0

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