org.drip.measure.discretemarginal

Class BoundedUniformIntegerDistribution

java.lang.Object

org.drip.measure.continuousmarginal.R1

org.drip.measure.discretemarginal.BoundedUniformIntegerDistribution

public class BoundedUniformIntegerDistribution
extends R1

BoundedUniformIntegerDistribution implements the Univariate Bounded Uniform Integer Distribution, with the Integer being generated between a(n inclusive) lower and an upper Bound.

Author:

Lakshmi Krishnamurthy

Constructor Summary

Constructors

Constructor and Description
BoundedUniformIntegerDistribution(int iStart, int iFinish) Construct a Univariate Bounded Uniform Integer Distribution

Method Summary

Modifier and Type	Method and Description
double	cumulative(double dblX) Compute the cumulative under the distribution to the given value
double	density(double dblX) Compute the Density under the Distribution at the given Variate
int	finish() Retrieve the Finish
Array2D	histogram() Retrieve the Univariate Weighted Histogram
double	incremental(double dblXLeft, double dblXRight) Compute the incremental under the distribution between the 2 variates
double	invCumulative(double dblY) Compute the inverse cumulative under the distribution corresponding to the given value
double	mean() Retrieve the Mean of the Distribution
int	start() Retrieve the Start
double	variance() Retrieve the Variance of the Distribution

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BoundedUniformIntegerDistribution

public BoundedUniformIntegerDistribution(int iStart,
                                         int iFinish)
                                  throws java.lang.Exception

Construct a Univariate Bounded Uniform Integer Distribution

Parameters:

iStart - The Starting Integer

iFinish - The Finishing Integer

Throws:

java.lang.Exception - Thrown if the inputs are invalid

Method Detail

start

public int start()

Retrieve the Start

Returns:

The Start

finish

public int finish()

Retrieve the Finish

Returns:

The Finish

cumulative

public double cumulative(double dblX)
                  throws java.lang.Exception

Description copied from class: R1

Compute the cumulative under the distribution to the given value

Specified by:

cumulative in class R1

Parameters:

dblX - Variate to which the cumulative is to be computed

Returns:

The cumulative

Throws:

java.lang.Exception - Thrown if the inputs are invalid

incremental

public double incremental(double dblXLeft,
                          double dblXRight)
                   throws java.lang.Exception

Description copied from class: R1

Compute the incremental under the distribution between the 2 variates

Specified by:

incremental in class R1

Parameters:

dblXLeft - Left Variate to which the cumulative is to be computed

dblXRight - Right Variate to which the cumulative is to be computed

Returns:

The incremental

Throws:

java.lang.Exception - Thrown if the inputs are invalid

invCumulative

public double invCumulative(double dblY)
                     throws java.lang.Exception

Description copied from class: R1

Compute the inverse cumulative under the distribution corresponding to the given value

Specified by:

invCumulative in class R1

Parameters:

dblY - Value corresponding to which the inverse cumulative is to be computed

Returns:

The inverse cumulative

Throws:

java.lang.Exception - Thrown if the input is invalid

density

public double density(double dblX)
               throws java.lang.Exception

Description copied from class: R1

Compute the Density under the Distribution at the given Variate

Specified by:

density in class R1

Parameters:

dblX - Variate at which the Density needs to be computed

Returns:

The Density

Throws:

java.lang.Exception - Thrown if the input is invalid

mean

public double mean()

Description copied from class: R1

Retrieve the Mean of the Distribution

Specified by:

mean in class R1

Returns:

The Mean of the Distribution

variance

public double variance()

Description copied from class: R1

Retrieve the Variance of the Distribution

Specified by:

variance in class R1

Returns:

The Variance of the Distribution

histogram

public Array2D histogram()

Description copied from class: R1

Retrieve the Univariate Weighted Histogram

Specified by:

histogram in class R1

Returns:

The Univariate Weighted Histogram