add alias 'disjoint' for 'is_intersection_empty'

JuliaReach · Sep 24, 2018 · 6b89716 · 6b89716
1 parent bf3ca1b
commit 6b89716
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 1 deletion.
diff --git a/docs/src/lib/binary_functions.md b/docs/src/lib/binary_functions.md
@@ -34,6 +34,7 @@ end
 ## Check for emptiness of intersection
 
 ```@docs
+disjoint
 is_intersection_empty(::AbstractHyperrectangle{N}, ::AbstractHyperrectangle{N}, ::Bool=false) where {N<:Real}
 is_intersection_empty(::AbstractHyperrectangle{N}, ::AbstractSingleton{N}, ::Bool=false) where {N<:Real}
 is_intersection_empty(::AbstractSingleton{N}, ::LazySet{N}, ::Bool=false) where {N<:Real}

diff --git a/src/is_intersection_empty.jl b/src/is_intersection_empty.jl
@@ -1,4 +1,5 @@
-export is_intersection_empty
+export is_intersection_empty,
+       disjoint
 
 
 # --- AbstractHyperrectangle ---
@@ -678,3 +679,14 @@ function is_intersection_empty(hp::Union{Hyperplane{N}, Line{N}},
                               )::Union{Bool, Tuple{Bool,Vector{N}}} where N<:Real
     return is_intersection_empty(X, hp, witness)
 end
+
+
+# --- alias ---
+
+
+"""
+    disjoint(X, Y)
+
+An alternative name for `is_intersection_empty(X, Y)`.
+"""
+const disjoint = is_intersection_empty