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

A class for handling generic vector CDFs. More...

#include <GenericVectorCdf.h>

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

Public Member Functions

Constructor/Destructor methods
 GenericVectorCdf (const char *prefix, const VectorSet< V, M > &pdfSupport, double(*routinePtr)(const V &paramValues, const void *routineDataPtr, V &cdfVec), const void *routineDataPtr)
 Constructor. More...
 
 ~GenericVectorCdf ()
 Destructor. More...
 
Mathematical method
void values (const V &paramValues, V &cdfVec) const
 TODO: Returns the values of the vector CDF at each element of paramValues, by calling m_routinePtr. 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 Attributes

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

A class for handling generic vector CDFs.

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

Definition at line 50 of file GenericVectorCdf.h.

Constructor & Destructor Documentation

template<class V , class M >
QUESO::GenericVectorCdf< V, M >::GenericVectorCdf ( const char *  prefix,
const VectorSet< V, M > &  pdfSupport,
double(*)(const V &paramValues, const void *routineDataPtr, V &cdfVec)  routinePtr,
const void *  routineDataPtr 
)

Constructor.

Instantiates an object of the class given a prefix, the support of the related-PDF, and a routine that calculates data (like a math function).

Definition at line 31 of file GenericVectorCdf.C.

36  :
37  BaseVectorCdf<V,M>(prefix,pdfSupport),
38  m_routinePtr (routinePtr),
39  m_routineDataPtr(routineDataPtr)
40 {
41 }
double(* m_routinePtr)(const V &paramValues, const void *routineDataPtr, V &cdfVec)
const VectorSet< V, M > & pdfSupport() const
Returns the image set (support) of the PDF; access to protected attribute m_pdfSupport.
Definition: VectorCdf.C:59
template<class V , class M >
QUESO::GenericVectorCdf< V, M >::~GenericVectorCdf ( )

Destructor.

Definition at line 44 of file GenericVectorCdf.C.

45 {
46 }

Member Function Documentation

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

TODO: Prints the vector CDF.

Todo:
: implement me!

Implements QUESO::BaseVectorCdf< V, M >.

Definition at line 60 of file GenericVectorCdf.C.

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

TODO: Returns the values of the vector CDF at each element of paramValues, by calling m_routinePtr.

Implements QUESO::BaseVectorCdf< V, M >.

Definition at line 50 of file GenericVectorCdf.C.

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

Member Data Documentation

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

Definition at line 80 of file GenericVectorCdf.h.

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

Definition at line 79 of file GenericVectorCdf.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