variable.h 2.8 KB
Newer Older
Y
Yi Wang 已提交
1 2 3 4 5 6 7 8 9 10 11 12 13 14
/*
  Copyright (c) 2016 PaddlePaddle Authors. All Rights Reserve.
  Licensed under the Apache License, Version 2.0 (the "License");
  you may not use this file except in compliance with the License.
  You may obtain a copy of the License at
  http://www.apache.org/licenses/LICENSE-2.0
  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS,
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.
*/
#pragma once

Y
Yi Wang 已提交
15 16
#include <memory>
#include <typeindex>
Y
Yi Wang 已提交
17 18
#include <typeinfo>

Y
Yu Yang 已提交
19
#include "paddle/platform/enforce.h"
Y
Yi Wang 已提交
20

Y
Yi Wang 已提交
21 22 23 24 25 26 27
namespace paddle {
namespace framework {

class Variable {
 public:
  template <typename T>
  const T& Get() const {
Y
Yu Yang 已提交
28 29 30 31
    PADDLE_ENFORCE(holder_ != nullptr, "Variable must hold some thing");
    PADDLE_ENFORCE(IsType<T>(),
                   "Variable must be type %s, the holding type is %s",
                   typeid(T).name(), holder_->Type().name());
Y
Yi Wang 已提交
32 33 34 35 36
    return *static_cast<const T*>(holder_->Ptr());
  }

  template <typename T>
  T* GetMutable() {
Y
Yu Yang 已提交
37
    if (!IsType<T>()) {
Y
Yi Wang 已提交
38
      holder_.reset(new PlaceholderImpl<T>(new T()));
Y
Yi Wang 已提交
39
    }
Y
Yi Wang 已提交
40
    return static_cast<T*>(holder_->Ptr());
Y
Yi Wang 已提交
41 42
  }

Y
Yu Yang 已提交
43 44 45 46 47 48
  template <typename T>
  bool IsType() const {
    return holder_ != nullptr &&
           std::type_index(typeid(T)) == std::type_index(holder_->Type());
  }

Y
Yu Yang 已提交
49 50
  void Clear() { holder_.reset(); }

51 52 53 54 55
  std::type_index Type() const {
    PADDLE_ENFORCE(holder_ != nullptr, "Must hold memory");
    return holder_->Type();
  }

Y
Yi Wang 已提交
56 57 58 59 60 61 62 63 64 65 66 67 68 69
 private:
  struct Placeholder {
    virtual ~Placeholder() {}
    virtual const std::type_info& Type() const = 0;
    virtual void* Ptr() const = 0;
  };

  // Placeholder hides type T, so it doesn't appear as a template
  // parameter of Variable.
  template <typename T>
  struct PlaceholderImpl : public Placeholder {
    PlaceholderImpl(T* ptr) : ptr_(ptr), type_(typeid(T)) {}

    virtual const std::type_info& Type() const { return type_; }
Y
Yi Wang 已提交
70
    virtual void* Ptr() const { return static_cast<void*>(ptr_.get()); }
Y
Yi Wang 已提交
71

Y
Yi Wang 已提交
72
    std::unique_ptr<T> ptr_;
Y
Yi Wang 已提交
73 74 75
    const std::type_info& type_;
  };

Y
Yi Wang 已提交
76 77
  std::unique_ptr<Placeholder>
      holder_;  // pointers to a PlaceholderImpl object indeed.
Y
Yi Wang 已提交
78 79 80 81 82 83 84 85 86 87

  // name_ is only meaningful with a Scope and accessible by it.
  //
  // NOTE: Please don't expose name_ by adding methods like
  // Variable::Name or Scope::VarName!  A variable could have a human
  // readable name or an auto-generated scope-unique name.  In the
  // former case, the caller knows the name and doesn't need to access
  // the name; in the latter case, the variable should be identified
  // by its address but not the unreadable name.
  friend class Scope;
Y
Yi Wang 已提交
88
  const std::string* name_;
Y
Yi Wang 已提交
89 90 91 92
};

}  // namespace framework
}  // namespace paddle