let_list.h 4.33 KB
Newer Older
1 2 3 4 5 6 7 8
/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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
9
 *
10
 *   http://www.apache.org/licenses/LICENSE-2.0
11
 *
12 13 14 15 16 17 18 19
 * 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.
 */

20
/*!
21
 *  Copyright (c) 2019 by Contributors
22 23 24 25 26 27 28 29 30 31 32 33
 * \file let_list.h
 * \brief LetList record let binding and insert let expression implicitly.
 *  using it, one can treat AST as value instead of expression,
 *  and pass them around freely without fear of AST explosion (or effect duplication).
 *  for example, if one write 'b = a + a; c = b + b; d = c + c', the AST will contain 8 'a'.
 *  if one instead write 'b = ll.Push(a + a); c = ll.Push(b + b); d = ll.Get(c + c);',
 *  the AST will contain 2 'a', as b and c are now variables.
 */
#ifndef TVM_RELAY_PASS_LET_LIST_H_
#define TVM_RELAY_PASS_LET_LIST_H_

#include <tvm/relay/expr.h>
34
#include <tvm/relay/analysis.h>
35 36 37
#include <utility>
#include <vector>
#include <tuple>
38
#include <string>
39 40 41 42 43
#include "tvm/relay/type.h"

namespace tvm {
namespace relay {

44 45
/*!
 * \brief LetList allow you to transform expression into variables, so you can copy them around.
46 47 48 49 50
 *  one can insert into the LetList by calling Push, and wrap an expression with bindings with Get.
 *  additionally, there is the 'With' function, which automatically call Get.
 */
class LetList {
 public:
51 52
  ~LetList() {
    if (lets_.size() > 0 && !used_) {
53
      LOG(WARNING) << "letlist not used";
54 55
    }
  }
56 57
  /*!
   * \brief insert a binding.
58
   *
59
   * \param pv the var of the binding.
60
   *
61
   * \param expr the value of the binding.
62
   *
63
   * \return a Var that hold the inserted expr.
64
   */
65
  Var Push(Var pv, Expr expr) {
66
    CHECK(!used_);
67
    CHECK(WellFormed(expr));
68
    lets_.emplace_back(std::make_pair(pv, expr));
69 70 71
    return pv;
  }

72 73
  /*!
   * \brief insert a binding.
74
   *
75
   * \param expr the value of the binding.
76
   *
77 78
   * \param ty the type of the binding.
   *
79
   * \return a Var that hold the inserted expr.
80
   */
81
  Var Push(Expr expr, Type ty) {
82
    return Push(VarNode::make("x", ty), expr);
83 84
  }

85 86
  /*!
   * \brief insert a binding.
87 88 89 90 91
   *
   *  \param expr the value of the binding.
   *
   *  \return a Var that hold the inserted expr.
   */
92
  Var Push(Expr expr) {
93
    return Push(expr, Type());
94 95
  }

96 97
  /*!
   * \brief wrap an expr around the LetList.
98 99 100 101 102
   *
   *  \param body the Expression to be wrapped around.
   *
   *  \return the wrapped expr.
   */
103 104
  Expr Get(const Expr& body) {
    CHECK(!used_);
105 106
    Expr ret = body;
    for (auto rit = lets_.rbegin(); rit != lets_.rend(); ++rit) {
107
      ret = LetNode::make(std::get<0>(*rit), std::get<1>(*rit), ret);
108
    }
109
    used_ = true;
110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139
    return ret;
  }

  /*! \brief generate an LetList and wrap the result automatically.
   *
   *  \param f a function that generate the unwrapped Expr.
   *
   *  \code
   *  // Example code that generate `16 * a` using 4 plus instead of 15 plus.
   *  Expr mult_sixteen(const Var& a) {
   *    Op plus = Op::Get("plus");
   *    // Automatically call Get with LetList::With
   *    return LetList::With([&](LetList* ll) {
   *      // Turn a call to plus into a variable to avoid duplication of code
   *      Var b = ll->Push(CallNode::make(plus, {a, a}));
   *      Var c = ll->Push(CallNode::make(plus, {b, b}));
   *      Var d = ll->Push(CallNode::make(plus, {c, c}));
   *      return CallNode::make(plus, {d, d});
   *    });
   *  }
   *  \endcode
   *
   *  \return the wrapped Expr.
   */
  template<typename F>
  static Expr With(F&& f) {
    LetList ll;
    return ll.Get(f(&ll));
  }

140 141 142 143 144 145
  static Expr Let(const Expr& e, const std::function<Expr(const Var&)>& f) {
    return With([&](LetList* ll) {
      return f(ll->Push(e));
    });
  }

146
 private:
147
  std::vector<std::pair<Var, Expr> > lets_;
148
  bool used_ = false;
149 150 151 152 153
};

}  // namespace relay
}  // namespace tvm
#endif  // TVM_RELAY_PASS_LET_LIST_H_