queso-0.53.0
ConstantScalarFunction.C
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-2015 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 #include <queso/VectorSet.h>
26 #include <queso/VectorSubset.h>
27 #include <queso/Environment.h>
28 #include <queso/Defines.h>
29 #include <queso/ConstantScalarFunction.h>
30 
31 namespace QUESO {
32 
33 // Default constructor
34 template<class V,class M>
36  const VectorSet<V,M>& domainSet,
37  double constantValue)
38  : BaseScalarFunction<V,M>(((std::string)(prefix)+"gen").c_str(), domainSet),
39  m_constantValue(constantValue)
40 {
41 }
42 
43 // Destructor
44 template<class V,class M>
46 {
47 }
48 
49 // Math methods
50 template<class V,class M>
51 double ConstantScalarFunction<V,M>::actualValue(const V& domainVector,
52  const V* domainDirection,
53  V* gradVector,
54  M* hessianMatrix,
55  V* hessianEffect) const
56 {
57  return m_constantValue;
58 }
59 
60 
61 template<class V,class M>
62 double ConstantScalarFunction<V,M>::lnValue(const V& domainVector,
63  const V* domainDirection,
64  V* gradVector,
65  M* hessianMatrix,
66  V* hessianEffect) const
67 {
68  return 0.;
69 }
70 
71 } // End namespace QUESO
A templated class for handling sets.
Definition: VectorSet.h:52
double actualValue(const V &domainVector, const V *domainDirection, V *gradVector, M *hessianMatrix, V *hessianEffect) const
Calculates the actual value of this scalar function.
A templated (base) class for handling scalar functions.
ConstantScalarFunction(const char *prefix, const VectorSet< V, M > &domainSet, double constantValue)
Default constructor.
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).
virtual ~ConstantScalarFunction()
Virtual destructor.

Generated on Thu Jun 11 2015 13:52:31 for queso-0.53.0 by  doxygen 1.8.5