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

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

#include <GaussianVectorCdf.h>

Inheritance diagram for QUESO::GaussianVectorCdf< V, M >:
QUESO::BaseVectorCdf< V, M >

Public Member Functions

Constructor/Destructor methods
 GaussianVectorCdf (const char *prefix, const VectorSet< V, M > &pdfSupport, const V &domainExpectedValues, const V &domainVarianceValues)
 TODO: Constructor. More...
 
 GaussianVectorCdf (const char *prefix, const VectorSet< V, M > &pdfSupport, const V &domainExpectedValues, const M &covMatrix)
 TODO: Constructor. More...
 
 ~GaussianVectorCdf ()
 
Mathematical method
void values (const V &paramValues, V &cdfVec) 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::BaseVectorCdf< V, M >
 BaseVectorCdf (const char *prefix, const VectorSet< V, M > &pdfSupport)
 Default constructor. More...
 
virtual ~BaseVectorCdf ()
 Virtual destructor. More...
 
const VectorSet< V, M > & pdfSupport () const
 Returns the image set (support) of the PDF; access to protected attribute m_pdfSupport. More...
 
virtual const BaseScalarCdf
< double > & 
cdf (unsigned int rowId) const =0
 
virtual void subWriteContents (const std::string &varNamePrefix, const std::string &fileName, const std::string &fileType, const std::set< unsigned int > &allowedSubEnvIds) const
 Writes the CDF of an allowed sub-environment to a file. More...
 

Protected Member Functions

void commonConstructor ()
 A common constructor to be used both class constructors. More...
 

Protected Attributes

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

Detailed Description

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

TODO: A class for handling Gaussian CDFs.

This class will implement a Gaussian vector cumulative distribution function (CDF).

Todo:
: Implement me!

Definition at line 51 of file GaussianVectorCdf.h.

Constructor & Destructor Documentation

template<class V , class M >
QUESO::GaussianVectorCdf< V, M >::GaussianVectorCdf ( const char *  prefix,
const VectorSet< V, M > &  pdfSupport,
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 support of the related-PDF, and the domain mean and expected values.

Definition at line 31 of file GaussianVectorCdf.C.

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

36  :
37  BaseVectorCdf<V,M>(prefix,pdfSupport),
38  m_covMatrix (m_pdfSupport.newDiagMatrix(domainVarianceValues*domainVarianceValues))
39 {
40  if ((m_env.subDisplayFile()) && (m_env.displayVerbosity() >= 5)) {
41  *m_env.subDisplayFile() << "Entering GaussianVectorCdf<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 GaussianVectorCdf<V,M>::constructor() [1]"
50  << ": prefix = " << m_prefix
51  << std::endl;
52  }
53 }
std::string m_prefix
Definition: VectorCdf.h:99
const VectorSet< V, M > & m_pdfSupport
Definition: VectorCdf.h:100
const BaseEnvironment & m_env
Definition: VectorCdf.h:98
const VectorSet< V, M > & pdfSupport() const
Returns the image set (support) of the PDF; access to protected attribute m_pdfSupport.
Definition: VectorCdf.C:59
void commonConstructor()
A common constructor to be used both class constructors.
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::GaussianVectorCdf< V, M >::GaussianVectorCdf ( const char *  prefix,
const VectorSet< V, M > &  pdfSupport,
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 support of the related-PDF, and the domain mean values and covariance matrix.

Definition at line 56 of file GaussianVectorCdf.C.

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

61  :
62  BaseVectorCdf<V,M>(prefix,pdfSupport),
63  m_covMatrix (new M(covMatrix))
64 {
65  if ((m_env.subDisplayFile()) && (m_env.displayVerbosity() >= 5)) {
66  *m_env.subDisplayFile() << "Entering GaussianVectorCdf<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 GaussianVectorCdf<V,M>::constructor() [2]"
75  << ": prefix = " << m_prefix
76  << std::endl;
77  }
78 }
std::string m_prefix
Definition: VectorCdf.h:99
const BaseEnvironment & m_env
Definition: VectorCdf.h:98
const VectorSet< V, M > & pdfSupport() const
Returns the image set (support) of the PDF; access to protected attribute m_pdfSupport.
Definition: VectorCdf.C:59
void commonConstructor()
A common constructor to be used both class constructors.
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::GaussianVectorCdf< V, M >::~GaussianVectorCdf ( )

Definition at line 81 of file GaussianVectorCdf.C.

82 {
83  delete m_covMatrix;
84 }

Member Function Documentation

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

A common constructor to be used both class constructors.

Definition at line 106 of file GaussianVectorCdf.C.

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

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

TODO: Prints the vector CDF.

Todo:
: implement me!

Implements QUESO::BaseVectorCdf< V, M >.

Definition at line 98 of file GaussianVectorCdf.C.

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

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

Todo:
: implement me!

Implements QUESO::BaseVectorCdf< V, M >.

Definition at line 88 of file GaussianVectorCdf.C.

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

Member Data Documentation

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

Definition at line 91 of file GaussianVectorCdf.h.


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

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