implement deleteat (#102)

* implement deleteat * Update src/functions.jl Co-authored-by: Glenn Moynihan <[email protected]> * test for invalid state * Update test/_functions.jl * use wrapdims Co-authored-by: Glenn Moynihan <[email protected]>
mcabbott · Feb 11, 2022 · a78ba3d · a78ba3d · mcabbott · Feb 11, 2022
1 parent 69a040c
commit a78ba3d
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 2 deletions.
diff --git a/Project.toml b/Project.toml
@@ -1,7 +1,7 @@
 name = "AxisKeys"
 uuid = "94b1ba4f-4ee9-5380-92f1-94cde586c3c5"
 license = "MIT"
-version = "0.2.0"
+version = "0.2.1"
 
 [deps]
 AbstractFFTs = "621f4979-c628-5d54-868e-fcf4e3e8185c"
@@ -27,7 +27,7 @@ FiniteDifferences = "0.12"
 IntervalSets = "0.5.1"
 InvertedIndices = "1.0"
 LazyStack = "0.0.7, 0.0.8"
-NamedDims = "0.2.45"
+NamedDims = "0.2.46"
 OffsetArrays = "0.10, 0.11, 1.0"
 StatsBase = "0.32, 0.33"
 Tables = "0.2, 1"

diff --git a/src/functions.jl b/src/functions.jl
@@ -409,3 +409,9 @@ LinearAlgebra.cholesky(A::Hermitian{T, <:KeyedArray{T}}; kwargs...) where {T} =
     cholesky(parent(A); kwargs...)
 LinearAlgebra.cholesky(A::KeyedMatrix; kwargs...) =
     cholesky(keyless_unname(A); kwargs...)
+
+function Base.deleteat!(v::KeyedVector, inds)
+    deleteat!(axiskeys(v, 1), inds)
+    deleteat!(v.data, inds)
+    return v
+end
diff --git a/test/_functions.jl b/test/_functions.jl
@@ -257,6 +257,19 @@ end
     @test AxisKeys.hasnames(similar(M, 2,2,2)) == false
 
 end
+@testset "deleteat!" begin
+    kv = wrapdims([1, 2, 3, 4, 5, 6.0], a=[:a, :b, :c, :d, :e, :f])
+
+    @test kv == deleteat!(kv, 1) == KeyedArray([2, 3, 4, 5, 6.0], a=[:b, :c, :d, :e, :f])
+    @test kv == deleteat!(kv, 1:2) == KeyedArray([4, 5, 6.0], a=[:d, :e, :f])
+    @test kv == deleteat!(kv, (1, 3)) == KeyedArray([5.0], a=[:e])
+
+    # make sure array is not in an invalid state if the deleteat for indices fails
+    ka = wrapdims([4, 5, 6.0], a=1:3)
+    @test_throws MethodError deleteat!(ka, 2)
+    @test ka == KeyedArray([4, 5, 6.0], a=1:3)
+end
+
 @testset "equality" begin
 
     data = parent(parent(M))