Skip to content

Latest commit

 

History

History
29 lines (22 loc) · 1.27 KB

linear_algebra_functions.rst

File metadata and controls

29 lines (22 loc) · 1.27 KB

Linear Algebra Functions

Array API specification for linear algebra functions.

A conforming implementation of the array API standard must provide and support the following functions adhering to the following conventions.

  • Positional parameters must be positional-only parameters. Positional-only parameters have no externally-usable name. When a function accepting positional-only parameters is called, positional arguments are mapped to these parameters based solely on their order.
  • Optional parameters must be keyword-only arguments.
  • Broadcasting semantics must follow the semantics defined in :ref:`broadcasting`.
  • Unless stated otherwise, functions must support the data types defined in :ref:`data-types`.
  • Unless stated otherwise, functions must adhere to the type promotion rules defined in :ref:`type-promotion`.
  • Unless stated otherwise, floating-point operations must adhere to IEEE 754-2019.
.. currentmodule:: array_api.linear_algebra_functions

Objects in API

.. autosummary::
   :toctree: generated
   :template: method.rst

   matmul
   matrix_transpose
   tensordot
   vecdot