tensor.h 7.35 KB
Newer Older
tqchen committed
1 2 3 4 5 6 7 8
/*!
 *  Copyright (c) 2016 by Contributors
 * \file tensor.h
 * \brief Dataflow tensor object
 */
#ifndef TVM_TENSOR_H_
#define TVM_TENSOR_H_

tqchen committed
9
#include <tvm/container.h>
tqchen committed
10
#include <ir/FunctionBase.h>
tqchen committed
11
#include <string>
tqchen committed
12
#include <vector>
tqchen committed
13
#include <type_traits>
tqchen committed
14

15
#include "./base.h"
tqchen committed
16
#include "./expr.h"
17
#include "./arithmetic.h"
tqchen committed
18 19 20

namespace tvm {

21 22
// Internal node container of Tensor
class TensorNode;
tqchen committed
23 24
// internal node container for Operation
class OperationNode;
25

26
using HalideIR::IR::FunctionRef;
27

tqchen committed
28 29 30 31
/*!
 * \brief Tensor structure representing a possible input,
 *  or intermediate computation result.
 */
32
class Tensor : public NodeRef {
33
 public:
tqchen committed
34 35
  /*! \brief default constructor, used internally */
  Tensor() {}
36
  explicit Tensor(std::shared_ptr<Node> n) : NodeRef(n) {}
tqchen committed
37
  /*!
38 39 40 41
   * \brief access the internal node container
   * \return the pointer to the internal node container
   */
  inline const TensorNode* operator->() const;
42 43 44 45 46 47
  /*!
   * \brief check if two tensors equals each other.
   * \param other tensor to be checked.
   * \return whether the two tensors equals each other.
   */
  inline bool operator==(const Tensor& other) const;
tqchen committed
48
  /*! \return The dimension of the tensor */
49
  inline size_t ndim() const;
tqchen committed
50 51 52 53 54
  /*!
   * \brief Take elements from the tensor
   * \param args The indices
   * \return the result expression representing tensor read.
   */
55 56 57
  template<typename... Args>
  inline Expr operator()(Args&& ...args) const {
    Array<Expr> indices{std::forward<Args>(args)...};
tqchen committed
58 59 60 61 62 63 64
    return operator()(indices);
  }
  /*!
   * \brief Take elements from the tensor
   * \param indices the indices.
   * \return the result expression representing tensor read.
   */
65
  TVM_DLL Expr operator()(Array<Expr> indices) const;
66
  /*!
67 68 69 70
   * \brief Take elements from the tensor
   * \param indices the indices.
   * \return the result expression representing tensor read.
   */
71
  TVM_DLL Expr operator()(Array<Var> indices) const;
72
  /*!
73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111
   * \brief data structure to represent a slice that fixes first k coordinates.
   *  This is used to enable syntax sugar of Tensor[x][y][z] to get the element.
   */
  class Slice {
   public:
    // construct via tensor and indices
    Slice(const Tensor& tensor, std::vector<Expr> indices)
        : tensor_(tensor), indices_(indices) {}
    /*!
     * \brief get i-th slice from the current slice.
     * \param i the index of the coordinate
     * \return the subsequent slice.
     */
    inline Slice operator[](Expr i) {
      std::vector<Expr> other = indices_;
      other.emplace_back(i);
      return Slice(tensor_, other);
    }
    /*!
     * \brief Convert slice to expression.
     *  This is only valid when all the coordinates are fully specified.
     * \return the corresponding expression of this slice.
     */
    inline operator Expr() const {
      return tensor_(indices_);
    }

   private:
    const Tensor& tensor_;
    std::vector<Expr> indices_;
  };
  /*!
   * \brief get i-th slice from the current Tensor.
   * \param i the index of the coordinate
   * \return the subsequent slice.
   */
  inline Slice operator[](Expr i) const {
    return Slice(*this, {i});
  }
tqchen committed
112 113
  /*! \brief specify container node */
  using ContainerType = TensorNode;
114 115
};

tqchen committed
116
/*! \brief Operation that produces tensors */
117
class Operation : public FunctionRef {
tqchen committed
118 119 120
 public:
  /*! \brief default constructor  */
  Operation() {}
121
  explicit Operation(std::shared_ptr<Node> n) : FunctionRef(n) {}
tqchen committed
122 123 124 125 126 127 128 129 130 131
  /*!
   * \brief access the internal node container
   * \return the pointer to the internal node container
   */
  inline const OperationNode* operator->() const;
  /*!
   * \brief get the i-th output of the operation.
   * \param i the output index.
   * \return The i-th output.
   */
132
  TVM_DLL Tensor output(size_t i) const;
tqchen committed
133 134
  /*! \brief specify container node */
  using ContainerType = OperationNode;
tqchen committed
135
};
tqchen committed
136

137
/*! \brief Node to represent a tensor */
138
class TensorNode : public Node {
139
 public:
tqchen committed
140 141
  /*! \brief The shape of the tensor */
  Array<Expr> shape;
142
  /*! \brief data type in the content of the tensor */
143
  Type dtype;
tqchen committed
144
  /*! \brief the source operation, can be None */
tqchen committed
145
  Operation op;
tqchen committed
146
  /*! \brief the output index from source operation */
tqchen committed
147
  int value_index{0};
148 149
  /*! \brief constructor */
  TensorNode() {}
150

151
  void VisitAttrs(AttrVisitor* v) final {
tqchen committed
152
    v->Visit("shape", &shape);
153
    v->Visit("dtype", &dtype);
tqchen committed
154 155
    v->Visit("op", &op);
    v->Visit("value_index", &value_index);
156
  }
157 158 159 160
  TVM_DLL static Tensor make(Array<Expr> shape,
                             Type dtype,
                             Operation op,
                             int value_index);
161 162

  static constexpr const char* _type_key = "Tensor";
163
  TVM_DECLARE_NODE_TYPE_INFO(TensorNode, Node);
tqchen committed
164 165
};

tqchen committed
166 167

// Implementations of inline functions
168 169 170 171 172 173 174 175
inline const TensorNode* Tensor::operator->() const {
  return static_cast<const TensorNode*>(node_.get());
}

inline size_t Tensor::ndim() const {
  return (*this)->shape.size();
}

176 177 178 179 180 181 182 183 184 185 186
inline bool Tensor::operator==(const Tensor& other) const {
  if (get() == other.get()) return true;
  if (get() == nullptr || other.get() == nullptr) return false;
  if ((*this)->op.defined() || other->op.defined()) {
    return (*this)->op == other->op &&
        (*this)->value_index == other->value_index;
  } else {
    return false;
  }
}

187 188 189 190
// macro to turn every operation of slice to expression
#define DEFINE_OVERLOAD_SLICE_UNARY_OP(Op)                              \
  inline Expr operator Op (const Tensor::Slice& a) {                    \
    return Op a.operator Expr() ;                                       \
191
  }                                                                     \
192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223

#define DEFINE_OVERLOAD_SLICE_BINARY_OP(Op)                             \
  template<typename T>                                                  \
  inline Expr operator Op (const Tensor::Slice& a, const T& b) {        \
    return a.operator Expr() Op b;                                      \
  }                                                                     \
  template<typename T>                                                  \
  inline Expr operator Op (const T& a, const Tensor::Slice& b) {        \
    return a Op b.operator Expr();                                      \
  }                                                                     \
  inline Expr operator Op (const Tensor::Slice& a, const Tensor::Slice& b) { \
    return a.operator Expr() Op b.operator Expr();                      \
  }

DEFINE_OVERLOAD_SLICE_UNARY_OP(!);
DEFINE_OVERLOAD_SLICE_UNARY_OP(-);
DEFINE_OVERLOAD_SLICE_BINARY_OP(+);
DEFINE_OVERLOAD_SLICE_BINARY_OP(-);
DEFINE_OVERLOAD_SLICE_BINARY_OP(*);
DEFINE_OVERLOAD_SLICE_BINARY_OP(/);
DEFINE_OVERLOAD_SLICE_BINARY_OP(%);
DEFINE_OVERLOAD_SLICE_BINARY_OP(==);
DEFINE_OVERLOAD_SLICE_BINARY_OP(<=);
DEFINE_OVERLOAD_SLICE_BINARY_OP(>=);
DEFINE_OVERLOAD_SLICE_BINARY_OP(!=);
DEFINE_OVERLOAD_SLICE_BINARY_OP(&&);
DEFINE_OVERLOAD_SLICE_BINARY_OP(||);
DEFINE_OVERLOAD_SLICE_BINARY_OP(>>);
DEFINE_OVERLOAD_SLICE_BINARY_OP(<<);
DEFINE_OVERLOAD_SLICE_BINARY_OP(>);  // NOLINT(*)
DEFINE_OVERLOAD_SLICE_BINARY_OP(<);  // NOLINT(*)

tqchen committed
224
}  // namespace tvm
225 226 227 228 229 230 231 232

namespace std {
template <>
struct hash<::tvm::Operation> {
  std::size_t operator()(const ::tvm::Operation& k) const {
    return k.hash();
  }
};
233 234 235 236 237 238 239 240 241 242 243 244

template <>
struct hash<::tvm::Tensor> {
  std::size_t operator()(const ::tvm::Tensor& k) const {
    if (k.defined() && k->op.defined()) {
      return k->op.hash();
    } else{
      return k.hash();
    }
  }
};
}  // namespace std
tqchen committed
245
#endif  // TVM_TENSOR_H_