queso-0.57.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Pages
GenericScalarCovarianceFunction.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_SCALAR_COVARIANCE_FUNCTION_H
26 #define UQ_GENERIC_SCALAR_COVARIANCE_FUNCTION_H
27 
28 #include <queso/ScalarCovarianceFunction.h>
29 #include <queso/VectorSet.h>
30 #include <queso/Environment.h>
31 #include <cmath>
32 
33 namespace QUESO {
34 
35 class GslVector;
36 class GslMatrix;
37 
38 //*****************************************************
39 // Generic class
40 //*****************************************************
47 template <class V = GslVector, class M = GslMatrix>
49 public:
51 
52 
54  GenericScalarCovarianceFunction(const char* prefix,
55  const VectorSet<V,M>& domainSet,
56  double (*covRoutinePtr)(const V& positionVector1, const V& positionVector2, const void* routineDataPtr),
57  const void* routinesDataPtr);
58 
62 
64 
66  double value(const V& positionVector1, const V& positionVector2) const;
67 
68 protected:
72 
73  double (*m_covRoutinePtr)(const V& positionVector1, const V& positionVector2, const void* routineDataPtr);
74  const void* m_routineDataPtr;
75 };
76 
77 } // End namespace QUESO
78 
79 #endif // UQ_GENERIC_SCALAR_COVARIANCE_FUNCTION_H
double(* m_covRoutinePtr)(const V &positionVector1, const V &positionVector2, const void *routineDataPtr)
double value(const V &positionVector1, const V &positionVector2) const
Calculates the value of the generic covariance function.
A templated class for handling sets.
Definition: VectorSet.h:52
GenericScalarCovarianceFunction(const char *prefix, const VectorSet< V, M > &domainSet, double(*covRoutinePtr)(const V &positionVector1, const V &positionVector2, const void *routineDataPtr), const void *routinesDataPtr)
Default constructor.
A templated (base) class to accommodate scalar covariance functions (of random variables).
virtual ~GenericScalarCovarianceFunction()
Virtual destructor.

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