TransposePoolingDelivery.hpp

/*
 * TransposePoolingDelivery.hpp
 *
 *  Created on: Jan 9, 2018
 *      Author: Pete Schultz
 */

#ifndef TRANSPOSEPOOLINGDELIVERY_HPP_
#define TRANSPOSEPOOLINGDELIVERY_HPP_

#include "components/DependentPatchSize.hpp"
#include "components/ImpliedWeightsPair.hpp"
#include "delivery/BaseDelivery.hpp"
#include "delivery/PoolingDelivery.hpp"
#include "layers/PoolingIndexLayer.hpp"
#ifdef PV_USE_CUDA
#include "cudakernels/CudaTransposePoolingDeliverKernel.hpp"
#endif // PV_USE_CUDA

namespace PV {

class TransposePoolingDelivery : public BaseDelivery {
  protected:
   virtual void ioParam_receiveGpu(enum ParamsIOFlag ioFlag) override;

   virtual void ioParam_updateGSynFromPostPerspective(enum ParamsIOFlag ioFlag);

  public:
   TransposePoolingDelivery(char const *name, HyPerCol *hc);

   virtual ~TransposePoolingDelivery();

   void setConnectionData(ConnectionData *connectionData);

   virtual void deliver() override;

   virtual bool isAllInputReady() override;

  protected:
   TransposePoolingDelivery();

   int initialize(char const *name, HyPerCol *hc);

   virtual void setObjectType() override;

   virtual int ioParamsFillGroup(enum ParamsIOFlag ioFlag) override;

   virtual Response::Status
   communicateInitInfo(std::shared_ptr<CommunicateInitInfoMessage const> message) override;

#ifdef PV_USE_CUDA
   virtual Response::Status
   setCudaDevice(std::shared_ptr<SetCudaDeviceMessage const> message) override;
#endif // PV_USE_CUDA

   virtual Response::Status allocateDataStructures() override;

#ifdef PV_USE_CUDA
   void initializeDeliverKernelArgs();
#endif // PV_USE_CUDA

   void allocateThreadGSyn();

   void deliverPostsynapticPerspective();

   void deliverPresynapticPerspective();

#ifdef PV_USE_CUDA
   void deliverGPU();
#endif // PV_USE_CUDA

   // Data members
  protected:
   PoolingDelivery::AccumulateType mAccumulateType = PoolingDelivery::UNDEFINED;
   bool mUpdateGSynFromPostPerspective             = false;

   DependentPatchSize *mPatchSize             = nullptr;
   ImpliedWeightsPair *mWeightsPair           = nullptr;
   PoolingIndexLayer *mOriginalPostIndexLayer = nullptr; // Used by deliverPresynapticPerspective
   HyPerLayer *mOriginalPreLayer              = nullptr; // Used by deliverGPU
   HyPerLayer *mOriginalPostLayer             = nullptr; // Used by deliverGPU

#ifdef PV_USE_CUDA
   PVCuda::CudaTransposePoolingDeliverKernel *mDeliverKernel = nullptr;
#endif // PV_USE_CUDA

   std::vector<std::vector<float>> mThreadGSyn;

}; // end class TransposePoolingDelivery

} // end namespace PV

#endif // TRANSPOSEPOOLINGDELIVERY_HPP_