Skip to content

Specify output array data types #57

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

Merged
rgommers merged 13 commits into from
Nov 6, 2020
Merged

Specify output array data types #57

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
3ff2b83
Specify output array data types and add TODOs
kgryte Oct 19, 2020
e32c4dd
Use consistent wording
kgryte Oct 19, 2020
9015c12
Add out data type for `pow`
kgryte Oct 19, 2020
370b076
Add default out data types for creation functions
kgryte Oct 19, 2020
a7b7928
Specify output data types
kgryte Oct 19, 2020
3d8a610
Add output data types for searching functions
kgryte Oct 19, 2020
efdbad8
Add out data type for set functions
kgryte Oct 19, 2020
b7bb00f
Merge branch 'master' of https://github.com/pydata-apis/array-api int…
kgryte Oct 22, 2020
02ed2ec
Add note
kgryte Oct 26, 2020
89d17b6
Merge branch 'master' of https://github.com/pydata-apis/array-api int…
kgryte Nov 4, 2020
44a6c15
Update output data type language
kgryte Nov 4, 2020
b08c679
Resolve feedback
kgryte Nov 5, 2020
3373c9e
Add TODO
kgryte Nov 5, 2020
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
14 changes: 7 additions & 7 deletions spec/API_specification/creation_functions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Returns evenly spaced values within the half-open interval `[start, stop)` as a

- **dtype**: _Optional\[ <dtype> ]_

- output array data type. Default: `None`.
- output array data type. If `dtype` is `None`, the output array data type must be the default floating-point data type. Default: `None`.

#### Returns

Expand All @@ -53,7 +53,7 @@ Returns an uninitialized array having a specified `shape`.

- **dtype**: _Optional\[ <dtype> ]_

- output array data type. Default: `None`.
- output array data type. If `dtype` is `None`, the output array data type must be the default floating-point data type. Default: `None`.

#### Returns

Expand Down Expand Up @@ -101,7 +101,7 @@ Returns a two-dimensional array with ones on the `k`th diagonal and zeros elsewh

- **dtype**: _Optional\[ <dtype> ]_

- output array data type. Default: `None`.
- output array data type. If `dtype` is `None`, the output array data type must be the default floating-point data type. Default: `None`.

#### Returns

Expand All @@ -125,7 +125,7 @@ Returns a new array having a specified `shape` and filled with `fill_value`.

- **dtype**: _Optional\[ <dtype> ]_

- output array data type. Default: `None`.
- output array data type. If `dtype` is `None`, the output array data type must be the default floating-point data type. Default: `None`.

#### Returns

Expand Down Expand Up @@ -179,7 +179,7 @@ Returns evenly spaced numbers over a specified interval.

- **dtype**: _Optional\[ <dtype> ]_

- output array data type. Default: `None`.
- output array data type. If `dtype` is `None`, the output array data type must be the default floating-point data type. Default: `None`.

- **endpoint**: _Optional\[ bool ]_

Expand All @@ -203,7 +203,7 @@ Returns a new array having a specified `shape` and filled with ones.

- **dtype**: _Optional\[ <dtype> ]_

- output array data type. Default: `None`.
- output array data type. If `dtype` is `None`, the output array data type must be the default floating-point data type. Default: `None`.

#### Returns

Expand Down Expand Up @@ -243,7 +243,7 @@ Returns a new array having a specified `shape` and filled with zeros.

- **dtype**: _Optional\[ <dtype> ]_

- output array data type. Default: `None`.
- output array data type. If `dtype` is `None`, the output array data type must be the default floating-point data type. Default: `None`.

#### Returns

Expand Down
18 changes: 15 additions & 3 deletions spec/API_specification/data_types.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,28 @@

A conforming implementation of the array API standard must provide and support the following data types.

.. note::

Data types ("dtypes") are objects that can be used as `dtype` specifiers in functions and methods (e.g., `zeros((2, 3), dtype=float32)`). A conforming implementation may add methods or attributes to data type objects; however, these methods and attributes are not included in this specification.

.. note::

Implementations may provide other ways to specify data types (e.g.,
`zeros((2, 3), dtype='f4')`); however, these are not included in this specification.

A conforming implementation of the array API standard may provide and support additional data types beyond those described in this specification.

A conforming implementation of the array API standard must define a default floating-point data type (either `float32` or `float64`).

.. note::

These dtypes are objects that can be used as dtype specifiers in functions and methods (e.g., `zeros((2, 3), dtype=float32)`). A conforming implementation may add methods or attributes to dtype objects; these are not part of this specification however.
The default floating-point data type should be clearly defined in a conforming library's documentation.

A conforming implementation of the array API standard must define a default data type for an array index (either `int32` or `int64`).

.. note::

Implementations may provide others ways to specify dtypes (e.g.,
`zeros((2, 3), dtype='f4')`); these are not part of this specification however.
The default array index data type should be clearly defined in a conforming library's documentation.


## bool
Expand Down
Loading