Function sqrt

imperative/python/megengine/functional/elemwise.py:762–798

r"""Element-wise :math:`\operatorname{sqrt}(x)` function. Calculates the square root for each element :math:`x_i` of the input tensor :math:`x`. After rounding, each result must be indistinguishable from the infinitely precise result (as required by IEEE 754). This function has dom

(x: Tensor)

def sqrt(x: Tensor) -> Tensor:
    r"""Element-wise :math:`\operatorname{sqrt}(x)` function.
    
    Calculates the square root for each element :math:`x_i` of the input tensor :math:`x`.
    After rounding, each result must be indistinguishable from the infinitely precise result (as required by IEEE 754).

    This function has domain ``[0, +infinity]`` and codomain ``[0, +infinity]``.
    
    Args:
        x: input tensor. Should have a floating-point data type.

    Returns:
        a tensor containing the evaluated square root result for each element in :math:`x`.
        The returned tensor must have a floating-point data type determined by :ref:`dtype-promotion`.
    
    .. admonition:: Special cases
    
       For floating-point operands,

       * If :math:`x_i` is ``NaN``, the result is ``NaN``.
       * If :math:`x_i` is less than ``0``, the result is ``NaN``.
       * If :math:`x_i` is ``+0``, the result is ``+0``.
       * If :math:`x_i` is ``-0``, the result is ``-0``.
       * If :math:`x_i` is ``+infinity``, the result is ``+infinity``.

    Examples:
        >>> F.sqrt(4)
        Tensor(2.0, device=xpux:0)

        Element-wise square root:

        >>> x = Tensor([1, 4, 9, 16])
        >>> F.sqrt(x)
        Tensor([1. 2. 3. 4.], device=xpux:0)

    """
    return _elwise(x, mode=Elemwise.Mode.SQRT)


def square(x: Tensor) -> Tensor: