AutoCorrelation.tpp

#ifndef UTIL_AUTOCORRELATION_TPP
#define UTIL_AUTOCORRELATION_TPP

/*
* 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 "AutoCorrelation.h"  
#include "AutoCorrStage.tpp"  

#include <string>

namespace Util
{

   /*
   * Constructor
   */
   template <typename Data, typename Product>
   AutoCorrelation<Data, Product>::AutoCorrelation()
    : AutoCorrStage<Data, Product>()
   {
      descendants_.append(this);
   }

   /*
   * Read parameters and initialize.
   */
   template <typename Data, typename Product>
   void AutoCorrelation<Data, Product>::readParameters(std::istream& in)
   {
      readOptional(in, "bufferCapacity", bufferCapacity_);
      readOptional(in, "maxStageId", maxStageId_);
      readOptional(in, "blockFactor", blockFactor_);
      allocate();
   }

   /*
   * Load internal state from archive.
   */
   template <typename Data, typename Product>
   void AutoCorrelation<Data, Product>::load(Serializable::IArchive &ar)
   {
      loadParameter<int>(ar, "bufferCapacity", bufferCapacity_); 
      loadParameter<int>(ar, "maxStageId", maxStageId_); 
      loadParameter<int>(ar, "blockFactor", blockFactor_); 
      serializePrivate(ar, 0);
   }

   /*
   * Save internal state to archive.
   */
   template <typename Data, typename Product>
   void AutoCorrelation<Data, Product>::save(Serializable::OArchive &ar)
   {  ar & *this; }

   /*
   * Return the maximum delay.
   */
   template <typename Data, typename Product> 
   int AutoCorrelation<Data, Product>::maxDelay() const
   {
      int iStage = descendants_.size() - 1;
      AutoCorrStage<Data, Product>* stagePtr = descendants_[iStage];
      int interval = stagePtr->stageInterval();
      int size = stagePtr->bufferSize();
      return (size - 1)*interval;
   }

   /*
   * Register the creation of a descendant stage.
   */
   template <typename Data, typename Product> 
   void 
   AutoCorrelation<Data, Product>
                  ::registerDescendant(AutoCorrStage<Data, Product>* ptr)
   {  descendants_.append(ptr); }

}
#endif