#include <conditionalpdf.h>
Public Member Functions | |
ConditionalPdf (int dimension=0, unsigned int num_conditional_arguments=0) | |
Constructor. | |
virtual | ~ConditionalPdf () |
Destructor. | |
virtual ConditionalPdf< Var, CondArg > * | Clone () const |
Clone function. | |
unsigned int | NumConditionalArgumentsGet () const |
Get the Number of conditional arguments. | |
virtual void | NumConditionalArgumentsSet (unsigned int numconditionalarguments) |
Set the Number of conditional arguments. | |
const std::vector< CondArg > & | ConditionalArgumentsGet () const |
Get the whole list of conditional arguments. | |
virtual void | ConditionalArgumentsSet (std::vector< CondArg > ConditionalArguments) |
Set the whole list of conditional arguments. | |
const CondArg & | ConditionalArgumentGet (unsigned int n_argument) const |
Get the n-th argument of the list. | |
virtual void | ConditionalArgumentSet (unsigned int n_argument, const CondArg &argument) |
Set the n-th argument of the list. | |
virtual bool | SampleFrom (vector< Sample< Var > > &list_samples, const unsigned int num_samples, int method=DEFAULT, void *args=NULL) const |
Draw multiple samples from the Pdf (overloaded). | |
virtual bool | SampleFrom (Sample< Var > &one_sample, int method=DEFAULT, void *args=NULL) const |
Draw 1 sample from the Pdf:. | |
virtual Probability | ProbabilityGet (const Var &input) const |
Get the probability of a certain argument. | |
unsigned int | DimensionGet () const |
Get the dimension of the argument. | |
virtual void | DimensionSet (unsigned int dim) |
Set the dimension of the argument. | |
virtual Var | ExpectedValueGet () const |
Get the expected value E[x] of the pdf. | |
virtual MatrixWrapper::SymmetricMatrix | CovarianceGet () const |
Get the Covariance Matrix E[(x - E[x])^2] of the Analytic pdf. |
This class inherits from Pdf Virtual public because of the multiple inheritance that follows Two templates are here to allow a mixture of discrete and continu variables in the Pdf!
Definition at line 49 of file conditionalpdf.h.
ConditionalPdf | ( | int | dimension = 0 , |
|
unsigned int | num_conditional_arguments = 0 | |||
) | [inline] |
Constructor.
dimension | int representing the number of rows of the state vector | |
num_conditional_arguments | the number of arguments behind the | |
Definition at line 116 of file conditionalpdf.h.
Referenced by ConditionalPdf< Var, CondArg >::Clone().
const CondArg & ConditionalArgumentGet | ( | unsigned int | n_argument | ) | const [inline] |
Get the n-th argument of the list.
Definition at line 165 of file conditionalpdf.h.
void ConditionalArgumentSet | ( | unsigned int | n_argument, | |
const CondArg & | argument | |||
) | [inline, virtual] |
Set the n-th argument of the list.
n_argument | which one of the conditional arguments | |
argument | value of the n-th argument |
Definition at line 173 of file conditionalpdf.h.
const std::vector< CondArg > & ConditionalArgumentsGet | ( | ) | const [inline] |
Get the whole list of conditional arguments.
Definition at line 152 of file conditionalpdf.h.
void ConditionalArgumentsSet | ( | std::vector< CondArg > | ConditionalArguments | ) | [inline, virtual] |
Set the whole list of conditional arguments.
ConditionalArguments | an STL-vector of type Tcontaining the condtional arguments |
Definition at line 158 of file conditionalpdf.h.
virtual MatrixWrapper::SymmetricMatrix CovarianceGet | ( | ) | const [virtual, inherited] |
unsigned int DimensionGet | ( | ) | const [inherited] |
Get the dimension of the argument.
virtual void DimensionSet | ( | unsigned int | dim | ) | [virtual, inherited] |
Set the dimension of the argument.
dim | the dimension |
virtual Var ExpectedValueGet | ( | ) | const [virtual, inherited] |
Get the expected value E[x] of the pdf.
Get low order statistic (Expected Value) of this AnalyticPdf
For certain discrete Pdfs, this function has no meaning, what is the average between yes and no?
unsigned int NumConditionalArgumentsGet | ( | ) | const [inline] |
Get the Number of conditional arguments.
Definition at line 135 of file conditionalpdf.h.
void NumConditionalArgumentsSet | ( | unsigned int | numconditionalarguments | ) | [inline, virtual] |
Set the Number of conditional arguments.
numconditionalarguments | the number of conditionalarguments |
Reimplemented in LinearAnalyticConditionalGaussian.
Definition at line 141 of file conditionalpdf.h.
virtual Probability ProbabilityGet | ( | const Var & | input | ) | const [virtual, inherited] |
Get the probability of a certain argument.
input | T argument of the Pdf |
virtual bool SampleFrom | ( | Sample< Var > & | one_sample, | |
int | method = DEFAULT , |
|||
void * | args = NULL | |||
) | const [virtual, inherited] |
Draw 1 sample from the Pdf:.
There's no need to create a list for only 1 sample!
one_sample | sample that will contain result of sampling | |
method | Sampling method to be used. Each sampling method is currently represented by a define statement, eg. define BOXMULLER 1 | |
args | Pointer to a struct representing extra sample arguments |
virtual bool SampleFrom | ( | vector< Sample< Var > > & | list_samples, | |
const unsigned int | num_samples, | |||
int | method = DEFAULT , |
|||
void * | args = NULL | |||
) | const [virtual, inherited] |
Draw multiple samples from the Pdf (overloaded).
list_samples | list of samples that will contain result of sampling | |
num_samples | Number of Samples to be drawn (iid) | |
method | Sampling method to be used. Each sampling method is currently represented by a define statement, eg. define BOXMULLER 1 | |
args | Pointer to a struct representing extra sample arguments. "Sample Arguments" can be anything (the number of steps a gibbs-iterator should take, the interval width in MCMC, ... (or nothing), so it is hard to give a meaning to what exactly Sample Arguments should represent... |