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

A templated (base) class for handling MDFs of vector functions. More...

#include <VectorMdf.h>

Inheritance diagram for QUESO::BaseVectorMdf< V, M >:
QUESO::GaussianVectorMdf< V, M > QUESO::GenericVectorMdf< V, M > QUESO::SampledVectorMdf< V, M >

Public Member Functions

Constructor/Destructor methods
 BaseVectorMdf (const char *prefix, const VectorSet< V, M > &domainSet)
 Default constructor. More...
 
virtual ~BaseVectorMdf ()
 Virtual destructor. More...
 
Mathematical methods
const VectorSet< V, M > & domainSet () const
 Returns the domain set; access to protected attribute m_domainSet. More...
 
virtual void values (const V &paramValues, V &mdfVec) const =0
 Finds the value of the vector MDF at each element of paramValue, and saves it in mdfVec. See template specialization. More...
 
I/O methods
virtual void print (std::ostream &os) const =0
 Prints the vector MDF. See template specialization. More...
 

Protected Attributes

const BaseEnvironmentm_env
 
std::string m_prefix
 
const VectorSet< V, M > & m_domainSet
 

Detailed Description

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

A templated (base) class for handling MDFs of vector functions.

To obtain the marginal distribution over a subset of multivariate (vector) RVs, one only needs to drop the irrelevant variables (the variables that one wants to marginalize out). If X is a Random Vector which contains the continuous random variables \( X_1, X_2, ..., X_n \). Then each \( X_i \) is a continuous random variable with its own Probability Distribution called the marginal distribution of \( X_i \). This class handles MDFs of a vector RV.

Definition at line 52 of file VectorMdf.h.

Constructor & Destructor Documentation

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

Default constructor.

Instantiates an object of the class given a prefix and domain set of the MDF.

Definition at line 31 of file VectorMdf.C.

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

34  :
35  m_env (domainSet.env()),
36  m_prefix ((std::string)(prefix)+"Mdf_"),
38 {
39  if ((m_env.subDisplayFile()) && (m_env.displayVerbosity() >= 5)) {
40  *m_env.subDisplayFile() << "Entering BaseVectorMdf<V,M>::constructor()"
41  << ": prefix = " << m_prefix
42  << std::endl;
43  }
44 
45  if ((m_env.subDisplayFile()) && (m_env.displayVerbosity() >= 5)) {
46  *m_env.subDisplayFile() << "Leaving BaseVectorMdf<V,M>::constructor()"
47  << ": prefix = " << m_prefix
48  << std::endl;
49  }
50 }
std::string m_prefix
Definition: VectorMdf.h:83
const BaseEnvironment & m_env
Definition: VectorMdf.h:82
const VectorSet< V, M > & m_domainSet
Definition: VectorMdf.h:84
const VectorSet< V, M > & domainSet() const
Returns the domain set; access to protected attribute m_domainSet.
Definition: VectorMdf.C:59
unsigned int displayVerbosity() const
Definition: Environment.C:450
std::ofstream * subDisplayFile() const
Access function for m_subDisplayFile (displays file on stream).
Definition: Environment.C:320
template<class V , class M >
QUESO::BaseVectorMdf< V, M >::~BaseVectorMdf ( )
virtual

Virtual destructor.

Definition at line 53 of file VectorMdf.C.

54 {
55 }

Member Function Documentation

template<class V , class M >
const VectorSet< V, M > & QUESO::BaseVectorMdf< V, M >::domainSet ( ) const

Returns the domain set; access to protected attribute m_domainSet.

Definition at line 59 of file VectorMdf.C.

60 {
61  return m_domainSet;
62 }
const VectorSet< V, M > & m_domainSet
Definition: VectorMdf.h:84
template<class V = GslVector, class M = GslMatrix>
virtual void QUESO::BaseVectorMdf< V, M >::print ( std::ostream &  os) const
pure virtual

Prints the vector MDF. See template specialization.

Implemented in QUESO::GaussianVectorMdf< V, M >, QUESO::SampledVectorMdf< V, M >, and QUESO::GenericVectorMdf< V, M >.

template<class V = GslVector, class M = GslMatrix>
virtual void QUESO::BaseVectorMdf< V, M >::values ( const V &  paramValues,
V &  mdfVec 
) const
pure virtual

Finds the value of the vector MDF at each element of paramValue, and saves it in mdfVec. See template specialization.

Implemented in QUESO::GaussianVectorMdf< V, M >, QUESO::SampledVectorMdf< V, M >, and QUESO::GenericVectorMdf< V, M >.

Member Data Documentation

template<class V = GslVector, class M = GslMatrix>
const VectorSet<V,M>& QUESO::BaseVectorMdf< V, M >::m_domainSet
protected

Definition at line 84 of file VectorMdf.h.

template<class V = GslVector, class M = GslMatrix>
const BaseEnvironment& QUESO::BaseVectorMdf< V, M >::m_env
protected
template<class V = GslVector, class M = GslMatrix>
std::string QUESO::BaseVectorMdf< V, M >::m_prefix
protected

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

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