AutoCorrStage.h

#ifndef UTIL_AUTO_CORR_STAGE_H
#define UTIL_AUTO_CORR_STAGE_H
 
/*
* Util Package - C++ Utilities for Scientific Computation
*
* Copyright 2010 - 2017, The Regents of the University of Minnesota
* Distributed under the terms of the GNU General Public License.
*/
 
#include <util/containers/RingBuffer.h>   // member
#include <util/containers/DArray.h>       // member
#include <util/global.h>
 
namespace Util
{
 
   template <typename Data, typename Product>
   class AutoCorrStage 
   {
 
   public:
 
      AutoCorrStage();
 
      virtual ~AutoCorrStage();
 
      void setParam(int bufferCapacity=64, int maxStageId=0, 
                    int blockFactor=2);
 
      virtual void sample(Data value);
 
      void clear();
 
      template <class Archive>
      void serialize(Archive& ar, const unsigned int version);
 
 
 
      void output(std::ostream& out);
 
      void output(std::ostream& out, Product aveSq);
 
      int bufferCapacity() const;
 
      int bufferSize() const;
 
      long nSample() const;
 
      long stageInterval() const;
 
      Product autoCorrelation(int t) const;
 
      Product autoCorrelation(int t, Product aveSq) const;
 
      double corrTime() const;
 
      double corrTime(Product aveSq) const;
 
 
   protected:
 
      int bufferCapacity_;
 
      int maxStageId_;
 
      int blockFactor_;
 
      void allocate();
 
      bool hasChild() const;
 
      AutoCorrStage& child();
 
      virtual void registerDescendant(AutoCorrStage<Data, Product>* ptr);
 
      template <class Archive>
      void serializePrivate(Archive& ar, const unsigned int version);
 
   private:
 
      // Ring buffer containing sequence of Data values
      RingBuffer<Data> buffer_;
 
      // Array in which corr_[j] = sum of values of <x(i-j), x(i)>
      DArray<Product> corr_;
 
      // Array in which nCorr_[i] = number of products added to corr_[i]
      DArray<int> nCorr_;
 
      // Sum of all previous values of x(t)
      Data sum_;
 
      long nSample_;
 
      Data blockSum_;
 
      long nBlockSample_;
 
      long stageInterval_;
 
      AutoCorrStage<Data, Product>* childPtr_;
 
      AutoCorrStage<Data, Product>* rootPtr_;
 
      int stageId_;
 
      AutoCorrStage(long stageInterval, int stageId, int maxStageId,
                    AutoCorrStage<Data, Product>* rootPtr, int blockFactor);
 
      AutoCorrStage(const AutoCorrStage& other);
 
      AutoCorrStage& operator = (const AutoCorrStage& other);
 
      bool isValid();
 
   };
 
   // Inline methods
 
   /*
   * Does this object have a child?  (protected)
   */
   template <typename Data, typename Product>
   inline bool AutoCorrStage<Data, Product>::hasChild() const
   {  return bool(childPtr_); }
 
   /*
   * Return child object by reference. (protected)
   */
   template <typename Data, typename Product>
   inline AutoCorrStage<Data, Product>& AutoCorrStage<Data, Product>::child()
   { return *childPtr_; }
 
}
#endif