Skip to content

🐛✨ sparse: fix and improve the lil_matrix and lil_array constructors #818

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jorenham merged 3 commits into from
Aug 18, 2025
Merged

🐛✨ sparse: fix and improve the lil_matrix and lil_array constructors #818

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
46ebe82
🧪 `sparse`: add type-tests for `lil_array` and `lil_matrix`
jorenham Aug 18, 2025
cb28ea6
🐛✨ `sparse`: fix and improve the `lil_matrix` and `lil_array` constru…
jorenham Aug 18, 2025
3b3add0
💡 `sparse`: fix copy-paste error in lil test comments
jorenham Aug 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
168 changes: 139 additions & 29 deletions scipy-stubs/sparse/_lil.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
from collections.abc import Sequence
from typing import Any, Generic, Literal, Self, TypeAlias, overload, type_check_only
from typing import Any, Generic, Literal, Self, SupportsIndex, TypeAlias, overload, type_check_only
from typing_extensions import TypeIs, TypeVar, override

import numpy as np
import numpy.typing as npt
import optype as op
import optype.numpy as onp
import optype.numpy.compat as npc

Expand All @@ -21,8 +20,9 @@ _T = TypeVar("_T")
_ScalarT = TypeVar("_ScalarT", bound=npc.number | np.bool_)
_ScalarT_co = TypeVar("_ScalarT_co", bound=npc.number | np.bool_, default=Any, covariant=True)

_ToMatrixPy: TypeAlias = Sequence[_T] | Sequence[Sequence[_T]]
_ToMatrixPy: TypeAlias = list[_T] | list[list[_T]] # intentionally invariant
_ToMatrix: TypeAlias = _spbase[_ScalarT] | onp.CanArrayND[_ScalarT] | Sequence[onp.CanArrayND[_ScalarT]] | _ToMatrixPy[_ScalarT]
_ToAnyLIL: TypeAlias = _ToShape2D | _ToMatrix[npc.number | np.bool_]

###

Expand Down Expand Up @@ -75,7 +75,7 @@ class _lil_base(_spbase[_ScalarT_co, tuple[int, int]], IndexMixin[_ScalarT_co, t
@overload
def count_nonzero(self, /, axis: None = None) -> np.intp: ...
@overload
def count_nonzero(self, /, axis: op.CanIndex) -> onp.Array1D[np.intp]: ...
def count_nonzero(self, /, axis: SupportsIndex) -> onp.Array1D[np.intp]: ...

#
def getrowview(self, /, i: int) -> Self: ...
Expand All @@ -98,7 +98,7 @@ class lil_array(_lil_base[_ScalarT_co], sparray[_ScalarT_co, tuple[int, int]], G
/,
arg1: _ToMatrix[_ScalarT_co],
shape: _ToShape2D | None = None,
dtype: None = None,
dtype: onp.ToDType[_ScalarT_co] | None = None,
copy: bool = False,
*,
maxprint: int | None = None,
Expand All @@ -118,7 +118,7 @@ class lil_array(_lil_base[_ScalarT_co], sparray[_ScalarT_co, tuple[int, int]], G
def __init__(
self: lil_array[np.bool_],
/,
arg1: _ToShape2D,
arg1: _ToAnyLIL,
shape: _ToShape2D | None,
dtype: onp.AnyBoolDType,
copy: bool = False,
Expand All @@ -129,7 +129,7 @@ class lil_array(_lil_base[_ScalarT_co], sparray[_ScalarT_co, tuple[int, int]], G
def __init__(
self: lil_array[np.bool_],
/,
arg1: _ToShape2D,
arg1: _ToAnyLIL,
shape: _ToShape2D | None = None,
*,
dtype: onp.AnyBoolDType,
Expand All @@ -138,9 +138,9 @@ class lil_array(_lil_base[_ScalarT_co], sparray[_ScalarT_co, tuple[int, int]], G
) -> None: ...
@overload # 2-d shape-like, dtype: int-like (positional)
def __init__(
self: lil_array[np.int64],
self: lil_array[np.int_],
/,
arg1: _ToShape2D,
arg1: _ToAnyLIL,
shape: _ToShape2D | None,
dtype: onp.AnyIntDType,
copy: bool = False,
Expand All @@ -149,20 +149,42 @@ class lil_array(_lil_base[_ScalarT_co], sparray[_ScalarT_co, tuple[int, int]], G
) -> None: ...
@overload # 2-d shape-like, dtype: int-like (keyword)
def __init__(
self: lil_array[np.int64],
self: lil_array[np.int_],
/,
arg1: _ToShape2D,
arg1: _ToAnyLIL,
shape: _ToShape2D | None = None,
*,
dtype: onp.AnyIntDType,
copy: bool = False,
maxprint: int | None = None,
) -> None: ...
@overload # 2-d shape-like, dtype: float64-like (positional)
def __init__(
self: lil_array[np.float64],
/,
arg1: _ToAnyLIL,
shape: _ToShape2D | None,
dtype: onp.AnyFloat64DType,
copy: bool = False,
*,
maxprint: int | None = None,
) -> None: ...
@overload # 2-d shape-like, dtype: float64-like (keyword)
def __init__(
self: lil_array[np.float64],
/,
arg1: _ToAnyLIL,
shape: _ToShape2D | None = None,
*,
dtype: onp.AnyFloat64DType,
copy: bool = False,
maxprint: int | None = None,
) -> None: ...
@overload # 2-d shape-like, dtype: complex128-like (positional)
def __init__(
self: lil_array[np.complex128],
/,
arg1: _ToShape2D,
arg1: _ToAnyLIL,
shape: _ToShape2D | None,
dtype: onp.AnyComplex128DType,
copy: bool = False,
Expand All @@ -173,7 +195,7 @@ class lil_array(_lil_base[_ScalarT_co], sparray[_ScalarT_co, tuple[int, int]], G
def __init__(
self: lil_array[np.complex128],
/,
arg1: _ToShape2D,
arg1: _ToAnyLIL,
shape: _ToShape2D | None = None,
*,
dtype: onp.AnyComplex128DType,
Expand All @@ -195,7 +217,7 @@ class lil_array(_lil_base[_ScalarT_co], sparray[_ScalarT_co, tuple[int, int]], G
def __init__(
self: lil_array[np.int_],
/,
arg1: _ToMatrixPy[op.JustInt],
arg1: _ToMatrixPy[int],
shape: _ToShape2D | None = None,
dtype: onp.AnyIntDType | None = None,
copy: bool = False,
Expand All @@ -206,7 +228,7 @@ class lil_array(_lil_base[_ScalarT_co], sparray[_ScalarT_co, tuple[int, int]], G
def __init__(
self: lil_array[np.float64],
/,
arg1: _ToMatrixPy[op.JustFloat],
arg1: _ToMatrixPy[float],
shape: _ToShape2D | None = None,
dtype: onp.AnyFloat64DType | None = None,
copy: bool = False,
Expand All @@ -217,7 +239,7 @@ class lil_array(_lil_base[_ScalarT_co], sparray[_ScalarT_co, tuple[int, int]], G
def __init__(
self: lil_array[np.complex128],
/,
arg1: _ToMatrixPy[op.JustComplex],
arg1: _ToMatrixPy[complex],
shape: _ToShape2D | None = None,
dtype: onp.AnyComplex128DType | None = None,
copy: bool = False,
Expand All @@ -228,7 +250,7 @@ class lil_array(_lil_base[_ScalarT_co], sparray[_ScalarT_co, tuple[int, int]], G
def __init__(
self,
/,
arg1: onp.ToComplex2D,
arg1: _ToAnyLIL,
shape: _ToShape2D | None,
dtype: onp.ToDType[_ScalarT_co],
copy: bool = False,
Expand All @@ -239,7 +261,7 @@ class lil_array(_lil_base[_ScalarT_co], sparray[_ScalarT_co, tuple[int, int]], G
def __init__(
self,
/,
arg1: onp.ToComplex2D,
arg1: _ToAnyLIL,
shape: _ToShape2D | None = None,
*,
dtype: onp.ToDType[_ScalarT_co],
Expand All @@ -250,7 +272,7 @@ class lil_array(_lil_base[_ScalarT_co], sparray[_ScalarT_co, tuple[int, int]], G
def __init__(
self,
/,
arg1: onp.ToComplex2D,
arg1: _ToAnyLIL,
shape: _ToShape2D | None = None,
dtype: npt.DTypeLike | None = None,
copy: bool = False,
Expand Down Expand Up @@ -279,22 +301,110 @@ class lil_matrix(_lil_base[_ScalarT_co], spmatrix[_ScalarT_co], Generic[_ScalarT
/,
arg1: _ToMatrix[_ScalarT_co],
shape: _ToShape2D | None = None,
dtype: None = None,
dtype: onp.ToDType[_ScalarT_co] | None = None,
copy: bool = False,
*,
maxprint: int | None = None,
) -> None: ...
@overload # 2-d shape-like, dtype: None
@overload # 2-d shape-like, dtype: float64-like | None
def __init__(
self: lil_matrix[np.float64],
/,
arg1: _ToShape2D,
shape: None = None,
shape: _ToShape2D | None = None,
dtype: onp.AnyFloat64DType | None = None,
copy: bool = False,
*,
maxprint: int | None = None,
) -> None: ...
@overload # 2-d shape-like, dtype: bool-like (positional)
def __init__(
self: lil_matrix[np.bool_],
/,
arg1: _ToAnyLIL,
shape: _ToShape2D | None,
dtype: onp.AnyBoolDType,
copy: bool = False,
*,
maxprint: int | None = None,
) -> None: ...
@overload # 2-d shape-like, dtype: bool-like (keyword)
def __init__(
self: lil_matrix[np.bool_],
/,
arg1: _ToAnyLIL,
shape: _ToShape2D | None = None,
*,
dtype: onp.AnyBoolDType,
copy: bool = False,
maxprint: int | None = None,
) -> None: ...
@overload # 2-d shape-like, dtype: int-like (positional)
def __init__(
self: lil_matrix[np.int_],
/,
arg1: _ToAnyLIL,
shape: _ToShape2D | None,
dtype: onp.AnyIntDType,
copy: bool = False,
*,
maxprint: int | None = None,
) -> None: ...
@overload # 2-d shape-like, dtype: int-like (keyword)
def __init__(
self: lil_matrix[np.int_],
/,
arg1: _ToAnyLIL,
shape: _ToShape2D | None = None,
*,
dtype: onp.AnyIntDType,
copy: bool = False,
maxprint: int | None = None,
) -> None: ...
@overload # 2-d shape-like, dtype: float64-like (positional)
def __init__(
self: lil_matrix[np.float64],
/,
arg1: _ToAnyLIL,
shape: _ToShape2D | None,
dtype: onp.AnyFloat64DType,
copy: bool = False,
*,
maxprint: int | None = None,
) -> None: ...
@overload # 2-d shape-like, dtype: float64-like (keyword)
def __init__(
self: lil_matrix[np.float64],
/,
arg1: _ToAnyLIL,
shape: _ToShape2D | None = None,
*,
dtype: onp.AnyFloat64DType,
copy: bool = False,
maxprint: int | None = None,
) -> None: ...
@overload # 2-d shape-like, dtype: complex128-like (positional)
def __init__(
self: lil_matrix[np.complex128],
/,
arg1: _ToAnyLIL,
shape: _ToShape2D | None,
dtype: onp.AnyComplex128DType,
copy: bool = False,
*,
maxprint: int | None = None,
) -> None: ...
@overload # 2-d shape-like, dtype: complex128-like (keyword)
def __init__(
self: lil_matrix[np.complex128],
/,
arg1: _ToAnyLIL,
shape: _ToShape2D | None = None,
*,
dtype: onp.AnyComplex128DType,
copy: bool = False,
maxprint: int | None = None,
) -> None: ...
@overload # matrix-like builtins.bool, dtype: bool-like | None
def __init__(
self: lil_matrix[np.bool_],
Expand All @@ -310,7 +420,7 @@ class lil_matrix(_lil_base[_ScalarT_co], spmatrix[_ScalarT_co], Generic[_ScalarT
def __init__(
self: lil_matrix[np.int_],
/,
arg1: _ToMatrixPy[op.JustInt],
arg1: _ToMatrixPy[int],
shape: _ToShape2D | None = None,
dtype: onp.AnyIntDType | None = None,
copy: bool = False,
Expand All @@ -321,7 +431,7 @@ class lil_matrix(_lil_base[_ScalarT_co], spmatrix[_ScalarT_co], Generic[_ScalarT
def __init__(
self: lil_matrix[np.float64],
/,
arg1: _ToMatrixPy[op.JustFloat],
arg1: _ToMatrixPy[float],
shape: _ToShape2D | None = None,
dtype: onp.AnyFloat64DType | None = None,
copy: bool = False,
Expand All @@ -332,7 +442,7 @@ class lil_matrix(_lil_base[_ScalarT_co], spmatrix[_ScalarT_co], Generic[_ScalarT
def __init__(
self: lil_matrix[np.complex128],
/,
arg1: _ToMatrixPy[op.JustComplex],
arg1: _ToMatrixPy[complex],
shape: _ToShape2D | None = None,
dtype: onp.AnyComplex128DType | None = None,
copy: bool = False,
Expand All @@ -343,7 +453,7 @@ class lil_matrix(_lil_base[_ScalarT_co], spmatrix[_ScalarT_co], Generic[_ScalarT
def __init__(
self,
/,
arg1: onp.ToComplex2D,
arg1: _ToAnyLIL,
shape: _ToShape2D | None,
dtype: onp.ToDType[_ScalarT_co],
copy: bool = False,
Expand All @@ -354,7 +464,7 @@ class lil_matrix(_lil_base[_ScalarT_co], spmatrix[_ScalarT_co], Generic[_ScalarT
def __init__(
self,
/,
arg1: onp.ToComplex2D,
arg1: _ToAnyLIL,
shape: _ToShape2D | None = None,
*,
dtype: onp.ToDType[_ScalarT_co],
Expand All @@ -365,7 +475,7 @@ class lil_matrix(_lil_base[_ScalarT_co], spmatrix[_ScalarT_co], Generic[_ScalarT
def __init__(
self,
/,
arg1: onp.ToComplex2D,
arg1: _ToAnyLIL,
shape: _ToShape2D | None = None,
dtype: npt.DTypeLike | None = None,
copy: bool = False,
Expand All @@ -381,7 +491,7 @@ class lil_matrix(_lil_base[_ScalarT_co], spmatrix[_ScalarT_co], Generic[_ScalarT
@overload
def getnnz(self, /, axis: None = None) -> int: ...
@overload
def getnnz(self, /, axis: op.CanIndex) -> onp.Array1D[np.int32]: ...
def getnnz(self, /, axis: SupportsIndex) -> onp.Array1D[np.int32]: ...

#
def isspmatrix_lil(x: object) -> TypeIs[lil_matrix]: ...
Loading