index_map.h

Go to the documentation of this file.

/*
 * 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
 *
 *   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.
 */
 
#ifndef TVM_TIR_INDEX_MAP_H_
#define TVM_TIR_INDEX_MAP_H_
 
#include <tvm/ffi/container/array.h>
#include <tvm/ir/expr.h>
#include <tvm/runtime/object.h>
#include <tvm/tir/var.h>
 
#include <utility>
 
namespace tvm {
namespace arith {
class Analyzer;
}
}  // namespace tvm
 
namespace tvm {
namespace tir {
 
class IndexMapNode : public Object {
 public:
  ffi::Array<Var> initial_indices;
 
  ffi::Array<PrimExpr> final_indices;
 
  ffi::Optional<ObjectRef> inverse_index_map;
 
  IndexMapNode() {}
 
  ffi::Array<PrimExpr> MapIndices(const ffi::Array<PrimExpr>& indices,
                                  arith::Analyzer* analyzer) const;
 
  ffi::Array<Range> MapRanges(const ffi::Array<Range>& ranges, arith::Analyzer* analyzer) const;
 
  ffi::Array<PrimExpr> MapShape(const ffi::Array<PrimExpr>& shape, arith::Analyzer* analyzer) const;
 
  /* \brief Map an Tensor according to this index map
   *
   * \param arr_src The Tensor whose layout is transformed by this index map.
   *
   * \returns The transformed Tensor.
   */
  runtime::Tensor MapTensor(runtime::Tensor arr_src) const;
 
  ffi::String ToPythonString(
      const std::function<ffi::Optional<ffi::String>(const Var& var)>& f_name_map = nullptr) const;
 
  static void RegisterReflection() {
    namespace refl = tvm::ffi::reflection;
    refl::ObjectDef<IndexMapNode>()
        .def_ro("initial_indices", &IndexMapNode::initial_indices,
                refl::AttachFieldFlag::SEqHashDef())
        .def_ro("final_indices", &IndexMapNode::final_indices)
        .def_ro("inverse_index_map", &IndexMapNode::inverse_index_map,
                refl::AttachFieldFlag::SEqHashIgnore());
  }
 
  static constexpr TVMFFISEqHashKind _type_s_eq_hash_kind = kTVMFFISEqHashKindTreeNode;
  TVM_FFI_DECLARE_OBJECT_INFO_FINAL("tir.IndexMap", IndexMapNode, Object);
};
 
class IndexMap : public ObjectRef {
 public:
  IndexMap(ffi::Array<Var> initial_indices, ffi::Array<PrimExpr> final_indices,
           ffi::Optional<IndexMap> inverse_index_map = std::nullopt);
 
  static IndexMap FromFunc(int ndim, ffi::TypedFunction<ffi::Array<PrimExpr>(ffi::Array<Var>)> func,
                           ffi::Optional<IndexMap> inverse_index_map = std::nullopt);
 
  IndexMap Inverse(ffi::Array<Range> initial_ranges, arith::Analyzer* analyzer) const;
 
  IndexMap RenameVariables(
      const std::function<ffi::Optional<ffi::String>(const Var& var)>& f_name_map = nullptr) const;
 
  std::pair<IndexMap, PrimExpr> NonSurjectiveInverse(ffi::Array<Range> initial_ranges,
                                                     arith::Analyzer* analyzer) const;
 
  TVM_FFI_DEFINE_OBJECT_REF_METHODS_NULLABLE(IndexMap, ObjectRef, IndexMapNode);
};
 
IndexMap Substitute(const IndexMap& index_map,
                    std::function<ffi::Optional<PrimExpr>(const Var& var)> f_subst);
 
}  // namespace tir
}  // namespace tvm
 
#endif  // TVM_TIR_INDEX_MAP_H_