Module org.bzdev.devqsim
Package org.bzdev.devqsim.rv
Class SimRandomVariableRV<T,RV extends RandomVariable<T>,RVRV extends RandomVariableRV<T,RV>>
java.lang.Object
org.bzdev.devqsim.SimObject
org.bzdev.devqsim.DefaultSimObject
org.bzdev.devqsim.rv.SimRandomVariable<RV,RVRV>
org.bzdev.devqsim.rv.SimRandomVariableRV<T,RV,RVRV>
- All Implemented Interfaces:
RandomVariableOps<RV>
,NamedObjectOps
,NamedRandomVariableOps<RV,
RVRV>
- Direct Known Subclasses:
SimBooleanRVRV
,SimIntegerRVRV
,SimLongRVRV
,SimRandomVariableRVN
public abstract class SimRandomVariableRV<T,RV extends RandomVariable<T>,RVRV extends RandomVariableRV<T,RV>>
extends SimRandomVariable<RV,RVRV>
Base class for named random variables that produce random variables
that in turn produce a sequence of values of type
RandomVariable
. The type parameters are:
- T - the type of the values that a generated random variable generate.
- RV - the type for the random variables generated.
- RVRV - the type of the random variable used to generate a sequence of random variables.
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
SimRandomVariableRV
(Simulation sim, String name, boolean intern) Constructor.protected
SimRandomVariableRV
(Simulation sim, String name, boolean intern, RVRV rvrv) Constructor given a random variable. -
Method Summary
Modifier and TypeMethodDescriptionboolean
Determine if this named object can be deleted.protected Object
clone()
Creates and returns a copy of this object.final boolean
delete()
Delete an object.final boolean
Determine if an object is being deleted.final String
getName()
Get an object's name.protected Simulation
Get the object namer for a named object.final boolean
Determine if an object has been deleted.boolean
Determine if an object is interned in a object namer's tables.Get an infinie parallel stream of random variables.parallelStream
(long size) Get a fixed-length parallel stream of random variables.stream()
Get an infinie stream of random variables.stream
(long size) Get a fixed-length stream of random variables.Methods inherited from class org.bzdev.devqsim.rv.SimRandomVariable
getRandomVariable, setRV, spliterator, spliterator
Methods inherited from class org.bzdev.devqsim.DefaultSimObject
getSimulation, printConfiguration, printState
Methods inherited from class org.bzdev.devqsim.SimObject
addSimulationListener, addTraceSet, bindCallable, bindCallable, bindCallable, bindCallable, bindRunnable, bindRunnable, bindRunnable, bindRunnable, callableObject, callableScript, callScriptFunction, callScriptMethod, clearTraceSets, evalScript, getEventListenerList, getScriptObject, getTraceSets, onDelete, printConfiguration, printConfiguration, printConfiguration, printConfiguration, printConfiguration, printConfiguration, printState, printState, printState, printState, printState, printState, putScriptObject, removeSimulationListener, removeTraceSet, runnableObject, runnableScript, scheduleCall, scheduleCall, scheduleCall, scheduleCall, scheduleCallObject, scheduleScript, scheduleTask, scheduleTask, scheduleTask, scheduleTask, scheduleTaskObject, scheduleTaskScript, startImmediateTask, startImmediateTask, trace, trace, unscheduledTaskThread, unscheduledTaskThread, update, update, usesTraceSet
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.bzdev.obnaming.NamedObjectOps
canDelete, delete, deletePending, getName, isDeleted, isInterned
Methods inherited from interface org.bzdev.obnaming.NamedRandomVariableOps
getMaximum, getMaximumClosed, getMinimum, getMinimumClosed, next, setMaximum, setMinimum, tightenMaximum, tightenMaximumS, tightenMinimum, tightenMinimumS
-
Constructor Details
-
SimRandomVariableRV
Constructor.- Parameters:
sim
- the simulationname
- the name of the object; null for an automatically generated nameintern
- true if the object can be looked up by using the methods inSimulation
; false otherwise.- Throws:
IllegalArgumentException
- typically means a name is already in use- See Also:
-
SimRandomVariableRV
Constructor given a random variable.- Parameters:
sim
- the simulationname
- the name of the object; null for an automatically generated nameintern
- true if the object can be looked up by using the methodsrvrv
- the random variable itself inSimulation
; false otherwise.- Throws:
IllegalArgumentException
- typically means a name is already in use- See Also:
-
-
Method Details
-
stream
Get a fixed-length stream of random variables.- Parameters:
size
- the number of random values to provide- Returns:
- the stream
-
parallelStream
Get a fixed-length parallel stream of random variables.- Parameters:
size
- the number of random values to provide- Returns:
- the stream
-
stream
Get an infinie stream of random variables.- Returns:
- the stream
-
parallelStream
Get an infinie parallel stream of random variables.- Returns:
- the stream
-
clone
Creates and returns a copy of this object. This method will throw the exception CloneNotSupportedException if the object is interned.- Overrides:
clone
in classObject
- Throws:
CloneNotSupportedException
- a clone could not be created- See Also:
-
isInterned
public boolean isInterned()Determine if an object is interned in a object namer's tables.- Specified by:
isInterned
in interfaceNamedObjectOps
- Returns:
- true if the object is interned; false if not
-
getObjectNamer
Get the object namer for a named object.- Returns:
- the object namer for this named object
-
getName
Get an object's name.- Specified by:
getName
in interfaceNamedObjectOps
- Returns:
- the name of the object
-
canDelete
public boolean canDelete()Determine if this named object can be deleted. A named object can be deleted if the method delete has not been called and if the object is not in a state that prevents the object from being deleted. Subclasses that override this method must call canDelete() for their superclasses and return false if the superclass' canDelete method returns false. The default method returns true if delete() has not been called and returned true.- Specified by:
canDelete
in interfaceNamedObjectOps
- Returns:
- true if this object can be deleted; false otherwise
-
delete
public final boolean delete()Delete an object. An object can only be deleted once. If this method returns true, the object (if interned) will have been removed from the object namer tables.The implementations provided by
DefaultNamedObect
and generated because of a@NamedObject
annotation provide a protected method named onDelete. A subclass that overrides onDelete() must call the onDelete method of its superclass after it's onDelete method has been called and any cleanup actions performed. In some cases, this may happen at a later time (e.g., if a thread is used for some of the cleanup operations or if it is otherwise necessary to wait).- Specified by:
delete
in interfaceNamedObjectOps
- Returns:
- true if the deletion request was accepted; false otherwise
-
isDeleted
public final boolean isDeleted()Determine if an object has been deleted. An object is deleted if the method delete() has been called and returned true.- Specified by:
isDeleted
in interfaceNamedObjectOps
- Returns:
- true if deleted; false otherwise
-
deletePending
public final boolean deletePending()Determine if an object is being deleted. An deletion is pending if the method delete() has been called and returned true but the deletion has not been completed.- Specified by:
deletePending
in interfaceNamedObjectOps
- Returns:
- true if deletion is pending; false otherwise
-