-
Notifications
You must be signed in to change notification settings - Fork 6
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
added a uniform distribution over a collection of objects #19
Merged
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
0b44190
added a uniform distribution over a collection of objects
zsunberg 784c10d
Merge branch 'master' into uniform
zsunberg 56859d9
Uniform checks uniqueness, added UnsafeUniform
zsunberg 8db5e7b
put code into common section
zsunberg 47936b3
deleted commented code
zsunberg File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -23,3 +23,10 @@ BoolDistribution | |
```@docs | ||
Deterministic | ||
``` | ||
|
||
## Uniform | ||
|
||
```@docs | ||
Uniform | ||
UnsafeUniform | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,70 @@ | ||
struct Uniform{T<:AbstractSet} | ||
set::T | ||
end | ||
|
||
""" | ||
Uniform(collection) | ||
|
||
Create a uniform categorical distribution over a collection of objects. | ||
|
||
The objects in the collection must be unique (this is tested on construction), and will be stored in a `Set`. To avoid this overhead, use `UnsafeUniform`. | ||
""" | ||
function Uniform(c) | ||
set = Set(c) | ||
if length(c) > length(set) | ||
error(""" | ||
Error constructing Uniform($c). | ||
|
||
Objects must be unique (that is, length(Set(c)) == length(c)). | ||
""" | ||
) | ||
end | ||
return Uniform(set) | ||
end | ||
|
||
# rand(rng::AbstractRNG, d::Uniform) = rand(rng, d.set) | ||
support(d::Uniform) = d.set | ||
sampletype(::Type{Uniform{T}}) where T = eltype(T) | ||
|
||
function pdf(d::Uniform, s) | ||
if s in d.set | ||
return 1.0/length(d.set) | ||
else | ||
return 0.0 | ||
end | ||
end | ||
|
||
# mean(d::Uniform) = mean(d.set) | ||
# mode(d::Uniform) = mode(d.set) | ||
# | ||
# function weighted_iterator(d::Uniform) | ||
# p = 1.0/length(d.set) | ||
# return (x=>p for x in d.set) | ||
# end | ||
|
||
""" | ||
UnsafeUniform(collection) | ||
|
||
Create a uniform categorical distribution over a collection of objects. | ||
|
||
No checks are performed to ensure uniqueness or check whether an object is actually in the set when evaluating the pdf. | ||
""" | ||
struct UnsafeUniform{T} | ||
collection::T | ||
end | ||
|
||
pdf(d::UnsafeUniform, s) = 1.0/length(d.collection) | ||
support(d::UnsafeUniform) = d.collection | ||
sampletype(::Type{UnsafeUniform{T}}) where T = eltype(T) | ||
|
||
# common | ||
const Unif = Union{Uniform,UnsafeUniform} | ||
|
||
rand(rng::AbstractRNG, d::Unif) = rand(rng, support(d)) | ||
mean(d::Unif) = mean(support(d)) | ||
mode(d::Unif) = mode(support(d)) | ||
|
||
function weighted_iterator(d::Unif) | ||
p = 1.0/length(support(d)) | ||
return (x=>p for x in support(d)) | ||
end |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,51 @@ | ||
d = Uniform([1]) | ||
|
||
@test rand(d) == 1 | ||
@test rand(MersenneTwister(4), d) == 1 | ||
@test collect(support(d)) == [1] | ||
@test sampletype(d) == typeof(1) | ||
@test sampletype(typeof(d)) == typeof(1) | ||
@test pdf(d, 0) == 0.0 | ||
@test pdf(d, 1) == 1.0 | ||
@test mode(d) == 1 | ||
@test mean(d) == 1 | ||
@test typeof(mean(d)) == typeof(mean([1])) | ||
@test collect(weighted_iterator(d)) == [1=>1.0] | ||
|
||
d2 = Uniform((:symbol,)) | ||
@test rand(d2) == :symbol | ||
@test rand(MersenneTwister(4), d2) == :symbol | ||
@test collect(support(d2)) == [:symbol] | ||
@test sampletype(d2) == typeof(:symbol) | ||
@test sampletype(typeof(d2)) == typeof(:symbol) | ||
@test pdf(d2, :another) == 0.0 | ||
@test pdf(d2, :symbol) == 1.0 | ||
@test mode(d2) == :symbol | ||
@test collect(weighted_iterator(d2)) == [:symbol=>1.0] | ||
|
||
# uniqueness test | ||
@test_throws ErrorException Uniform((:symbol, :symbol)) | ||
|
||
d3 = UnsafeUniform([1]) | ||
|
||
@test rand(d3) == 1 | ||
@test rand(MersenneTwister(4), d3) == 1 | ||
@test collect(support(d3)) == [1] | ||
@test sampletype(d3) == typeof(1) | ||
@test sampletype(typeof(d3)) == typeof(1) | ||
@test pdf(d3, 1) == 1.0 | ||
@test mean(d3) == 1 | ||
@test mode(d3) == 1 | ||
@test typeof(mean(d3)) == typeof(mean([1])) | ||
@test collect(weighted_iterator(d3)) == [1=>1.0] | ||
|
||
d4 = UnsafeUniform((:symbol,)) | ||
@test rand(d4) == :symbol | ||
@test rand(MersenneTwister(4), d4) == :symbol | ||
@test collect(support(d4)) == [:symbol] | ||
@test sampletype(d4) == typeof(:symbol) | ||
@test sampletype(typeof(d4)) == typeof(:symbol) | ||
# @test pdf(d4, :another) == 0.0 # this will not work | ||
@test pdf(d4, :symbol) == 1.0 | ||
@test mode(d4) == :symbol | ||
@test collect(weighted_iterator(d4)) == [:symbol=>1.0] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Delete these?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
oh yeah 🤦♂️