VectorCdf.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_VECTOR_CUMULATIVE_DISTRIBUTION_FUNCTION_H
#define UQ_VECTOR_CUMULATIVE_DISTRIBUTION_FUNCTION_H

#include <queso/ArrayOfOneDGrids.h>
#include <queso/ArrayOfOneDTables.h>
#include <queso/ScalarCdf.h>
#include <queso/SampledScalarCdf.h>
#include <queso/Environment.h>
#include <math.h>

namespace QUESO {

//*****************************************************
// Classes to accommodate a cumulative distribution function
//*****************************************************
//*****************************************************
// Base class
//*****************************************************
template<class V, class M>
class BaseVectorCdf {
public:


  BaseVectorCdf(const char*                  prefix,
                       const VectorSet<V,M>& pdfSupport);

  virtual ~BaseVectorCdf();


  const VectorSet<V,M>&        pdfSupport      ()                                const;

  virtual void                                values          (const V& paramValues, V& cdfVec) const = 0;

  virtual const BaseScalarCdf<double>& cdf             (unsigned int rowId)              const = 0;


  virtual void                                print           (std::ostream& os)                const = 0;
  friend std::ostream& operator<< (std::ostream& os,
      const BaseVectorCdf<V,M>& obj) {
    obj.print(os);
    return os;
  }


  virtual void                                subWriteContents(const std::string&            varNamePrefix,
                                                               const std::string&            fileName,
                                                               const std::string&            fileType,
                                                               const std::set<unsigned int>& allowedSubEnvIds) const;
protected:

  const   BaseEnvironment& m_env;
          std::string             m_prefix;
  const   VectorSet<V,M>&  m_pdfSupport;
};

//---------------------------------------------------
// Method outside either class definition------------
//---------------------------------------------------
//
template <class V, class M>
void
horizontalDistances(const BaseVectorCdf<V,M>& cdf1,
                    const BaseVectorCdf<V,M>& cdf2,
                    const V& epsilonVec,
                    V&       distances);

}  // End namespace QUESO

#endif // UQ_VECTOR_CUMULATIVE_DISTRIBUTION_FUNCTION_H