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.
 
virtual ~WeightedSample ()
 Destructor.
 
 WeightedSample (const WeightedSample< T > &my_weighted_sample)
 Copy constructor.
 
double WeightGet () const
 Get the weight.
 
void WeightSet (double weight)
 Set the weight.
 
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
 
void DimensionSet (unsigned int dim)
 
void ValueSet (const T &value)
 Set the value of the Sample.
 

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.
 

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() [1/2]

WeightedSample ( int  dimension = 0)

Constructor.

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

Definition at line 93 of file weightedsample.h.

◆ ~WeightedSample()

~WeightedSample
virtual

Destructor.

Definition at line 96 of file weightedsample.h.

◆ WeightedSample() [2/2]

WeightedSample ( const WeightedSample< T > &  my_weighted_sample)

Copy constructor.

Definition at line 98 of file weightedsample.h.

References WeightedSample< T >::Weight.

Member Function Documentation

◆ DimensionGet()

unsigned int DimensionGet
inherited

Definition at line 145 of file sample.h.

◆ DimensionSet()

void DimensionSet ( unsigned int  dim)
inherited

Definition at line 151 of file sample.h.

◆ operator=() [1/2]

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

Turn sample into weighted one (weight = 1)

Definition at line 136 of file weightedsample.h.

◆ operator=() [2/2]

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

Operator =.

Definition at line 124 of file weightedsample.h.

References WeightedSample< T >::WeightGet().

◆ ValueGet() [1/2]

T & ValueGet
inherited

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
inherited

Get the value of the Sample.

Definition at line 139 of file sample.h.

◆ ValueSet()

void ValueSet ( const T &  value)
inherited

Set the value of the Sample.

Parameters
valuethe value indeed :-)

Definition at line 125 of file sample.h.

◆ WeightGet()

double WeightGet

Get the weight.

Returns
the weight

Definition at line 104 of file weightedsample.h.

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

◆ WeightSet()

void WeightSet ( double  weight)

Set the weight.

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

Definition at line 109 of file weightedsample.h.

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.

Member Data Documentation

◆ Value

T Value
protectedinherited

The Sample Value.

Definition at line 51 of file sample.h.

◆ Weight

double Weight
protected

The weight.

Definition at line 52 of file weightedsample.h.

Referenced by WeightedSample< T >::WeightedSample().


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