queso-0.57.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Pages
GenericVectorRV.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_GENERIC_VECTOR_RV_H
26 #define UQ_GENERIC_VECTOR_RV_H
27 
28 #include <queso/VectorRV.h>
29 #include <queso/VectorSpace.h>
30 #include <queso/JointPdf.h>
31 #include <queso/VectorRealizer.h>
32 #include <queso/VectorCdf.h>
33 #include <queso/VectorMdf.h>
34 #include <queso/SequenceOfVectors.h>
35 
36 namespace QUESO {
37 
38 class GslVector;
39 class GslMatrix;
40 
41 //*****************************************************
42 // Generic class [RV-01]
43 //*****************************************************
51 template <class V = GslVector, class M = GslMatrix>
52 class GenericVectorRV : public BaseVectorRV<V,M> {
53 public:
55 
56 
58  GenericVectorRV(const char* prefix,
59  const VectorSet <V,M>& imageSet);
60 
62 
63  GenericVectorRV(const char* prefix,
64  const VectorSet <V,M>& imageSet,
69  const BaseVectorMdf <V,M>& mdf);
71  virtual ~GenericVectorRV();
73 
75 
76  void setPdf (BaseJointPdf <V,M>& pdf );
78 
80  void setRealizer (BaseVectorRealizer<V,M>& realizer );
81 
83  void setSubCdf (BaseVectorCdf <V,M>& subCdf );
84 
86  void setUnifiedCdf(BaseVectorCdf <V,M>& unifiedCdf);
87 
89  void setMdf (BaseVectorMdf <V,M>& mdf );
91 
93 
94 
96  void print(std::ostream& os) const;
98 
99 private:
108 };
109 
110 } // End namespace QUESO
111 
112 #endif // UQ_GENERIC_VECTOR_RV_H
const BaseJointPdf< V, M > & pdf() const
Posterior Density Function of the vector RV; access to private attribute m_pdf.
Definition: VectorRV.C:90
A templated (base) class for handling sampling from vector RVs.
void print(std::ostream &os) const
TODO: Prints the vector RV.
GenericVectorRV(const char *prefix, const VectorSet< V, M > &imageSet)
Default constructor.
void setSubCdf(BaseVectorCdf< V, M > &subCdf)
Sets the CDF of the sub-sequence of this vector RV to subCdf.
const VectorSet< V, M > & imageSet() const
Image set of the vector RV; access to private attribute m_imageSet.
Definition: VectorRV.C:83
A templated (base) class for handling MDFs of vector functions.
Definition: VectorMdf.h:52
A templated (base) class for handling CDFs of vector functions.
Definition: VectorCdf.h:53
A templated class for handling sets.
Definition: VectorSet.h:52
virtual ~GenericVectorRV()
Virtual destructor.
void setMdf(BaseVectorMdf< V, M > &mdf)
Sets the MDF of this vector RV to Mdf.
const BaseVectorMdf< V, M > & mdf() const
Finds the Marginal Density Function of this vector RV; access to private attribute m_mdf...
Definition: VectorRV.C:133
A templated class for handling generic vector RVs.
A templated (base) class for handling joint PDFs.
Definition: JointPdf.h:55
void setPdf(BaseJointPdf< V, M > &pdf)
Sets the PDF of this vector RV to pdf.
const BaseVectorCdf< V, M > & subCdf() const
Finds the Cumulative Distribution Function of this vector RV, considering only the sub-sequence of da...
Definition: VectorRV.C:115
void setRealizer(BaseVectorRealizer< V, M > &realizer)
Sets the realizer of this vector RV to realizer.
A templated base class for handling vector RV.
Definition: VectorRV.h:53
const BaseVectorRealizer< V, M > & realizer() const
Finds a realization (sample) of the PDF of this vector RV; access to private attribute m_realizer...
Definition: VectorRV.C:106
const BaseVectorCdf< V, M > & unifiedCdf() const
Finds the Cumulative Distribution Function of this vector RV, considering the unified sequence of dat...
Definition: VectorRV.C:124
void setUnifiedCdf(BaseVectorCdf< V, M > &unifiedCdf)
Sets the CDF of the unified sequence of this vector RV to unifiedCdf.

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