ANNLayer.hpp

/*
 * ANNLayer.hpp
 *
 *  Created on: Dec 21, 2010
 *      Author: pschultz
 */

#ifndef ANNLAYER_HPP_
#define ANNLAYER_HPP_

#include "HyPerLayer.hpp"
#include <limits>

#define NUM_ANN_EVENTS 3
#define EV_ANN_ACTIVITY 2

namespace PV {

class ANNLayer : public HyPerLayer {
  public:
   ANNLayer(const char *name, HyPerCol *hc);
   virtual ~ANNLayer();

   bool layerListsVerticesInParams() const { return verticesListInParams; }

   float getVThresh() const { return VThresh; }
   float getAMax() const { return AMax; }
   float getAMin() const { return AMin; }
   float getAShift() const { return AShift; }
   float getVWidth() const { return VWidth; }

   int getNumVertices() const { return numVertices; }

   float getVertexV(int n) const {
      if (n >= 0 && n < numVertices) {
         return verticesV[n];
      }
      else {
         return nan("");
      }
   }

   float getVertexA(int n) const {
      if (n >= 0 && n < numVertices) {
         return verticesA[n];
      }
      else {
         return nan("");
      }
   }
   float getSlopeNegInf() const { return slopeNegInf; }
   float getSlopePosInf() const { return slopePosInf; }

   virtual bool activityIsSpiking() override { return false; }

  protected:
   ANNLayer();
   int initialize(const char *name, HyPerCol *hc);
   virtual Response::Status updateState(double time, double dt) override;
   virtual int setActivity() override;

   virtual int ioParamsFillGroup(enum ParamsIOFlag ioFlag) override;

   virtual void ioParam_verticesV(enum ParamsIOFlag ioFlag);

   virtual void ioParam_verticesA(enum ParamsIOFlag ioFlag);

   virtual void ioParam_slopeNegInf(enum ParamsIOFlag ioFlag);

   virtual void ioParam_slopePosInf(enum ParamsIOFlag ioFlag);

   virtual void ioParam_VThresh(enum ParamsIOFlag ioFlag);

   virtual void ioParam_AMin(enum ParamsIOFlag ioFlag);

   virtual void ioParam_AMax(enum ParamsIOFlag ioFlag);

   virtual void ioParam_AShift(enum ParamsIOFlag ioFlag);

   virtual void ioParam_VWidth(enum ParamsIOFlag ioFlag);

   virtual int setVertices();

   virtual int checkVertices() const;

   void setSlopes();

   virtual int resetGSynBuffers(double timef, double dt) override;

   // Data members, initialized to default values.
   bool verticesListInParams =
         false; // True if verticesV/verticesA were specified in params explicitly; false otherwise
   int numVertices  = 0;
   float *verticesV = nullptr;
   float *verticesA = nullptr;
   float *slopes    = nullptr; // slopes[0]=slopeNegInf; slopes[numVertices]=slopePosInf;
   // slopes[k]=slope from vertex k-1 to vertex k
   float slopeNegInf = 1.0f;
   float slopePosInf = 1.0f;

   float VThresh = -FLT_MAX; // threshold potential, values smaller than VThresh are set to AMin
   float AMax    = FLT_MAX; // maximum membrane potential, larger values are set to AMax
   float AMin    = -FLT_MAX; // minimum membrane potential, smaller values are set to AMin
   float AShift =
         (float)0; // shift potential, values above VThresh are shifted downward by this amount
   // AShift == 0, hard threshold condition
   // AShift == VThresh, soft threshold condition
   float VWidth = (float)0; // The thresholding occurs linearly over the region
   // [VThresh,VThresh+VWidth].  VWidth=0,AShift=0 is standard
   // hard-thresholding

  private:
   int initialize_base();
}; // end of class ANNLayer

} // end namespace PV

#endif /* ANNLAYER_HPP_ */