QUESO::GenericVectorRealizer< V, M > Class Template Reference

A class for handling sampling from generic probability density distributions. More...

#include <GenericVectorRealizer.h>

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

Collaboration diagram for QUESO::GenericVectorRealizer< V, M >:

Public Member Functions
Constructor/Destructor methods
	GenericVectorRealizer (const char *prefix, const VectorSet< V, M > &unifiedImageSet, unsigned int subPeriod, double(*routinePtr)(const void *routineDataPtr, V &nextParamValues), const void *routineDataPtr)
	Default constructor. More...
	~GenericVectorRealizer ()
	Destructor. More...
Realization-related methods
Draws a realization.
void	realization (V &nextValues) const
Public Member Functions inherited from QUESO::BaseVectorRealizer< V, M >
	BaseVectorRealizer (const char *prefix, const VectorSet< V, M > &unifiedImageSet, unsigned int subPeriod)
	Default constructor. More...
virtual	~BaseVectorRealizer ()
	Virtual destructor. More...
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...

Private Attributes
double(*	m_routinePtr )(const void *routineDataPtr, V &nextParamValues)
const void *	m_routineDataPtr

Additional Inherited Members
Protected Attributes inherited from QUESO::BaseVectorRealizer< V, M >
const BaseEnvironment &	m_env
std::string	m_prefix
const VectorSet< V, M > &	m_unifiedImageSet
unsigned int	m_subPeriod

Detailed Description

template<class V, class M>
class QUESO::GenericVectorRealizer< V, M >

A class for handling sampling from generic probability density distributions.

A realizer is an object that, simply put, contains a realization() operation that returns a sample of a vector RV, or, particularly, a generic probability density distribution. This is the class that handles generic sampling, used, for example, to sample, posterior PDFs (the solution of a Bayesian problem).

Definition at line 48 of file GenericVectorRealizer.h.

Constructor & Destructor Documentation

template<class V , class M >

QUESO::GenericVectorRealizer< V, M >::GenericVectorRealizer	(	const char *	prefix,
		const VectorSet< V, M > &	unifiedImageSet,
		unsigned int	subPeriod,
		double(*)(const void *routineDataPtr, V &nextParamValues)	routinePtr,
		const void *	routineDataPtr
	)

Default constructor.

Constructs a new object, given a prefix and the image set of the vector realizer, the sub period for the realizations and a pointer to a generic routine.

Definition at line 33 of file GenericVectorRealizer.C.

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

  :
  BaseVectorRealizer<V,M>(((std::string)(prefix)+"gen").c_str(),unifiedImageSet,subPeriod),
  m_routinePtr    (routinePtr),
  m_routineDataPtr(routineDataPtr)
{
  if ((m_env.subDisplayFile()) && (m_env.displayVerbosity() >= 5)) {
    *m_env.subDisplayFile() << "Entering GenericVectorRealizer<V,M>::constructor()"
                            << ": prefix = " << m_prefix
                            << std::endl;
  }

  if ((m_env.subDisplayFile()) && (m_env.displayVerbosity() >= 5)) {
    *m_env.subDisplayFile() << "Leaving GenericVectorRealizer<V,M>::constructor()"
                            << ": prefix = " << m_prefix
                            << std::endl;
  }
}

template<class V , class M >

QUESO::GenericVectorRealizer< V, M >::~GenericVectorRealizer

(

)

Destructor.

Definition at line 58 of file GenericVectorRealizer.C.

{
}

Member Function Documentation

template<class V , class M >

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

virtual

This function draws a realization of this considering the generic routine m_routinePtr and saves it in nextValues.

Implements QUESO::BaseVectorRealizer< V, M >.

Definition at line 64 of file GenericVectorRealizer.C.

{
  m_routinePtr(m_routineDataPtr,nextValues);
  return;
}

Member Data Documentation

template<class V , class M >

const void* QUESO::GenericVectorRealizer< V, M >::m_routineDataPtr

private

Definition at line 74 of file GenericVectorRealizer.h.

template<class V , class M >

double(* QUESO::GenericVectorRealizer< V, M >::m_routinePtr)(const void *routineDataPtr, V &nextParamValues)

private

Definition at line 73 of file GenericVectorRealizer.h.

---

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

• src/stats/inc/GenericVectorRealizer.h
• src/stats/src/GenericVectorRealizer.C