elementwise.py 1.2 KB

1234567891011121314151617181920212223242526272829303132333435363738
  1. """
  2. ===================================================================
  3. Elementwise Scalar Optimization (:mod:`scipy.optimize.elementwise`)
  4. ===================================================================
  5. .. currentmodule:: scipy.optimize.elementwise
  6. This module provides a collection of functions for root finding and
  7. minimization of scalar, real-valued functions of one variable. Unlike their
  8. counterparts in the base :mod:`scipy.optimize` namespace, these functions work
  9. elementwise, enabling the solution of many related problems in an efficient,
  10. vectorized call. Furthermore, when environment variable ``SCIPY_ARRAY_API=1``,
  11. these functions can accept non-NumPy, array API standard compatible arrays and
  12. perform all calculations using the corresponding array library (e.g. PyTorch,
  13. JAX, CuPy).
  14. Root finding
  15. ============
  16. .. autosummary::
  17. :toctree: generated/
  18. find_root
  19. bracket_root
  20. Minimization
  21. ============
  22. .. autosummary::
  23. :toctree: generated/
  24. find_minimum
  25. bracket_minimum
  26. """
  27. from ._elementwise import find_root, find_minimum, bracket_root, bracket_minimum # noqa: F401, E501
  28. __all__ = ["find_root", "find_minimum", "bracket_root", "bracket_minimum"]