queso-0.57.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Pages
ConstantScalarFunction.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_CONSTANT_SCALAR_FUNCTION_H
26 #define UQ_CONSTANT_SCALAR_FUNCTION_H
27 
28 #include <queso/ScalarFunction.h>
29 #include <queso/VectorSet.h>
30 #include <queso/VectorSubset.h>
31 #include <queso/Environment.h>
32 #include <queso/Defines.h>
33 
34 namespace QUESO {
35 
36 class GslVector;
37 class GslMatrix;
38 
45 template <class V = GslVector, class M = GslMatrix>
47 public:
49 
50 
52  ConstantScalarFunction(const char* prefix,
54  double constantValue);
56  virtual ~ConstantScalarFunction();
57 
59 
60  double actualValue (const V& domainVector, const V* domainDirection, V* gradVector, M* hessianMatrix, V* hessianEffect) const;
62 
64  double lnValue (const V& domainVector, const V* domainDirection, V* gradVector, M* hessianMatrix, V* hessianEffect) const;
66 protected:
70 
73 };
74 
75 } // End namespace QUESO
76 
77 #endif // UQ_CONSTANT_SCALAR_FUNCTION_H
A templated (base) class for handling scalar functions.
A class for handling scalar functions which image is a constant (real number).
double m_constantValue
Constant value is the image set of this scalar function.
A templated class for handling sets.
Definition: VectorSet.h:52
double lnValue(const V &domainVector, const V *domainDirection, V *gradVector, M *hessianMatrix, V *hessianEffect) const
Calculates the logarithm of the value of this scalar function (which is zero).
const VectorSet< V, M > & domainSet() const
Access to the protected attribute m_domainSet: domain set of the scalar function. ...
virtual ~ConstantScalarFunction()
Virtual destructor.
double actualValue(const V &domainVector, const V *domainDirection, V *gradVector, M *hessianMatrix, V *hessianEffect) const
Calculates the actual value of this scalar function.
ConstantScalarFunction(const char *prefix, const VectorSet< V, M > &domainSet, double constantValue)
Default constructor.

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