queso-0.51.1
VectorRealizer.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,2009,2010,2011,2012,2013 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_REALIZER_H
26 #define UQ_REALIZER_H
27 
28 #include <queso/VectorSequence.h>
29 #include <queso/Environment.h>
30 #include <math.h>
31 
32 namespace QUESO {
33 
34 //*****************************************************
35 // Classes to accommodate a probability density routine.
36 //*****************************************************
37 
38 //*****************************************************
39 // Base class [R-00]
40 //*****************************************************
52 template<class V, class M>
54 public:
55 
57 
58 
60  BaseVectorRealizer(const char* prefix,
62  unsigned int subPeriod);
63 
65  virtual ~BaseVectorRealizer();
67 
69 
70  const VectorSet<V,M>& unifiedImageSet() const;
72 
74  unsigned int subPeriod () const;
75 
77  virtual void realization (V& nextValues) const = 0;
79 
80 protected:
82  std::string m_prefix;
84  unsigned int m_subPeriod;
85 };
86 
87 } // End namespace QUESO
88 
89 #endif // UQ_REALIZER_H
A templated class for handling sets.
Definition: VectorSet.h:49
virtual ~BaseVectorRealizer()
Virtual destructor.
A templated (base) class for handling sampling from vector RVs.
const VectorSet< V, M > & m_unifiedImageSet
This (virtual) class sets up the environment underlying the use of the QUESO library by an executable...
Definition: Environment.h:187
const BaseEnvironment & m_env
unsigned int subPeriod() const
Sub-period of the realization. Access to protected attribute m_subPeriod.
BaseVectorRealizer(const char *prefix, const VectorSet< V, M > &unifiedImageSet, unsigned int subPeriod)
Default constructor.
const VectorSet< V, M > & unifiedImageSet() const
Image set where the realizations lie. Access to protected attribute m_unifiedImageSet.
virtual void realization(V &nextValues) const =0
Performs a realization (sample) from a probability density function. See template specialization...

Generated on Thu Apr 23 2015 19:26:15 for queso-0.51.1 by  doxygen 1.8.5