Add deprecation warnings for ChebHash and MIPSHash. Fixes #29.

Author: kernelmethod

Manifest.toml

@@ -99,6 +99,7 @@ uuid = "682c06a0-de6a-54ab-a142-c8b1cf79cde6"
 version = "0.21.0"
 
 [[LibGit2]]
+deps = ["Printf"]
 uuid = "76f85450-5226-5b5a-8eaa-529ad045b433"
 
 [[Libdl]]
@@ -160,7 +161,7 @@ uuid = "69de0a69-1ddd-5017-9359-2bf0b02dc9f0"
 version = "1.0.6"
 
 [[Pkg]]
-deps = ["Dates", "LibGit2", "Libdl", "Logging", "Markdown", "Printf", "REPL", "Random", "SHA", "Test", "UUIDs"]
+deps = ["Dates", "LibGit2", "Libdl", "Logging", "Markdown", "Printf", "REPL", "Random", "SHA", "UUIDs"]
 uuid = "44cfe95a-1eb2-52ea-b672-e2afdf69b78f"
 
 [[Printf]]

Project.toml

@@ -1,13 +1,14 @@
 name = "LSHFunctions"
 uuid = "5134c85a-a9db-11e9-340f-8514dff59a31"
 authors = ["Will Shand <wish5031@colorado.edu>"]
-version = "0.1.1"
+version = "0.1.2"
 
 [deps]
 Distributions = "31c24e10-a181-5473-b8eb-7969acd0382f"
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
 FFTW = "7a1cc6ca-52ef-59f5-83cd-3a7055c09341"
 LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"
+Logging = "56ddb016-857b-54e1-b83d-db4d58db5568"
 Markdown = "d6f4376e-aef5-505a-96c1-9c027394607a"
 QuadGK = "1fd47b50-473d-5c70-9696-f719f8f3bcdc"
 Random = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c"

docs/src/function_hashing.md

@@ -50,7 +50,7 @@ When ``f`` and ``g`` are allowed to take on complex values, ``g(x)`` is replaced
 
 Create a hash function for cosine similarity for functions in ``L^2([-1,1])``:
 
-```jldoctest; setup = :(using LSHFunctions)
+```
 julia> hashfn = ChebHash(cossim, 50; interval=@interval(-1 ≤ x ≤ 1));
 
 julia> n_hashes(hashfn)
@@ -65,7 +65,7 @@ Bool
 
 Create a hash function for ``L^2`` distance defined over ``L^2([0,2\pi])``. Hash the functions `f(x) = cos(x)` and `f(x) = x/(2π)` using the returned [`ChebHash`](@ref):
 
-```jldoctest; setup = :(using LSHFunctions, Random; Random.seed!(0))
+```
 julia> hashfn = ChebHash(L2, 3; interval=@interval(0 ≤ x ≤ 2π));
 
 julia> hashfn(cos)

src/function_hashing/chebhash.jl

@@ -5,6 +5,7 @@ ChebHash for hashing the L^2([-1,1]) function space.
 ================================================================#
 
 using FFTW
+using Logging
 
 #========================
 Global constants
@@ -31,6 +32,7 @@ struct ChebHash{B, F<:SimilarityFunction, H<:LSHFunction, I<:RealInterval}
                 interval::I
             ) where {B, F<:SimilarityFunction, H<:LSHFunction, I<:RealInterval}
 
+        @warn "ChebHash is deprecated. Starting in version 0.2.0 ChebHash will no longer be available."
         new{B,F,H,I}(hashfn, interval)
     end
 end
@@ -71,7 +73,7 @@ join(
 # Examples
 Create a hash function for cosine similarity for functions in ``L^2([-1,1])``:
 
-```jldoctest; setup = :(using LSHFunctions)
+```
 julia> hashfn = ChebHash(cossim, 50; interval=@interval(-1 ≤ x ≤ 1));
 
 julia> n_hashes(hashfn)
@@ -86,7 +88,7 @@ $(cossim |> LSHFunction |> hashtype)
 
 Create a hash function for ``L^2`` distance defined over ``L^2([0,2\\pi])``. Hash the functions `f(x) = cos(x)` and `f(x) = x/(2π)` using the returned `ChebHash`:
 
-```jldoctest; setup = :(using LSHFunctions, Random; Random.seed!(0))
+```
 julia> hashfn = ChebHash(L2, 3; interval=@interval(0 ≤ x ≤ 2π));
 
 julia> hashfn(cos)

src/hashes/mips_hash.jl

@@ -4,6 +4,8 @@ Definition of MIPSHash for hashing on inner products.
 
 ================================================================#
 
+using Logging
+
 #========================
 Typedefs
 ========================#
@@ -52,7 +54,7 @@ Create a `MIPSHash` hash function for hashing on inner product similarity.
 # Examples
 `MIPSHash` is an [`AsymmetricLSHFunction`](@ref), and hence hashes must be computed using `index_hash` and `query_hash`.
 
-```jldoctest; setup = :(using LSHFunctions)
+```
 julia> hashfn = MIPSHash(5; maxnorm=10);
 
 julia> x = rand(4);
@@ -68,14 +70,14 @@ true
 
 You need to explicitly specify the `maxnorm` keyword parameter when constructing `MIPSHash`, otherwise you will get an error.
 
-```jldoctest; setup = :(using LSHFunctions)
+```
 julia> hashfn = MIPSHash(5)
 ERROR: maxnorm must be specified for MIPSHash
 ```
 
 You'll also get an error if you try to hash a vector that has norm greater than the `maxnorm` that you specified.
 
-```jldoctest; setup = :(using LSHFunctions)
+```
 julia> hashfn = MIPSHash(; maxnorm=1);
 
 julia> index_hash(hashfn, ones(4))
@@ -98,6 +100,7 @@ See also: [`inner_prod`](@ref), [`ℓ2_norm`](@ref ℓp_norm)
           throw)
     else
         quote
+            @warn "MIPSHash is deprecated. Starting in version 0.2.0 MIPSHash will no longer be available."
             if n_hashes < 1
                 "n_hashes must be positive" |>
                 ErrorException |>
@@ -125,8 +128,8 @@ See also: [`inner_prod`](@ref), [`ℓ2_norm`](@ref ℓp_norm)
 
             MIPSHash{T}(coeff_A, coeff_B, scale, shift, Qshift, m,
 	                    maxnorm, resize_pow2)
-	    end
 	end
+    end
 end
 
 MIPSHash(args...; dtype=DEFAULT_DTYPE, kws...) =