Export the interval macro from the LSHFunctions module.

Author: kernelmethod

docs/src/full_api.md

@@ -34,6 +34,12 @@ Private = false
 Pages = ["similarities.jl"]
 ```
 
+## Miscellaneous
+
+```@docs
+@interval
+```
+
 ## Private interface
 
 ```@autodocs

src/LSHFunctions.jl

@@ -48,6 +48,6 @@ export SimHash, L1Hash, L2Hash, MIPSHash, SignALSH, MinHash,
 
 # Helper / utility functions for LSHFunctions
 export index_hash, query_hash, n_hashes, hashtype, similarity, lsh_family,
-       embedded_similarity, collision_probability
+       embedded_similarity, collision_probability, @interval
 
 end # module

src/function_hashing/chebhash.jl

@@ -27,7 +27,7 @@ ChebHash(similarity, args...; kws...) =
 
 function ChebHash(::SimilarityFunction{S},
                   args...;
-                  interval::RealInterval = LSHFunctions.@interval(-1 ≤ x ≤ 1),
+                  interval::RealInterval = @interval(-1 ≤ x ≤ 1),
                   kws...) where S
 
     discrete_hashfn = LSHFunction(S, args...; kws...)

src/intervals.jl

@@ -153,25 +153,25 @@ The returned expression constructs an `LSHFunctions.RealInterval` encoding the l
 You can construct an interval using the following syntax:
 
 ```jldoctest; setup = :(using LSHFunctions)
-julia> interval = LSHFunctions.@interval(0 ≤ x < 1);
+julia> interval = @interval(0 ≤ x < 1);
 ```
 
 There are usually multiple ways of constructing the same interval. For instance, each of the expressions below are equivalent ways of constructing the interval `[-1,1]`.
 
 ```jldoctest; setup = :(using LSHFunctions)
-julia> LSHFunctions.@interval(-1 ≤  x ≤  1) ==
-       LSHFunctions.@interval(-1 <= x <= 1) ==
-       LSHFunctions.@interval(-1 ≤  y ≤  1) ==
-       LSHFunctions.@interval( 1 ≥  x ≥ -1)
+julia> @interval(-1 ≤  x ≤  1) ==
+       @interval(-1 <= x <= 1) ==
+       @interval(-1 ≤  y ≤  1) ==
+       @interval( 1 ≥  x ≥ -1)
 true
 ```
 
-You can even create intervals with `Inf` or `-Inf` at the endpoints, e.g. `LSHFunctions.@interval(-Inf < x < Inf)`.
+You can even create intervals with `Inf` or `-Inf` at the endpoints, e.g. `@interval(-Inf < x < Inf)`.
 
 There are two primary operations you can run on an interval: testing for membership and intersection. You can test whether or not `x` is in an interval using `x ∈ interval`, as shown below.
 
 ```jldoctest; setup = :(using LSHFunctions)
-julia> interval = LSHFunctions.@interval(0 ≤ x < 1);
+julia> interval = @interval(0 ≤ x < 1);
 
 julia> 0 ∈ interval && 1 ∉ interval
 true
@@ -183,20 +183,20 @@ true
 You can also intersect two intervals using the `∩` operator (or by using `intersect(interval_1, interval_2)`).
 
 ```
-julia> LSHFunctions.@interval(0 ≤ x < 1) ∩ LSHFunctions.@interval(1/2 < x ≤ 1) == LSHFunctions.@interval(1/2 < x < 1)
+julia> @interval(0 ≤ x < 1) ∩ @interval(1/2 < x ≤ 1) == @interval(1/2 < x < 1)
 true
 ```
 
 See also: [`RealInterval`](@ref)
 """
 macro interval(expr)
     invalid_expr_msg = """
-    Expression is invalid. The expression passed to LSHFunctions.@interval must take the form
+    Expression is invalid. The expression passed to @interval must take the form
 
         a {<,≤,>,≥} x {<,≤,>,≥} b
 
     where a and b evaluate to real numbers, and x is a valid variable identifier.
-    See the documentation for LSHFunctions.@interval for more information.
+    See the documentation for @interval for more information.
     """
 
     if !isa(expr, Expr)

src/similarities.jl

@@ -177,7 +177,7 @@ for ``p = 1``, ``p = 2``, and ``p = 3``.
 ```jldoctest; setup = :(using LSHFunctions)
 julia> f(x) = x^2 + 1; g(x) = 2x;
 
-julia> interval = LSHFunctions.@interval(0 ≤ x ≤ 1);
+julia> interval = @interval(0 ≤ x ≤ 1);
 
 julia> Lp(f, g, interval, 1) ≈ L1(f, g, interval) ≈ 3^(-1)
 true
@@ -279,7 +279,7 @@ where the interval we're integrating over is specified by the `interval` argumen
 ```jldoctest; setup = :(using LSHFunctions)
 julia> f(x) = cos(x); g(x) = sin(x);
 
-julia> inner_prod(f, g, LSHFunctions.@interval(0 ≤ x ≤ π/2)) ≈ 1/2
+julia> inner_prod(f, g, @interval(0 ≤ x ≤ π/2)) ≈ 1/2
 true
 ```
 """
@@ -356,7 +356,7 @@ Computes the ``L^p`` function-space norm of a function ``f``, which is given by
 ```jldoctest; setup = :(using LSHFunctions)
 julia> f(x) = x;
 
-julia> interval = LSHFunctions.@interval(0 ≤ x ≤ 1);
+julia> interval = @interval(0 ≤ x ≤ 1);
 
 julia> Lp_norm(f, interval, 1) ≈ L1_norm(f, interval) ≈ 2^(-1/1)
 true