Create

[oxinabox]

Checklist from JuliaCollections/AxisArraysFuture#1 (comment)

• Wrapper Type, that wraps an AbstractArray giving names to the indexes. The index named can go in the type params
• Mapping function: name2dim(::NamedDimsArray, ::Symbol)::Int that will take an array with named dimentsions and dimention name, and return its dimension index.
• Overloads for common functions that take a dims argument. Like sum and mean
  - that return NamedDimArrays
• kwarg style indexing feature request: kwargs for getindex JuliaLang/julia#25631
• Optional AbstractArray methods see docs

[oxinabox]

probably want to implement a bunch of the optional AbstractArray stuff

[oxinabox]

Julia 1.1 is noticable better at constant propergation such that things happen at compile time.

[codecov]

Codecov Report

Merging #1 into master will increase coverage by 91.66%.
The diff coverage is 91.54%.

@@             Coverage Diff             @@
##           master       #1       +/-   ##
===========================================
+ Coverage       0%   91.66%   +91.66%     
===========================================
  Files           1        5        +4     
  Lines           1       72       +71     
===========================================
+ Hits            0       66       +66     
- Misses          1        6        +5

Impacted Files	Coverage Δ
src/NamedDims.jl	100% <ø> (+100%)	⬆️
src/functions_dims.jl	100% <100%> (ø)
src/wrapper_array.jl	88.46% <88.46%> (ø)
src/functions.jl	91.66% <91.66%> (ø)
src/name_core.jl	93.1% <93.1%> (ø)

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update f167597...c4082dd. Read the comment docs.

[iamed2]

I feel like you would want to return a NamedDimsArray from operations on a NamedDimsArray

[rofinn]

This seems mostly fine, but the inconsistent conventions bugs me a little. There appears to be a mixture of _s, combined and shortened names. It'd be good to pick one convention for the package.

[rofinn]

Seems weird to only partially follow the _ convention.

[nickrobinson251]

i prefer a2b naming only for Dicts but I don't have a good alternative

Although if name2dim is part of the public API i'd like to try finding a better name :)

Is dim[s] or dimension[s] better or worse?

[oxinabox]

so name_to_dim?
I am ok with that.

[oxinabox]

get_dim?
dim?

[nickrobinson251]

i quite to like dims(names) and dims(names, name) ...but maybe it's scarily short?

plus NamedDims.dims goes nicely with NamedDims.names

edit: think dims better than dim :)

[oxinabox]

We have axes it is only slightly shorter.

[oxinabox]

Can't do dims,
it is a kwarg on functions that want to call this.

e.g.
sum(xs::NamedDimArray; dims)=sum(parent(xs), dims(xs, dims))
does not work; and
sum(xs::NamedDimArray; dims)=sum(parent(xs), NamedDimArray.dims(xs, dims))
is ugly.

[oxinabox]

I feel like you would want to return a NamedDimsArray from operations on a NamedDimsArray

Ah yes, indeed I do.
Did not think sum etc through fully.

Looks like I will have to implement more functions for working out dimensions, after operations
but that should make #2 #3 #4 easier at least

[oxinabox]

Added dropdims, because I implemented the code for it by mistake (I thought summing over a dimension dropped that dimension, but apparently not (did it used to?))

This is ready for another round of review.

[nickrobinson251]

LGTM (bar very minor style things)

I'd quite like to test on both the 1d and Nd case, but extra tests can always be added later :)

Good work!