-
Notifications
You must be signed in to change notification settings - Fork 53
PR: Add finfo and iinfo in the spec #129
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.
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
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
8c414d6
add finfo and iinfo in the spec
steff456 39a9cb2
move result_type function to new file and minor fixes
steff456 79dc82c
add review changes and remove tiny from the finfo object
steff456 2cc6683
Make finfo/info argument positional-only
rgommers File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,81 @@ | ||
# Data type functions | ||
|
||
> Array API specification for data type functions. | ||
|
||
A conforming implementation of the array API standard must provide and support the following data type functions. | ||
|
||
<!-- NOTE: please keep the constants in alphabetical order --> | ||
|
||
## Objects in API | ||
|
||
(finfo)= | ||
### finfo(type) | ||
|
||
Machine limits for floating-point data types. | ||
|
||
#### Parameters | ||
|
||
- **type**: _Union\[ <dtype>, <array> ]_ | ||
|
||
- the kind of floating-point data-type about which to get information. | ||
|
||
#### Returns | ||
|
||
- **out**: _<class>_ | ||
|
||
- an object having the following attributes: | ||
|
||
- **bits**: _int_ | ||
- number of bits occupied by the floating-point data type. | ||
- **eps**: _float_ | ||
- difference between 1.0 and the next smallest representable floating-point number larger than 1.0 according to the IEEE-754 standard. | ||
- **max**: _float_ | ||
- largest representable number. | ||
- **min**: _float_ | ||
- smallest representable number. | ||
|
||
(iinfo)= | ||
### iinfo(type) | ||
|
||
Machine limits for integer data types. | ||
|
||
#### Parameters | ||
|
||
- **type**: _Union\[ <dtype>, <array> ]_ | ||
|
||
- the kind of integer data-type about which to get information. | ||
|
||
#### Returns | ||
|
||
- **out**: _<class>_ | ||
|
||
- a class with that encapsules the following attributes: | ||
|
||
- **bits**: _int_ | ||
- number of bits occupied by the type | ||
- **max**: _int_ | ||
- largest representable number. | ||
- **min**: _int_ | ||
- smallest representable number. | ||
|
||
(function-result_type)= | ||
### result_type(*arrays_and_dtypes) | ||
|
||
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. | ||
``` | ||
|
||
#### Parameters | ||
|
||
- **arrays_and_dtypes**: _Sequence\[ Union\[ <array>, <dtype> \] \];_ | ||
|
||
- input arrays and dtypes. | ||
|
||
#### Returns | ||
|
||
- **out**: _<dtype>_ | ||
|
||
- the dtype resulting from an operation involving the input arrays and dtypes. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
type
should be a positional argument here, so this should befinfo(type, /)
.And same for
iinfo
.