Bayesian Filtering Library Generated from SVN r
Public Member Functions | Protected Attributes | Friends | List of all members
Sample< T > Class Template Reference

#include <sample.h>

Inheritance diagram for Sample< T >:
WeightedSample< ColumnVector > WeightedSample< StateVar > WeightedSample< T >

Public Member Functions

 Sample (unsigned int dimension=0)
 Constructor.
 
virtual ~Sample ()
 Destructor.
 
 Sample (const Sample< T > &my_sample)
 Copy Constructor.
 
T & ValueGet ()
 Get the value of the Sample.
 
const T & ValueGet () const
 Get the value of the Sample.
 
unsigned int DimensionGet () const
 
void DimensionSet (unsigned int dim)
 
void ValueSet (const T &value)
 Set the value of the Sample.
 
Sampleoperator= (const Sample &my_sample)
 Operator =.
 

Protected Attributes

Value
 The Sample Value.
 

Friends

template<typename S >
ostream & operator<< (ostream &stream, Sample< S > &my_sample)
 Print a sample.
 
template<typename S >
istream & operator>> (istream &stream, Sample< S > &my_sample)
 

Detailed Description

template<typename T>
class BFL::Sample< T >

Template Class representing a basic sample of a continuous or discrete pdf

Definition at line 47 of file sample.h.

Constructor & Destructor Documentation

◆ Sample()

Sample ( unsigned int  dimension = 0)

Constructor.

Parameters
dimensionof the ColumnVector for the continuous samples. This parameter is ignored in the discrete case.

Definition at line 108 of file sample.h.

◆ ~Sample()

~Sample
virtual

Destructor.

Definition at line 113 of file sample.h.

Member Function Documentation

◆ DimensionGet()

unsigned int DimensionGet

Definition at line 145 of file sample.h.

◆ DimensionSet()

void DimensionSet ( unsigned int  dim)

Definition at line 151 of file sample.h.

◆ operator=()

Sample< T > & operator= ( const Sample< T > &  my_sample)

Operator =.

Definition at line 170 of file sample.h.

References Sample< T >::ValueGet().

◆ ValueGet() [1/2]

T & ValueGet

Get the value of the Sample.

Definition at line 132 of file sample.h.

Referenced by Sample< T >::operator=().

◆ ValueGet() [2/2]

const T & ValueGet

Get the value of the Sample.

Definition at line 139 of file sample.h.

◆ ValueSet()

void ValueSet ( const T &  value)

Set the value of the Sample.

Parameters
valuethe value indeed :-)

Definition at line 125 of file sample.h.

Friends And Related Function Documentation

◆ operator<<

ostream & operator<< ( ostream &  stream,
Sample< S > &  my_sample 
)
friend

Print a sample.

Parameters
streamthe stream to be returned
my_samplethe sample to be printed
Returns
the stream :-)

Definition at line 155 of file sample.h.

◆ operator>>

istream & operator>> ( istream &  stream,
Sample< S > &  my_sample 
)
friend

Definition at line 161 of file sample.h.

Member Data Documentation

◆ Value

T Value
protected

The Sample Value.

Definition at line 51 of file sample.h.


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