Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add complex number support to asarray #434

Merged
merged 2 commits into from
Jun 6, 2022
Merged

Add complex number support to asarray #434

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
64b2ac0
Add complex number support to `asarray`
kgryte May 23, 2022
c1db7aa
Update copy to include all integer values
kgryte May 24, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions spec/API_specification/array_api/creation_functions.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,13 +28,13 @@ def arange(start: Union[int, float], /, stop: Optional[Union[int, float]] = None
a one-dimensional array containing evenly spaced values. The length of the output array must be ``ceil((stop-start)/step)`` if ``stop - start`` and ``step`` have the same sign, and length ``0`` otherwise.
"""

def asarray(obj: Union[array, bool, int, float, NestedSequence, SupportsBufferProtocol], /, *, dtype: Optional[dtype] = None, device: Optional[device] = None, copy: Optional[bool] = None) -> array:
def asarray(obj: Union[array, bool, int, float, complex, NestedSequence, SupportsBufferProtocol], /, *, dtype: Optional[dtype] = None, device: Optional[device] = None, copy: Optional[bool] = None) -> array:
"""
Convert the input to an array.

Parameters
----------
obj: Union[array, bool, int, float, NestedSequence[bool | int | float], SupportsBufferProtocol]
obj: Union[array, bool, int, float, complex, NestedSequence[bool | int | float | complex], SupportsBufferProtocol]
object to be converted to an array. May be a Python scalar, a (possibly nested) sequence of Python scalars, or an object supporting the Python buffer protocol.

.. admonition:: Tip
Expand All @@ -43,10 +43,11 @@ def asarray(obj: Union[array, bool, int, float, NestedSequence, SupportsBufferPr
An object supporting the buffer protocol can be turned into a memoryview through ``memoryview(obj)``.

dtype: Optional[dtype]
output array data type. If ``dtype`` is ``None``, the output array data type must be inferred from the data type(s) in ``obj``. If all input values are Python scalars, then
output array data type. If ``dtype`` is ``None``, the output array data type must be inferred from the data type(s) in ``obj``. If all input values are Python scalars, then, in order of precedence,
rgommers marked this conversation as resolved.
Show resolved Hide resolved

- if all values are of type ``bool``, the output data type must be ``bool``.
- if the values are a mixture of ``bool``\s and ``int``, the output data type must be the default integer data type.
kgryte marked this conversation as resolved.
Show resolved Hide resolved
- if one or more values are ``complex`` numbers, the output data type must be the default complex floating-point data type.
- if one or more values are ``float``\s, the output data type must be the default real-valued floating-point data type.

Default: ``None``.
Expand Down