queso-0.57.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Pages
GenericVectorCdf.h
Go to the documentation of this file.
1 //-----------------------------------------------------------------------bl-
2 //--------------------------------------------------------------------------
3 //
4 // QUESO - a library to support the Quantification of Uncertainty
5 // for Estimation, Simulation and Optimization
6 //
7 // Copyright (C) 2008-2017 The PECOS Development Team
8 //
9 // This library is free software; you can redistribute it and/or
10 // modify it under the terms of the Version 2.1 GNU Lesser General
11 // Public License as published by the Free Software Foundation.
12 //
13 // This library is distributed in the hope that it will be useful,
14 // but WITHOUT ANY WARRANTY; without even the implied warranty of
15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 // Lesser General Public License for more details.
17 //
18 // You should have received a copy of the GNU Lesser General Public
19 // License along with this library; if not, write to the Free Software
20 // Foundation, Inc. 51 Franklin Street, Fifth Floor,
21 // Boston, MA 02110-1301 USA
22 //
23 //-----------------------------------------------------------------------el-
24 
25 #ifndef UQ_GENERIC_VECTOR_CUMULATIVE_DISTRIBUTION_FUNCTION_H
26 #define UQ_GENERIC_VECTOR_CUMULATIVE_DISTRIBUTION_FUNCTION_H
27 
28 #include <queso/VectorCdf.h>
29 #include <queso/ArrayOfOneDGrids.h>
30 #include <queso/ArrayOfOneDTables.h>
31 #include <queso/ScalarCdf.h>
32 #include <queso/Environment.h>
33 #include <math.h>
34 
35 namespace QUESO {
36 
37 class GslVector;
38 class GslMatrix;
39 
40 //*****************************************************
41 // Generic cumulative distribution function class
42 //*****************************************************
49 template <class V = GslVector, class M = GslMatrix>
50 class GenericVectorCdf : public BaseVectorCdf<V,M> {
51 public:
53 
54 
57  GenericVectorCdf(const char* prefix,
59  double (*routinePtr)(const V& paramValues, const void* routineDataPtr, V& cdfVec),
60  const void* routineDataPtr);
64 
66 
67  void values(const V& paramValues, V& cdfVec) const;
70 
72 
73 
75  void print (std::ostream& os) const;
77 
78 protected:
79  double (*m_routinePtr)(const V& paramValues, const void* routineDataPtr, V& cdfVec);
80  const void* m_routineDataPtr;
81 
85 };
86 
87 } // End namespace QUESO
88 
89 #endif // UQ_GENERIC_VECTOR_CUMULATIVE_DISTRIBUTION_FUNCTION_H
double(* m_routinePtr)(const V &paramValues, const void *routineDataPtr, V &cdfVec)
~GenericVectorCdf()
Destructor.
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...
A templated (base) class for handling CDFs of vector functions.
Definition: VectorCdf.h:53
A templated class for handling sets.
Definition: VectorSet.h:52
GenericVectorCdf(const char *prefix, const VectorSet< V, M > &pdfSupport, double(*routinePtr)(const V &paramValues, const void *routineDataPtr, V &cdfVec), const void *routineDataPtr)
Constructor.
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 print(std::ostream &os) const
TODO: Prints the vector CDF.
A class for handling generic vector CDFs.

Generated on Tue Jun 5 2018 19:48:55 for queso-0.57.1 by  doxygen 1.8.5