scope.h 2.7 KB
Newer Older
Q
qiaolongfei 已提交
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. */

Q
qiaolongfei 已提交
15 16
#pragma once

Y
Yi Wang 已提交
17
#include <list>
Q
qiaolongfei 已提交
18
#include <string>
Y
Yu Yang 已提交
19
#include <unordered_map>
20
#include <vector>
Q
qiaolongfei 已提交
21

Q
qiaolongfei 已提交
22
#include "paddle/framework/variable.h"
D
format  
dongzhihong 已提交
23
#include "paddle/platform/macros.h"
Q
qiaolongfei 已提交
24 25 26 27

namespace paddle {
namespace framework {

Q
Qiao Longfei 已提交
28 29
class Scope;

Q
qiaolongfei 已提交
30
/**
31 32
 * @brief Scope that manage all variables.
 *
33
 * Scope is an association of a name to Variable. All variables belong to
34
 * Scope. You need to specify a scope to run a Net, i.e., `net.Run(&scope)`.
35 36
 * One net can run in different scopes and update different variable in the
 * scope.
Q
qiaolongfei 已提交
37 38
 */
class Scope {
Q
qiaolongfei 已提交
39
 public:
40
  Scope() {}
Y
Yi Wang 已提交
41
  ~Scope();
42

Y
Yu Yang 已提交
43 44 45 46 47 48
  /// Create a sub-scope. Returns a reference other than a pointer so
  /// to prevent from manual deletion.
  /// Mark it to const because that new kid scope cannot change parent scope.
  Scope& NewScope() const;

  /// Create a variable with given name if it doesn't exist.
D
dongzhihong 已提交
49
  Variable* Var(const std::string& name);
Y
Yi Wang 已提交
50

Y
Yu Yang 已提交
51
  /// Create a variable with a scope-unique name.
Y
Yu Yang 已提交
52
  Variable* Var(std::string* name = nullptr);
Y
Yi Wang 已提交
53

Y
Yu Yang 已提交
54 55
  /// Find a variable in the scope or any of its ancestors.  Returns
  /// nullptr if cannot find.
Y
Yi Wang 已提交
56 57
  Variable* FindVar(const std::string& name) const;

Y
Yan Chunwei 已提交
58 59
  const Scope& parent() const { return *parent_; }

Y
Yu Yang 已提交
60 61 62
  /// Find the scope or an ancestor scope that contains the given variable.
  const Scope* FindScope(const Variable* var) const;

Y
Yu Yang 已提交
63 64
  void DeleteScope(Scope* scope);

Y
Yu Yang 已提交
65 66
  /// Drop all kids scopes belonged to this scope.
  void DropKids();
67

68
  // enumerate all the variables current contains.
Y
Yang Yu 已提交
69
  std::vector<std::string> LocalVarNames() const;
70

Y
Yu Yang 已提交
71 72 73 74 75 76 77
  // Rename variable to a new name
  void Rename(const std::string& origin_name,
              const std::string& new_name) const;

  // Rename variable to a new name and return the new name
  std::string Rename(const std::string& origin_name) const;

78 79
  Variable* FindVarLocally(const std::string& name) const;

80
 private:
Y
Yi Wang 已提交
81
  // Call Scope::NewScope for a sub-scope.
Y
Yu Yang 已提交
82
  explicit Scope(Scope const* parent) : parent_(parent) {}
Y
Yi Wang 已提交
83

Y
Yu Yang 已提交
84
  mutable std::unordered_map<std::string, Variable*> vars_;
Y
Yu Yang 已提交
85 86
  mutable std::list<Scope*> kids_;
  Scope const* parent_{nullptr};
D
format  
dongzhihong 已提交
87 88

  DISABLE_COPY_AND_ASSIGN(Scope);
Q
qiaolongfei 已提交
89 90 91
};
}  // namespace framework
}  // namespace paddle