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

A class for handling generic MDFs of vector functions. More...

#include <GenericVectorMdf.h>

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

Public Member Functions

Constructor/Destructor methods
 GenericVectorMdf (const char *prefix, const VectorSet< V, M > &domainSet, double(*routinePtr)(const V &paramValues, const void *routineDataPtr, V &mdfVec), const void *routineDataPtr)
 Constructor. More...
 
 ~GenericVectorMdf ()
 Destructor. More...
 
Mathematical method
void values (const V &paramValues, V &mdfVec) const
 Finds the values of the vector MDF at each element of paramValues, by calling m_routinePtr, and saves it at mdfValues. More...
 
I/O method
void print (std::ostream &os) const
 TODO: Prints the vector MDF. 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

double(* m_routinePtr )(const V &paramValues, const void *routineDataPtr, V &mdfVec)
 
const void * m_routineDataPtr
 
- 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::GenericVectorMdf< V, M >

A class for handling generic MDFs of vector functions.

Definition at line 46 of file GenericVectorMdf.h.

Constructor & Destructor Documentation

template<class V , class M >
QUESO::GenericVectorMdf< V, M >::GenericVectorMdf ( const char *  prefix,
const VectorSet< V, M > &  domainSet,
double(*)(const V &paramValues, const void *routineDataPtr, V &mdfVec)  routinePtr,
const void *  routineDataPtr 
)

Constructor.

Instantiates an object of the class given a prefix, the domain set, and a routine (acting as a math function).

Definition at line 31 of file GenericVectorMdf.C.

36  :
37  BaseVectorMdf<V,M>(prefix,domainSet),
38  m_routinePtr (routinePtr),
39  m_routineDataPtr(routineDataPtr)
40 {
41 }
const VectorSet< V, M > & domainSet() const
Returns the domain set; access to protected attribute m_domainSet.
Definition: VectorMdf.C:59
double(* m_routinePtr)(const V &paramValues, const void *routineDataPtr, V &mdfVec)
template<class V , class M >
QUESO::GenericVectorMdf< V, M >::~GenericVectorMdf ( )

Destructor.

Definition at line 44 of file GenericVectorMdf.C.

45 {
46 }

Member Function Documentation

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

TODO: Prints the vector MDF.

Todo:
: implement me!

Implements QUESO::BaseVectorMdf< V, M >.

Definition at line 60 of file GenericVectorMdf.C.

61 {
62  return;
63 }
template<class V , class M >
void QUESO::GenericVectorMdf< V, M >::values ( const V &  paramValues,
V &  mdfVec 
) const
virtual

Finds the values of the vector MDF at each element of paramValues, by calling m_routinePtr, and saves it at mdfValues.

Implements QUESO::BaseVectorMdf< V, M >.

Definition at line 50 of file GenericVectorMdf.C.

53 {
54  m_routinePtr(paramValues, m_routineDataPtr, mdfVec);
55  return;
56 }
double(* m_routinePtr)(const V &paramValues, const void *routineDataPtr, V &mdfVec)

Member Data Documentation

template<class V = GslVector, class M = GslMatrix>
const void* QUESO::GenericVectorMdf< V, M >::m_routineDataPtr
protected

Definition at line 76 of file GenericVectorMdf.h.

template<class V = GslVector, class M = GslMatrix>
double(* QUESO::GenericVectorMdf< V, M >::m_routinePtr)(const V &paramValues, const void *routineDataPtr, V &mdfVec)
protected

Definition at line 75 of file GenericVectorMdf.h.


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

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