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

A class for handling sampled vector MDFs. More...

#include <SampledVectorMdf.h>

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

Public Member Functions

Constructor/Destructor methods
 SampledVectorMdf (const char *prefix, const ArrayOfOneDGrids< V, M > &oneDGrids, const ArrayOfOneDTables< V, M > &mdfValues)
 Default constructor. More...
 
 ~SampledVectorMdf ()
 Destructor. More...
 
Mathematical methods
void values (const V &paramValues, V &mdfVec) const
 TODO: Returns the values of the vector MDF at each element of paramValues. More...
 
I/O methods
void print (std::ostream &os) const
 Prints the vector MDF (values of the grid points and of the MDF at such grid points). 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 Attributes

const ArrayOfOneDGrids< V, M > & m_oneDGrids
 
const ArrayOfOneDTables< V, M > & m_mdfValues
 
- 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::SampledVectorMdf< V, M >

A class for handling sampled vector MDFs.

This class implements a sampled vector marginal density function (MDF), given the grid points where it will be sampled and it returns its values.

Definition at line 50 of file SampledVectorMdf.h.

Constructor & Destructor Documentation

template<class V , class M >
QUESO::SampledVectorMdf< V, M >::SampledVectorMdf ( const char *  prefix,
const ArrayOfOneDGrids< V, M > &  oneDGrids,
const ArrayOfOneDTables< V, M > &  mdfValues 
)

Default constructor.

Instantiates an object of the class given a prefix and the grid points where it will be sampled/evaluated.

Definition at line 31 of file SampledVectorMdf.C.

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

35  :
36  BaseVectorMdf<V,M>(prefix,oneDGrids.rowSpace()),
37  m_oneDGrids(oneDGrids),
38  m_mdfValues(mdfValues)
39 {
40  if ((m_env.subDisplayFile()) && (m_env.displayVerbosity() >= 5)) {
41  *m_env.subDisplayFile() << "Entering SampledVectorMdf<V,M>::constructor()"
42  << ": prefix = " << m_prefix
43  << std::endl;
44  }
45 
46  if ((m_env.subDisplayFile()) && (m_env.displayVerbosity() >= 5)) {
47  *m_env.subDisplayFile() << "Leaving SampledVectorMdf<V,M>::constructor()"
48  << ": prefix = " << m_prefix
49  << std::endl;
50  }
51 }
std::string m_prefix
Definition: VectorMdf.h:83
const BaseEnvironment & m_env
Definition: VectorMdf.h:82
const ArrayOfOneDTables< V, M > & m_mdfValues
const ArrayOfOneDGrids< V, M > & m_oneDGrids
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::SampledVectorMdf< V, M >::~SampledVectorMdf ( )

Destructor.

Definition at line 54 of file SampledVectorMdf.C.

55 {
56 }

Member Function Documentation

template<class V , class M >
void QUESO::SampledVectorMdf< V, M >::print ( std::ostream &  os) const
virtual

Prints the vector MDF (values of the grid points and of the MDF at such grid points).

Implements QUESO::BaseVectorMdf< V, M >.

Definition at line 70 of file SampledVectorMdf.C.

71 {
72  // Print values *of* grid points
73  os << m_oneDGrids;
74 
75  // Print *mdf* values *at* grid points
76  os << m_mdfValues;
77 
78  return;
79 }
const ArrayOfOneDTables< V, M > & m_mdfValues
const ArrayOfOneDGrids< V, M > & m_oneDGrids
template<class V , class M >
void QUESO::SampledVectorMdf< V, M >::values ( const V &  paramValues,
V &  mdfVec 
) const
virtual

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

Todo:
: implement me!

Implements QUESO::BaseVectorMdf< V, M >.

Definition at line 60 of file SampledVectorMdf.C.

63 {
64  queso_error_msg("incomplete code");
65  return;
66 }

Member Data Documentation

template<class V = GslVector, class M = GslMatrix>
const ArrayOfOneDTables<V,M>& QUESO::SampledVectorMdf< V, M >::m_mdfValues
protected

Definition at line 83 of file SampledVectorMdf.h.

template<class V = GslVector, class M = GslMatrix>
const ArrayOfOneDGrids<V,M>& QUESO::SampledVectorMdf< V, M >::m_oneDGrids
protected

Definition at line 82 of file SampledVectorMdf.h.


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

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