org.drip.sequence.random

Class BoundedUniformInteger

java.lang.Object

org.drip.sequence.random.UnivariateSequenceGenerator

org.drip.sequence.random.BoundedUniformInteger

public class BoundedUniformInteger
extends UnivariateSequenceGenerator

BoundedUniformInteger implements the Bounded Uniform Distribution, with a Uniform Integer being generated between a lower and an upper Bound.

Author:

Lakshmi Krishnamurthy

Constructor Summary

Constructors

Constructor and Description
BoundedUniformInteger(int iStart, int iFinish) BoundedUniformInteger Distribution Constructor

Method Summary

Modifier and Type	Method and Description
int	finish() Retrieve the Finish
double	random() Generate a Random Number according to the specified rule
SingleSequenceAgnosticMetrics	sequence(int iNumEntry, R1 distPopulation) Generate a Random Sequence along with its Metrics
int	start() Retrieve the Start

Methods inherited from class org.drip.sequence.random.UnivariateSequenceGenerator

sequence

Methods inherited from class java.lang.Object

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

Constructor Detail

BoundedUniformInteger

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

BoundedUniformInteger Distribution Constructor

Parameters:

iStart - The Lower Bound

iFinish - The Upper Bound

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

random

public double random()

Description copied from class: UnivariateSequenceGenerator

Generate a Random Number according to the specified rule

Specified by:

random in class UnivariateSequenceGenerator

Returns:

The Random Number

sequence

public SingleSequenceAgnosticMetrics sequence(int iNumEntry,
                                              R1 distPopulation)

Description copied from class: UnivariateSequenceGenerator

Generate a Random Sequence along with its Metrics

Overrides:

sequence in class UnivariateSequenceGenerator

Parameters:

iNumEntry - Number of Entries in the Sequence

distPopulation - The True Underlying Generator Distribution of the Population

Returns:

The Random Sequence (along with its Metrics)