A templated (base) class for handling sampling from vector RVs. More...

#include <VectorRealizer.h>

Inheritance diagram for QUESO::BaseVectorRealizer< V, M >:

Public Member Functions
Constructor/Destructor methods
	BaseVectorRealizer (const char *prefix, const VectorSet< V, M > &unifiedImageSet, unsigned int subPeriod)
	Default constructor. More...

virtual	~BaseVectorRealizer ()
	Virtual destructor. More...

Realization-related methods
const VectorSet< V, M > &	unifiedImageSet () const
	Image set where the realizations lie. Access to protected attribute m_unifiedImageSet. More...

unsigned int	subPeriod () const
	Sub-period of the realization. Access to protected attribute m_subPeriod. More...

virtual void	realization (V &nextValues) const =0
	Performs a realization (sample) from a probability density function. See template specialization. More...

Protected Attributes
const BaseEnvironment &	m_env

std::string	m_prefix

const VectorSet< V, M > &	m_unifiedImageSet

unsigned int	m_subPeriod

Detailed Description

template<class V = GslVector, class M = GslMatrix>
class QUESO::BaseVectorRealizer< V, M >

A templated (base) class for handling sampling from vector RVs.

A realizer is an object that, simply put, contains a realization() operation that returns a sample of a vector RV. This is the base class. QUESO also support uniform, Gaussian, Beta, Gamma, Inverse Gamma and LogNormal realizers, as described and implemented in the derived classes.

Definition at line 49 of file VectorRealizer.h.

Constructor & Destructor Documentation

template<class V, class M>

QUESO::BaseVectorRealizer< V, M >::BaseVectorRealizer	(	const char *	prefix,
		const VectorSet< V, M > &	unifiedImageSet,
		unsigned int	subPeriod
	)

Default constructor.

Constructs a new object, given a prefix and the image set of the vector realizer.

Definition at line 33 of file VectorRealizer.C.

References QUESO::BaseEnvironment::displayVerbosity(), QUESO::BaseVectorRealizer< V, M >::m_env, QUESO::BaseVectorRealizer< V, M >::m_prefix, and QUESO::BaseEnvironment::subDisplayFile().

   :
   m_env            (unifiedImageSet.env()),
   m_prefix         ((std::string)(prefix)+"re_"),
   m_unifiedImageSet(unifiedImageSet),
   m_subPeriod      (subPeriod)
 {
   if ((m_env.subDisplayFile()) && (m_env.displayVerbosity() >= 5)) {
     *m_env.subDisplayFile() << "Entering BaseVectorRealizer<V,M>::constructor() [4]"
                             << ": prefix = " << m_prefix
                             << std::endl;
   }
 
   if ((m_env.subDisplayFile()) && (m_env.displayVerbosity() >= 5)) {
     *m_env.subDisplayFile() << "Leaving BaseVectorRealizer<V,M>::constructor() [4]"
                             << ": prefix = " << m_prefix
                             << std::endl;
   }
 }

template<class V , class M >

QUESO::BaseVectorRealizer< V, M >::~BaseVectorRealizer ( )

virtual

Virtual destructor.

Definition at line 57 of file VectorRealizer.C.

58 {

59 }

Member Function Documentation

template<class V = GslVector, class M = GslMatrix>

virtual void QUESO::BaseVectorRealizer< V, M >::realization ( V & nextValues ) const

pure virtual

Performs a realization (sample) from a probability density function. See template specialization.

Implemented in QUESO::InvLogitGaussianVectorRealizer< V, M >, QUESO::GaussianVectorRealizer< V, M >, QUESO::LogNormalVectorRealizer< V, M >, QUESO::ConcatenatedVectorRealizer< V, M >, QUESO::UniformVectorRealizer< V, M >, QUESO::BetaVectorRealizer< V, M >, QUESO::GenericVectorRealizer< V, M >, QUESO::GammaVectorRealizer< V, M >, QUESO::InverseGammaVectorRealizer< V, M >, QUESO::WignerVectorRealizer< V, M >, QUESO::SequentialVectorRealizer< V, M >, and QUESO::JeffreysVectorRealizer< V, M >.

Referenced by QUESO::MonteCarloSG< P_V, P_M, Q_V, Q_M >::actualGenerateSequence(), QUESO::MonteCarloSG< P_V, P_M, Q_V, Q_M >::actualReadSequence(), QUESO::ComputeCovCorrMatricesBetweenVectorRvs(), and QUESO::MonteCarloQuadrature< V, M >::MonteCarloQuadrature().

template<class V , class M >

unsigned int QUESO::BaseVectorRealizer< V, M >::subPeriod ( ) const

Sub-period of the realization. Access to protected attribute m_subPeriod.

Definition at line 63 of file VectorRealizer.C.

Referenced by QUESO::MonteCarloSG< P_V, P_M, Q_V, Q_M >::internGenerateSequence().

 {
   return m_subPeriod;
 }

template<class V , class M >

const VectorSet< V, M > & QUESO::BaseVectorRealizer< V, M >::unifiedImageSet ( ) const

Image set where the realizations lie. Access to protected attribute m_unifiedImageSet.

Definition at line 70 of file VectorRealizer.C.

 {
   return m_unifiedImageSet;
 }

Member Data Documentation

template<class V = GslVector, class M = GslMatrix>

const BaseEnvironment& QUESO::BaseVectorRealizer< V, M >::m_env

protected

Definition at line 77 of file VectorRealizer.h.

template<class V = GslVector, class M = GslMatrix>

std::string QUESO::BaseVectorRealizer< V, M >::m_prefix

protected

Definition at line 78 of file VectorRealizer.h.

template<class V = GslVector, class M = GslMatrix>

unsigned int QUESO::BaseVectorRealizer< V, M >::m_subPeriod

protected

Definition at line 80 of file VectorRealizer.h.

template<class V = GslVector, class M = GslMatrix>

const VectorSet<V,M>& QUESO::BaseVectorRealizer< V, M >::m_unifiedImageSet

protected

Definition at line 79 of file VectorRealizer.h.

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

src/stats/inc/VectorRealizer.h
src/stats/src/VectorRealizer.C

Public Member Functions

Protected Attributes

Detailed Description

template<class V = GslVector, class M = GslMatrix> class QUESO::BaseVectorRealizer< V, M >

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<class V = GslVector, class M = GslMatrix>
class QUESO::BaseVectorRealizer< V, M >