at-deprecate ones

Author: fredrikekre

NEWS.md

@@ -612,6 +612,14 @@ Deprecated or removed
     and/or shape depending on `opts...`. For an algebraic multiplicative identity,
     consider `one(A)` ([#24656]).
 
+  * `ones(dims...)` and `ones(T, dims)` have been deprecated. The direct replacements are
+    `fill(1.0, dims...)` and `fill(one(T), dims...)`/`fill(T(1), dims...)`, but for common
+    types it is often shorter to use numeric literals, e.g. `fill(1, dims...)` for `Int`s,
+    `fill(1f0, dims...)` for `Float32`s, `fill(1+0im, dims...)` for complex types,
+    `fill(0x1, dims...)` for `UInt8`s etc. Other common patterns, such as `x*ones(dims)`
+    for some value `x` can, with advantage, instead be rewritten as
+    `fill(x, dims)` ([#25087]).
+
   * The `Operators` module is deprecated. Instead, import required operators explicitly
     from `Base`, e.g. `import Base: +, -, *, /` ([#22251]).
 

base/array.jl

@@ -343,7 +343,7 @@ fill(v, dims::Integer...) = fill!(Array{typeof(v)}(uninitialized, dims...), v)
     zeros([T=Float64,] dims...)
 
 Create an `Array`, with element type `T`, of all zeros with size specified by `dims`.
-See also [`similar`](@ref).
+See also [`fill`](@ref), [`similar`](@ref).
 
 # Examples
 ```jldoctest
@@ -359,34 +359,10 @@ julia> zeros(Int8, 2, 3)
 """
 function zeros end
 
-"""
-    ones([T=Float64,] dims...)
-
-Create an `Array`, with element type `T`, of all ones with size specified by `dims`.
-See also [`zeros`](@ref), [`similar`](@ref).
-
-# Examples
-```jldoctest
-julia> ones(1,2)
-1×2 Array{Float64,2}:
- 1.0  1.0
-
-julia> ones(ComplexF64, 2, 3)
-2×3 Array{Complex{Float64},2}:
- 1.0+0.0im  1.0+0.0im  1.0+0.0im
- 1.0+0.0im  1.0+0.0im  1.0+0.0im
-```
-"""
-function ones end
-
-for (fname, felt) in ((:zeros, :zero), (:ones, :one))
-    @eval begin
-        $fname(::Type{T}, dims::NTuple{N, Any}) where {T, N} = fill!(Array{T,N}(uninitialized, convert(Dims, dims)::Dims), $felt(T))
-        $fname(dims::Tuple) = ($fname)(Float64, dims)
-        $fname(::Type{T}, dims...) where {T} = $fname(T, dims)
-        $fname(dims...) = $fname(dims)
-    end
-end
+zeros(::Type{T}, dims::NTuple{N, Any}) where {T, N} = fill!(Array{T,N}(uninitialized, convert(Dims, dims)), zero(T))
+zeros(dims::Tuple) = (zeros)(Float64, dims)
+zeros(::Type{T}, dims...) where {T} = zeros(T, dims)
+zeros(dims...) = zeros(dims)
 
 function _one(unit::T, x::AbstractMatrix) where T
     m,n = size(x)

base/deprecated.jl

@@ -1766,6 +1766,12 @@ end
 @deprecate zeros(a::AbstractArray, ::Type{T}) where {T}               fill!(similar(a, T), 0)
 @deprecate zeros(a::AbstractArray)                                    fill!(similar(a), 0)
 
+# deprecate ones
+@deprecate ones(::Type{T}, dims::Tuple) where {T} fill(one(T), dims)
+@deprecate ones(dims::Tuple) fill(1., dims)
+@deprecate ones(::Type{T}, dims...) where {T} fill(one(T), dims...)
+@deprecate ones(dims...) fill(1., dims...)
+
 # PR #23711
 @eval LibGit2 begin
     @deprecate get_creds!(cache::CachedCredentials, credid, default) get!(cache, credid, default)

base/exports.jl

@@ -477,7 +477,6 @@ export
     minmax,
     ndims,
     nonzeros,
-    ones,
     parent,
     parentindices,
     partialsort,

doc/src/stdlib/arrays.md

@@ -22,7 +22,6 @@ Base.Matrix(::Nothing, ::Any, ::Any)
 Base.Matrix(::Missing, ::Any, ::Any)
 Base.getindex(::Type, ::Any...)
 Base.zeros
-Base.ones
 Base.BitArray
 Base.BitArray(::Uninitialized, ::Integer...)
 Base.BitArray(::Any)