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

#include <asirfilter.h>

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

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

Template Class representing a basic sample of a continuous or discrete pdf

Definition at line 47 of file asirfilter.h.

Constructor & Destructor Documentation

◆ Sample() [1/3]

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.

Definition at line 108 of file asirfilter.h.

◆ ~Sample()

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

Destructor.

Definition at line 113 of file asirfilter.h.

◆ Sample() [2/3]

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

Copy Constructor.

Definition at line 118 of file asirfilter.h.

◆ Sample() [3/3]

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

Definition at line 31 of file asirfilter.h.

Member Function Documentation

◆ DimensionGet() [1/4]

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

Definition at line 37 of file asirfilter.h.

◆ DimensionGet() [2/4]

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

Definition at line 50 of file asirfilter.h.

◆ DimensionGet() [3/4]

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

Definition at line 63 of file asirfilter.h.

◆ DimensionGet() [4/4]

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

Definition at line 145 of file asirfilter.h.

◆ DimensionSet() [1/4]

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

Definition at line 43 of file asirfilter.h.

◆ DimensionSet() [2/4]

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

Definition at line 56 of file asirfilter.h.

◆ DimensionSet() [3/4]

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

Definition at line 69 of file asirfilter.h.

◆ DimensionSet() [4/4]

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

Definition at line 151 of file asirfilter.h.

◆ operator=()

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

Operator =.

Definition at line 170 of file asirfilter.h.

◆ ValueGet() [1/2]

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

Get the value of the Sample.

Definition at line 132 of file asirfilter.h.

◆ ValueGet() [2/2]

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

Get the value of the Sample.

Definition at line 139 of file asirfilter.h.

◆ ValueSet()

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

Set the value of the Sample.

Parameters
valuethe value indeed :-)

Definition at line 125 of file asirfilter.h.

Friends And Related Function Documentation

◆ operator<<

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 asirfilter.h.

◆ operator>>

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

Definition at line 161 of file asirfilter.h.

Member Data Documentation

◆ Value

template<typename T>
T BFL::BFL::Sample< T >::Value
protected

The Sample Value.

Definition at line 51 of file asirfilter.h.


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


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