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

#include <sample.h>

Public Member Functions

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

Value
 The Sample Value. More...
 

Friends

template<typename S >
ostream & operator<< (ostream &stream, Sample< S > &my_sample)
 Print a sample. More...
 
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

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

Constructor.

Parameters
dimensionof the ColumnVector for the continuous samples. This parameter is ignored in the discrete case.
template<typename T>
virtual BFL::Sample< T >::~Sample ( )
virtual

Destructor.

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

Copy Constructor.

template<>
BFL::Sample< ColumnVector >::Sample ( unsigned int  dimension)
inline

Definition at line 30 of file sample.cpp.

Member Function Documentation

template<>
unsigned int BFL::Sample< ColumnVector >::DimensionGet ( ) const
inline

Definition at line 36 of file sample.cpp.

template<>
unsigned int BFL::Sample< double >::DimensionGet ( ) const
inline

Definition at line 49 of file sample.cpp.

template<>
unsigned int BFL::Sample< int >::DimensionGet ( ) const
inline

Definition at line 62 of file sample.cpp.

template<typename T>
unsigned int BFL::Sample< T >::DimensionGet ( ) const
template<>
void BFL::Sample< ColumnVector >::DimensionSet ( unsigned int  dim)
inline

Definition at line 42 of file sample.cpp.

template<>
void BFL::Sample< double >::DimensionSet ( unsigned int  dim)
inline

Definition at line 55 of file sample.cpp.

template<>
void BFL::Sample< int >::DimensionSet ( unsigned int  dim)
inline

Definition at line 68 of file sample.cpp.

template<typename T>
void BFL::Sample< T >::DimensionSet ( unsigned int  dim)
template<typename T>
Sample& BFL::Sample< T >::operator= ( const Sample< T > &  my_sample)

Operator =.

template<typename T>
T& BFL::Sample< T >::ValueGet ( )

Get the value of the Sample.

template<typename T>
const T& BFL::Sample< T >::ValueGet ( ) const

Get the value of the Sample.

template<typename T>
void BFL::Sample< T >::ValueSet ( const T &  value)

Set the value of the Sample.

Parameters
valuethe value indeed :-)

Friends And Related Function Documentation

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

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

Definition at line 161 of file sample.h.

Member Data Documentation

template<typename T>
T BFL::Sample< 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:


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 Jun 10 2019 12:48:01