SampleEstimator.h

Go to the documentation of this file.

#ifndef SAMPLEESTIMATOR_H
#define SAMPLEESTIMATOR_H
 
#include <Eigen/Core>
 
#include "MUQ/Modeling/ModPiece.h"
 
namespace muq{
namespace SamplingAlgorithms{
 
  class SampleEstimator {
 
  public:
 
      virtual ~SampleEstimator() = default;
    
      virtual unsigned int BlockSize(int blockInd) const = 0;
 
      virtual unsigned int NumBlocks() const = 0;
 
      virtual Eigen::VectorXd CentralMoment(unsigned int order, 
                                            int          blockNum=-1) const;
 
      virtual Eigen::VectorXd CentralMoment(unsigned int           order, 
                                            Eigen::VectorXd const& mean, 
                                            int                    blockNum=-1) const;
 
      virtual Eigen::VectorXd StandardizedMoment(unsigned int order,
                                                 int          blockInd=-1) const;
 
      virtual Eigen::VectorXd StandardizedMoment(unsigned int           order,
                                                 Eigen::VectorXd const& mean,
                                                 int                    blockInd=-1) const;
 
      virtual Eigen::VectorXd StandardizedMoment(unsigned int           order,
                                                 Eigen::VectorXd const& mean,
                                                 Eigen::VectorXd const& stdDev,
                                                 int                    blockInd=-1) const;
 
      
 
      virtual Eigen::VectorXd Mean(int blockInd=-1) const;
    
      virtual Eigen::VectorXd Variance(int blockInd=-1) const;
 
      virtual Eigen::VectorXd Variance(Eigen::VectorXd const& mean, 
                                       int                    blockInd=-1) const;
 
      virtual Eigen::VectorXd Skewness(int blockInd=-1) const;
 
      virtual Eigen::VectorXd Skewness(Eigen::VectorXd const& mean,
                                       int                    blockInd=-1) const;
 
      virtual Eigen::VectorXd Skewness(Eigen::VectorXd const& mean,
                                       Eigen::VectorXd const& stdDev,
                                       int                    blockInd=-1) const;
      virtual Eigen::VectorXd Kurtosis(int blockInd=-1) const;
 
      virtual Eigen::VectorXd Kurtosis(Eigen::VectorXd const& mean,
                                       int                    blockInd=-1) const;
 
      virtual Eigen::VectorXd Kurtosis(Eigen::VectorXd const& mean,
                                       Eigen::VectorXd const& stdDev,
                                       int                    blockInd=-1) const;
      virtual Eigen::MatrixXd Covariance(int blockInd=-1) const;
 
      virtual Eigen::MatrixXd Covariance(Eigen::VectorXd const& mean, 
                                         int                    blockInd=-1) const = 0;
 
      virtual Eigen::VectorXd ExpectedValue(std::shared_ptr<muq::Modeling::ModPiece> const& f,
                                            std::vector<std::string> const& metains = std::vector<std::string>()) const = 0;
 
 
    virtual Eigen::VectorXd StandardError(int                blockInd, 
                                          std::string const& method) const = 0;
 
    virtual Eigen::VectorXd StandardError(std::string const& method="Batch") const{return StandardError(-1,method);};
    virtual Eigen::VectorXd StandardError(int blockDim) const{return StandardError(blockDim,"Batch");};
    
    virtual Eigen::VectorXd ESS(int                blockInd, 
                                std::string const& method) const  = 0;
    virtual Eigen::VectorXd ESS(int blockDim) const {return ESS(blockDim,"Batch");};
    virtual Eigen::VectorXd ESS(std::string const& method="Batch") const {return ESS(-1,method);};
 
  }; // class SampleEstimator
 
}
}
#endif