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 >:

Collaboration diagram for QUESO::SampledVectorMdf< 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 BaseEnvironment &	m_env
std::string	m_prefix
const VectorSet< V, M > &	m_domainSet

Detailed Description

template<class V, class M>
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 47 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().

  :
  BaseVectorMdf<V,M>(prefix,oneDGrids.rowSpace()),
  m_oneDGrids(oneDGrids),
  m_mdfValues(mdfValues)
{
  if ((m_env.subDisplayFile()) && (m_env.displayVerbosity() >= 5)) {
    *m_env.subDisplayFile() << "Entering SampledVectorMdf<V,M>::constructor()"
                           << ": prefix = " << m_prefix
                           << std::endl;
  }

  if ((m_env.subDisplayFile()) && (m_env.displayVerbosity() >= 5)) {
    *m_env.subDisplayFile() << "Leaving SampledVectorMdf<V,M>::constructor()"
                           << ": prefix = " << m_prefix
                           << std::endl;
  }
}

template<class V , class M >

QUESO::SampledVectorMdf< V, M >::~SampledVectorMdf

(

)

Destructor.

Definition at line 54 of file SampledVectorMdf.C.

{
}

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 73 of file SampledVectorMdf.C.

{
  // Print values *of* grid points
  os << m_oneDGrids;

  // Print *mdf* values *at* grid points
  os << m_mdfValues;

  return;
}

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.

References UQ_FATAL_TEST_MACRO.

{
  UQ_FATAL_TEST_MACRO(true,
                      m_env.worldRank(),
                      "SampledVectorMdf<V,M>::mdfVec()",
                      "incomplete code");
  return;
}

Member Data Documentation

template<class V , class M >

const ArrayOfOneDTables<V,M>& QUESO::SampledVectorMdf< V, M >::m_mdfValues

protected

Definition at line 80 of file SampledVectorMdf.h.

template<class V , class M >

const ArrayOfOneDGrids<V,M>& QUESO::SampledVectorMdf< V, M >::m_oneDGrids

protected

Definition at line 79 of file SampledVectorMdf.h.

---

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

• src/stats/inc/SampledVectorMdf.h
• src/stats/src/SampledVectorMdf.C