Merge deleteat() into delete!() and deprecate it

The generic definition of delete!() suits deleteat!() very well, and the signatures do not conflict.
JuliaLang · Feb 8, 2017 · a6d4207 · a6d4207
1 parent e24faa5
commit a6d4207
Show file tree

Hide file tree

Showing 25 changed files with 110 additions and 107 deletions.
diff --git a/NEWS.md b/NEWS.md
@@ -324,6 +324,8 @@ Deprecated or removed
   * `produce`, `consume` and iteration over a Task object have been deprecated in favor of
     using Channels for inter-task communication  ([#19841]).
 
+  * `deleteat!` has been deprecated in favor of `delete!` ([#20531]).
+
 <!--- generated by NEWS-update.jl: -->
 [#265]: https://github.com/JuliaLang/julia/issues/265
 [#7669]: https://github.com/JuliaLang/julia/issues/7669

diff --git a/base/array.jl b/base/array.jl
@@ -767,13 +767,13 @@ function insert!{T}(a::Array{T,1}, i::Integer, item)
 end
 
 """
-    deleteat!(a::Vector, i::Integer)
+    delete!(a::Vector, i::Integer)
 
 Remove the item at the given `i` and return the modified `a`. Subsequent items
 are shifted to fill the resulting gap.
 
 ```jldoctest
-julia> deleteat!([6, 5, 4, 3, 2, 1], 2)
+julia> delete!([6, 5, 4, 3, 2, 1], 2)
 5-element Array{Int64,1}:
  6
  4
@@ -782,34 +782,34 @@ julia> deleteat!([6, 5, 4, 3, 2, 1], 2)
  1
 ```
 """
-deleteat!(a::Vector, i::Integer) = (_deleteat!(a, i, 1); a)
+delete!(a::Vector, i::Integer) = (_deleteat!(a, i, 1); a)
 
-function deleteat!{T<:Integer}(a::Vector, r::UnitRange{T})
+function delete!{T<:Integer}(a::Vector, r::UnitRange{T})
     n = length(a)
     isempty(r) || _deleteat!(a, first(r), length(r))
     return a
 end
 
 """
-    deleteat!(a::Vector, inds)
+    delete!(a::Vector, inds)
 
 Remove the items at the indices given by `inds`, and return the modified `a`.
 Subsequent items are shifted to fill the resulting gap. `inds` must be sorted and unique.
 
 ```jldoctest
-julia> deleteat!([6, 5, 4, 3, 2, 1], 1:2:5)
+julia> delete!([6, 5, 4, 3, 2, 1], 1:2:5)
 3-element Array{Int64,1}:
  5
  3
  1
 
-julia> deleteat!([6, 5, 4, 3, 2, 1], (2, 2))
+julia> delete!([6, 5, 4, 3, 2, 1], (2, 2))
 ERROR: ArgumentError: indices must be unique and sorted
 Stacktrace:
- [1] deleteat!(::Array{Int64,1}, ::Tuple{Int64,Int64}) at ./array.jl:808
+ [1] delete!(::Array{Int64,1}, ::Tuple{Int64,Int64}) at ./array.jl:822
 ```
 """
-function deleteat!(a::Vector, inds)
+function delete!(a::Vector, inds)
     n = length(a)
     s = start(inds)
     done(inds, s) && return a
@@ -938,7 +938,7 @@ function splice!{T<:Integer}(a::Vector, r::UnitRange{T}, ins=_default_splice)
     v = a[r]
     m = length(ins)
     if m == 0
-        deleteat!(a, r)
+        delete!(a, r)
         return v
     end
 
@@ -1746,7 +1746,7 @@ function filter!(f, a::Vector)
             insrt += 1
         end
     end
-    deleteat!(a, insrt:length(a))
+    delete!(a, insrt:length(a))
     return a
 end
 

diff --git a/base/bitarray.jl b/base/bitarray.jl
@@ -894,7 +894,7 @@ function resize!(B::BitVector, n::Integer)
     n == n0 && return B
     n >= 0 || throw(BoundsError(B, n))
     if n < n0
-        deleteat!(B, n+1:n0)
+        delete!(B, n+1:n0)
         return B
     end
     Bc = B.chunks
@@ -992,7 +992,7 @@ function insert!(B::BitVector, i::Integer, item)
     B
 end
 
-function _deleteat!(B::BitVector, i::Integer)
+function _delete!(B::BitVector, i::Integer)
     k, j = get_chunks_id(i)
 
     msk_bef = _msk64 >>> (63 - j)
@@ -1025,14 +1025,14 @@ function _deleteat!(B::BitVector, i::Integer)
     return B
 end
 
-function deleteat!(B::BitVector, i::Integer)
+function delete!(B::BitVector, i::Integer)
     n = length(B)
     1 <= i <= n || throw(BoundsError(B, i))
 
-    return _deleteat!(B, i)
+    return _delete!(B, i)
 end
 
-function deleteat!(B::BitVector, r::UnitRange{Int})
+function delete!(B::BitVector, r::UnitRange{Int})
     n = length(B)
     i_f = first(r)
     i_l = last(r)
@@ -1056,7 +1056,7 @@ function deleteat!(B::BitVector, r::UnitRange{Int})
     return B
 end
 
-function deleteat!(B::BitVector, inds)
+function delete!(B::BitVector, inds)
     n = new_l = length(B)
     s = start(inds)
     done(inds, s) && return B
@@ -1099,7 +1099,7 @@ function splice!(B::BitVector, i::Integer)
     1 <= i <= n || throw(BoundsError(B, i))
 
     v = B[i]   # TODO: change to a copy if/when subscripting becomes an ArrayView
-    _deleteat!(B, i)
+    _delete!(B, i)
     return v
 end
 

diff --git a/base/client.jl b/base/client.jl
@@ -241,7 +241,7 @@ try_include(path::AbstractString) = isfile(path) && include(path)
 function process_options(opts::JLOptions)
     if !isempty(ARGS)
         idxs = find(x -> x == "--", ARGS)
-        length(idxs) > 0 && deleteat!(ARGS, idxs[1])
+        length(idxs) > 0 && delete!(ARGS, idxs[1])
     end
     repl                  = true
     startup               = (opts.startupfile != 2)

diff --git a/base/deprecated.jl b/base/deprecated.jl
@@ -605,8 +605,8 @@ function gen_broadcast_body_zpreserving(f::Function, is_first_sparse::Bool)
             end
             B.colptr[col+1] = ptrB
         end
-        deleteat!(B.rowval, B.colptr[end]:length(B.rowval))
-        deleteat!(B.nzval, B.colptr[end]:length(B.nzval))
+        delete!(B.rowval, B.colptr[end]:length(B.rowval))
+        delete!(B.nzval, B.colptr[end]:length(B.nzval))
         nothing
     end
 end
@@ -1227,6 +1227,8 @@ for name in ("alnum", "alpha", "cntrl", "digit", "number", "graph",
     @eval @deprecate ($f)(s::AbstractString) all($f, s)
 end
 
+@deprecate deleteat! delete!
+
 # END 0.6 deprecations
 
 # BEGIN 1.0 deprecations

diff --git a/base/dict.jl b/base/dict.jl
@@ -554,6 +554,14 @@ function _delete!(h::Dict, index)
     return h
 end
 
+"""
+    delete!(collection, keys)
+
+Delete the mapping for the given key(s) or index(es) in a collection, and return
+the collection.
+"""
+function delete! end
+
 function delete!(h::Dict, key)
     index = ht_keyindex(h, key)
     if index > 0

diff --git a/base/docs/helpdb/Base.jl b/base/docs/helpdb/Base.jl
@@ -1170,13 +1170,6 @@ The largest integer losslessly representable by the given floating-point DataTyp
 """
 maxintfloat
 
-"""
-    delete!(collection, key)
-
-Delete the mapping for the given key in a collection, and return the collection.
-"""
-delete!
-
 """
     eps(T)
 

diff --git a/base/event.jl b/base/event.jl
@@ -204,7 +204,7 @@ function wait()
                     end
                     # return ourself to the runnable state
                     i = findfirst(Workqueue, ct)
-                    i == 0 || deleteat!(Workqueue, i)
+                    i == 0 || delete!(Workqueue, i)
                     ct.state = :runnable
                 end
                 rethrow(e)

diff --git a/base/exports.jl b/base/exports.jl
@@ -708,7 +708,6 @@ export
     contains,
     count,
     delete!,
-    deleteat!,
     eltype,
     empty!,
     endof,

diff --git a/base/expr.jl b/base/expr.jl
@@ -230,8 +230,8 @@ function popmeta!(body::Array{Any,1}, sym::Symbol)
         return false, []
     end
     ret = isa(metaargs[i], Expr) ? (metaargs[i]::Expr).args : []
-    deleteat!(metaargs, i)
-    isempty(metaargs) && deleteat!(blockargs, idx)
+    delete!(metaargs, i)
+    isempty(metaargs) && delete!(blockargs, idx)
     true, ret
 end
 

diff --git a/base/inference.jl b/base/inference.jl
@@ -3066,8 +3066,8 @@ function type_annotate!(sv::InferenceState)
             end
             # This can create `Expr(:gotoifnot)` with dangling label, which we
             # clean up in `reindex_labels!`
-            deleteat!(body, i)
-            deleteat!(states, i)
+            delete!(body, i)
+            delete!(states, i)
             nexpr -= 1
             continue
         end
@@ -4898,7 +4898,7 @@ function alloc_elim_pass!(sv::InferenceState)
                 continue
             end
 
-            deleteat!(body, i)  # remove tuple allocation
+            delete!(body, i)  # remove tuple allocation
             # convert tuple allocation to a series of local var assignments
             n_ins = 0
             if var === nothing
@@ -4993,7 +4993,7 @@ function delete_void_use!(body, var::Slot, i0)
     while i <= narg
         a = body[i]
         if isa(a, Slot) && slot_id(a) == slot_id(var)
-            deleteat!(body, i)
+            delete!(body, i)
             if i + ndel < i0
                 ndel += 1
             end

diff --git a/base/methodshow.jl b/base/methodshow.jl
@@ -79,7 +79,7 @@ function kwarg_decl(m::Method, kwtype::DataType)
         i = findfirst(x -> endswith(string(x), "..."), kws)
         i==0 && return kws
         push!(kws, kws[i])
-        return deleteat!(kws,i)
+        return delete!(kws,i)
     end
     return ()
 end

diff --git a/base/path.jl b/base/path.jl
@@ -222,7 +222,7 @@ function normpath(path::String)
         clean = true
         for j = 1:length(parts)-1
             if parts[j] != ".." && parts[j+1] == ".."
-                deleteat!(parts, j:j+1)
+                delete!(parts, j:j+1)
                 clean = false
                 break
             end

diff --git a/base/precompile.jl b/base/precompile.jl
@@ -194,7 +194,7 @@ precompile(Base.convert, (Type{Module}, Module))
 precompile(Base.convert, (Type{AbstractString}, String))
 precompile(Base.copy!, (Array{Dict{Any, Any}, 1}, Int, Array{Dict{Any, Any}, 1}, Int, Int))
 precompile(Base.copy, (Bool,))
-precompile(Base.deleteat!, (Array{UInt8, 1}, Base.UnitRange{Int}))
+precompile(Base.delete!, (Array{UInt8, 1}, Base.UnitRange{Int}))
 precompile(Base.done, (Array{Base.LineEdit.TextInterface, 1}, Int))
 precompile(Base.done, (Dict{Any,Any}, Int))
 precompile(Base.done, (Dict{Symbol,Any}, Int))

diff --git a/base/printf.jl b/base/printf.jl
@@ -64,7 +64,7 @@ function parse(s::AbstractString)
                 end
                 list[i] *= list[j]
             end
-            deleteat!(list,i+1:j)
+            delete!(list,i+1:j)
         end
         i += 1
     end

diff --git a/base/sparse/linalg.jl b/base/sparse/linalg.jl
@@ -184,8 +184,8 @@ function spmatmul{Tv,Ti}(A::SparseMatrixCSC{Tv,Ti}, B::SparseMatrixCSC{Tv,Ti};
         colptrC[nB+1] = ip
     end
 
-    deleteat!(rowvalC, colptrC[end]:length(rowvalC))
-    deleteat!(nzvalC, colptrC[end]:length(nzvalC))
+    delete!(rowvalC, colptrC[end]:length(rowvalC))
+    delete!(nzvalC, colptrC[end]:length(nzvalC))
 
     # The Gustavson algorithm does not guarantee the product to have sorted row indices.
     Cunsorted = SparseMatrixCSC(mA, nB, colptrC, rowvalC, nzvalC)
@@ -394,8 +394,8 @@ function sparse_diff1{Tv,Ti}(S::SparseMatrixCSC{Tv,Ti})
         end
         colptr[col+1] = numnz+1
     end
-    deleteat!(rowval, numnz+1:length(rowval))
-    deleteat!(nzval, numnz+1:length(nzval))
+    delete!(rowval, numnz+1:length(rowval))
+    delete!(nzval, numnz+1:length(nzval))
     return SparseMatrixCSC(m-1, n, colptr, rowval, nzval)
 end
 
@@ -483,8 +483,8 @@ function sparse_diff2{Tv,Ti}(a::SparseMatrixCSC{Tv,Ti})
 
         colptr[col+1] = ptrS
     end
-    deleteat!(rowval, ptrS:length(rowval))
-    deleteat!(nzval, ptrS:length(nzval))
+    delete!(rowval, ptrS:length(rowval))
+    delete!(nzval, ptrS:length(nzval))
     return SparseMatrixCSC(m, n-1, colptr, rowval, nzval)
 end