Public Member Functions | Protected Attributes | Friends
BFL::WeightedSample< T > Class Template Reference

#include <weightedsample.h>

Inheritance diagram for BFL::WeightedSample< T >:
Inheritance graph
[legend]

List of all members.

Public Member Functions

WeightedSample< T > & operator= (const WeightedSample< T > &my_sample)
 Operator =.
WeightedSample< T > & operator= (const Sample< T > &my_sample)
 Turn sample into weighted one (weight = 1)
 WeightedSample (int dimension=0)
 Constructor.
 WeightedSample (const WeightedSample< T > &my_weighted_sample)
 Copy constructor.
double WeightGet () const
 Get the weight.
void WeightSet (double weight)
 Set the weight.
virtual ~WeightedSample ()
 Destructor.

Protected Attributes

double Weight
 The weight.

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

template<typename T>
BFL::WeightedSample< T >::WeightedSample ( int  dimension = 0)

Constructor.

Parameters:
dimensionof the ColumnVector for the continuous samples, number of discrete states for the discrete case
template<typename T>
virtual BFL::WeightedSample< T >::~WeightedSample ( ) [virtual]

Destructor.

template<typename T>
BFL::WeightedSample< T >::WeightedSample ( const WeightedSample< T > &  my_weighted_sample)

Copy constructor.


Member Function Documentation

template<typename T>
WeightedSample<T>& BFL::WeightedSample< T >::operator= ( const WeightedSample< T > &  my_sample)

Operator =.

template<typename T>
WeightedSample<T>& BFL::WeightedSample< T >::operator= ( const Sample< T > &  my_sample)

Turn sample into weighted one (weight = 1)

template<typename T>
double BFL::WeightedSample< T >::WeightGet ( ) const

Get the weight.

Returns:
the weight
template<typename T>
void BFL::WeightedSample< T >::WeightSet ( double  weight)

Set the weight.

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

Friends And Related Function Documentation

template<typename T>
template<typename S >
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

template<typename T>
double BFL::WeightedSample< T >::Weight [protected]

The weight.

Definition at line 52 of file weightedsample.h.


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


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 Sun Oct 5 2014 22:29:53