Class representing uniform density.
More...
#include <uniform.h>
|
| Uniform (const MatrixWrapper::ColumnVector &Center, const MatrixWrapper::ColumnVector &Width) |
| Constructor.
|
|
| Uniform (int dimension=0) |
| constructor with only dimensions or nothing
|
|
virtual | ~Uniform () |
| Default Copy Constructor will do.
|
|
virtual Uniform * | Clone () const |
| Clone function.
|
|
virtual Probability | ProbabilityGet (const MatrixWrapper::ColumnVector &input) const |
| Get the probability of a certain argument.
|
|
bool | SampleFrom (vector< Sample< MatrixWrapper::ColumnVector > > &list_samples, const unsigned int num_samples, const SampleMthd method=SampleMthd::DEFAULT, void *args=NULL) const |
| Draw multiple samples from the Pdf (overloaded)
|
|
virtual bool | SampleFrom (Sample< MatrixWrapper::ColumnVector > &one_sample, const SampleMthd method=SampleMthd::DEFAULT, void *args=NULL) const |
| Draw 1 sample from the Pdf:
|
|
virtual MatrixWrapper::ColumnVector | CenterGet () const |
| Get the center of the uniform.
|
|
virtual MatrixWrapper::ColumnVector | WidthGet () const |
| Get the Width of the uniform distribution.
|
|
void | UniformSet (const MatrixWrapper::ColumnVector ¢er, const MatrixWrapper::ColumnVector &width) |
| Set the center and width of the uniform.
|
|
unsigned int | DimensionGet () const |
| Get the dimension of the argument.
|
|
virtual void | DimensionSet (unsigned int dim) |
| Set the dimension of the argument.
|
|
virtual MatrixWrapper::ColumnVector | 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.
|
|
|
std::ostream & | operator<< (std::ostream &os, const Uniform &u) |
| output stream for Uniform distribution
|
|
Class representing uniform density.
Definition at line 26 of file uniform.h.
◆ Uniform()
Uniform |
( |
const MatrixWrapper::ColumnVector & | Center, |
|
|
const MatrixWrapper::ColumnVector & | Width ) |
Constructor.
- Parameters
-
Center | center of the uniform distribution |
Width | width of the uniform distribution |
◆ ~Uniform()
Default Copy Constructor will do.
Destructor
◆ CenterGet()
virtual MatrixWrapper::ColumnVector CenterGet |
( |
| ) |
const |
|
virtual |
Get the center of the uniform.
Get the center of the uniform
◆ Clone()
◆ CovarianceGet()
MatrixWrapper::SymmetricMatrix CovarianceGet |
( |
| ) |
const |
|
virtualinherited |
Get the Covariance Matrix E[(x - E[x])^2] of the Analytic pdf.
Get first order statistic (Covariance) of this AnalyticPdf
- Returns
- The Covariance of the Pdf (a SymmetricMatrix of dim DIMENSION)
- Todo
- extend this more general to n-th order statistic
- Bug
- Discrete pdfs should not be able to use this!
Reimplemented in Gaussian.
Definition at line 138 of file pdf.h.
◆ DimensionGet()
unsigned int DimensionGet |
( |
| ) |
const |
|
inlineinherited |
Get the dimension of the argument.
- Returns
- the dimension of the argument
Definition at line 113 of file pdf.h.
◆ DimensionSet()
void DimensionSet |
( |
unsigned int | dim | ) |
|
|
virtualinherited |
Set the dimension of the argument.
- Parameters
-
Reimplemented in Gaussian.
Definition at line 118 of file pdf.h.
◆ ExpectedValueGet()
MatrixWrapper::ColumnVector ExpectedValueGet |
( |
| ) |
const |
|
virtualinherited |
Get the expected value E[x] of the pdf.
Get low order statistic (Expected Value) of this AnalyticPdf
- Returns
- The Expected Value of the Pdf (a ColumnVector with DIMENSION rows)
- Note
- No set functions here! This can be useful for analytic functions, but not for sample based representations!
-
For certain discrete Pdfs, this function has no meaning, what is the average between yes and no?
Reimplemented in Gaussian.
Definition at line 129 of file pdf.h.
◆ ProbabilityGet()
virtual Probability ProbabilityGet |
( |
const MatrixWrapper::ColumnVector & | input | ) |
const |
|
virtual |
◆ SampleFrom() [1/2]
virtual bool SampleFrom |
( |
Sample< MatrixWrapper::ColumnVector > & | one_sample, |
|
|
const SampleMthd | method = SampleMthd::DEFAULT, |
|
|
void * | args = NULL ) const |
|
virtual |
Draw 1 sample from the Pdf:
There's no need to create a list for only 1 sample!
- Parameters
-
one_sample | sample that will contain result of sampling |
method | Sampling method to be used. Each sampling method is currently represented by an enum, eg. SampleMthd::BOXMULLER |
args | Pointer to a struct representing extra sample arguments |
- See also
- SampleFrom()
- Bug
- Sometimes the compiler doesn't know which method to choose!
Reimplemented from Pdf< MatrixWrapper::ColumnVector >.
◆ SampleFrom() [2/2]
bool SampleFrom |
( |
vector< Sample< MatrixWrapper::ColumnVector > > & | list_samples, |
|
|
const unsigned int | num_samples, |
|
|
const SampleMthd | method = SampleMthd::DEFAULT, |
|
|
void * | args = NULL ) const |
|
virtual |
Draw multiple samples from the Pdf (overloaded)
- Parameters
-
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 an enum eg. SampleMthd::BOXMULLER |
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... |
- Todo
- replace the C-call "void * args" by a more object-oriented structure: Perhaps something like virtual Sample * Sample (const int num_samples,class Sampler)
- Bug
- Sometimes the compiler doesn't know which method to choose!
Reimplemented from Pdf< MatrixWrapper::ColumnVector >.
◆ UniformSet()
void UniformSet |
( |
const MatrixWrapper::ColumnVector & | center, |
|
|
const MatrixWrapper::ColumnVector & | width ) |
Set the center and width of the uniform.
Set the center and width of the uniform
- Parameters
-
center | The new center of uniform distribution |
width | The new width of the uniform distribution |
◆ WidthGet()
virtual MatrixWrapper::ColumnVector WidthGet |
( |
| ) |
const |
|
virtual |
Get the Width of the uniform distribution.
Get the Width of the uniform distribution
The documentation for this class was generated from the following file: