Public Member Functions | Private Attributes | Friends
BFL::Uniform Class Reference

Class representing uniform density. More...

#include <uniform.h>

Inheritance diagram for BFL::Uniform:
Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual MatrixWrapper::ColumnVector CenterGet () const
 Get the center of the uniform.
virtual UniformClone () 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 int num_samples, int method=DEFAULT, void *args=NULL) const
virtual bool SampleFrom (Sample< MatrixWrapper::ColumnVector > &one_sample, int method=DEFAULT, void *args=NULL) const
 Uniform (const MatrixWrapper::ColumnVector &Center, const MatrixWrapper::ColumnVector &Width)
 Constructor.
 Uniform (int dimension=0)
 constructor with only dimensions or nothing
void UniformSet (const MatrixWrapper::ColumnVector &center, const MatrixWrapper::ColumnVector &width)
 Set the center and width of the uniform.
virtual MatrixWrapper::ColumnVector WidthGet () const
 Get the Width of the uniform distribution.
virtual ~Uniform ()
 Default Copy Constructor will do.

Private Attributes

double _Height
 Height of the uniform distribution.
MatrixWrapper::ColumnVector _Higher
 Upper border of the uniform distribution.
MatrixWrapper::ColumnVector _Lower
 Lower border of the uniform distribution.
ColumnVector _samples

Friends

std::ostream & operator<< (std::ostream &os, const Uniform &u)
 output stream for Uniform distribution

Detailed Description

Class representing uniform density.

Definition at line 26 of file uniform.h.


Constructor & Destructor Documentation

BFL::Uniform::Uniform ( const MatrixWrapper::ColumnVector &  Center,
const MatrixWrapper::ColumnVector &  Width 
)

Constructor.

Parameters:
Centercenter of the uniform distribution
Widthwidth of the uniform distribution
BFL::Uniform::Uniform ( int  dimension = 0)

constructor with only dimensions or nothing

Definition at line 44 of file uniform.cpp.

BFL::Uniform::~Uniform ( ) [virtual]

Default Copy Constructor will do.

Destructor

Definition at line 52 of file uniform.cpp.


Member Function Documentation

ColumnVector BFL::Uniform::CenterGet ( ) const [virtual]

Get the center of the uniform.

Get the center of the uniform

Definition at line 117 of file uniform.cpp.

Uniform * BFL::Uniform::Clone ( ) const [virtual]

Clone function.

Implements BFL::BFL::Pdf< MatrixWrapper::ColumnVector >.

Definition at line 62 of file uniform.cpp.

Probability BFL::Uniform::ProbabilityGet ( const MatrixWrapper::ColumnVector &  input) const [virtual]

Get the probability of a certain argument.

Parameters:
inputT argument of the Pdf
Returns:
the probability value of the argument

Reimplemented from BFL::BFL::Pdf< MatrixWrapper::ColumnVector >.

Definition at line 67 of file uniform.cpp.

bool BFL::Uniform::SampleFrom ( vector< Sample< MatrixWrapper::ColumnVector > > &  list_samples,
const int  num_samples,
int  method = DEFAULT,
void *  args = NULL 
) const
virtual bool BFL::Uniform::SampleFrom ( Sample< MatrixWrapper::ColumnVector > &  one_sample,
int  method = DEFAULT,
void *  args = NULL 
) const [virtual]
void BFL::Uniform::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:
centerThe new center of uniform distribution
widthThe new width of the uniform distribution

Definition at line 129 of file uniform.cpp.

ColumnVector BFL::Uniform::WidthGet ( ) const [virtual]

Get the Width of the uniform distribution.

Get the Width of the uniform distribution

Definition at line 123 of file uniform.cpp.


Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  os,
const Uniform u 
) [friend]

output stream for Uniform distribution

Definition at line 54 of file uniform.cpp.


Member Data Documentation

double BFL::Uniform::_Height [private]

Height of the uniform distribution.

Definition at line 34 of file uniform.h.

MatrixWrapper::ColumnVector BFL::Uniform::_Higher [private]

Upper border of the uniform distribution.

Definition at line 32 of file uniform.h.

MatrixWrapper::ColumnVector BFL::Uniform::_Lower [private]

Lower border of the uniform distribution.

Definition at line 30 of file uniform.h.

ColumnVector BFL::Uniform::_samples [mutable, private]

Definition at line 37 of file uniform.h.


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


bfl
Author(s): Klaas Gadeyne, Wim Meeussen, Tinne Delaet and many others. See web page for a full contributor list. ROS package maintained by Wim Meeussen.
autogenerated on Fri Aug 28 2015 10:10:22