Skip to content

Require that data type objects implement __eq__ in order to test for data type equality #273

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
merged 2 commits into from
Sep 20, 2021
Merged

Require that data type objects implement __eq__ in order to test for data type equality #273

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ec3a1a8
Specify `__eq__`
kgryte Sep 20, 2021
862a910
Fix reference
kgryte Sep 20, 2021
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
43 changes: 39 additions & 4 deletions spec/API_specification/data_types.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,14 +64,49 @@ for more details.
:::

```{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.
A conforming implementation of the array API standard may provide and support additional data types beyond those described in this specification.
```

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

A conforming implementation of the array API standard may provide and support additional data types beyond those described in this specification.
Data types ("dtypes") are objects which are used as `dtype` specifiers in functions and methods (e.g., `zeros((2, 3), dtype=float32)`).

```{note}
A conforming implementation may add additional methods or attributes to data type objects beyond those described in this specification.
```

```{note}
Implementations may provide other ways to specify data types (e.g., `zeros((2, 3), dtype='f4')`) which are not described in this specification; however, in order to ensure portability, array library consumers are recommended to use data type objects as provided by specification conforming array libraries.
```

A conforming implementation of the array API standard must provide and support data type objects having the following attributes and methods.

### Methods

<!-- NOTE: please keep the methods in alphabetical order -->

(data-type-method-__eq__)=
### \_\_eq\_\_(self, other, /)

Computes the truth value of `self == other` in order to test for data type object equality.

#### Parameters

- **self**: _&lt;dtype&gt;_

- data type instance. May be any supported data type.

- **other**: _&lt;dtype&gt;_

- other data type instance. May be any supported data type.

#### Returns

- **out**: _&lt;bool&gt;_

- a boolean indicating whether the data type objects are equal.

(data-type-defaults)=
## Default Data Types

Expand Down