broadwick.stochastic

Class TransitionKernel

java.lang.Object

broadwick.stochastic.TransitionKernel

All Implemented Interfaces:

Cloneable

public class TransitionKernel
extends Object
implements Cloneable

Class that holds the transition kernel for a stochastic simulation. The kernel comprises of a map of SimulationEvents to the probability of that event occurring. This is NOT thread safe.

Field Summary

Fields

Modifier and Type	Field and Description
private Map<SimulationEvent,Double>	kernel

Constructor Summary

Constructors

Constructor and Description
TransitionKernel() Create a transition kernel object to hold the transition probabilities between vents.

Method Summary

Modifier and Type	Method and Description
void	addToKernel(SimulationEvent event, Double rate) Add the transition rate for a given event.
void	clear() Clear all the events from the kernel.
Object	clone() Copy this kernel object.
Map<SimulationEvent,Double>	getCDF() Get the cumulativeDistFn for this transition kernel.
Set<SimulationEvent>	getTransitionEvents() Get the collection of events stored in the transition kernel.
Double	getTransitionProbability(SimulationEvent event) Get the probability of an event occurring.
void	setTransitionProbabilities(Map<SimulationEvent,Double> probabilities) Set the transition probabilities between states.

Methods inherited from class java.lang.Object

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

Field Detail

kernel

private Map<SimulationEvent,Double> kernel

Constructor Detail

TransitionKernel

public TransitionKernel()

Create a transition kernel object to hold the transition probabilities between vents.

Method Detail

clone

public final Object clone()
                   throws CloneNotSupportedException

Copy this kernel object.

Overrides:

clone in class Object

Returns:

a copy of this object.

Throws:

CloneNotSupportedException - if cloneable is not implemented.

addToKernel

public final void addToKernel(SimulationEvent event,
                              Double rate)

Add the transition rate for a given event.

Parameters:

event - the event to be added to the kernel

rate - the rate at which this event occurs.

clear

public final void clear()

Clear all the events from the kernel.

getTransitionEvents

public final Set<SimulationEvent> getTransitionEvents()

Get the collection of events stored in the transition kernel. This actually returns the keyset from the transition rates since they are always present and will always be in the kernel.

Returns:

the events in the kernel.

getTransitionProbability

public final Double getTransitionProbability(SimulationEvent event)

Get the probability of an event occurring.

Parameters:

event - the event

Returns:

the probability of the event occurring.

setTransitionProbabilities

public final void setTransitionProbabilities(Map<SimulationEvent,Double> probabilities)

Set the transition probabilities between states.

Parameters:

probabilities - the new set of probabilities.

getCDF

public final Map<SimulationEvent,Double> getCDF()

Get the cumulativeDistFn for this transition kernel.

Returns:

the cumulativeDistFn;