Module org.bzdev.math

Package org.bzdev.math.rv

Class DetermIntegerRV

java.lang.Object

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

org.bzdev.math.rv.IntegerRandomVariable

org.bzdev.math.rv.DetermIntegerRV

All Implemented Interfaces:

Cloneable, RandomVariableOps<Integer>

public class DetermIntegerRV
extends IntegerRandomVariable

Random variable that generates a deterministic sequence of integer values.

Constructor Summary

Constructors

Constructor	Description
DetermIntegerRV(int[] values)	Constructor for a repeating sequence.
DetermIntegerRV(int[] values, int finalValue)	Constructor.
DetermIntegerRV(int value, int finalValue)	Constructor given a starting value and a final value.

Method Summary

Modifier and Type	Method	Description
protected int	getCharacteristics()	Spliterator characteristics.
long	getFinalValue()	Get the final value
int[]	getValues()	Get the values.
boolean	isRepeating()	Determine if the sequence is a repeating one.
Integer	next()	Get the next value for a random variable.
void	setMaximum(Integer max, boolean closed)	Set the maximum value for a random variable.
void	setMinimum(Integer min, boolean closed)	Set the minimum value for a random variable.
String	toString()

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

clearRangeTest, getMaximum, getMaximumClosed, getMinimum, getMinimumClosed, parallelStream, parallelStream, rangeTestFailed, rangeTestNeeded, setRequiredMaximum, setRequiredMinimum, spliterator, spliterator, stream, stream, tightenMaximum, tightenMaximumS, tightenMinimum, tightenMinimumS

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

clone

Methods inherited from class java.lang.Object

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

Constructor Details

DetermIntegerRV

public DetermIntegerRV(int[] values,
 int finalValue)

Constructor. When next is called, after the values in the first argument are returned in order, the final value is returned persistently from then on.

Parameters:

values - the values of the random variable in the order in which these are returned

finalValue - the final value of the random variable

DetermIntegerRV

public DetermIntegerRV(int[] values)

Constructor for a repeating sequence.

Parameters:

values - the values of the random variable in the order in which these are returned

DetermIntegerRV

public DetermIntegerRV(int value,
 int finalValue)

Constructor given a starting value and a final value.

Parameters:

value - the starting value of the random variable

finalValue - the subsequent value of the random variable

Method Details

getValues

public int[] getValues()

Get the values.

Returns:

an array of the values, excluding the final value

getFinalValue

public long getFinalValue()

Get the final value

Returns:

the final value; undefined if the sequence repeats forever

isRepeating

public boolean isRepeating()

Determine if the sequence is a repeating one.

Returns:

true if repeating, false otherwise.

setMinimum

public void setMinimum(Integer min,
 boolean closed)
                throws UnsupportedOperationException,
IllegalArgumentException

Description copied from class: RandomVariable

Set the minimum value for a random variable.

Specified by:

setMinimum in interface RandomVariableOps<Integer>

Overrides:

setMinimum in class 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

Throws:

UnsupportedOperationException - the random variable's type does not have an order imposed on it or the operation is not supported for implementation reasons

IllegalArgumentException - an argument is out of range

setMaximum

public void setMaximum(Integer max,
 boolean closed)
                throws UnsupportedOperationException,
IllegalArgumentException

Description copied from class: RandomVariable

Set the maximum value for a random variable.

Specified by:

setMaximum in interface RandomVariableOps<Integer>

Overrides:

setMaximum in class IntegerRandomVariable

Parameters:

max - maximum value.

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

Throws:

UnsupportedOperationException - the random variable's type does not have an order imposed on it or the operation is not supported for implementation reasons

IllegalArgumentException - an argument is out of range

next

public Integer next()

Description copied from class: RandomVariable

Get the next value for a random variable. In general, each value will be independent of the last.

Specified by:

next in interface RandomVariableOps<Integer>

Specified by:

next in class RandomVariable<Integer>

Returns:

the next value

toString

public String toString()

Overrides:

toString in class Object

getCharacteristics

protected int getCharacteristics()

Description copied from class: RandomVariable

Spliterator characteristics. The characteristics returned should not include Spliterator.SIZED or Spliterator.SUBSIZED. The default value is Spliterator.IMMUTABLE | Spliterator.NONNULL. If the characteristics include Spliterator.ORDERED, Spliterator.trySplit() will return null. The characteristics include Spliterator.ORDERED for the random variables in this package that return a deterministic sequence of values.

Overrides:

getCharacteristics in class RandomVariable<Integer>

Returns:

the characteristics