as_coo

将任何给定格式转换为sparse.COO。有关详细信息，请参阅“另请参阅”部分。

参数

名称	类型	描述	默认值
x	SparseArray 或 numpy.ndarray 或 scipy.sparse.spmatrix 或 Iterable。	要转换的项目。	必需
shape	tuple[int]	输出数组的形状。仅可在 Iterable 的情况下使用。	无

返回值

名称	类型	描述
out	COO	转换后的 sparse.COO 数组。

另请参阅

• sparse.SparseArray.asformat：一个用于在本库中进行格式转换的实用函数。
• sparse.COO.from_numpy：将 Numpy 数组转换为 sparse.COO。
• sparse.COO.from_scipy_sparse：将 SciPy 稀疏矩阵转换为 sparse.COO。
• sparse.COO.from_iter：将可迭代对象转换为 sparse.COO。

源代码位于 sparse/numba_backend/_coo/core.py

def as_coo(x, shape=None, fill_value=None, idx_dtype=None):
    """
    Converts any given format to [`sparse.COO`][]. See the "See Also" section for details.

    Parameters
    ----------
    x : SparseArray or numpy.ndarray or scipy.sparse.spmatrix or Iterable.
        The item to convert.
    shape : tuple[int], optional
        The shape of the output array. Can only be used in case of Iterable.

    Returns
    -------
    out : COO
        The converted [`sparse.COO`][] array.

    See Also
    --------
    - [`sparse.SparseArray.asformat`][] :
        A utility function to convert between formats in this library.
    - [`sparse.COO.from_numpy`][] :
        Convert a Numpy array to [`sparse.COO`][].
    - [`sparse.COO.from_scipy_sparse`][] :
        Convert a SciPy sparse matrix to [`sparse.COO`][].
    - [`sparse.COO.from_iter`][] :
        Convert an iterable to [`sparse.COO`][].
    """
    from .._common import _is_scipy_sparse_obj

    if hasattr(x, "shape") and shape is not None:
        raise ValueError("Cannot provide a shape in combination with something that already has a shape.")

    if hasattr(x, "fill_value") and fill_value is not None:
        raise ValueError("Cannot provide a fill-value in combination with something that already has a fill-value.")

    if isinstance(x, SparseArray):
        return x.asformat("coo")

    if isinstance(x, np.ndarray) or np.isscalar(x):
        return COO.from_numpy(x, fill_value=fill_value, idx_dtype=idx_dtype)

    if _is_scipy_sparse_obj(x):
        return COO.from_scipy_sparse(x)

    if isinstance(x, Iterable | Iterator):
        return COO.from_iter(x, shape=shape, fill_value=fill_value)

    raise NotImplementedError(
        f"Format not supported for conversion. Supplied type is "
        f"{type(x)}, see help(sparse.as_coo) for supported formats."
    )