queso-0.57.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Pages
LikelihoodBase.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_GAUSSIAN_LLHD_H
26 #define UQ_GAUSSIAN_LLHD_H
27 
28 #include <vector>
29 #include <cmath>
30 #include <queso/ScalarFunction.h>
31 
32 namespace QUESO {
33 
34 class GslVector;
35 class GslMatrix;
36 
48 template <class V = GslVector, class M = GslMatrix>
49 class LikelihoodBase : public BaseScalarFunction<V, M> {
50 public:
52 
53 
58  LikelihoodBase(const char * prefix,
59  const VectorSet<V, M> & domainSet,
60  const V & observations);
61 
63  virtual ~LikelihoodBase() =0;
65 
67 
71  virtual void evaluateModel(const V & domainVector, const V * domainDirection,
72  V & modelOutput, V * gradVector, M * hessianMatrix,
73  V * hessianEffect) const;
74 
76 
94  virtual void evaluateModel(const V & domainVector, V & modelOutput) const
95  { this->evaluateModel(domainVector,NULL,modelOutput,NULL,NULL,NULL); }
96 
98  virtual double actualValue(const V & domainVector, const V * /*domainDirection*/,
99  V * /*gradVector*/, M * /*hessianMatrix*/, V * /*hessianEffect*/) const
100  { return std::exp(this->lnValue(domainVector)); }
101 
102 protected:
103  const V & m_observations;
104 };
105 
106 } // End namespace QUESO
107 
108 #endif // UQ_GAUSSIAN_LLHD_H
A templated (base) class for handling scalar functions.
virtual ~LikelihoodBase()=0
Destructor, pure to make this class abstract.
A templated class for handling sets.
Definition: VectorSet.h:52
const VectorSet< V, M > & domainSet() const
Access to the protected attribute m_domainSet: domain set of the scalar function. ...
virtual double actualValue(const V &domainVector, const V *, V *, M *, V *) const
Actual value of the scalar function.
virtual double lnValue(const V &domainVector, const V *domainDirection, V *gradVector, M *hessianMatrix, V *hessianEffect) const
Logarithm of the value of the scalar function. Deprecated.
LikelihoodBase(const char *prefix, const VectorSet< V, M > &domainSet, const V &observations)
Default constructor.
virtual void evaluateModel(const V &domainVector, const V *domainDirection, V &modelOutput, V *gradVector, M *hessianMatrix, V *hessianEffect) const
Deprecated. Evaluates the user&#39;s model at the point domainVector.
virtual void evaluateModel(const V &domainVector, V &modelOutput) const
Evaluates the user&#39;s model at the point domainVector.
Base class for canned Gaussian likelihoods.

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