Skip to content

Latest commit

 

History

History
88 lines (79 loc) · 2.2 KB

elementwise_functions.rst

File metadata and controls

88 lines (79 loc) · 2.2 KB

Element-wise Functions

Array API specification for element-wise 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`.
  • Functions may only be required for a subset of input data type. Libraries may choose to implement functions for additional data types, but that behavior is not required by the specification. See :ref:`data-type-categories`.
  • 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.
  • Unless stated otherwise, element-wise mathematical functions must satisfy the minimum accuracy requirements defined in :ref:`accuracy`.

Objects in API

.. currentmodule:: array_api

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

   abs
   acos
   acosh
   add
   asin
   asinh
   atan
   atan2
   atanh
   bitwise_and
   bitwise_left_shift
   bitwise_invert
   bitwise_or
   bitwise_right_shift
   bitwise_xor
   ceil
   conj
   cos
   cosh
   divide
   equal
   exp
   expm1
   floor
   floor_divide
   greater
   greater_equal
   isfinite
   isinf
   isnan
   less
   less_equal
   log
   log1p
   log2
   log10
   logaddexp
   logical_and
   logical_not
   logical_or
   logical_xor
   multiply
   negative
   not_equal
   positive
   pow
   real
   remainder
   round
   sign
   sin
   sinh
   square
   sqrt
   subtract
   tan
   tanh
   trunc