[ndarray][doc] Improve behaviors of 0darray + more docstring #209
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.
This PR aims to improve the behaviors of 0-dimensional array (numojo scalar). Note that
a.item(0)ora[Item(0)]is always preferred because the behavior is more determined, but we also allow some basic operations on 0darray to make users' life easier.0-dimensional array cannot be constructed by users but can be obtained by array indexing and slicing. Printing this variable gives the scalar and a note that it is an 0darray instead of a mojo scalar. It is similar to
numpyin thata[0]returns a numpy scalar anda.item(0)returns a Python scalar. For example,0-dimensional array can be unpacked to get the corresponding mojo scalar either by
[]or byitem(). For example,0-dimensional array can be used in arithmetic operations, just like a scalar.