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

document that DenseArrays do not need to define strides to follow the strided array API #54558

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

document that DenseArrays do not need to define strides to follow the strided array API #54558

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c285ef6
document that DenseArrays do not need to define `strides` to be Strid…
LilithHafner May 22, 2024
fb57c81
Fix preexisting typo
LilithHafner May 23, 2024
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
4 changes: 2 additions & 2 deletions doc/src/manual/interfaces.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -399,11 +399,11 @@ perhaps range-types `Ind` of your own design. For more information, see

| Methods to implement | | Brief description |
|:----------------------------------------------- |:-------------------------------------- |:------------------------------------------------------------------------------------- |
| `strides(A)` | | Return the distance in memory (in number of elements) between adjacent elements in each dimension as a tuple. If `A` is an `AbstractArray{T,0}`, this should return an empty tuple. |
| `Base.unsafe_convert(::Type{Ptr{T}}, A)` | | Return the native address of an array. |
| `Base.elsize(::Type{<:A})` | | Return the stride between consecutive elements in the array. |
| **Optional methods** | **Default definition** | **Brief description** |
| `stride(A, i::Int)` | `strides(A)[i]` | Return the distance in memory (in number of elements) between adjacent elements in dimension k. |
| `strides(A)` | `strides(a::DenseArray{<:Any, 0}) = (); strides(a::DenseArray) = (1, accumulate(*, Base.front(size(a)))...);` | Return the distance in memory (in number of elements) between adjacent elements in each dimension as a tuple. If `A` is an `AbstractArray{T,0}`, this should return an empty tuple. Required iff `A` does not subtype `DenseArray`. |
| `stride(A, i::Int)` | `strides(A)[i]` | Return the distance in memory (in number of elements) between adjacent elements in dimension i. |

A strided array is a subtype of `AbstractArray` whose entries are stored in memory with fixed strides.
Provided the element type of the array is compatible with BLAS, a strided array can utilize BLAS and LAPACK routines
Expand Down