queso-0.55.0
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 = GslVector, class M = GslMatrix>
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 54 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 36 of file VectorRV.C.

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

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

Virtual destructor.

Definition at line 63 of file VectorRV.C.

64 {
65  //if (m_mdf ) delete m_mdf;
66  //if (m_subCdf ) delete m_subCdf;
67  //if (m_unifiedCdf) delete m_unifiedCdf;
68  //if (m_realizer ) delete m_realizer;
69  //if (m_pdf ) delete m_pdf;
70 }

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 75 of file VectorRV.C.

76 {
77  return m_env;
78 }
QUESO::BaseVectorRV::m_env
const BaseEnvironment & m_env
Definition: VectorRV.h:115
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 82 of file VectorRV.C.

Referenced by QUESO::BetaVectorRV< V, M >::BetaVectorRV(), QUESO::ComputeCovCorrMatricesBetweenVectorRvs(), QUESO::GammaVectorRV< V, M >::GammaVectorRV(), QUESO::GcmTotalInfo< S_V, S_M, D_V, D_M, P_V, P_M, Q_V, Q_M >::initializeTotalDim(), QUESO::InverseGammaVectorRV< V, M >::InverseGammaVectorRV(), QUESO::LogNormalVectorRV< V, M >::LogNormalVectorRV(), and QUESO::StatisticalInverseProblem< P_V, P_M >::StatisticalInverseProblem().

83 {
84  return m_imageSet;
85 }
QUESO::BaseVectorRV::m_imageSet
const VectorSet< V, M > & m_imageSet
Definition: VectorRV.h:117
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 125 of file VectorRV.C.

References queso_require_msg.

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

126 {
127  queso_require_msg(m_mdf, "m_mdf is NULL");
128 
129  return *m_mdf;
130 }
queso_require_msg
#define queso_require_msg(asserted, msg)
Definition: asserts.h:69
QUESO::BaseVectorRV::m_mdf
const BaseVectorMdf< V, M > * m_mdf
Definition: VectorRV.h:122
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 89 of file VectorRV.C.

References queso_require_msg.

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

90 {
91  queso_require_msg(m_pdf, "m_pdf is NULL");
92 
93  return *m_pdf;
94 }
queso_require_msg
#define queso_require_msg(asserted, msg)
Definition: asserts.h:69
QUESO::BaseVectorRV::m_pdf
BaseJointPdf< V, M > * m_pdf
Definition: VectorRV.h:118
template<class V = GslVector, class M = GslMatrix>
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::BetaVectorRV< P_V, P_M >, QUESO::GammaVectorRV< V, M >, QUESO::GammaVectorRV< P_V, P_M >, QUESO::InverseGammaVectorRV< V, M >, QUESO::ConcatenatedVectorRV< V, M >, QUESO::ConcatenatedVectorRV< P_V, P_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 queso_require_msg.

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  queso_require_msg(m_realizer, "m_realizer is NULL");
101 
102  return *m_realizer;
103 }
queso_require_msg
#define queso_require_msg(asserted, msg)
Definition: asserts.h:69
QUESO::BaseVectorRV::m_realizer
BaseVectorRealizer< V, M > * m_realizer
Definition: VectorRV.h:119
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 107 of file VectorRV.C.

References queso_require_msg.

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

108 {
109  queso_require_msg(m_subCdf, "m_subCdf is NULL");
110 
111  return *m_subCdf;
112 }
queso_require_msg
#define queso_require_msg(asserted, msg)
Definition: asserts.h:69
QUESO::BaseVectorRV::m_subCdf
const BaseVectorCdf< V, M > * m_subCdf
Definition: VectorRV.h:120
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 116 of file VectorRV.C.

References queso_require_msg.

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

117 {
118  queso_require_msg(m_unifiedCdf, "m_unifiedCdf is NULL");
119 
120  return *m_unifiedCdf;
121 }
queso_require_msg
#define queso_require_msg(asserted, msg)
Definition: asserts.h:69
QUESO::BaseVectorRV::m_unifiedCdf
const BaseVectorCdf< V, M > * m_unifiedCdf
Definition: VectorRV.h:121

Friends And Related Function Documentation

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

Definition at line 98 of file VectorRV.h.

99  {
100  obj.print(os);
101  return os;
102  }

Member Data Documentation

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

Definition at line 115 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 = GslVector, class M = GslMatrix>
const VectorSet<V,M>& QUESO::BaseVectorRV< V, M >::m_imageSet
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::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 = GslVector, class M = GslMatrix>
const BaseVectorMdf<V,M>* QUESO::BaseVectorRV< V, M >::m_mdf
protected

Definition at line 122 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 = GslVector, class M = GslMatrix>
BaseJointPdf<V,M>* QUESO::BaseVectorRV< V, M >::m_pdf
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().

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

Definition at line 116 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 = GslVector, class M = GslMatrix>
BaseVectorRealizer<V,M>* QUESO::BaseVectorRV< V, M >::m_realizer
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 = GslVector, class M = GslMatrix>
const BaseVectorCdf<V,M>* QUESO::BaseVectorRV< V, M >::m_subCdf
protected

Definition at line 120 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 = GslVector, class M = GslMatrix>
const BaseVectorCdf<V,M>* QUESO::BaseVectorRV< V, M >::m_unifiedCdf
protected

Definition at line 121 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 Fri Jun 17 2016 14:17:46 for queso-0.55.0 by  doxygen 1.8.5