MarkovChainPositionData.h

Go to the documentation of this file.

//-----------------------------------------------------------------------bl-
//--------------------------------------------------------------------------
//
// QUESO - a library to support the Quantification of Uncertainty
// for Estimation, Simulation and Optimization
//
// Copyright (C) 2008-2017 The PECOS Development Team
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the Version 2.1 GNU Lesser General
// Public License as published by the Free Software Foundation.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc. 51 Franklin Street, Fifth Floor,
// Boston, MA  02110-1301  USA
//
//-----------------------------------------------------------------------el-

#ifndef UQ_CHAIN_POSITION_DATA_H
#define UQ_CHAIN_POSITION_DATA_H

#include <queso/Environment.h>

namespace QUESO {

class GslVector;

template <class V = GslVector>
class MarkovChainPositionData
{
public:


  MarkovChainPositionData(const BaseEnvironment& env);


  MarkovChainPositionData(const BaseEnvironment& env,
                                 const V& vecValues,
                                 bool     outOfTargetSupport,
                                 double   logLikelihood,
                                 double   logTarget);

  MarkovChainPositionData(const MarkovChainPositionData<V>& rhs);

  ~MarkovChainPositionData();


  MarkovChainPositionData<V>& operator= (const MarkovChainPositionData<V>& rhs);


  const V& vecValues         () const;

  bool     outOfTargetSupport() const;

  double   logLikelihood     () const;

  double   logTarget         () const;

  void     set               (const V& vecValues,
                              bool     outOfTargetSupport,
                              double   logLikelihood,
                              double   logTarget);


  void     print             (std::ostream& os) const;
  friend std::ostream& operator<<(std::ostream& os,
      const MarkovChainPositionData<V>& obj)
  {
    obj.print(os);

    return os;
  }

private:
  const BaseEnvironment& m_env;
  V*     m_vecValues;
  bool   m_outOfTargetSupport;
  double m_logLikelihood;
  double m_logTarget;
};

}  // End namespace QUESO

#endif // UQ_CHAIN_POSITION_DATA_H