WeightedSample< T > Class Template Reference

#include <weightedsample.h>

Inheritance diagram for WeightedSample< T >:

List of all members.

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

(

int

dimension = 0

)

[inline]

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.

---

Member Function Documentation

void ValueSet

(

const T &

value

)

[inherited]

Set the value of the Sample.

Parameters:

value

the value indeed :-)

double WeightGet

(

)

const [inline]

Get the weight.

Returns:

the weight

Definition at line 104 of file weightedsample.h.

References WeightedSample< T >::Weight.

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

void WeightSet

(

double

weight

)

[inline]

Set the weight.

Parameters:

weight

the weight :-)

Returns:

true if weight is a reasonable value

Definition at line 109 of file weightedsample.h.

References WeightedSample< T >::Weight.

---

Friends And Related Function Documentation

ostream& operator<<	(	ostream &	stream,
		Sample< S > &	my_sample
	)			[friend, inherited]

Print a sample.

Parameters:

	stream	the stream to be returned
	my_sample	the sample to be printed

Returns:

the stream :-)

Definition at line 155 of file sample.h.

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.

---

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

• weightedsample.h