StochasticProcess Class Template Reference

Inheritance diagram for StochasticProcess:

Inheritance graph
[legend]

List of all members.


Detailed Description

template<class T = unsigned int>
class indii::ml::aux::StochasticProcess< T >

Abstract stochastic process.

Author:
Lawrence Murray <lawrence@indii.org>
Version:
Rev
Date:
Date

Definition at line 21 of file StochasticProcess.hpp.


Public Member Functions

 StochasticProcess ()
 Default constructor.
 StochasticProcess (const unsigned int N)
 Constructor.
virtual ~StochasticProcess ()
 Destructor.
unsigned int getDimensions () const
 Get the dimensionality of the process.
virtual void setDimensions (const unsigned int N, const bool preserve=false)=0
 Set the dimensionality of the process.
virtual const vectorgetDrift ()=0
 Get the drift of the process.
virtual const
symmetric_matrix
getDiffusion ()=0
 Get the diffusion of the process.
virtual vector getExpectation (const T delta)=0
 Get the expected value of the process after a given time.
virtual symmetric_matrix getCovariance (const T delta)=0
 Get the covariance of the process after a given time.
virtual vector sample (const T delta)=0
 Sample from the process.
virtual double densityAt (const T delta, const vector &x)=0
 Calculate the density of the distribution at a given point after a given time has elapsed.

Protected Attributes

unsigned int N
 $N$; number of dimensions.

Constructor & Destructor Documentation

StochasticProcess (  )  [inline]

Default constructor.

Initialises the process with zero dimensions. This should generally only be used when the object is to be restored from a serialization.

Definition at line 141 of file StochasticProcess.hpp.

StochasticProcess ( const unsigned int  N  )  [inline]

Constructor.

Parameters:
N $N$; number of dimensions of the process.

Definition at line 146 of file StochasticProcess.hpp.

~StochasticProcess (  )  [inline, virtual]

Destructor.

Definition at line 152 of file StochasticProcess.hpp.


Member Function Documentation

unsigned int getDimensions (  )  const [inline]

Get the dimensionality of the process.

Definition at line 157 of file StochasticProcess.hpp.

virtual void setDimensions ( const unsigned int  N,
const bool  preserve = false 
) [pure virtual]

Set the dimensionality of the process.

Parameters:
N Dimensionality of the process.
preserve True to preserve the current sufficient statistics of the process in the lower dimensional space, false if these may be discarded.

Implemented in WienerProcess, and WienerProcess< double >.

virtual const vector& getDrift (  )  [pure virtual]

Get the drift of the process.

Returns:
The drift of the process.

Implemented in WienerProcess, and WienerProcess< double >.

virtual const symmetric_matrix& getDiffusion (  )  [pure virtual]

Get the diffusion of the process.

Returns:
The diffusion of the process.

Implemented in WienerProcess, and WienerProcess< double >.

virtual vector getExpectation ( const T  delta  )  [pure virtual]

Get the expected value of the process after a given time.

Parameters:
delta $\Delta t$; time step.
Returns:
$\mathbf{\mu}(\Delta t)$; expected value of the process after time $\Delta t$.

Implemented in WienerProcess, and WienerProcess< double >.

virtual symmetric_matrix getCovariance ( const T  delta  )  [pure virtual]

Get the covariance of the process after a given time.

Parameters:
delta $\Delta t$; time step.
Returns:
$\Sigma(\Delta t)$; covariance of the process after time $\Delta t$.

Implemented in WienerProcess, and WienerProcess< double >.

virtual vector sample ( const T  delta  )  [pure virtual]

Sample from the process.

Parameters:
delta $\Delta t$; time step.
Returns:
A sample from the process after time $\Delta t$.

Implemented in WienerProcess, and WienerProcess< double >.

virtual double densityAt ( const T  delta,
const vector x 
) [pure virtual]

Calculate the density of the distribution at a given point after a given time has elapsed.

Parameters:
delta $\Delta t$; elapsed time.
x $\mathbf{x}$; the point at which to calculate the density.
Returns:
The density of the distribution at $\mathbf{x}$ after time $\Delta t$.

Implemented in WienerProcess, and WienerProcess< double >.


Member Data Documentation

unsigned int N [protected]

$N$; number of dimensions.

Definition at line 120 of file StochasticProcess.hpp.


Generated on Wed Dec 17 15:11:58 2008 for dysii Dynamical Systems Library by  doxygen 1.5.3