Module org.bzdev.math

Package org.bzdev.math.rv

Class DetermBooleanRV

java.lang.Object

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

org.bzdev.math.rv.BooleanRandomVariable

org.bzdev.math.rv.DetermBooleanRV

All Implemented Interfaces:

Cloneable, RandomVariableOps<Boolean>

public class DetermBooleanRV
extends BooleanRandomVariable

Random variable that generates a deterministic sequence of boolean values.

Constructor Summary

Constructors

Constructor	Description
DetermBooleanRV(boolean[] values)	/** Constructor for a repeating sequence.
DetermBooleanRV(boolean[] values, boolean finalValue)	Constructor given initial values and a final value.
DetermBooleanRV(boolean value, boolean finalValue)	Constructor given a starting value and a final value.

Method Summary

Modifier and Type	Method	Description
protected int	getCharacteristics()	Spliterator characteristics.
boolean	getFinalValue()	Get the final value
boolean[]	getValues()	Get the values.
boolean	isRepeating()	Determine if the sequence is a repeating one.
Boolean	next()	Get the next value for a random variable.
String	toString()

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

parallelStream, parallelStream, stream, stream, tightenMaximumS, tightenMinimumS

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

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

Methods inherited from class java.lang.Object

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

Constructor Details

DetermBooleanRV

public DetermBooleanRV(boolean[] values)

/** Constructor for a repeating sequence.

Parameters:

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

DetermBooleanRV

public DetermBooleanRV(boolean value,
 boolean 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

DetermBooleanRV

public DetermBooleanRV(boolean[] values,
 boolean finalValue)

Constructor given initial values and a final value.

Parameters:

values - the initial sequence of values for the random variable

finalValue - the subsequent value of the random variable after the initial sequence is used

Method Details

getValues

public boolean[] getValues()

Get the values.

Returns:

an array of the values, excluding the final value

getFinalValue

public boolean 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.

next

public Boolean 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<Boolean>

Specified by:

next in class RandomVariable<Boolean>

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<Boolean>

Returns:

the characteristics