HyPerLCALayer.hpp

/*
 * HyPerLCALayer.hpp
 *
 *  Created on: Jan 24, 2013
 *      Author: garkenyon
 */

#ifndef HYPERLCALAYER_HPP_
#define HYPERLCALAYER_HPP_

#include "ANNLayer.hpp"
#include "probes/AdaptiveTimeScaleProbe.hpp"

namespace PV {

class HyPerLCALayer : public PV::ANNLayer {
  public:
   HyPerLCALayer(const char *name, HyPerCol *hc);
   virtual ~HyPerLCALayer();
   virtual double getDeltaUpdateTime() override;
   virtual int requireChannel(int channelNeeded, int *numChannelsResult) override;

  protected:
   HyPerLCALayer();
   int initialize(const char *name, HyPerCol *hc);
   virtual Response::Status
   communicateInitInfo(std::shared_ptr<CommunicateInitInfoMessage const> message) override;
   virtual Response::Status allocateDataStructures() override;
   virtual int ioParamsFillGroup(enum ParamsIOFlag ioFlag) override;

   virtual void ioParam_timeConstantTau(enum ParamsIOFlag ioFlag);

   virtual void ioParam_selfInteract(enum ParamsIOFlag ioFlag);

   virtual void ioParam_adaptiveTimeScaleProbe(enum ParamsIOFlag ioFlag);
   virtual Response::Status updateState(double time, double dt) override;

#ifdef PV_USE_CUDA
   virtual Response::Status updateStateGpu(double time, double dt) override;
#endif

   virtual float getChannelTimeConst(enum ChannelType channel_type) override {
      return timeConstantTau;
   };

#ifdef PV_USE_CUDA
   virtual int allocateUpdateKernel() override;
#endif

   double *deltaTimes(); // TODO: make const-correct
   // Better name?  getDeltaTimes isn't good because it sounds like it's just the getter-method.

  private:
   int initialize_base();

   // Data members
  protected:
   float timeConstantTau;
   bool selfInteract;
   char *mAdaptiveTimeScaleProbeName               = nullptr;
   AdaptiveTimeScaleProbe *mAdaptiveTimeScaleProbe = nullptr;
   std::vector<double> mDeltaTimes;

#ifdef PV_USE_CUDA
   PVCuda::CudaBuffer *d_dtAdapt;
   PVCuda::CudaBuffer *d_verticesV;
   PVCuda::CudaBuffer *d_verticesA;
   PVCuda::CudaBuffer *d_slopes;
#endif
}; // class HyPerLCALayer

} /* namespace PV */
#endif /* HYPERLCALAYER_HPP_ */