AutoCorrelation.h

#ifndef UTIL_AUTOCORRELATION_H
#define UTIL_AUTOCORRELATION_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/global.h>
#include "AutoCorrStage.h"               // base class
#include <util/param/ParamComposite.h>   // base class
#include <util/containers/GArray.h>      // member

namespace Util
{

   template <typename Data, typename Product>
   class AutoCorrelation : public AutoCorrStage<Data, Product>,
                           public ParamComposite
   {

   public:

      AutoCorrelation();

      virtual void readParameters(std::istream& in);

      virtual void load(Serializable::IArchive &ar);

      virtual void save(Serializable::OArchive &ar);

      int maxDelay() const;

      using AutoCorrStage<Data, Product>::setParam;
      using AutoCorrStage<Data, Product>::sample;
      using AutoCorrStage<Data, Product>::clear;
      using AutoCorrStage<Data, Product>::serialize;
      using AutoCorrStage<Data, Product>::output;
      using AutoCorrStage<Data, Product>::bufferCapacity;
      using AutoCorrStage<Data, Product>::nSample;
      using AutoCorrStage<Data, Product>::stageInterval;
      using AutoCorrStage<Data, Product>::autoCorrelation;
      using AutoCorrStage<Data, Product>::corrTime;

   protected:

      using AutoCorrStage<Data, Product>::bufferCapacity_;
      using AutoCorrStage<Data, Product>::maxStageId_;
      using AutoCorrStage<Data, Product>::blockFactor_;
      using AutoCorrStage<Data, Product>::allocate;
      using AutoCorrStage<Data, Product>::serializePrivate;

      virtual void registerDescendant(AutoCorrStage<Data, Product>* ptr);

   private:

      // Pointers to descendant AutoCorrStage objects
      GArray< AutoCorrStage<Data, Product>* > descendants_;

   };

}
#endif