Skip to content

Commit

Permalink
🤡 improve scipy.optimize.zeros (deprecated)
Browse files Browse the repository at this point in the history
  • Loading branch information
jorenham committed Nov 27, 2024
1 parent f86ab0f commit b08e9f6
Showing 1 changed file with 58 additions and 56 deletions.
114 changes: 58 additions & 56 deletions scipy-stubs/optimize/zeros.pyi
Original file line number Diff line number Diff line change
@@ -1,85 +1,87 @@
# This file is not meant for public use and will be removed in SciPy v2.0.0.

from collections.abc import Callable
from typing_extensions import deprecated

from ._zeros_py import RootResults as _RootResults

__all__ = ["RootResults", "bisect", "brenth", "brentq", "newton", "ridder", "toms748"]

@deprecated("will be removed in SciPy v2.0.0")
class RootResults:
def __init__(self, root: object, iterations: object, function_calls: object, flag: object, method: object) -> None: ...
class RootResults(_RootResults): ...

@deprecated("will be removed in SciPy v2.0.0")
def newton(
func: object,
func: Callable[..., object],
x0: object,
fprime: object = ...,
args: object = ...,
tol: object = ...,
maxiter: object = ...,
fprime2: object = ...,
fprime: Callable[..., object] | None = None,
args: tuple[object, ...] = (),
tol: float = ...,
maxiter: int = ...,
fprime2: Callable[..., object] | None = None,
x1: object = ...,
rtol: object = ...,
full_output: object = ...,
disp: object = ...,
rtol: float = ...,
full_output: bool = False,
disp: bool = True,
) -> object: ...
@deprecated("will be removed in SciPy v2.0.0")
def bisect(
f: object,
a: object,
b: object,
args: object = ...,
xtol: object = ...,
rtol: object = ...,
maxiter: object = ...,
full_output: object = ...,
disp: object = ...,
f: Callable[..., object],
a: float,
b: float,
args: tuple[object, ...] = (),
xtol: float = ...,
rtol: float = ...,
maxiter: int = ...,
full_output: bool = False,
disp: bool = True,
) -> object: ...
@deprecated("will be removed in SciPy v2.0.0")
def ridder(
f: object,
a: object,
b: object,
args: object = ...,
xtol: object = ...,
rtol: object = ...,
maxiter: object = ...,
full_output: object = ...,
disp: object = ...,
f: Callable[..., object],
a: float,
b: float,
args: tuple[object, ...] = (),
xtol: float = ...,
rtol: float = ...,
maxiter: int = ...,
full_output: bool = False,
disp: bool = True,
) -> object: ...
@deprecated("will be removed in SciPy v2.0.0")
def brentq(
f: object,
a: object,
b: object,
args: object = ...,
xtol: object = ...,
rtol: object = ...,
maxiter: object = ...,
full_output: object = ...,
disp: object = ...,
f: Callable[..., object],
a: float,
b: float,
args: tuple[object, ...] = (),
xtol: float = ...,
rtol: float = ...,
maxiter: int = ...,
full_output: bool = False,
disp: bool = True,
) -> object: ...
@deprecated("will be removed in SciPy v2.0.0")
def brenth(
f: object,
a: object,
b: object,
args: object = ...,
xtol: object = ...,
rtol: object = ...,
maxiter: object = ...,
full_output: object = ...,
disp: object = ...,
f: Callable[..., object],
a: float,
b: float,
args: tuple[object, ...] = (),
xtol: float = ...,
rtol: float = ...,
maxiter: int = ...,
full_output: bool = False,
disp: bool = True,
) -> object: ...
@deprecated("will be removed in SciPy v2.0.0")
def toms748(
f: object,
a: object,
b: object,
args: object = ...,
f: Callable[..., object],
a: float,
b: float,
args: tuple[object, ...] = (),
k: object = ...,
xtol: object = ...,
rtol: object = ...,
maxiter: object = ...,
full_output: object = ...,
disp: object = ...,
xtol: float = ...,
rtol: float = ...,
maxiter: int = ...,
full_output: bool = False,
disp: bool = True,
) -> object: ...

0 comments on commit b08e9f6

Please sign in to comment.