imag

Returns the imaginary component of a complex number for each element x_i of the input array x.

Parameters:

Name	Type	Description	Default
x		input array of a complex floating-point data type.	required

Returns:

Name	Type	Description
out	array	an array containing the element-wise results. The returned array has a floating-point data type with the same floating-point precision as x (e.g., if x is complex64, the returned array has the floating-point data type float32).

Examples:

>>> a = sparse.COO.from_numpy(np.array([[0 + 1j, 2 + 0j], [0 + 0j, 3 + 1j]]))
>>> o = sparse.imag(a)
>>> o.todense()
array([[1., 0.],
       [0., 1.]])

Source code in sparse/numba_backend/_common.py

def imag(x, /):
    """
    Returns the imaginary component of a complex number for each element ``x_i`` of the input array ``x``.

    Parameters
    ----------
    x: array
        input array of a complex floating-point data type.

    Returns
    -------
    out: array
        an array containing the element-wise results.
        The returned array has a floating-point data type with the same floating-point precision as ``x``
        (e.g., if ``x`` is ``complex64``, the returned array has the floating-point data type ``float32``).

    Examples
    --------
    >>> a = sparse.COO.from_numpy(np.array([[0 + 1j, 2 + 0j], [0 + 0j, 3 + 1j]]))
    >>> o = sparse.imag(a)
    >>> o.todense()  # doctest: +NORMALIZE_WHITESPACE
    array([[1., 0.],
           [0., 1.]])
    """
    return x.imag