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

TODO: A class for handling Gaussian MDFs. More...

#include <GaussianVectorMdf.h>

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

Public Member Functions

Constructor/Destructor methods
 GaussianVectorMdf (const char *prefix, const VectorSet< V, M > &domainSet, const V &domainExpectedValues, const V &domainVarianceValues)
 TODO: Constructor. More...
 
 GaussianVectorMdf (const char *prefix, const VectorSet< V, M > &domainSet, const V &domainExpectedValues, const M &covMatrix)
 TODO: Constructor. More...
 
 ~GaussianVectorMdf ()
 Destructor. More...
 
Mathematical method
void values (const V &paramValues, V &mdfVec) const
 TODO: Returns the values of the vector CDF at each element of paramValues. More...
 
I/O method
void print (std::ostream &os) const
 TODO: Prints the vector CDF. More...
 
- Public Member Functions inherited from QUESO::BaseVectorMdf< V, M >
 BaseVectorMdf (const char *prefix, const VectorSet< V, M > &domainSet)
 Default constructor. More...
 
virtual ~BaseVectorMdf ()
 Virtual destructor. More...
 
const VectorSet< V, M > & domainSet () const
 Returns the domain set; access to protected attribute m_domainSet. More...
 

Protected Member Functions

void commonConstructor ()
 

Protected Attributes

const M * m_covMatrix
 
- Protected Attributes inherited from QUESO::BaseVectorMdf< V, M >
const BaseEnvironmentm_env
 
std::string m_prefix
 
const VectorSet< V, M > & m_domainSet
 

Detailed Description

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

TODO: A class for handling Gaussian MDFs.

This class will implement a Gaussian vector marginal density function function (MDF).

Todo:
: Implement me!

Definition at line 50 of file GaussianVectorMdf.h.

Constructor & Destructor Documentation

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

TODO: Constructor.

Todo:
: implement me! This method calls commonConstructor() which is not yet implemented. Instantiates an object of the class given a prefix, the domain set, and the domain mean and expected values.

Definition at line 31 of file GaussianVectorMdf.C.

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

36  :
37  BaseVectorMdf<V,M>(prefix,domainSet),
38  m_covMatrix (m_domainSet.newDiagMatrix(domainVarianceValues*domainVarianceValues))
39 {
40  if ((m_env.subDisplayFile()) && (m_env.displayVerbosity() >= 5)) {
41  *m_env.subDisplayFile() << "Entering GaussianVectorMdf<V,M>::constructor() [1]"
42  << ": prefix = " << m_prefix
43  << std::endl;
44  }
45 
47 
48  if ((m_env.subDisplayFile()) && (m_env.displayVerbosity() >= 5)) {
49  *m_env.subDisplayFile() << "Leaving GaussianVectorMdf<V,M>::constructor() [1]"
50  << ": prefix = " << m_prefix
51  << std::endl;
52  }
53 }
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::GaussianVectorMdf< V, M >::GaussianVectorMdf ( const char *  prefix,
const VectorSet< V, M > &  domainSet,
const V &  domainExpectedValues,
const M &  covMatrix 
)

TODO: Constructor.

Todo:
: implement me! This method calls commonConstructor() which is not yet implemented. Instantiates an object of the class given a prefix, the domain set, and the domain mean and covariance matrix.

Definition at line 56 of file GaussianVectorMdf.C.

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

61  :
62  BaseVectorMdf<V,M>(prefix,domainSet),
63  m_covMatrix (new M(covMatrix))
64 {
65  if ((m_env.subDisplayFile()) && (m_env.displayVerbosity() >= 5)) {
66  *m_env.subDisplayFile() << "Entering GaussianVectorMdf<V,M>::constructor() [2]"
67  << ": prefix = " << m_prefix
68  << std::endl;
69  }
70 
72 
73  if ((m_env.subDisplayFile()) && (m_env.displayVerbosity() >= 5)) {
74  *m_env.subDisplayFile() << "Leaving GaussianVectorMdf<V,M>::constructor() [2]"
75  << ": prefix = " << m_prefix
76  << std::endl;
77  }
78 }
std::string m_prefix
Definition: VectorMdf.h:83
const BaseEnvironment & m_env
Definition: VectorMdf.h:82
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::GaussianVectorMdf< V, M >::~GaussianVectorMdf ( )

Destructor.

Definition at line 81 of file GaussianVectorMdf.C.

82 {
83  delete m_covMatrix;
84 }

Member Function Documentation

template<class V , class M >
void QUESO::GaussianVectorMdf< V, M >::commonConstructor ( )
protected

Definition at line 105 of file GaussianVectorMdf.C.

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

106 {
107  queso_error_msg("incomplete code");
108  return;
109 }
template<class V , class M >
void QUESO::GaussianVectorMdf< V, M >::print ( std::ostream &  os) const
virtual

TODO: Prints the vector CDF.

Todo:
: implement me!

Implements QUESO::BaseVectorMdf< V, M >.

Definition at line 98 of file GaussianVectorMdf.C.

99 {
100  return;
101 }
template<class V , class M >
void QUESO::GaussianVectorMdf< V, M >::values ( const V &  paramValues,
V &  mdfVec 
) const
virtual

TODO: Returns the values of the vector CDF at each element of paramValues.

Todo:
: implement me!

Implements QUESO::BaseVectorMdf< V, M >.

Definition at line 88 of file GaussianVectorMdf.C.

91 {
92  queso_error_msg("incomplete code");
93  return;
94 }

Member Data Documentation

template<class V = GslVector, class M = GslMatrix>
const M* QUESO::GaussianVectorMdf< V, M >::m_covMatrix
protected

Definition at line 89 of file GaussianVectorMdf.h.


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

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