queso-0.57.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Pages
QUESO::BaseVectorRealizer< V, M > Class Template Referenceabstract

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

#include <VectorRealizer.h>

Inheritance diagram for QUESO::BaseVectorRealizer< V, M >:
QUESO::BetaVectorRealizer< V, M > QUESO::ConcatenatedVectorRealizer< V, M > QUESO::GammaVectorRealizer< V, M > QUESO::GaussianVectorRealizer< V, M > QUESO::GenericVectorRealizer< V, M > QUESO::InverseGammaVectorRealizer< V, M > QUESO::InvLogitGaussianVectorRealizer< V, M > QUESO::JeffreysVectorRealizer< V, M > QUESO::LogNormalVectorRealizer< V, M > QUESO::SequentialVectorRealizer< V, M > QUESO::UniformVectorRealizer< V, M > QUESO::WignerVectorRealizer< 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 BaseEnvironmentm_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().

37  :
38  m_env (unifiedImageSet.env()),
39  m_prefix ((std::string)(prefix)+"re_"),
42 {
43  if ((m_env.subDisplayFile()) && (m_env.displayVerbosity() >= 5)) {
44  *m_env.subDisplayFile() << "Entering BaseVectorRealizer<V,M>::constructor() [4]"
45  << ": prefix = " << m_prefix
46  << std::endl;
47  }
48 
49  if ((m_env.subDisplayFile()) && (m_env.displayVerbosity() >= 5)) {
50  *m_env.subDisplayFile() << "Leaving BaseVectorRealizer<V,M>::constructor() [4]"
51  << ": prefix = " << m_prefix
52  << std::endl;
53  }
54 }
const BaseEnvironment & m_env
unsigned int subPeriod() const
Sub-period of the realization. Access to protected attribute m_subPeriod.
const VectorSet< V, M > & unifiedImageSet() const
Image set where the realizations lie. Access to protected attribute m_unifiedImageSet.
unsigned int displayVerbosity() const
Definition: Environment.C:450
const VectorSet< V, M > & m_unifiedImageSet
std::ofstream * subDisplayFile() const
Access function for m_subDisplayFile (displays file on stream).
Definition: Environment.C:320
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 , 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().

64 {
65  return m_subPeriod;
66 }
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.

71 {
72  return m_unifiedImageSet;
73 }
const VectorSet< V, M > & m_unifiedImageSet

Member Data Documentation

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:

Generated on Tue Jun 5 2018 19:49:39 for queso-0.57.1 by  doxygen 1.8.5