Skip to content

complete scipy.fft.dct, and add relevant type aliases #118

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
merged 4 commits into from
Oct 21, 2024
Merged

complete scipy.fft.dct, and add relevant type aliases #118

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a890c3f
Annotate `scipy.fft._realtransforms.dct`
Avasam Oct 20, 2024
47b0c6e
Add type aliases for "DCT type" and "normalization mode"
Avasam Oct 20, 2024
7de0ca0
Address PR comments and fill in other simple types
Avasam Oct 21, 2024
eba7dec
Leftover import + `n` is also a simple param type
Avasam Oct 21, 2024
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
2 changes: 2 additions & 0 deletions scipy-stubs/_typing.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,8 @@ CorrelateMode: TypeAlias = Literal["valid", "same", "full"]
# scipy literals
NanPolicy: TypeAlias = Literal["raise", "propagate", "omit"]
Alternative: TypeAlias = Literal["two-sided", "less", "greater"]
DCTType: TypeAlias = Literal[1, 2, 3, 4]
NormalizationMode: TypeAlias = Literal["backward", "ortho", "forward"]

# used in `scipy.linalg.blas` and `scipy.linalg.lapack`
@type_check_only
Expand Down
83 changes: 44 additions & 39 deletions scipy-stubs/fft/_realtransforms.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,83 +1,88 @@
from scipy._typing import Untyped
import numpy.typing as npt
from numpy._typing import _ArrayLikeNumber_co
from scipy._typing import DCTType, NormalizationMode, Untyped

def dctn(
x: Untyped,
type: int = 2,
type: DCTType = 2,
s: Untyped | None = None,
axes: Untyped | None = None,
norm: Untyped | None = None,
norm: NormalizationMode | None = None,
overwrite_x: bool = False,
workers: Untyped | None = None,
workers: int | None = None,
*,
orthogonalize: Untyped | None = None,
orthogonalize: bool | None = None,
) -> Untyped: ...
def idctn(
x: Untyped,
type: int = 2,
type: DCTType = 2,
s: Untyped | None = None,
axes: Untyped | None = None,
norm: Untyped | None = None,
norm: NormalizationMode | None = None,
overwrite_x: bool = False,
workers: Untyped | None = None,
orthogonalize: Untyped | None = None,
workers: int | None = None,
orthogonalize: bool | None = None,
) -> Untyped: ...
def dstn(
x: Untyped,
type: int = 2,
type: DCTType = 2,
s: Untyped | None = None,
axes: Untyped | None = None,
norm: Untyped | None = None,
norm: NormalizationMode | None = None,
overwrite_x: bool = False,
workers: Untyped | None = None,
orthogonalize: Untyped | None = None,
workers: int | None = None,
orthogonalize: bool | None = None,
) -> Untyped: ...
def idstn(
x: Untyped,
type: int = 2,
type: DCTType = 2,
s: Untyped | None = None,
axes: Untyped | None = None,
norm: Untyped | None = None,
norm: NormalizationMode | None = None,
overwrite_x: bool = False,
workers: Untyped | None = None,
orthogonalize: Untyped | None = None,
workers: int | None = None,
orthogonalize: bool | None = None,
) -> Untyped: ...

# We could use overloads based on the type of x to get more accurate return type
# see https://github.com/jorenham/scipy-stubs/pull/118#discussion_r1807957439
def dct(
x: Untyped,
type: int = 2,
n: Untyped | None = None,
x: _ArrayLikeNumber_co,
type: DCTType = 2,
n: int | None = None,
axis: int = -1,
norm: Untyped | None = None,
norm: NormalizationMode | None = None,
overwrite_x: bool = False,
workers: Untyped | None = None,
orthogonalize: Untyped | None = None,
) -> Untyped: ...
workers: int | None = None,
orthogonalize: bool | None = None,
) -> npt.NDArray[Untyped]: ...
def idct(
x: Untyped,
type: int = 2,
n: Untyped | None = None,
type: DCTType = 2,
n: int | None = None,
axis: int = -1,
norm: Untyped | None = None,
norm: NormalizationMode | None = None,
overwrite_x: bool = False,
workers: Untyped | None = None,
orthogonalize: Untyped | None = None,
workers: int | None = None,
orthogonalize: bool | None = None,
) -> Untyped: ...
def dst(
x: Untyped,
type: int = 2,
n: Untyped | None = None,
type: DCTType = 2,
n: int | None = None,
axis: int = -1,
norm: Untyped | None = None,
norm: NormalizationMode | None = None,
overwrite_x: bool = False,
workers: Untyped | None = None,
orthogonalize: Untyped | None = None,
workers: int | None = None,
orthogonalize: bool | None = None,
) -> Untyped: ...
def idst(
x: Untyped,
type: int = 2,
n: Untyped | None = None,
type: DCTType = 2,
n: int | None = None,
axis: int = -1,
norm: Untyped | None = None,
norm: NormalizationMode | None = None,
overwrite_x: bool = False,
workers: Untyped | None = None,
orthogonalize: Untyped | None = None,
workers: int | None = None,
orthogonalize: bool | None = None,
) -> Untyped: ...