param.h

#ifndef INCLUDE_UTILS_PARAM_H_
#define INCLUDE_UTILS_PARAM_H_
#include <vector>
#include <string>
#include <map>
#include <functional>
#include "proto/model.pb.h"
#include "utils/blob.h"
#include "communication/msg.h"
// Base paramter class.
namespace singa {
class Param {
 public:
  Param():data_(nullptr){}
  virtual ~Param(){};

  virtual Msg* GenGetMsg(void* arg=nullptr);
  virtual Msg* GenPutMsg(void* arg=nullptr);
  virtual Msg* GenUpdateMsg(void* arg=nullptr);
  virtual Msg* GenSyncMsg(void* arg=nullptr);

  virtual Msg* HandleGetMsg(Msg** msg);
  virtual Msg* HandlePutMsg(Msg** msg);
  virtual int ParseUpdateMsg(Msg** msg);
  virtual Msg* GenUpdateResponseMsg(void* arg=nullptr);
  virtual Msg* HandleSyncMsg(Msg** msg);

  virtual int ParseGetResponseMsg(Msg** msg);
  virtual int ParsePutResponseMsg(Msg** msg);
  virtual int ParseUpdateResponseMsg(Msg** msg);
  virtual int ParseSyncResponseMsg(Msg** msg);

  virtual void Setup(const ParamProto& proto, const std::vector<int>& shape, int fan_in);
  /*
   * fill the data according to initmethod, i.e., random/gaussian/fixed value
   */
  virtual void Init(int v=0);
  void ShareData(shared_ptr<Param> other){
    proto_.set_owner(other->owner());
    if(data_!=nullptr)
      CHECK(std::equal(data_->shape().begin(), data_->shape().end(),
          other->data_->shape().begin()));
    data_=other->data_;
  }
  float learning_rate_multiplier() {
    return proto_.learning_rate_multiplier();
  }
  float weight_decay_multiplier() {
    return proto_.weight_decay_multiplier();
  }
  /*
  const int split_threshold(){
    return proto_.split_threshold();
  }
  */
  const std::string& name() {
    return proto_.name();
  }
  const int owner() const{
    return proto_.owner();
  }
  int id() const{
    return proto_.id();
  }
  void set_id(int id){
    proto_.set_id(id);
    proto_.set_owner(id);
  }

  int version() const {
    return data_->version(); // TODO store version in data blob
  }
  void set_version(int v) {
    data_->set_version(v); // TODO read version from data blob
  }
  int size() const {
    return data_->count();
  }
  const Blob<float> &data() {
    return *data_;
  }
  Blob<float> *mutable_data() {
    return data_.get();
  }
  const Blob<float> &grad() {
    return grad_;
  }
  Blob<float> *mutable_grad() {
    return &grad_;
  }

  const Blob<float> &history() {
    return history_;
  }
  Blob<float> *mutable_history() {
    return &history_;
  }

  float* mutable_cpu_data(){
    return data_->mutable_cpu_data();
  }
  float* mutable_cpu_grad(){
    return grad_.mutable_cpu_data();
  }
  float* mutable_cpu_history(){
    return history_.mutable_cpu_data();
  }
 protected:
  std::string name_;
  shared_ptr<Blob<float>> data_;
  Blob<float> grad_, history_;
  ParamProto proto_;
  int fan_in_;
};
}  // namespace singa

#endif  // INCLUDE_UTILS_PARAM_H_