Update version and extend docstring

Author: meggart

Project.toml

@@ -1,10 +1,14 @@
 name = "WeightedOnlineStats"
 uuid = "bbac0a1f-7c9d-5672-960b-c6ca726e5d5d"
 authors = ["Guido Kraemer <[email protected]>", "Martin Gutwin <[email protected]>"]
-version = "0.3.3"
+version = "0.4.0"
 
 [compat]
 julia = "1"
+MultivariateStats = "0.7"
+OnlineStats = "1"
+OnlineStatsBase = "1"
+StatsBase = "0.30,0.31,0.32"
 
 [deps]
 LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"

src/histogram.jl

@@ -27,7 +27,12 @@ Create a histogram with bin partition defined by `edges`.
 - If `left`, the bins will be left-closed.
 - If `closed`, the bin on the end will be closed.
     - E.g. for a two bin histogram ``[a, b), [b, c)`` vs. ``[a, b), [b, c]``
-# Example
+
+If `edges` is a tuple instead of an array, a multidimensional histogram will be
+generated that behaves like a `WeightedOnlineStat{VectorOb}`.
+
+# Examples
+
     o = fit!(WeightedHist(-5:.1:5), randn(10^6))
 
     # approximate statistics
@@ -40,6 +45,11 @@ Create a histogram with bin partition defined by `edges`.
     extrema(o)
     area(o)
     pdf(o)
+
+## 2d Histogram
+
+    hist2d = fit!(WeightedHist((-5:1:5, -5:1:5) ), randn(10000,2), rand(10000))
+    value(hist2d).y
 """
 struct WeightedHist1D{R} <: WeightedHist{Float64}
     edges::R
@@ -76,6 +86,7 @@ end
 nobs(o::WeightedHist) = sum(o.counts) + sum(o.outcount)
 weightsum(o::WeightedHist) = LinearAlgebra.dot(o.counts, o.meanw) + LinearAlgebra.dot(o.outcount,o.meanwout)
 value(o::WeightedHist) = (x=edges(o), y=o.counts .* o.meanw)
+binindices(o::WeightedHistND{<:Any,N}, x::AbstractVector) where N = binindices(o, ntuple(i->x[i],N))
 binindices(o::WeightedHist1D,x) = OnlineStats.binindex(o.edges, x, o.left, o.closed)
 binindices(o::WeightedHistND,x) = CartesianIndex(map((e,ix)->OnlineStats.binindex(e, ix, o.left, o.closed), o.edges, x))
 midpoints(o::WeightedHistND) = Iterators.product(map(midpoints,o.edges)...)