Skip to content
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
merged 5 commits into from
Jun 6, 2019
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions docs/src/distributions.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,3 +23,9 @@ BoolDistribution
```@docs
Deterministic
```

## Uniform

```@docs
Uniform
```
4 changes: 4 additions & 0 deletions src/POMDPModelTools.jl
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,10 @@ export
Deterministic
include("distributions/deterministic.jl")

export
Uniform
include("distributions/uniform.jl")

# convenient implementations
include("convenient_implementations.jl")

Expand Down
35 changes: 35 additions & 0 deletions src/distributions/uniform.jl
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
"""
Uniform(collection)

Create a categorical distribution over a collection of objects.
"""
mutable struct Uniform{C, T}
collection::C
_set::Union{Set{T}, Nothing} # keep track of what's in the collection to make pdf more efficient
end

Uniform(c) = Uniform{typeof(c), eltype(c)}(c, nothing)
Uniform(c::Set) = Uniform{typeof(c), eltype(c)}(c, c)

rand(rng::AbstractRNG, d::Uniform) = rand(rng, d.collection)
Copy link
Member

@rejuvyesh rejuvyesh Jun 3, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unclear about the rationale here. If you are allowing for non-sets and converting it into sets and giving them equal weights, then how can you sample uniformly from the collection which might have multiple instances of the same and therefore higher weight?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, thanks, I need to redesign this.

rand(rng::AbstractRNG, d::Uniform{<:NamedTuple}) = d.collection[rand(rng, 1:length(d.collection))]

support(d::Uniform) = d.collection
sampletype(::Type{Uniform{C, T}}) where {C,T} = T

function pdf(d::Uniform, s)
d._set = something(d._set, Set(d.collection))
if s in d._set
return 1/length(d.collection)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

1.0/length(d.collection)

else
return 0.0
end
end

mode(d::Uniform) = mode(d.collection)
mean(d::Uniform) = mean(d.collection)

function weighted_iterator(d::Uniform)
p = 1/length(d.collection)
return (x=>p for x in d.collection)
end
4 changes: 4 additions & 0 deletions test/runtests.jl
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ using Random
using Test
using Pkg
using POMDPSimulators
import Distributions.Categorical

@testset "ordered" begin
include("test_ordered_spaces.jl")
Expand All @@ -29,6 +30,9 @@ end
@testset "deterministic" begin
include("test_deterministic.jl")
end
@testset "uniform" begin
include("test_uniform.jl")
end
@testset "terminalstate" begin
include("test_terminal_state.jl")
end
Expand Down
22 changes: 22 additions & 0 deletions test/test_uniform.jl
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
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]))

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
1 change: 0 additions & 1 deletion test/test_weighted_iteration.jl
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
let
using Distributions
dist = Categorical([0.4, 0.5, 0.1])
c = collect(weighted_iterator(dist))
@test c == [1=>0.4, 2=>0.5, 3=>0.1]
Expand Down