queso-0.57.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Pages
SampledVectorCdf.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_SAMPLED_VECTOR_CUMULATIVE_DISTRIBUTION_FUNCTION_H
26 #define UQ_SAMPLED_VECTOR_CUMULATIVE_DISTRIBUTION_FUNCTION_H
27 
28 #include <queso/VectorCdf.h>
29 #include <queso/ArrayOfOneDGrids.h>
30 #include <queso/ArrayOfOneDTables.h>
31 #include <queso/ScalarCdf.h>
32 #include <queso/Environment.h>
33 #include <math.h>
34 
35 namespace QUESO {
36 
37 class GslVector;
38 class GslMatrix;
39 
40 //*****************************************************
41 // Sampled cumulative distribution function class
42 //*****************************************************
50 template <class V = GslVector, class M = GslMatrix>
51 class SampledVectorCdf : public BaseVectorCdf<V,M> {
52 public:
54 
55 
58  SampledVectorCdf(const char* prefix,
59  const ArrayOfOneDGrids <V,M>& oneDGrids,
60  const ArrayOfOneDTables<V,M>& cdfValues);
64 
66 
67 
69  void values(const V& paramValues, V& cdfVec) const;
70 
72  const BaseScalarCdf<double>& cdf (unsigned int rowId) const;
74 
76 
77  void print (std::ostream& os) const;
79 
81  void subWriteContents(const std::string& varNamePrefix,
82  const std::string& fileName,
83  const std::string& fileType,
84  const std::set<unsigned int>& allowedSubEnvIds) const;
86 protected:
90 
92 };
93 
94 } // End namespace QUESO
95 
96 #endif // UQ_SAMPLED_VECTOR_CUMULATIVE_DISTRIBUTION_FUNCTION_H
Class to accommodate arrays of one-dimensional grid.
A class for handling sampled vector CDFs.
SampledVectorCdf(const char *prefix, const ArrayOfOneDGrids< V, M > &oneDGrids, const ArrayOfOneDTables< V, M > &cdfValues)
Default constructor.
Class to accommodate arrays of one-dimensional tables.
const BaseScalarCdf< double > & cdf(unsigned int rowId) const
Returns a scalar CDF stored at row rowId of the vector CDF.
DistArray< SampledScalarCdf< double > * > m_cdfs
A templated (base) class for handling CDFs of vector functions.
Definition: VectorCdf.h:53
void print(std::ostream &os) const
Prints the vector CDF (values of the grid points and of the CDF at such grid points).
A templated (base) class for handling CDFs.
Definition: ScalarCdf.h:49
void values(const V &paramValues, V &cdfVec) const
TODO: Returns the values of the vector CDF at each element of paramValues.
A class for partitioning vectors and matrices.
Definition: DistArray.h:56
void subWriteContents(const std::string &varNamePrefix, const std::string &fileName, const std::string &fileType, const std::set< unsigned int > &allowedSubEnvIds) const
Writes the CDF of an allowed sub-environment to a file.
~SampledVectorCdf()
Destructor.

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