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

#include <weightedsample.h>

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

Public Member Functions

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

Protected Attributes

double Weight
 The weight. More...
 
- Protected Attributes inherited from BFL::BFL::Sample< T >
Value
 The Sample Value. More...
 

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

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

◆ ~WeightedSample()

template<typename T>
virtual BFL::WeightedSample< T >::~WeightedSample ( )
virtual

Destructor.

◆ WeightedSample() [2/2]

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

Copy constructor.

Member Function Documentation

◆ operator=() [1/2]

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

Operator =.

◆ operator=() [2/2]

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

Turn sample into weighted one (weight = 1)

◆ WeightGet()

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

Get the weight.

Returns
the weight

◆ WeightSet()

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

◆ operator<<

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

◆ Weight

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 Mon Feb 28 2022 21:56:34