queso-0.57.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Pages
VectorFunction.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_BASE_VECTOR_FUNCTION_H
26 #define UQ_BASE_VECTOR_FUNCTION_H
27 
28 #include <queso/Environment.h>
29 #include <queso/DistArray.h>
30 #include <queso/VectorSet.h>
31 
32 namespace QUESO {
33 
34 class GslVector;
35 class GslMatrix;
36 
49 template <class P_V = GslVector, class P_M = GslMatrix, class Q_V = GslVector, class Q_M = GslMatrix>
51 public:
53 
54 
56  BaseVectorFunction(const char* prefix,
60  virtual ~BaseVectorFunction();
62 
64 
65 
68  const VectorSet<P_V,P_M>& domainSet() const;
69 
71  const VectorSet<Q_V,Q_M>& imageSet () const;
72 
74  virtual void compute (const P_V& domainVector,
75  const P_V* domainDirection,
76  Q_V& imageVector,
77  DistArray<P_V*>* gradVectors, // Yes, 'P_V'
78  DistArray<P_M*>* hessianMatrices, // Yes, 'P_M'
79  DistArray<P_V*>* hessianEffects) const = 0;
81 protected:
83  std::string m_prefix;
84 
87 
90 };
91 
92 } // End namespace QUESO
93 
94 #endif // UQ_BASE_VECTOR_FUNCTION_H
const VectorSet< Q_V, Q_M > & imageSet() const
Access to the protected attribute m_imageSet: image set of the vector function/ It is an instance of ...
A templated (base) class for handling vector functions.
const VectorSet< P_V, P_M > & m_domainSet
Domain set of the vector function.
This (virtual) class sets up the environment underlying the use of the QUESO library by an executable...
Definition: Environment.h:198
virtual ~BaseVectorFunction()
Destructor.
virtual void compute(const P_V &domainVector, const P_V *domainDirection, Q_V &imageVector, DistArray< P_V * > *gradVectors, DistArray< P_M * > *hessianMatrices, DistArray< P_V * > *hessianEffects) const =0
Computes the image vector. See template specialization.
const VectorSet< P_V, P_M > & domainSet() const
Access to the protected attribute m_domainSet: domain set of the vector function. It is an instance o...
A class for partitioning vectors and matrices.
Definition: DistArray.h:56
const VectorSet< Q_V, Q_M > & m_imageSet
Image set of the vector function.
const BaseEnvironment & m_env
BaseVectorFunction(const char *prefix, const VectorSet< P_V, P_M > &domainSet, const VectorSet< Q_V, Q_M > &imageSet)
Default Constructor.

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