chore: import upstream snapshot with attribution

python/tvm/topi/broadcast.py

@@ -0,0 +1,566 @@
+# 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.
+"""Broadcast operators"""
+
+from . import cpp as _cpp
+
+
+def broadcast_to(data, shape):
+    """Broadcast the src to the target shape
+
+    We follows the numpy broadcasting rule.
+    See also https://docs.scipy.org/doc/numpy/user/basics.broadcasting.html
+
+    Parameters
+    ----------
+    data : tvm.te.Tensor
+        The input data
+
+    shape : list or tuple
+        The target shape to be broadcasted.
+
+    Returns
+    -------
+    ret : tvm.te.Tensor
+    """
+    return _cpp.broadcast_to(data, shape)
+
+
+def add(lhs, rhs):
+    """Addition with auto-broadcasting
+
+    Parameters
+    ----------
+    lhs : tvm.te.Tensor or Expr
+        The left operand
+    rhs : tvm.te.Tensor or Expr
+        The right operand
+
+    Returns
+    -------
+    ret : tvm.te.Tensor or Expr
+        Returns Expr if both operands are Expr.
+        Otherwise returns Tensor.
+    """
+    return _cpp.add(lhs, rhs)
+
+
+def subtract(lhs, rhs):
+    """Subtraction with auto-broadcasting
+
+    Parameters
+    ----------
+    lhs : tvm.te.Tensor or Expr
+        The left operand
+    rhs : tvm.te.Tensor or Expr
+        The right operand
+
+    Returns
+    -------
+    ret : tvm.te.Tensor or Expr
+        Returns Expr if both operands are Expr.
+        Otherwise returns Tensor.
+    """
+    return _cpp.subtract(lhs, rhs)
+
+
+def multiply(lhs, rhs):
+    """Multiplication with auto-broadcasting
+
+    Parameters
+    ----------
+    lhs : tvm.te.Tensor or Expr
+        The left operand
+    rhs : tvm.te.Tensor or Expr
+        The right operand
+
+    Returns
+    -------
+    ret : tvm.te.Tensor or Expr
+        Returns Expr if both operands are Expr.
+        Otherwise returns Tensor.
+    """
+    return _cpp.multiply(lhs, rhs)
+
+
+def divide(lhs, rhs):
+    """Division with auto-broadcasting
+
+    Parameters
+    ----------
+    lhs : tvm.te.Tensor or Expr
+        The left operand
+    rhs : tvm.te.Tensor or Expr
+        The right operand
+
+    Returns
+    -------
+    ret : tvm.te.Tensor or Expr
+        Returns Expr if both operands are Expr.
+        Otherwise returns Tensor.
+    """
+    return _cpp.divide(lhs, rhs)
+
+
+def floor_divide(lhs, rhs):
+    """Floor division with auto-broadcasting
+
+    Parameters
+    ----------
+    lhs : tvm.te.Tensor or Expr
+        The left operand
+    rhs : tvm.te.Tensor or Expr
+        The right operand
+
+    Returns
+    -------
+    ret : tvm.te.Tensor or Expr
+        Returns Expr if both operands are Expr.
+        Otherwise returns Tensor.
+    """
+    return _cpp.floor_divide(lhs, rhs)
+
+
+def log_add_exp(lhs, rhs):
+    """Log-sum-exp operation with auto-broadcasting.
+
+    Parameters
+    ----------
+    x1 : tvm.te.Tensor or Expr
+        The first input tensor or expression.
+    x2 : tvm.te.Tensor or Expr
+        The second input tensor or expression.
+
+    Returns
+    -------
+    ret : tvm.te.Tensor or Expr
+        Returns an Expr if both operands are Expr.
+        Otherwise, returns a Tensor.
+    """
+    return _cpp.log_add_exp(lhs, rhs)
+
+
+def mod(lhs, rhs):
+    """Modulus with auto-broadcasting
+
+    Parameters
+    ----------
+    lhs : tvm.te.Tensor or Expr
+        The left operand
+    rhs : tvm.te.Tensor or Expr
+        The right operand
+
+    Returns
+    -------
+    ret : tvm.te.Tensor or Expr
+        Returns Expr if both operands are Expr.
+        Otherwise returns Tensor.
+    """
+    return _cpp.mod(lhs, rhs)
+
+
+def floor_mod(lhs, rhs):
+    """Floor modulus with auto-broadcasting
+
+    Parameters
+    ----------
+    lhs : tvm.te.Tensor or Expr
+        The left operand
+    rhs : tvm.te.Tensor or Expr
+        The right operand
+
+    Returns
+    -------
+    ret : tvm.te.Tensor or Expr
+        Returns Expr if both operands are Expr.
+        Otherwise returns Tensor.
+    """
+    return _cpp.floor_mod(lhs, rhs)
+
+
+def maximum(lhs, rhs):
+    """Take element-wise maximum of two tensors with auto-broadcasting
+
+    Parameters
+    ----------
+    lhs : tvm.te.Tensor or Expr
+        The left operand
+    rhs : tvm.te.Tensor or Expr
+        The right operand
+
+    Returns
+    -------
+    ret : tvm.te.Tensor or Expr
+        Returns Expr if both operands are Expr.
+        Otherwise returns Tensor.
+    """
+    return _cpp.maximum(lhs, rhs)
+
+
+def minimum(lhs, rhs):
+    """Take element-wise maximum of two tensors with auto-broadcasting
+
+    Parameters
+    ----------
+    lhs : tvm.te.Tensor or Expr
+        The left operand
+    rhs : tvm.te.Tensor or Expr
+        The right operand
+
+    Returns
+    -------
+    ret : tvm.te.Tensor or Expr
+        Returns Expr if both operands are Expr.
+        Otherwise returns Tensor.
+    """
+    return _cpp.minimum(lhs, rhs)
+
+
+def power(lhs, rhs):
+    """Power with auto-broadcasting
+
+    Parameters
+    ----------
+    lhs : tvm.te.Tensor or Expr
+        The left operand
+    rhs : tvm.te.Tensor or Expr
+        The right operand
+
+    Returns
+    -------
+    ret : tvm.te.Tensor or Expr
+        Returns Expr if both operands are Expr.
+        Otherwise returns Tensor.
+    """
+    return _cpp.power(lhs, rhs)
+
+
+def atan2(lhs, rhs):
+    """Atan2 with auto-broadcasting.
+
+    Parameters
+    ----------
+    lhs : tvm.te.Tensor or Expr
+        The left operand (y-coordinates).
+    rhs : tvm.te.Tensor or Expr
+        The right operand (x-coordinates).
+
+    Returns
+    -------
+    ret : tvm.te.Tensor or Expr
+        Returns Expr if both operands are Expr.
+        Otherwise returns Tensor.
+    """
+    return _cpp.atan2(lhs, rhs)
+
+
+def left_shift(lhs, rhs):
+    """Left shift with auto-broadcasting
+
+    Parameters
+    ----------
+    lhs : tvm.te.Tensor or Expr
+        The left operand
+    rhs : tvm.te.Tensor or Expr
+        The right operand
+
+    Returns
+    -------
+    ret : tvm.te.Tensor or Expr
+        Returns Expr if both operands are Expr.
+        Otherwise returns Tensor.
+    """
+    return _cpp.left_shift(lhs, rhs)
+
+
+def right_shift(lhs, rhs):
+    """Right shift with auto-broadcasting
+
+    Parameters
+    ----------
+    lhs : tvm.te.Tensor or Expr
+        The left operand
+    rhs : tvm.te.Tensor or Expr
+        The right operand
+
+    Returns
+    -------
+    ret : tvm.te.Tensor or Expr
+        Returns Expr if both operands are Expr.
+        Otherwise returns Tensor.
+    """
+    return _cpp.right_shift(lhs, rhs)
+
+
+def greater(lhs, rhs):
+    """Compute (lhs>rhs) with auto-broadcasting
+
+    Parameters
+    ----------
+    lhs : tvm.te.Tensor or Expr
+        The left operand
+    rhs : tvm.te.Tensor or Expr
+        The right operand
+
+    Returns
+    -------
+    ret : tvm.te.Tensor or Expr
+        Returns Expr if both operands are Expr.
+        Otherwise returns Tensor.
+    """
+    return _cpp.greater(lhs, rhs)
+
+
+def less(lhs, rhs):
+    """Compute (lhs<rhs) with auto-broadcasting
+
+    Parameters
+    ----------
+    lhs : tvm.te.Tensor or Expr
+        The left operand
+    rhs : tvm.te.Tensor or Expr
+        The right operand
+
+    Returns
+    -------
+    ret : tvm.te.Tensor or Expr
+        Returns Expr if both operands are Expr.
+        Otherwise returns Tensor.
+    """
+    return _cpp.less(lhs, rhs)
+
+
+def equal(lhs, rhs):
+    """Compute (lhs==rhs) with auto-broadcasting
+
+    Parameters
+    ----------
+    lhs : tvm.te.Tensor or Expr
+        The left operand
+    rhs : tvm.te.Tensor or Expr
+        The right operand
+
+    Returns
+    -------
+    ret : tvm.te.Tensor or Expr
+        Returns Expr if both operands are Expr.
+        Otherwise returns Tensor.
+    """
+    return _cpp.equal(lhs, rhs)
+
+
+def not_equal(lhs, rhs):
+    """Compute (lhs!=rhs) with auto-broadcasting
+
+    Parameters
+    ----------
+    lhs : tvm.te.Tensor or Expr
+        The left operand
+    rhs : tvm.te.Tensor or Expr
+        The right operand
+
+    Returns
+    -------
+    ret : tvm.te.Tensor or Expr
+        Returns Expr if both operands are Expr.
+        Otherwise returns Tensor.
+    """
+    return _cpp.not_equal(lhs, rhs)
+
+
+def greater_equal(lhs, rhs):
+    """Compute (lhs>=rhs) with auto-broadcasting
+
+    Parameters
+    ----------
+    lhs : tvm.te.Tensor or Expr
+        The left operand
+    rhs : tvm.te.Tensor or Expr
+        The right operand
+
+    Returns
+    -------
+    ret : tvm.te.Tensor or Expr
+        Returns Expr if both operands are Expr.
+        Otherwise returns Tensor.
+    """
+    return _cpp.greater_equal(lhs, rhs)
+
+
+def less_equal(lhs, rhs):
+    """Compute (lhs<=rhs) with auto-broadcasting
+
+    Parameters
+    ----------
+    lhs : tvm.te.Tensor or Expr
+        The left operand
+    rhs : tvm.te.Tensor or Expr
+        The right operand
+
+    Returns
+    -------
+    ret : tvm.te.Tensor or Expr
+        Returns Expr if both operands are Expr.
+        Otherwise returns Tensor.
+    """
+    return _cpp.less_equal(lhs, rhs)
+
+
+def logical_and(lhs, rhs):
+    """Compute element-wise logical and of data.
+
+    Parameters
+    ----------
+    lhs : tvm.te.Tensor or Expr
+          The left operand
+    rhs : tvm.te.Tensor or Expr
+          The right operand
+
+    Returns
+    -------
+    ret : tvm.te.Tensor or Expr
+          Returns Expr if both operands are Expr.
+          Otherwise returns Tensor.
+    """
+    return _cpp.logical_and(lhs, rhs)
+
+
+def logical_or(lhs, rhs):
+    """Compute element-wise logical or of data.
+
+    Parameters
+    ----------
+    lhs : tvm.te.Tensor or Expr
+          The left operand
+    rhs : tvm.te.Tensor or Expr
+          The right operand
+
+    Returns
+    -------
+    ret : tvm.te.Tensor or Expr
+          Returns Expr if both operands are Expr.
+          Otherwise returns Tensor.
+    """
+    return _cpp.logical_or(lhs, rhs)
+
+
+def logical_xor(lhs, rhs):
+    """Compute element-wise logical xor of data.
+
+    Parameters
+    ----------
+    lhs : tvm.te.Tensor or Expr
+          The left operand
+    rhs : tvm.te.Tensor or Expr
+          The right operand
+
+    Returns
+    -------
+    ret : tvm.te.Tensor or Expr
+          Returns Expr if both operands are Expr.
+          Otherwise returns Tensor.
+    """
+    return _cpp.logical_xor(lhs, rhs)
+
+
+def bitwise_and(lhs, rhs):
+    """Compute element-wise bitwise and of data.
+
+    Parameters
+    ----------
+    lhs : tvm.te.Tensor or Expr
+          The left operand
+    rhs : tvm.te.Tensor or Expr
+          The right operand
+
+    Returns
+    -------
+    ret : tvm.te.Tensor or Expr
+          Returns Expr if both operands are Expr.
+          Otherwise returns Tensor.
+    """
+    return _cpp.bitwise_and(lhs, rhs)
+
+
+def bitwise_or(lhs, rhs):
+    """Compute element-wise bitwise or of data.
+
+    Parameters
+    ----------
+    lhs : tvm.te.Tensor or Expr
+          The left operand
+    rhs : tvm.te.Tensor or Expr
+          The right operand
+
+    Returns
+    -------
+    ret : tvm.te.Tensor or Expr
+          Returns Expr if both operands are Expr.
+          Otherwise returns Tensor.
+    """
+    return _cpp.bitwise_or(lhs, rhs)
+
+
+def bitwise_xor(lhs, rhs):
+    """Compute element-wise bitwise xor of data.
+
+    Parameters
+    ----------
+    lhs : tvm.te.Tensor or Expr
+          The left operand
+    rhs : tvm.te.Tensor or Expr
+          The right operand
+
+    Returns
+    -------
+    ret : tvm.te.Tensor or Expr
+          Returns Expr if both operands are Expr.
+          Otherwise returns Tensor.
+    """
+    return _cpp.bitwise_xor(lhs, rhs)
+
+
+def logical_not(data):
+    """Compute element-wise logical not of data.
+
+    Parameters
+    ----------
+    data : tvm.te.Tensor or Expr
+
+    Returns
+    -------
+    ret : tvm.te.Tensor or Expr
+          Returns Expr if the operand are Expr.
+          Otherwise returns Tensor.
+    """
+    return _cpp.logical_not(data)
+
+
+def bitwise_not(data):
+    """Compute element-wise bitwise not of data.
+
+    Parameters
+    ----------
+    data : tvm.te.Tensor or Expr
+
+    Returns
+    -------
+    ret : tvm.te.Tensor or Expr
+          Returns Expr if the operand are Expr.
+          Otherwise returns Tensor.
+    """
+    return _cpp.bitwise_not(data)