update sprand to take in rfn function

Author: lkdvos

src/abstractsparsearrayinterface.jl

@@ -43,40 +43,45 @@ The optional `T` argument specifies the element type, which defualts to `Float64
 spzeros(dims::Dims) = spzeros(Float64, dims)
 spzeros(::Type{T}, dims::Dims) where {T} = SparseArrayDOK{T}(undef, dims)
 
+@doc """
+    sprand([rng], [T::Type], dims; density::Real=0.5, rfn::Function=rand) -> A::SparseArrayDOK{T}
+
 Create a random size `dims` sparse array in which the probability of any element being stored is independently given by `density`.
 The optional `rng` argument specifies a random number generator, see also `Random`.
 The optional `T` argument specifies the element type, which defaults to `Float64`.
 
 See also [`sprand!`](@ref).
 """ sprand
 
-function sprand(::Type{T}, dims::Dims; density::Real=0.5) where {T}
-  return sprand(default_rng(), T, dims; density)
+function sprand(::Type{T}, dims::Dims; kwargs...) where {T}
+  return sprand(default_rng(), T, dims; kwargs...)
 end
-sprand(dims::Dims; density::Real=0.5) = sprand(default_rng(), Float64, dims; density)
-function sprand(rng::AbstractRNG, dims::Dims; density::Real=0.5)
-  return sprand(rng, Float64, dims; density)
+sprand(dims::Dims; kwargs...) = sprand(default_rng(), Float64, dims; kwargs...)
+function sprand(rng::AbstractRNG, dims::Dims; kwargs...)
+  return sprand(rng, Float64, dims; kwargs...)
 end
-function sprand(rng::AbstractRNG, ::Type{T}, dims::Dims; density::Real=0.5) where {T}
+function sprand(rng::AbstractRNG, ::Type{T}, dims::Dims; kwargs...) where {T}
   A = SparseArrayDOK{T}(undef, dims)
-  sprand!(rng, A; density)
+  sprand!(rng, A; kwargs...)
   return A
 end
 
 @doc """
-    sprand!([rng], A::AbstractArray; density::Real=0.5) -> A
+    sprand!([rng], A::AbstractArray; density::Real=0.5, rfn::Function=rand) -> A
 
 Overwrite part of an array with random entries, where the probability of overwriting is independently given by `density`.
 The optional `rng` argument specifies a random number generator, see also `Random`.
 
 See also [`sprand`](@ref).
 """ sprand!
 
-sprand!(A::AbstractArray; density::Real=0.5) = sprand!(default_rng(), A; density)
-function sprand!(rng::AbstractRNG, A::AbstractArray; density::Real=0.5)
+sprand!(A::AbstractArray; kwargs...) = sprand!(default_rng(), A; kwargs...)
+function sprand!(
+  rng::AbstractRNG, A::AbstractArray; density::Real=0.5, rfn::Function=Random.rand
+)
+  ArrayLayouts.zero!(A)
   rand_inds = Random.randsubseq(rng, eachindex(A), density)
-  rand_entries = rand(rng, eltype(A), length(rand_inds))
-
+  rand_entries = rfn(rng, eltype(A), length(rand_inds))
   for (I, v) in zip(rand_inds, rand_entries)
     A[I] = v
   end