JuliaArrays / JuliaArrays/AxisArrays.jl
Document indexing semantics
Open
Nobody has claimed this yet.
- Dominant language
- Julia
- Stars
- 207
- Forks
- 41
- PR merge metrics
- No merged PRs in 30d
Description
I'm curious why the API has this indexing syntax and why it's different from standard Julia array indexing.
julia> A = AxisArray(reshape(1:60, 12, 5), (.1:.1:1.2, .1:.1:.5));
julia> A[Axis{:col}(2)] == A[:,2]
true
julia> A[Axis{:col}(2)] === A[:,2]
false
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start from the AxisArray indexing API and the Julia REPL examples in the issue. Compare Axis{:col}(2) with A[:,2] and determine why they are equal but not identical, as well as why the syntax differs from standard Julia indexing. Done means the documentation clearly explains these semantics and the relevant examples.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- julia
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 30/100