Bayesian Filtering Library  Generated from SVN r
Public Member Functions | Protected Attributes | List of all members
DiscreteSystemModel Class Reference

Class for discrete System Models. More...

#include <discretesystemmodel.h>

Inheritance diagram for DiscreteSystemModel:
SystemModel< int >

Public Member Functions

 DiscreteSystemModel (DiscreteConditionalPdf *systempdf=NULL)
 Constructor. More...
 
virtual ~DiscreteSystemModel ()
 Destructor.
 
 DiscreteSystemModel (const DiscreteSystemModel &)
 Copy constructor.
 
unsigned int NumStatesGet () const
 Get the number of discrete states.
 
int StateSizeGet () const
 Get State Size. More...
 
bool SystemWithoutInputs () const
 Has the system inputs or not.
 
ConditionalPdf< int, int > * SystemPdfGet ()
 Get the SystemPDF. More...
 
void SystemPdfSet (ConditionalPdf< int, int > *pdf)
 Set the SystemPDF. More...
 
int Simulate (const int &x, const int &u, const SampleMthd sampling_method=SampleMthd::DEFAULT, void *sampling_args=NULL)
 Simulate the system. More...
 
int Simulate (const int &x, const SampleMthd sampling_method=SampleMthd::DEFAULT, void *sampling_args=NULL)
 Simulate the system (no input system) More...
 
Probability ProbabilityGet (const int &x_k, const int &x_kminusone, const int &u)
 Get the probability of arriving in a next state. More...
 
Probability ProbabilityGet (const int &x_k, const int &x_kminusone)
 Get the probability of arriving in a next state. More...
 

Protected Attributes

ConditionalPdf< int, int > * _SystemPdf
 ConditionalPdf representing $ P(X_k | X_{k-1}, U_{k}) $.
 
bool _systemWithoutInputs
 System with no inputs?
 

Detailed Description

Class for discrete System Models.

Class representing discrete System Models, ie. System Models for which BOTH states and inputs are discrete variables!

Definition at line 30 of file discretesystemmodel.h.

Constructor & Destructor Documentation

◆ DiscreteSystemModel()

Constructor.

Parameters
systempdfConditionalPdf<int> representing P(X_k | X_{k-1}, U_{k})
See also
SystemPdf

Member Function Documentation

◆ ProbabilityGet() [1/2]

Probability ProbabilityGet ( const int &  x_k,
const int &  x_kminusone 
)
inherited

Get the probability of arriving in a next state.

(no-input-system)

Parameters
x_kthe next state (at time k)
x_kminusonethe current state (at time k-1)
Returns
the probability value

◆ ProbabilityGet() [2/2]

Probability ProbabilityGet ( const int &  x_k,
const int &  x_kminusone,
const int &  u 
)
inherited

Get the probability of arriving in a next state.

Parameters
x_kthe next state (at time k)
x_kminusonethe current state (at time k-1)
uthe input
Returns
the probability value

◆ Simulate() [1/2]

int Simulate ( const int &  x,
const int &  u,
const SampleMthd  sampling_method = SampleMthd::DEFAULT,
void *  sampling_args = NULL 
)
inherited

Simulate the system.

Parameters
xcurrent state of the system
uinput to the system
Returns
State where we arrive by simulating the system model for 1 step
Parameters
sampling_methodthe sampling method to be used while sampling from the Conditional Pdf describing the system (if not specified = DEFAULT)
sampling_argsSometimes a sampling method can have some extra parameters (eg mcmc sampling)
Note
Maybe the return value would better be a Sample<T> instead of a T

◆ Simulate() [2/2]

int Simulate ( const int &  x,
const SampleMthd  sampling_method = SampleMthd::DEFAULT,
void *  sampling_args = NULL 
)
inherited

Simulate the system (no input system)

Parameters
xcurrent state of the system
Returns
State where we arrive by simulating the system model for 1 step
Note
Maybe the return value would better be a Sample<T> instead of a T
Parameters
sampling_methodthe sampling method to be used while sampling from the Conditional Pdf describing the system (if not specified = DEFAULT)
sampling_argsSometimes a sampling method can have some extra parameters (eg mcmc sampling)

◆ StateSizeGet()

int StateSizeGet ( ) const
inherited

Get State Size.

Copy constructor SystemModel(const SystemModel<T>& model);

Returns
the statesize of the system

◆ SystemPdfGet()

ConditionalPdf<int ,int >* SystemPdfGet ( )
inherited

Get the SystemPDF.

Returns
a reference to the ConditionalPdf describing the system

◆ SystemPdfSet()

void SystemPdfSet ( ConditionalPdf< int , int > *  pdf)
inherited

Set the SystemPDF.

Parameters
pdfa reference to the ConditionalPdf describing the system

The documentation for this class was generated from the following file: