API specification¶
A conforming implementation of the array API standard must provide and support the APIs and behavior detailed in this specification while adhering to the following conventions.
When a function signature includes a
/, positional parameters must bepositional-only parameters. SeeFunction and method signatures.When a function signature includes a
*, optional parameters must bekeyword-only arguments. SeeFunction and method signatures.Broadcasting semantics must follow the semantics defined inBroadcasting.
Unless stated otherwise, functions must support the data types defined inData Types.
Functions may only be required for a subset of input data types. Libraries may choose to implement functions for additional data types, but that behavior is not required by the specification. SeeData Type Categories.
Unless stated otherwise, functions must adhere to the type promotion rules defined inType Promotion Rules.
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 inAccuracy.
API specification
- Array object
- Broadcasting
- Constants
- Creation Functions
- Data Type Functions
- Data Types
- Element-wise Functions
- Objects in API
- abs
- acos
- acosh
- add
- asin
- asinh
- atan
- atan2
- atanh
- bitwise_and
- bitwise_left_shift
- bitwise_invert
- bitwise_or
- bitwise_right_shift
- bitwise_xor
- ceil
- clip
- conj
- copysign
- cos
- cosh
- divide
- equal
- exp
- expm1
- floor
- floor_divide
- greater
- greater_equal
- hypot
- imag
- isfinite
- isinf
- isnan
- less
- less_equal
- log
- log1p
- log2
- log10
- logaddexp
- logical_and
- logical_not
- logical_or
- logical_xor
- maximum
- minimum
- multiply
- negative
- nextafter
- not_equal
- positive
- pow
- real
- reciprocal
- remainder
- round
- sign
- signbit
- sin
- sinh
- square
- sqrt
- subtract
- tan
- tanh
- trunc
- Objects in API
- Function and method signatures
- Indexing
- Indexing Functions
- Inspection
- Linear Algebra Functions
- Manipulation Functions
- Searching Functions
- Set Functions
- Sorting Functions
- Statistical Functions
- Type Promotion Rules
- Utility Functions
- Version