Skip to content

Commit

Permalink
feat: add support for scalars in result_type
Browse files Browse the repository at this point in the history
Closes: #805
  • Loading branch information
kgryte committed Dec 12, 2024
1 parent c492972 commit 3a1fa0e
Showing 1 changed file with 13 additions and 8 deletions.
21 changes: 13 additions & 8 deletions src/array_api_stubs/_draft/data_type_functions.py
Original file line number Diff line number Diff line change
Expand Up @@ -209,20 +209,25 @@ def isdtype(
"""


def result_type(*arrays_and_dtypes: Union[array, dtype]) -> dtype:
def result_type(
*arrays_and_dtypes: Union[array, int, float, complex, bool, dtype]
) -> dtype:
"""
Returns the dtype that results from applying the type promotion rules (see :ref:`type-promotion`) to the arguments.
.. note::
If provided mixed dtypes (e.g., integer and floating-point), the returned dtype will be implementation-specific.
Returns the dtype that results from applying type promotion rules (see :ref:`type-promotion`) to the arguments.
Parameters
----------
arrays_and_dtypes: Union[array, dtype]
an arbitrary number of input arrays and/or dtypes.
arrays_and_dtypes: Union[array, int, float, complex, bool, dtype]
an arbitrary number of input arrays, scalars, and/or dtypes.
Returns
-------
out: dtype
the dtype resulting from an operation involving the input arrays and dtypes.
the dtype resulting from an operation involving the input arrays, scalars, and/or dtypes.
Notes
-----
- At least one argument must be an array or a dtype.
- If provided array and/or dtype arguments having mixed data type kinds (e.g., integer and floating-point), the returned dtype is unspecified and is implementation-dependent.
"""

0 comments on commit 3a1fa0e

Please sign in to comment.