queso-0.51.1
Protected Attributes | List of all members
QUESO::BaseVectorRV< V, M > Class Template Referenceabstract

A templated base class for handling vector RV. More...

#include <VectorRV.h>

Inheritance diagram for QUESO::BaseVectorRV< V, M >:
Inheritance graph
[legend]
Collaboration diagram for QUESO::BaseVectorRV< V, M >:
Collaboration graph
[legend]

Public Member Functions

Constructor/Destructor methods
 BaseVectorRV (const char *prefix, const VectorSet< V, M > &imageSet)
 Constructor. More...
 
virtual ~BaseVectorRV ()
 Virtual destructor. More...
 
Random variable-handling methods
const BaseEnvironment & env () const
 QUESO environment; access to private attribute m_env. More...
 
const VectorSet< V, M > & imageSet () const
 Image set of the vector RV; access to private attribute m_imageSet. More...
 
const BaseJointPdf< V, M > & pdf () const
 Posterior Density Function of the vector RV; access to private attribute m_pdf. More...
 
const BaseVectorRealizer< V, M > & realizer () const
 Finds a realization (sample) of the PDF of this vector RV; access to private attribute m_realizer. More...
 
const BaseVectorCdf< V, M > & subCdf () const
 Finds the Cumulative Distribution Function of this vector RV, considering only the sub-sequence of data; access to private attribute m_subCdf. More...
 
const BaseVectorCdf< V, M > & unifiedCdf () const
 Finds the Cumulative Distribution Function of this vector RV, considering the unified sequence of data; access to private attribute m_unifiedCdf. More...
 
const BaseVectorMdf< V, M > & mdf () const
 Finds the Mass Density Function of this vector RV; access to private attribute m_mdf. More...
 

Protected Attributes

const BaseEnvironment & m_env
 
std::string m_prefix
 
const VectorSet< V, M > & m_imageSet
 
BaseJointPdf< V, M > * m_pdf
 
BaseVectorRealizer< V, M > * m_realizer
 
const BaseVectorCdf< V, M > * m_subCdf
 
const BaseVectorCdf< V, M > * m_unifiedCdf
 
const BaseVectorMdf< V, M > * m_mdf
 

I/O methods

virtual void print (std::ostream &os) const =0
 TODO: Prints the vector RV. More...
 
std::ostream & operator<< (std::ostream &os, const BaseVectorRV< V, M > &obj)
 

Detailed Description

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

A templated base class for handling vector RV.

This class allows two basic but quite crucial functionalities: to compute the value of the PDF of a random variable (RV) at a point and to generate realizations (samples) from such PDF.

Definition at line 51 of file VectorRV.h.

Constructor & Destructor Documentation

template<class V, class M>
QUESO::BaseVectorRV< V, M >::BaseVectorRV ( const char *  prefix,
const VectorSet< V, M > &  imageSet 
)

Constructor.

Constructs a new instance of BaseVectorRV, given a prefix and the image set of the vector RV.

Definition at line 33 of file VectorRV.C.

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

36  :
37  m_env (imageSet.env()),
38  m_prefix ((std::string)(prefix)+"rv_"),
39  m_imageSet (imageSet),
40  m_pdf (NULL),
41  m_realizer (NULL),
42  m_subCdf (NULL),
43  m_unifiedCdf(NULL),
44  m_mdf (NULL)
45 {
46  if ((m_env.subDisplayFile()) && (m_env.displayVerbosity() >= 54)) {
47  *m_env.subDisplayFile() << "Entering BaseVectorRV<V,M>::constructor()"
48  << ": prefix = " << m_prefix
49  << std::endl;
50  }
51 
52  if ((m_env.subDisplayFile()) && (m_env.displayVerbosity() >= 54)) {
53  *m_env.subDisplayFile() << "Leaving BaseVectorRV<V,M>::constructor()"
54  << ": prefix = " << m_prefix
55  << std::endl;
56  }
57 }
QUESO::BaseVectorRV::m_unifiedCdf
const BaseVectorCdf< V, M > * m_unifiedCdf
Definition: VectorRV.h:118
QUESO::BaseEnvironment::subDisplayFile
std::ofstream * subDisplayFile() const
Access function for m_subDisplayFile (displays file on stream).
Definition: Environment.C:305
QUESO::BaseVectorRV::m_imageSet
const VectorSet< V, M > & m_imageSet
Definition: VectorRV.h:114
QUESO::BaseVectorRV::m_env
const BaseEnvironment & m_env
Definition: VectorRV.h:112
QUESO::BaseVectorRV::m_subCdf
const BaseVectorCdf< V, M > * m_subCdf
Definition: VectorRV.h:117
QUESO::BaseVectorRV::m_realizer
BaseVectorRealizer< V, M > * m_realizer
Definition: VectorRV.h:116
QUESO::BaseVectorRV::imageSet
const VectorSet< V, M > & imageSet() const
Image set of the vector RV; access to private attribute m_imageSet.
Definition: VectorRV.C:79
QUESO::BaseEnvironment::displayVerbosity
unsigned int displayVerbosity() const
Definition: Environment.C:436
QUESO::BaseVectorRV::m_mdf
const BaseVectorMdf< V, M > * m_mdf
Definition: VectorRV.h:119
QUESO::BaseVectorRV::m_prefix
std::string m_prefix
Definition: VectorRV.h:113
QUESO::BaseVectorRV::m_pdf
BaseJointPdf< V, M > * m_pdf
Definition: VectorRV.h:115
template<class V , class M >
QUESO::BaseVectorRV< V, M >::~BaseVectorRV ( )
virtual

Virtual destructor.

Definition at line 60 of file VectorRV.C.

61 {
62  //if (m_mdf ) delete m_mdf;
63  //if (m_subCdf ) delete m_subCdf;
64  //if (m_unifiedCdf) delete m_unifiedCdf;
65  //if (m_realizer ) delete m_realizer;
66  //if (m_pdf ) delete m_pdf;
67 }

Member Function Documentation

template<class V , class M >
const BaseEnvironment & QUESO::BaseVectorRV< V, M >::env ( ) const

QUESO environment; access to private attribute m_env.

Definition at line 72 of file VectorRV.C.

Referenced by QUESO::ComputeCovCorrMatricesBetweenVectorRvs().

73 {
74  return m_env;
75 }
QUESO::BaseVectorRV::m_env
const BaseEnvironment & m_env
Definition: VectorRV.h:112
template<class V , class M >
const VectorSet< V, M > & QUESO::BaseVectorRV< V, M >::imageSet ( ) const

Image set of the vector RV; access to private attribute m_imageSet.

Definition at line 79 of file VectorRV.C.

Referenced by QUESO::BetaVectorRV< V, M >::BetaVectorRV(), QUESO::ComputeCovCorrMatricesBetweenVectorRvs(), QUESO::GammaVectorRV< V, M >::GammaVectorRV(), QUESO::InverseGammaVectorRV< V, M >::InverseGammaVectorRV(), QUESO::LogNormalVectorRV< V, M >::LogNormalVectorRV(), and QUESO::StatisticalInverseProblem< P_V, P_M >::StatisticalInverseProblem().

80 {
81  return m_imageSet;
82 }
QUESO::BaseVectorRV::m_imageSet
const VectorSet< V, M > & m_imageSet
Definition: VectorRV.h:114
template<class V , class M >
const BaseVectorMdf< V, M > & QUESO::BaseVectorRV< V, M >::mdf ( ) const

Finds the Mass Density Function of this vector RV; access to private attribute m_mdf.

Definition at line 134 of file VectorRV.C.

References UQ_FATAL_TEST_MACRO.

Referenced by QUESO::GenericVectorRV< V, M >::GenericVectorRV().

135 {
136  UQ_FATAL_TEST_MACRO(m_mdf == NULL,
137  m_env.worldRank(),
138  (std::string)("BaseVectorRV<V,M>::mdf(), prefix=")+m_prefix,
139  "m_mdf is NULL");
140 
141  return *m_mdf;
142 }
QUESO::BaseEnvironment::worldRank
int worldRank() const
Returns the process world rank.
Definition: Environment.C:235
QUESO::BaseVectorRV::m_env
const BaseEnvironment & m_env
Definition: VectorRV.h:112
QUESO::BaseVectorRV::m_mdf
const BaseVectorMdf< V, M > * m_mdf
Definition: VectorRV.h:119
UQ_FATAL_TEST_MACRO
#define UQ_FATAL_TEST_MACRO(test, givenRank, where, what)
Definition: Defines.h:223
QUESO::BaseVectorRV::m_prefix
std::string m_prefix
Definition: VectorRV.h:113
template<class V , class M >
const BaseJointPdf< V, M > & QUESO::BaseVectorRV< V, M >::pdf ( ) const

Posterior Density Function of the vector RV; access to private attribute m_pdf.

Definition at line 86 of file VectorRV.C.

References UQ_FATAL_TEST_MACRO.

Referenced by QUESO::GenericVectorRV< V, M >::GenericVectorRV().

87 {
88  UQ_FATAL_TEST_MACRO(m_pdf == NULL,
89  m_env.worldRank(),
90  "BaseVectorRV<V,M>::pdf()",
91  "m_pdf is NULL");
92 
93  return *m_pdf;
94 }
QUESO::BaseEnvironment::worldRank
int worldRank() const
Returns the process world rank.
Definition: Environment.C:235
QUESO::BaseVectorRV::m_env
const BaseEnvironment & m_env
Definition: VectorRV.h:112
UQ_FATAL_TEST_MACRO
#define UQ_FATAL_TEST_MACRO(test, givenRank, where, what)
Definition: Defines.h:223
QUESO::BaseVectorRV::m_pdf
BaseJointPdf< V, M > * m_pdf
Definition: VectorRV.h:115
template<class V, class M>
virtual void QUESO::BaseVectorRV< V, M >::print ( std::ostream &  os) const
pure virtual

TODO: Prints the vector RV.

Todo:
: implement me!

Implemented in QUESO::GaussianVectorRV< V, M >, QUESO::GaussianVectorRV< Q_V, Q_M >, QUESO::GenericVectorRV< V, M >, QUESO::GenericVectorRV< P_V, P_M >, QUESO::GenericVectorRV< Q_V, Q_M >, QUESO::InvLogitGaussianVectorRV< V, M >, QUESO::BetaVectorRV< V, M >, QUESO::GammaVectorRV< V, M >, QUESO::InverseGammaVectorRV< V, M >, QUESO::ConcatenatedVectorRV< V, M >, QUESO::LogNormalVectorRV< V, M >, QUESO::WignerVectorRV< V, M >, QUESO::UniformVectorRV< V, M >, and QUESO::JeffreysVectorRV< V, M >.

template<class V , class M >
const BaseVectorRealizer< V, M > & QUESO::BaseVectorRV< V, M >::realizer ( ) const

Finds a realization (sample) of the PDF of this vector RV; access to private attribute m_realizer.

Definition at line 98 of file VectorRV.C.

References UQ_FATAL_TEST_MACRO.

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(), QUESO::GenericVectorRV< V, M >::GenericVectorRV(), and QUESO::MonteCarloSG< P_V, P_M, Q_V, Q_M >::internGenerateSequence().

99 {
100  UQ_FATAL_TEST_MACRO(m_realizer == NULL,
101  m_env.worldRank(),
102  (std::string)("BaseVectorRV<V,M>::realizer(), prefix=")+m_prefix,
103  "m_realizer is NULL");
104 
105  return *m_realizer;
106 }
QUESO::BaseEnvironment::worldRank
int worldRank() const
Returns the process world rank.
Definition: Environment.C:235
QUESO::BaseVectorRV::m_env
const BaseEnvironment & m_env
Definition: VectorRV.h:112
QUESO::BaseVectorRV::m_realizer
BaseVectorRealizer< V, M > * m_realizer
Definition: VectorRV.h:116
UQ_FATAL_TEST_MACRO
#define UQ_FATAL_TEST_MACRO(test, givenRank, where, what)
Definition: Defines.h:223
QUESO::BaseVectorRV::m_prefix
std::string m_prefix
Definition: VectorRV.h:113
template<class V , class M >
const BaseVectorCdf< V, M > & QUESO::BaseVectorRV< V, M >::subCdf ( ) const

Finds the Cumulative Distribution Function of this vector RV, considering only the sub-sequence of data; access to private attribute m_subCdf.

Definition at line 110 of file VectorRV.C.

References UQ_FATAL_TEST_MACRO.

Referenced by QUESO::GenericVectorRV< V, M >::GenericVectorRV().

111 {
112  UQ_FATAL_TEST_MACRO(m_subCdf == NULL,
113  m_env.worldRank(),
114  (std::string)("BaseVectorRV<V,M>::subCdf(), prefix=")+m_prefix,
115  "m_subCdf is NULL");
116 
117  return *m_subCdf;
118 }
QUESO::BaseEnvironment::worldRank
int worldRank() const
Returns the process world rank.
Definition: Environment.C:235
QUESO::BaseVectorRV::m_env
const BaseEnvironment & m_env
Definition: VectorRV.h:112
QUESO::BaseVectorRV::m_subCdf
const BaseVectorCdf< V, M > * m_subCdf
Definition: VectorRV.h:117
UQ_FATAL_TEST_MACRO
#define UQ_FATAL_TEST_MACRO(test, givenRank, where, what)
Definition: Defines.h:223
QUESO::BaseVectorRV::m_prefix
std::string m_prefix
Definition: VectorRV.h:113
template<class V , class M >
const BaseVectorCdf< V, M > & QUESO::BaseVectorRV< V, M >::unifiedCdf ( ) const

Finds the Cumulative Distribution Function of this vector RV, considering the unified sequence of data; access to private attribute m_unifiedCdf.

Definition at line 122 of file VectorRV.C.

References UQ_FATAL_TEST_MACRO.

Referenced by QUESO::GenericVectorRV< V, M >::GenericVectorRV().

123 {
124  UQ_FATAL_TEST_MACRO(m_unifiedCdf == NULL,
125  m_env.worldRank(),
126  (std::string)("BaseVectorRV<V,M>::unifiedCdf(), prefix=")+m_prefix,
127  "m_unifiedCdf is NULL");
128 
129  return *m_unifiedCdf;
130 }
QUESO::BaseVectorRV::m_unifiedCdf
const BaseVectorCdf< V, M > * m_unifiedCdf
Definition: VectorRV.h:118
QUESO::BaseEnvironment::worldRank
int worldRank() const
Returns the process world rank.
Definition: Environment.C:235
QUESO::BaseVectorRV::m_env
const BaseEnvironment & m_env
Definition: VectorRV.h:112
UQ_FATAL_TEST_MACRO
#define UQ_FATAL_TEST_MACRO(test, givenRank, where, what)
Definition: Defines.h:223
QUESO::BaseVectorRV::m_prefix
std::string m_prefix
Definition: VectorRV.h:113

Friends And Related Function Documentation

template<class V, class M>
std::ostream& operator<< ( std::ostream &  os,
const BaseVectorRV< V, M > &  obj 
)
friend

Definition at line 95 of file VectorRV.h.

96  {
97  obj.print(os);
98  return os;
99  }

Member Data Documentation

template<class V, class M>
const BaseEnvironment& QUESO::BaseVectorRV< V, M >::m_env
protected

Definition at line 112 of file VectorRV.h.

Referenced by QUESO::BaseVectorRV< V, M >::BaseVectorRV(), QUESO::BetaVectorRV< V, M >::BetaVectorRV(), QUESO::ConcatenatedVectorRV< V, M >::ConcatenatedVectorRV(), QUESO::GammaVectorRV< V, M >::GammaVectorRV(), QUESO::GaussianVectorRV< V, M >::GaussianVectorRV(), QUESO::GenericVectorRV< V, M >::GenericVectorRV(), QUESO::InverseGammaVectorRV< V, M >::InverseGammaVectorRV(), QUESO::InvLogitGaussianVectorRV< V, M >::InvLogitGaussianVectorRV(), QUESO::JeffreysVectorRV< V, M >::JeffreysVectorRV(), QUESO::LogNormalVectorRV< V, M >::LogNormalVectorRV(), QUESO::UniformVectorRV< V, M >::UniformVectorRV(), and QUESO::WignerVectorRV< V, M >::WignerVectorRV().

template<class V, class M>
const VectorSet<V,M>& QUESO::BaseVectorRV< V, M >::m_imageSet
protected

Definition at line 114 of file VectorRV.h.

Referenced by QUESO::BetaVectorRV< V, M >::BetaVectorRV(), QUESO::ConcatenatedVectorRV< V, M >::ConcatenatedVectorRV(), QUESO::GammaVectorRV< V, M >::GammaVectorRV(), QUESO::GaussianVectorRV< V, M >::GaussianVectorRV(), QUESO::InverseGammaVectorRV< V, M >::InverseGammaVectorRV(), QUESO::InvLogitGaussianVectorRV< V, M >::InvLogitGaussianVectorRV(), QUESO::JeffreysVectorRV< V, M >::JeffreysVectorRV(), QUESO::LogNormalVectorRV< V, M >::LogNormalVectorRV(), QUESO::UniformVectorRV< V, M >::UniformVectorRV(), and QUESO::WignerVectorRV< V, M >::WignerVectorRV().

template<class V, class M>
const BaseVectorMdf<V,M>* QUESO::BaseVectorRV< V, M >::m_mdf
protected

Definition at line 119 of file VectorRV.h.

Referenced by QUESO::BetaVectorRV< V, M >::BetaVectorRV(), QUESO::ConcatenatedVectorRV< V, M >::ConcatenatedVectorRV(), QUESO::GammaVectorRV< V, M >::GammaVectorRV(), QUESO::GaussianVectorRV< V, M >::GaussianVectorRV(), QUESO::GenericVectorRV< V, M >::GenericVectorRV(), QUESO::InverseGammaVectorRV< V, M >::InverseGammaVectorRV(), QUESO::InvLogitGaussianVectorRV< V, M >::InvLogitGaussianVectorRV(), QUESO::JeffreysVectorRV< V, M >::JeffreysVectorRV(), QUESO::LogNormalVectorRV< V, M >::LogNormalVectorRV(), QUESO::UniformVectorRV< V, M >::UniformVectorRV(), and QUESO::WignerVectorRV< V, M >::WignerVectorRV().

template<class V, class M>
BaseJointPdf<V,M>* QUESO::BaseVectorRV< V, M >::m_pdf
protected

Definition at line 115 of file VectorRV.h.

Referenced by QUESO::BetaVectorRV< V, M >::BetaVectorRV(), QUESO::ConcatenatedVectorRV< V, M >::ConcatenatedVectorRV(), QUESO::GammaVectorRV< V, M >::GammaVectorRV(), QUESO::GaussianVectorRV< V, M >::GaussianVectorRV(), QUESO::GenericVectorRV< V, M >::GenericVectorRV(), QUESO::InverseGammaVectorRV< V, M >::InverseGammaVectorRV(), QUESO::InvLogitGaussianVectorRV< V, M >::InvLogitGaussianVectorRV(), QUESO::JeffreysVectorRV< V, M >::JeffreysVectorRV(), QUESO::LogNormalVectorRV< V, M >::LogNormalVectorRV(), QUESO::UniformVectorRV< V, M >::UniformVectorRV(), and QUESO::WignerVectorRV< V, M >::WignerVectorRV().

template<class V, class M>
std::string QUESO::BaseVectorRV< V, M >::m_prefix
protected

Definition at line 113 of file VectorRV.h.

Referenced by QUESO::BaseVectorRV< V, M >::BaseVectorRV(), QUESO::BetaVectorRV< V, M >::BetaVectorRV(), QUESO::ConcatenatedVectorRV< V, M >::ConcatenatedVectorRV(), QUESO::GammaVectorRV< V, M >::GammaVectorRV(), QUESO::GaussianVectorRV< V, M >::GaussianVectorRV(), QUESO::GenericVectorRV< V, M >::GenericVectorRV(), QUESO::InverseGammaVectorRV< V, M >::InverseGammaVectorRV(), QUESO::InvLogitGaussianVectorRV< V, M >::InvLogitGaussianVectorRV(), QUESO::JeffreysVectorRV< V, M >::JeffreysVectorRV(), QUESO::LogNormalVectorRV< V, M >::LogNormalVectorRV(), QUESO::UniformVectorRV< V, M >::UniformVectorRV(), and QUESO::WignerVectorRV< V, M >::WignerVectorRV().

template<class V, class M>
BaseVectorRealizer<V,M>* QUESO::BaseVectorRV< V, M >::m_realizer
protected

Definition at line 116 of file VectorRV.h.

Referenced by QUESO::BetaVectorRV< V, M >::BetaVectorRV(), QUESO::ConcatenatedVectorRV< V, M >::ConcatenatedVectorRV(), QUESO::GammaVectorRV< V, M >::GammaVectorRV(), QUESO::GaussianVectorRV< V, M >::GaussianVectorRV(), QUESO::GenericVectorRV< V, M >::GenericVectorRV(), QUESO::InverseGammaVectorRV< V, M >::InverseGammaVectorRV(), QUESO::InvLogitGaussianVectorRV< V, M >::InvLogitGaussianVectorRV(), QUESO::JeffreysVectorRV< V, M >::JeffreysVectorRV(), QUESO::LogNormalVectorRV< V, M >::LogNormalVectorRV(), QUESO::UniformVectorRV< V, M >::UniformVectorRV(), and QUESO::WignerVectorRV< V, M >::WignerVectorRV().

template<class V, class M>
const BaseVectorCdf<V,M>* QUESO::BaseVectorRV< V, M >::m_subCdf
protected

Definition at line 117 of file VectorRV.h.

Referenced by QUESO::BetaVectorRV< V, M >::BetaVectorRV(), QUESO::ConcatenatedVectorRV< V, M >::ConcatenatedVectorRV(), QUESO::GammaVectorRV< V, M >::GammaVectorRV(), QUESO::GaussianVectorRV< V, M >::GaussianVectorRV(), QUESO::GenericVectorRV< V, M >::GenericVectorRV(), QUESO::InverseGammaVectorRV< V, M >::InverseGammaVectorRV(), QUESO::InvLogitGaussianVectorRV< V, M >::InvLogitGaussianVectorRV(), QUESO::JeffreysVectorRV< V, M >::JeffreysVectorRV(), QUESO::LogNormalVectorRV< V, M >::LogNormalVectorRV(), QUESO::UniformVectorRV< V, M >::UniformVectorRV(), and QUESO::WignerVectorRV< V, M >::WignerVectorRV().

template<class V, class M>
const BaseVectorCdf<V,M>* QUESO::BaseVectorRV< V, M >::m_unifiedCdf
protected

Definition at line 118 of file VectorRV.h.

Referenced by QUESO::BetaVectorRV< V, M >::BetaVectorRV(), QUESO::ConcatenatedVectorRV< V, M >::ConcatenatedVectorRV(), QUESO::GammaVectorRV< V, M >::GammaVectorRV(), QUESO::GaussianVectorRV< V, M >::GaussianVectorRV(), QUESO::GenericVectorRV< V, M >::GenericVectorRV(), QUESO::InverseGammaVectorRV< V, M >::InverseGammaVectorRV(), QUESO::InvLogitGaussianVectorRV< V, M >::InvLogitGaussianVectorRV(), QUESO::JeffreysVectorRV< V, M >::JeffreysVectorRV(), QUESO::LogNormalVectorRV< V, M >::LogNormalVectorRV(), QUESO::UniformVectorRV< V, M >::UniformVectorRV(), and QUESO::WignerVectorRV< V, M >::WignerVectorRV().

The documentation for this class was generated from the following files:
Generated on Thu Apr 23 2015 19:26:19 for queso-0.51.1 by  doxygen 1.8.5