GenericVectorRV.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-2015 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_GENERIC_VECTOR_RV_H
#define UQ_GENERIC_VECTOR_RV_H

#include <queso/VectorRV.h>
#include <queso/VectorSpace.h>
#include <queso/JointPdf.h>
#include <queso/VectorRealizer.h>
#include <queso/VectorCdf.h>
#include <queso/VectorMdf.h>
#include <queso/SequenceOfVectors.h>
#include <queso/InfoTheory.h>
#include <gsl/gsl_sf_psi.h> // todo: take specificity of gsl_, i.e., make it general (gsl or boost or etc)

namespace QUESO {

class GslVector;
class GslMatrix;

//*****************************************************
// Generic class [RV-01]
//*****************************************************
template <class V = GslVector, class M = GslMatrix>
class GenericVectorRV : public BaseVectorRV<V,M> {
public:


  GenericVectorRV(const char*                           prefix,
                         const VectorSet         <V,M>& imageSet);


  GenericVectorRV(const char*                           prefix,
                         const VectorSet         <V,M>& imageSet,
                         BaseJointPdf      <V,M>& pdf,
                         BaseVectorRealizer<V,M>& realizer,
                         const BaseVectorCdf     <V,M>& subCdf,
                         const BaseVectorCdf     <V,M>& unifiedCdf,
                         const BaseVectorMdf     <V,M>& mdf);
  virtual ~GenericVectorRV();


  void setPdf       (BaseJointPdf      <V,M>& pdf       );

  void setRealizer  (BaseVectorRealizer<V,M>& realizer  );

  void setSubCdf    (BaseVectorCdf     <V,M>& subCdf    );

  void setUnifiedCdf(BaseVectorCdf     <V,M>& unifiedCdf);

  void setMdf       (BaseVectorMdf     <V,M>& mdf       );



  void print(std::ostream& os) const;

private:
  using BaseVectorRV<V,M>::m_env;
  using BaseVectorRV<V,M>::m_prefix;
  using BaseVectorRV<V,M>::m_imageSet;
  using BaseVectorRV<V,M>::m_pdf;
  using BaseVectorRV<V,M>::m_realizer;
  using BaseVectorRV<V,M>::m_subCdf;
  using BaseVectorRV<V,M>::m_unifiedCdf;
  using BaseVectorRV<V,M>::m_mdf;
};

}  // End namespace QUESO

#endif // UQ_GENERIC_VECTOR_RV_H