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

#include <weightedsample.h>

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

Public Member Functions

 WeightedSample (int dimension=0)
 Constructor. More...
 
virtual ~WeightedSample ()
 Destructor.
 
 WeightedSample (const WeightedSample< T > &my_weighted_sample)
 Copy constructor.
 
double WeightGet () const
 Get the weight. More...
 
void WeightSet (double weight)
 Set the weight. More...
 
WeightedSample< T > & operator= (const WeightedSample< T > &my_sample)
 Operator =.
 
WeightedSample< T > & operator= (const Sample< T > &my_sample)
 Turn sample into weighted one (weight = 1)
 
T & ValueGet ()
 Get the value of the Sample.
 
const T & ValueGet () const
 Get the value of the Sample.
 
unsigned int DimensionGet () const
 
template<>
unsigned int DimensionGet () const
 
template<>
unsigned int DimensionGet () const
 
template<>
unsigned int DimensionGet () const
 
void DimensionSet (unsigned int dim)
 
template<>
void DimensionSet (unsigned int dim)
 
template<>
void DimensionSet (unsigned int dim)
 
template<>
void DimensionSet (unsigned int dim)
 
void ValueSet (const T &value)
 Set the value of the Sample. More...
 

Protected Attributes

double Weight
 The weight.
 
Value
 The Sample Value.
 

Friends

template<typename S >
ostream & operator<< (ostream &stream, WeightedSample< S > &mws)
 Print a weighted sample. More...
 

Detailed Description

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

Template Class representing a sample of a continuous or discrete pdf, together with a weight denoting the relative importance of that sample. Inheritance is virtual (only important for a particular class hybridweightedsample (see the rob/actsens/cubeincorner CVS tree)

Definition at line 48 of file weightedsample.h.

Constructor & Destructor Documentation

◆ WeightedSample()

WeightedSample ( int  dimension = 0)

Constructor.

Parameters
dimensionof the ColumnVector for the continuous samples, number of discrete states for the discrete case

Member Function Documentation

◆ WeightGet()

double WeightGet ( ) const

Get the weight.

Returns
the weight

◆ WeightSet()

void WeightSet ( double  weight)

Set the weight.

Parameters
weightthe weight :-)
Returns
true if weight is a reasonable value

Friends And Related Function Documentation

◆ operator<<

ostream& operator<< ( ostream &  stream,
WeightedSample< S > &  mws 
)
friend

Print a weighted sample.

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

Definition at line 116 of file weightedsample.h.


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