Module org.bzdev.math

Package org.bzdev.math.rv

Class FixedDoubleRV

java.lang.Object

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

org.bzdev.math.rv.DoubleRandomVariable

org.bzdev.math.rv.FixedDoubleRV

All Implemented Interfaces:

Cloneable, RandomVariableOps<Double>

public class FixedDoubleRV
extends DoubleRandomVariable

Random variable that always generates the same double-precision value. Useful when passing a constant to a method that expects a random variable.

Constructor Summary

Constructors

Constructor	Description
FixedDoubleRV(double value)	Constructor.

Method Summary

Modifier and Type	Method	Description
double	getValue()	Get the value of this random variable, which is a constant.
Double	next()	Get the next value for a random variable.
void	setMaximum(Double max, boolean closed)	Set the maximum value for a random variable.
void	setMinimum(Double min, boolean closed)	Set the minimum value for a random variable.
void	tightenMaximum(Double max, boolean closed)	Tighten the maximum value for a random variable.
void	tightenMinimum(Double min, boolean closed)	Tighten the minimum value for a random variable.
String	toString()

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

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

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

clone, getCharacteristics

Methods inherited from class java.lang.Object

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

Constructor Details

FixedDoubleRV

public FixedDoubleRV(double value)

Constructor.

Parameters:

value - the value of the random variable

Method Details

getValue

public double getValue()

Get the value of this random variable, which is a constant.

Returns:

the value

setMinimum

public void setMinimum(Double 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<Double>

Overrides:

setMinimum in class DoubleRandomVariable

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

tightenMinimum

public void tightenMinimum(Double min,
 boolean closed)
                    throws UnsupportedOperationException,
IllegalArgumentException

Description copied from class: RandomVariable

Tighten the minimum value for a random variable. If there is no minimum value, it will be set. Otherwise the minimum of the allowed range will not decrease.

Specified by:

tightenMinimum in interface RandomVariableOps<Double>

Overrides:

tightenMinimum in class DoubleRandomVariable

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(Double 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<Double>

Overrides:

setMaximum in class DoubleRandomVariable

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

tightenMaximum

public void tightenMaximum(Double max,
 boolean closed)
                    throws UnsupportedOperationException,
IllegalArgumentException

Description copied from class: RandomVariable

Tighten the maximum value for a random variable. If there is no maximum value, it will be set. Otherwise the maximum of the allowed range will not increase.

Specified by:

tightenMaximum in interface RandomVariableOps<Double>

Overrides:

tightenMaximum in class DoubleRandomVariable

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

Specified by:

next in class RandomVariable<Double>

Returns:

the next value

toString

public String toString()

Overrides:

toString in class Object