Exporting discretemeasure (#15)

* ✨ Exporting discretemeasure.

* Formatting.

* 📚 Adding discretemeasure docs.

* Update src/utils.jl

Co-authored-by: David Widmann <[email protected]>

* Removed double docstring and changed text.

* Update src/utils.jl

Co-authored-by: David Widmann <[email protected]>

* Update Project.toml

Co-authored-by: David Widmann <[email protected]>

Author: davibarreira

Project.toml

@@ -1,7 +1,7 @@
 name = "ExactOptimalTransport"
 uuid = "24df6009-d856-477c-ac5c-91f668376b31"
 authors = ["JuliaOptimalTransport"]
-version = "0.1.0"
+version = "0.1.1"
 
 [deps]
 Distances = "b4f34e82-e78d-54a5-968a-f98e89d6e8f7"

docs/src/index.md

@@ -28,3 +28,7 @@ ot_cost(::ExactOptimalTransport.SqEuclidean, ::ExactOptimalTransport.MvNormal, :
 wasserstein
 squared2wasserstein
 ```
+
+```@docs
+discretemeasure
+```

src/ExactOptimalTransport.jl

@@ -12,6 +12,7 @@ using SparseArrays
 
 export emd, emd2
 export ot_cost, ot_plan, wasserstein, squared2wasserstein
+export discretemeasure
 
 const MOI = MathOptInterface
 

src/utils.jl

@@ -12,7 +12,7 @@ end
 """
     discretemeasure(
         support::AbstractVector,
-        probs::AbstractVector{<:Real}=fill(inv(length(support)), length(support))
+        probs::AbstractVector{<:Real}=fill(inv(length(support)), length(support)),
     )
 
 Construct a finite discrete probability measure with `support` and corresponding
@@ -33,6 +33,12 @@ using KernelFunctions
     If `support` is a 1D vector, the constructed measure will be sorted,
     e.g. for `mu = discretemeasure([3, 1, 2],[0.5, 0.2, 0.3])`, then
     `mu.support` will be `[1, 2, 3]` and `mu.p` will be `[0.2, 0.3, 0.5]`.
+    Also, avoid passing 1D distributions as `RowVecs(rand(3))` or `[[1],[3],[4]]`,
+    since this will be dispatched to the multivariate case instead
+    of the univariate case for which the algorithm is more efficient.
+
+!!! warning
+    This function and in particular its return values are not stable and might be changed in future releases.
 """
 function discretemeasure(
     support::AbstractVector{<:Real},