Skip to content

Latest commit

 

History

History
28 lines (19 loc) · 1.17 KB

indexing_functions.rst

File metadata and controls

28 lines (19 loc) · 1.17 KB

Indexing Functions

Array API specification for functions for indexing arrays.

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`.

Objects in API

.. currentmodule:: signatures.indexing_functions

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

   take