TypeUtilities.h

Go to the documentation of this file.

//===- TypeUtilities.h - Helper function for type queries -------*- C++ -*-===//
//
// Part of the MLIR Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
//
// This file defines generic type utilities.
//
//===----------------------------------------------------------------------===//

#ifndef MLIR_SUPPORT_TYPEUTILITIES_H
#define MLIR_SUPPORT_TYPEUTILITIES_H

#include "mlir/IR/Operation.h"
#include "llvm/ADT/STLExtras.h"

namespace mlir {

class Attribute;
class TupleType;
class Type;
class Value;

//===----------------------------------------------------------------------===//
// Utility Functions
//===----------------------------------------------------------------------===//

Type getElementTypeOrSelf(Type type);

Type getElementTypeOrSelf(Attribute attr);
Type getElementTypeOrSelf(Value val);

SmallVector<Type, 10> getFlattenedTypes(TupleType t);

bool isOpaqueTypeWithName(Type type, StringRef dialect, StringRef typeData);

LogicalResult verifyCompatibleShape(ArrayRef<int64_t> shape1,
                                    ArrayRef<int64_t> shape2);

LogicalResult verifyCompatibleShape(Type type1, Type type2);

//===----------------------------------------------------------------------===//
// Utility Iterators
//===----------------------------------------------------------------------===//

// An iterator for the element types of an op's operands of shaped types.
class OperandElementTypeIterator final
    : public llvm::mapped_iterator<Operation::operand_iterator,
                                   Type (*)(Value)> {
public:
  using reference = Type;

  explicit OperandElementTypeIterator(Operation::operand_iterator it);

private:
  static Type unwrap(Value value);
};

using OperandElementTypeRange = iterator_range<OperandElementTypeIterator>;

// An iterator for the tensor element types of an op's results of shaped types.
class ResultElementTypeIterator final
    : public llvm::mapped_iterator<Operation::result_iterator,
                                   Type (*)(Value)> {
public:
  using reference = Type;

  explicit ResultElementTypeIterator(Operation::result_iterator it);

private:
  static Type unwrap(Value value);
};

using ResultElementTypeRange = iterator_range<ResultElementTypeIterator>;

} // end namespace mlir

#endif // MLIR_SUPPORT_TYPEUTILITIES_H