Module org.bzdev.math

Package org.bzdev.math.rv

Class IntegerRandomVariableRV<IRV extends IntegerRandomVariable>

java.lang.Object

org.bzdev.math.rv.RandomVariable<RV>

org.bzdev.math.rv.RandomVariableRV<T,RV>

org.bzdev.math.rv.RandomVariableRVN<Integer,IRV>

org.bzdev.math.rv.IntegerRandomVariableRV<IRV>

All Implemented Interfaces:

Cloneable, RandomVariableOps<IRV>, RandomVariableRVNOps<Integer,IRV>, RandomVariableRVOps<Integer,IRV>

Direct Known Subclasses:

BinomialIntegerRVRV, FixedIntegerRVRV, PoissonIntegerRVRV, UniformIntegerRVRV

public abstract class IntegerRandomVariableRV<IRV extends IntegerRandomVariable>
extends RandomVariableRVN<Integer,IRV>

Random variable that generates the a sequence of random variables, each of which generates a sequence of integers (of type Integer). The type parameter IRV is set to the type of random variable that is to be generated, which will usually be a subclass of IntegerRandomVariable.

Constructor Summary

Constructors

Constructor	Description
IntegerRandomVariableRV()

Method Summary

Modifier and Type	Method	Description
protected int	cmp(Integer x, Integer y)	Compare two numbers of type T.
IRV	next()	Get the next value for a random variable.
void	setMaximum(Integer min, boolean closed)	Set the maximum value for a random variable.
void	setMinimum(Integer min, boolean closed)	Set the minimum value for a random variable.
void	tightenMaximum(Integer x, boolean b)	Set the maximum value for a random variable, provided the new value is lower than the previous value.
void	tightenMaximumS(String s, boolean b)	Tighten the maximum value for a random variable given a string.
void	tightenMinimum(Integer x, boolean b)	Set the manimum value for a random variable, provided the new value is higher than the previous value.
void	tightenMinimumS(String s, boolean b)	Tighten the minimum value for a random variable given a string.

Methods inherited from class org.bzdev.math.rv.RandomVariableRVN

doNext, getMaximumClosed, getMaximumRV, getMinimumClosed, getMinimumRV

Methods inherited from class org.bzdev.math.rv.RandomVariableRV

determineIfOrdered, getCharacteristics, parallelStream, parallelStream, stream, stream

Methods inherited from class org.bzdev.math.rv.RandomVariable

clone, getMaximum, getMinimum, setMaximum, setMinimum, setRequiredMaximum, setRequiredMinimum, spliterator, spliterator, tightenMaximum, tightenMinimum

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.bzdev.math.rv.RandomVariableOps

getMaximum, getMinimum, setMaximum, setMinimum, tightenMaximum, tightenMinimum

Constructor Details

IntegerRandomVariableRV

public IntegerRandomVariableRV()

Method Details

cmp

protected int cmp(Integer x,
 Integer y)

Description copied from class: RandomVariableRVN

Compare two numbers of type T.

Specified by:

cmp in class RandomVariableRVN<Integer,IRV extends IntegerRandomVariable>

Parameters:

x - the first number

y - the second number

Returns:

a negative value if v1 $lt; v2, 0 if v1 == v2, and a positive value if v1 > v2

tightenMinimumS

public void tightenMinimumS(String s,
 boolean b)
                     throws IllegalArgumentException

Description copied from class: RandomVariable

Tighten the minimum value for a random variable given a string. If there is no minimum value, it will be set. Otherwise the minimum of the allowed range will not decrease. The string argument is a number in a format acceptable to the constructors for Integer, Long, or Double as appropriate.

Specified by:

tightenMinimumS in interface RandomVariableOps<IRV extends IntegerRandomVariable>

Specified by:

tightenMinimumS in class RandomVariable<IRV extends IntegerRandomVariable>

Parameters:

s - minimum value.

b - true if the minimum value is part of the range; false if it is a lower bound on the range

Throws:

IllegalArgumentException - an argument is out of range

tightenMaximumS

public void tightenMaximumS(String s,
 boolean b)
                     throws IllegalArgumentException

Description copied from class: RandomVariable

Tighten the maximum value for a random variable given a string. If there is no maximum value, it will be set. Otherwise the maximum of the allowed range will not increase. The string argument is a number in a format acceptable to the constructors for Integer, Long, or Double as appropriate.

Specified by:

tightenMaximumS in interface RandomVariableOps<IRV extends IntegerRandomVariable>

Specified by:

tightenMaximumS in class RandomVariable<IRV extends IntegerRandomVariable>

Parameters:

s - maximum value.

b - true if the minimum value is part of the range; false if it is a lower bound on the range

Throws:

IllegalArgumentException - an argument is out of range

tightenMinimum

public void tightenMinimum(Integer x,
 boolean b)

Description copied from interface: RandomVariableRVNOps

Set the manimum value for a random variable, provided the new value is higher than the previous value.

Specified by:

tightenMinimum in interface RandomVariableRVNOps<Integer,IRV extends IntegerRandomVariable>

Overrides:

tightenMinimum in class RandomVariableRVN<Integer,IRV extends IntegerRandomVariable>

Parameters:

x - minimum value.

b - true if the minimum value is part of the range; false if it is a lower bound on the range

tightenMaximum

public void tightenMaximum(Integer x,
 boolean b)

Description copied from interface: RandomVariableRVNOps

Set the maximum value for a random variable, provided the new value is lower than the previous value.

Specified by:

tightenMaximum in interface RandomVariableRVNOps<Integer,IRV extends IntegerRandomVariable>

Overrides:

tightenMaximum in class RandomVariableRVN<Integer,IRV extends IntegerRandomVariable>

Parameters:

x - maximum value.

b - true if the minimum value is part of the range; false if it is a lower bound on the range

setMinimum

public void setMinimum(Integer min,
 boolean closed)

Description copied from class: RandomVariableRVN

Set the minimum value for a random variable. The minimum value will be set for the random variable returned by a call to next()

Specified by:

setMinimum in interface RandomVariableRVNOps<Integer,IRV extends IntegerRandomVariable>

Overrides:

setMinimum in class RandomVariableRVN<Integer,IRV extends IntegerRandomVariable>

Parameters:

min - minimum value.

closed - true if the minimum value is part of the range; false if it is a lower bound on the range

setMaximum

public void setMaximum(Integer min,
 boolean closed)

Description copied from class: RandomVariableRVN

Set the maximum value for a random variable. The maximum value will be set for the random variable returned by a call to next()

Specified by:

setMaximum in interface RandomVariableRVNOps<Integer,IRV extends IntegerRandomVariable>

Overrides:

setMaximum in class RandomVariableRVN<Integer,IRV extends IntegerRandomVariable>

Parameters:

min - maximum value.

closed - true if the minimum value is part of the range; false if it is a lower bound on the range

next

public IRV next()

Description copied from class: RandomVariableRVN

Get the next value for a random variable. The next value is actually computed by calling RandomVariableRVN.doNext(), which subclasses must implement and which should either create a new random variable or clone an existing one. Direct subclasses will in general have to include the method definition "public RV next() {return super.next();}" with RV replaced with the type or type parameter appearing in the RV slot above in order to prevent issues with type-erasures. This is handled by the classes IntegerRandomVariableRV, LongRandomVariableRV, and DoubleRandomVariableRV

Specified by:

next in interface RandomVariableOps<IRV extends IntegerRandomVariable>

Specified by:

next in interface RandomVariableRVNOps<Integer,IRV extends IntegerRandomVariable>

Overrides:

next in class RandomVariableRVN<Integer,IRV extends IntegerRandomVariable>

Returns:

the next random variable