Add emd_1d and emd2_1d (#12)

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

Project.toml

@@ -1,7 +1,7 @@
 name = "PythonOT"
 uuid = "3c485715-4278-42b2-9b5f-8f00e43c12ef"
 authors = ["David Widmann"]
-version = "0.1.2"
+version = "0.1.3"
 
 [deps]
 PyCall = "438e738f-606a-5dbb-bf0a-cddfbfd45ab0"

docs/src/api.md

@@ -5,6 +5,8 @@
 ```@docs
 emd
 emd2
+emd_1d
+emd2_1d
 ```
 
 ## Regularized optimal transport

src/PythonOT.jl

@@ -4,6 +4,8 @@ using PyCall: PyCall
 
 export emd,
     emd2,
+    emd_1d,
+    emd2_1d,
     sinkhorn,
     sinkhorn2,
     barycenter,

src/lib.jl

@@ -69,6 +69,78 @@ function emd2(μ, ν, C; kwargs...)
     return pot.lp.emd2(μ, ν, PyCall.PyReverseDims(permutedims(C)); kwargs...)
 end
 
+"""
+    emd_1d(xsource, xtarget; kwargs...)
+
+Compute the optimal transport plan for the Monge-Kantorovich problem with univariate
+discrete measures with support `xsource` and `xtarget` as source and target marginals.
+
+This function is a wrapper of the function
+[`emd_1d`](https://pythonot.github.io/all.html#ot.emd_1d) in the Python Optimal Transport
+package. Keyword arguments are listed in the documentation of the Python function.
+
+# Examples
+
+```jldoctest
+julia> xsource = [0.2, 0.5];
+
+julia> xtarget = [0.8, 0.3];
+
+julia> emd_1d(xsource, xtarget)
+2×2 Matrix{Float64}:
+ 0.0  0.5
+ 0.5  0.0
+
+julia> histogram_source = [0.8, 0.2];
+
+julia> histogram_target = [0.7, 0.3];
+
+julia> emd_1d(xsource, xtarget; a=histogram_source, b=histogram_target)
+2×2 Matrix{Float64}:
+ 0.5  0.3
+ 0.2  0.0
+```
+
+See also: [`emd`](@ref), [`emd2_1d`](@ref)
+"""
+function emd_1d(xsource, xtarget; kwargs...)
+    return pot.lp.emd_1d(xsource, xtarget; kwargs...)
+end
+
+"""
+    emd2_1d(xsource, xtarget; kwargs...)
+
+Compute the optimal transport cost for the Monge-Kantorovich problem with univariate
+discrete measures with support `xsource` and `xtarget` as source and target marginals.
+
+This function is a wrapper of the function
+[`emd2_1d`](https://pythonot.github.io/all.html#ot.emd2_1d) in the Python Optimal Transport
+package. Keyword arguments are listed in the documentation of the Python function.
+
+# Examples
+
+```jldoctest
+julia> xsource = [0.2, 0.5];
+
+julia> xtarget = [0.8, 0.3];
+
+julia> round(emd2_1d(xsource, xtarget); sigdigits=6)
+0.05
+
+julia> histogram_source = [0.8, 0.2];
+
+julia> histogram_target = [0.7, 0.3];
+
+julia> round(emd2_1d(xsource, xtarget; a=histogram_source, b=histogram_target); sigdigits=6)
+0.201
+```
+
+See also: [`emd2`](@ref), [`emd2_1d`](@ref)
+"""
+function emd2_1d(xsource, xtarget; kwargs...)
+    return pot.lp.emd2_1d(xsource, xtarget; kwargs...)
+end
+
 """
     sinkhorn(μ, ν, C, ε; kwargs...)