deprecate sprandbool + add new syntax for creating random sparse matrix #16098

KristofferC · 2016-04-28T16:21:06Z

This mimics the one already existing for rand.

Now:

julia> rand(Float32, 3, 3)
3×3 Array{Float32,2}:
 0.938487  0.200827  0.746491
 0.566157  0.650916  0.466414
 0.408861  0.166284  0.648508

julia> sparsity = 0.5
0.5

julia> sprand(Float32, 3, 3, sparsity)
3×3 sparse matrix with 4 Float32 nonzero entries:
    [2, 1]  =  0.181532
    [3, 2]  =  0.51335
    [1, 3]  =  0.630208
    [2, 3]  =  0.632587

[edit by tkelman: closes #11688]

KristofferC · 2016-04-28T16:25:02Z

Probably makes sense to deprecate sprandbool here too since now it is just:

julia> sprand(Bool, 3, 3, 0.5)
3×3 sparse matrix with 5 Bool nonzero entries:
    [2, 1]  =  false
    [1, 2]  =  false
    [2, 2]  =  false
    [3, 2]  =  true
    [3, 3]  =  true

KristofferC · 2016-04-28T17:09:46Z

Actually the above is wrong since false shouldn't be stored.

KristofferC · 2016-04-28T21:56:15Z

base/sparse/sparsevector.jl

@@ -356,17 +356,17 @@ function sprand(r::AbstractRNG, n::Integer, p::AbstractFloat, rfn::Function)
    SparseVector(n, I, V)
 end

+sprand{T}(::Type{T}, n::Integer, p::AbstractFloat) = sprand(GLOBAL_RNG, n, p, rand, T)
 sprand{T}(n::Integer, p::AbstractFloat, ::Type{T}) = sprand(GLOBAL_RNG, n, p, rand, T)


Should this one be deprecated as well? It doesn't correspond to the dense case.

tkelman · 2016-04-29T00:53:54Z

Needs a doc update for the new sprand syntax with eltype first. It's a little annoying that eltype comes last in the existing version of sprand if you want to provide both an RNG and an eltype. Ideally we could make the whole thing more consistent with the way rand works when you want to provide just one or both (but with the additional density parameter).

KristofferC · 2016-04-29T12:33:07Z

Yes, I will make stuff more consistent between rand and sprand but then there will have to be some deprecations for sprand too

KristofferC · 2016-04-29T15:47:07Z

Updated. Some usage examples:

julia> sprand(Bool, 3, 3, 0.3)
3×3 sparse matrix with 2 Bool nonzero entries:
    [3, 1]  =  true
    [1, 3]  =  true

julia> sprand(Base.GLOBAL_RNG, Bool, 3, 3, 0.3)
3×3 sparse matrix with 4 Bool nonzero entries:
    [1, 1]  =  true
    [3, 1]  =  true
    [1, 3]  =  true
    [2, 3]  =  true

julia> sprand(Base.GLOBAL_RNG, Float32, 3, 3, 0.3)
3×3 sparse matrix with 2 Float32 nonzero entries:
    [3, 2]  =  0.954499
    [2, 3]  =  0.00251913

julia> sprand(Float64, 3, 3, 0.3)
3×3 sparse matrix with 3 Float64 nonzero entries:
    [2, 1]  =  0.960525
    [3, 1]  =  0.990573
    [1, 3]  =  0.475681

julia> sprand(Float64, 2, 0.3)
Sparse vector of length 2 with 1 Float64 nonzero entries:
  [1]  =  0.446653

julia> sprand(Bool, 5, 0.3)
Sparse vector of length 5 with 2 Bool nonzero entries:
  [2]  =  true
  [5]  =  true

tkelman · 2016-04-29T15:49:57Z

base/sparse/sparsematrix.jl


 Create a random length `m` sparse vector or `m` by `n` sparse matrix, in
 which the probability of any element being nonzero is independently given by
 `p` (and hence the mean density of nonzeros is also exactly `p`). Nonzero
-values are sampled from the distribution specified by `rfn`. The uniform
+values are sampled from the distribution specified by `rfn` and have the type `type`. The uniform


run genstdlib

looks really good, thanks for getting to this before I did

wow, you are fast.. just ran it.

think I need to rerun make for the actual docstring to get updated though..

yeah make docs is the more precise way that will also rerun bootstrap to get the updated docstring into the system image

KristofferC · 2016-04-29T15:51:53Z

What is the policy regarding documentation? Should documentation for deprecated methods be removed?

tkelman · 2016-04-29T15:52:36Z

I think that's what we've been doing. The deprecation warning will point to the new syntax and the new syntax should be as well or better documented than the old syntax.

…trix

KristofferC · 2016-04-29T16:15:12Z

I built up a bit of unnecessary CI queue which could possibly be killed.

nalimilan · 2016-04-29T16:20:20Z

I've cancelled the duplicate builds.

tkelman · 2016-04-29T16:26:53Z

there are hooks that fail fast on redundant builds automatically, so not a big deal. manually cancelling saves maybe a minute or two tops.

edit: unless they builds have already started, in which case manually cancelling is worthwhile

nalimilan · 2016-04-29T16:35:40Z

@tkelman The issue is that the obsolete builds had already started, and AFAIK they aren't cancelled automatically in that case.

KristofferC · 2016-04-29T18:14:53Z

Error is OSX timeout.

tkelman · 2016-04-29T22:49:57Z

Last few places it should be cleaned up, from git grep:

base/exports.jl:1462:    sprandbool,
base/sparse.jl:34:    sprand, sprandbool, sprandn, spzeros, symperm, nnz
contrib/BBEditTextWrangler-julia.plist:1073:            <string>sprandbool</string>

then we're good to merge

KristofferC · 2016-04-30T07:21:14Z

Doesn't it still need to be exported? Or does the deprecated macro export?

tkelman · 2016-04-30T08:25:06Z

the deprecate macro should be handling the exporting, I believe

nalimilan · 2016-04-30T09:05:28Z

the deprecate macro should be handling the exporting, I believe

That's right (as documented in the comment at the top of deprecated.jl).

KristofferC · 2016-04-30T09:57:25Z

I accidentally amended the latest changes to the "remove documentation" commit. However, if things are fine now then it will be squashed by the one who merges anyway so it shouldn't matter much.

KristofferC · 2016-04-30T11:31:46Z

Anyway this is ready from my pov.

tkelman · 2017-04-26T21:12:07Z

test/sparsedir/sparsevector.jl

@@ -152,7 +152,7 @@ end
 let r1 = MersenneTwister(), r2 = MersenneTwister()
    @test sprand(r1, 100, .9) == sprand(r2, 100, .9)
    @test sprandn(r1, 100, .9) == sprandn(r2, 100, .9)
-    @test sprandbool(r1, 100, .9) == sprandbool(r2, 100, .9)
+    @test sprand(r1, Bool, 100, .9, ) == sprand(r2,  Bool, 100, .9)


any recollection why there's an extra comma here?

Accident probably.

KristofferC changed the title ~~add new syntax for creating random sparse matrix~~ WIP: add new syntax for creating random sparse matrix Apr 28, 2016

KristofferC changed the title ~~WIP: add new syntax for creating random sparse matrix~~ deprecate sprandbool + add new syntax for creating random sparse matrix Apr 28, 2016

KristofferC reviewed Apr 28, 2016
View reviewed changes

KristofferC force-pushed the kc/rand_type branch from 0b5e0c7 to 21b3b2a Compare April 29, 2016 15:45

tkelman reviewed Apr 29, 2016
View reviewed changes

KristofferC force-pushed the kc/rand_type branch from 21b3b2a to 7d65f74 Compare April 29, 2016 15:50

KristofferC force-pushed the kc/rand_type branch from 077afc3 to 9e53eda Compare April 29, 2016 16:03

deprecate sprandbool and add new syntax for creating random sparse ma…

f6ab0c2

…trix

remove documentation for sprandbool

8044d1d

KristofferC force-pushed the kc/rand_type branch from 9e53eda to 8044d1d Compare April 30, 2016 09:55

tkelman merged commit bbc8e60 into JuliaLang:master Apr 30, 2016

KristofferC deleted the kc/rand_type branch April 30, 2016 12:54

ViralBShah added the domain:arrays:sparse Sparse arrays label Apr 30, 2016

tkelman reviewed Apr 26, 2017

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

deprecate sprandbool + add new syntax for creating random sparse matrix #16098

deprecate sprandbool + add new syntax for creating random sparse matrix #16098

KristofferC commented Apr 28, 2016 •

edited by tkelman

Loading

KristofferC commented Apr 28, 2016

KristofferC commented Apr 28, 2016

KristofferC Apr 28, 2016

tkelman commented Apr 29, 2016

KristofferC commented Apr 29, 2016

KristofferC commented Apr 29, 2016 •

edited

Loading

tkelman Apr 29, 2016

KristofferC Apr 29, 2016

KristofferC Apr 29, 2016

tkelman Apr 29, 2016

KristofferC commented Apr 29, 2016

tkelman commented Apr 29, 2016

KristofferC commented Apr 29, 2016

nalimilan commented Apr 29, 2016

tkelman commented Apr 29, 2016 •

edited

Loading

nalimilan commented Apr 29, 2016

KristofferC commented Apr 29, 2016

tkelman commented Apr 29, 2016

KristofferC commented Apr 30, 2016

tkelman commented Apr 30, 2016

nalimilan commented Apr 30, 2016

KristofferC commented Apr 30, 2016

KristofferC commented Apr 30, 2016

tkelman Apr 26, 2017

KristofferC Apr 27, 2017

deprecate sprandbool + add new syntax for creating random sparse matrix #16098

deprecate sprandbool + add new syntax for creating random sparse matrix #16098

Conversation

KristofferC commented Apr 28, 2016 • edited by tkelman Loading

KristofferC commented Apr 28, 2016

KristofferC commented Apr 28, 2016

KristofferC Apr 28, 2016

Choose a reason for hiding this comment

tkelman commented Apr 29, 2016

KristofferC commented Apr 29, 2016

KristofferC commented Apr 29, 2016 • edited Loading

tkelman Apr 29, 2016

Choose a reason for hiding this comment

KristofferC Apr 29, 2016

Choose a reason for hiding this comment

KristofferC Apr 29, 2016

Choose a reason for hiding this comment

tkelman Apr 29, 2016

Choose a reason for hiding this comment

KristofferC commented Apr 29, 2016

tkelman commented Apr 29, 2016

KristofferC commented Apr 29, 2016

nalimilan commented Apr 29, 2016

tkelman commented Apr 29, 2016 • edited Loading

nalimilan commented Apr 29, 2016

KristofferC commented Apr 29, 2016

tkelman commented Apr 29, 2016

KristofferC commented Apr 30, 2016

tkelman commented Apr 30, 2016

nalimilan commented Apr 30, 2016

KristofferC commented Apr 30, 2016

KristofferC commented Apr 30, 2016

tkelman Apr 26, 2017

Choose a reason for hiding this comment

KristofferC Apr 27, 2017

Choose a reason for hiding this comment

KristofferC commented Apr 28, 2016 •

edited by tkelman

Loading

KristofferC commented Apr 29, 2016 •

edited

Loading

tkelman commented Apr 29, 2016 •

edited

Loading