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

The generic definition of delete!() suits deleteat!() very well, and
the signatures do not conflict.

Author: nalimilan

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

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
 

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
 

base/client.jl

@@ -246,7 +246,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)

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!
+
 # TODO: remove warning for using `_` in parse_input_line in base/client.jl
 
 # END 0.6 deprecations

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

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)
 

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)

base/exports.jl

@@ -708,7 +708,6 @@ export
     contains,
     count,
     delete!,
-    deleteat!,
     eltype,
     empty!,
     endof,

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