queso-0.57.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Pages
MarkovChainPositionData.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_CHAIN_POSITION_DATA_H
26 #define UQ_CHAIN_POSITION_DATA_H
27 
28 #include <queso/Environment.h>
29 
30 namespace QUESO {
31 
32 class GslVector;
33 
48 template <class V = GslVector>
50 {
51 public:
53 
54 
58 
60 
63  const V& vecValues,
64  bool outOfTargetSupport,
65  double logLikelihood,
66  double logTarget);
68 
70 
74 
76 
80 
82 
83  const V& vecValues () const;
85 
87  bool outOfTargetSupport() const;
88 
90  double logLikelihood () const;
91 
93  double logTarget () const;
94 
96  void set (const V& vecValues,
97  bool outOfTargetSupport,
98  double logLikelihood,
99  double logTarget);
101 
103 
105  void print (std::ostream& os) const;
106  friend std::ostream& operator<<(std::ostream& os,
107  const MarkovChainPositionData<V>& obj)
108  {
109  obj.print(os);
110 
111  return os;
112  }
114 
115 private:
120  double m_logTarget;
121 };
122 
123 } // End namespace QUESO
124 
125 #endif // UQ_CHAIN_POSITION_DATA_H
friend std::ostream & operator<<(std::ostream &os, const MarkovChainPositionData< V > &obj)
This (virtual) class sets up the environment underlying the use of the QUESO library by an executable...
Definition: Environment.h:198
const V & vecValues() const
Values of the chain (vector); access to private attribute m_vecValues.
void print(std::ostream &os) const
TODO: Prints the Markov chain.
MarkovChainPositionData< V > & operator=(const MarkovChainPositionData< V > &rhs)
Assignment operator.
double logTarget() const
Logarithm of the value of the target; access to private attribute m_logTarget.
void set(const V &vecValues, bool outOfTargetSupport, double logLikelihood, double logTarget)
Sets the values of the chain.
MarkovChainPositionData(const BaseEnvironment &env)
Constructor 1.
A templated class that represents a Markov Chain.
bool outOfTargetSupport() const
Whether or not a position is out of target support; access to private attribute m_outOfTargetSupport...
double logLikelihood() const
Logarithm of the value of the likelihood; access to private attribute m_logLikelihood.

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