WeightedSample< T > Class Template Reference

#include <weightedsample.h>

Inheritance diagram for WeightedSample< 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.
T	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]

template<typename T >

WeightedSample

(

int

dimension = 0

)

Constructor.

Parameters

dimension

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

Definition at line 93 of file weightedsample.h.

~WeightedSample()

template<typename T >

~WeightedSample ( )

virtual

Destructor.

Definition at line 96 of file weightedsample.h.

WeightedSample() [2/2]

template<typename T >

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()

template<typename T >

unsigned int DimensionGet ( ) const

inherited

Definition at line 145 of file sample.h.

DimensionSet()

template<typename T >

void DimensionSet ( unsigned int  dim )

inherited

Definition at line 151 of file sample.h.

operator=() [1/2]

template<typename T >

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]

template<typename T >

WeightedSample< T > & operator=

(

const WeightedSample< T > &

my_sample

)

Operator =.

Definition at line 124 of file weightedsample.h.

References WeightedSample< T >::WeightGet().

ValueGet() [1/2]

template<typename T >

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]

template<typename T >

const T & ValueGet ( ) const

inherited

Get the value of the Sample.

Definition at line 139 of file sample.h.

ValueSet()

template<typename T >

void ValueSet ( const T &  value )

inherited

Set the value of the Sample.

Parameters

value

the value indeed :-)

Definition at line 125 of file sample.h.

WeightGet()

template<typename T >

double WeightGet

(

)

const

Get the weight.

Returns

the weight

Definition at line 104 of file weightedsample.h.

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

WeightSet()

template<typename T >

void WeightSet

(

double

weight

)

Set the weight.

Parameters

weight

the weight :-)

Returns

true if weight is a reasonable value

Definition at line 109 of file weightedsample.h.

Friends And Related Symbol Documentation

operator<<

template<typename T >

template<typename S >

ostream & operator<< ( ostream &  stream, WeightedSample< S > &  mws  )

friend

Print a weighted sample.

Parameters

stream	the stream to be returned
mws	the weighted sample to be printed

Returns

the stream :-)

Definition at line 116 of file weightedsample.h.

Member Data Documentation

Value

template<typename T >

T Value

protectedinherited

The Sample Value.

Definition at line 51 of file sample.h.

Weight

template<typename T >

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:

• weightedsample.h