Drop support for ChebHash.

Remove ChebHash from the package in favor of better support for
MonteCarloHash. Fixes #26.

Author: kernelmethod

Manifest.toml

@@ -1,11 +1,5 @@
 # This file is machine-generated - editing it directly is not advised
 
-[[AbstractFFTs]]
-deps = ["LinearAlgebra"]
-git-tree-sha1 = "051c95d6836228d120f5f4b984dd5aba1624f716"
-uuid = "621f4979-c628-5d54-868e-fcf4e3e8185c"
-version = "0.5.0"
-
 [[Arpack]]
 deps = ["Arpack_jll", "Libdl", "LinearAlgebra"]
 git-tree-sha1 = "2ff92b71ba1747c5fdd541f8fc87736d82f40ec9"
@@ -64,30 +58,12 @@ git-tree-sha1 = "f3464968c65fc78846dad1c038c474a2c39bbb23"
 uuid = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
 version = "0.25.0"
 
-[[FFTW]]
-deps = ["AbstractFFTs", "FFTW_jll", "IntelOpenMP_jll", "Libdl", "LinearAlgebra", "MKL_jll", "Reexport"]
-git-tree-sha1 = "14536c95939aadcee44014728a459d2fe3ca9acf"
-uuid = "7a1cc6ca-52ef-59f5-83cd-3a7055c09341"
-version = "1.2.2"
-
-[[FFTW_jll]]
-deps = ["Libdl", "Pkg"]
-git-tree-sha1 = "6c975cd606128d45d1df432fb812d6eb10fee00b"
-uuid = "f5851436-0d7a-5f13-b9de-f02708fd171a"
-version = "3.3.9+5"
-
 [[FillArrays]]
 deps = ["LinearAlgebra", "Random", "SparseArrays"]
 git-tree-sha1 = "bf726ba7ce99e00d10bf63c031285fb9ab3676ae"
 uuid = "1a297f60-69ca-5386-bcde-b61e274b549b"
 version = "0.8.11"
 
-[[IntelOpenMP_jll]]
-deps = ["Libdl", "Pkg"]
-git-tree-sha1 = "fb8e1c7a5594ba56f9011310790e03b5384998d6"
-uuid = "1d5cc7b8-4909-519e-a0f8-d0f5ad9712d0"
-version = "2018.0.3+0"
-
 [[InteractiveUtils]]
 deps = ["Markdown"]
 uuid = "b77e0a4c-d291-57a0-90e8-8db25a27a240"
@@ -112,12 +88,6 @@ uuid = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"
 [[Logging]]
 uuid = "56ddb016-857b-54e1-b83d-db4d58db5568"
 
-[[MKL_jll]]
-deps = ["IntelOpenMP_jll", "Libdl", "Pkg"]
-git-tree-sha1 = "0ce9a7fa68c70cf83c49d05d2c04d91b47404b08"
-uuid = "856f044c-d86e-5d09-b602-aeab76dc8ba7"
-version = "2020.1.216+0"
-
 [[Markdown]]
 deps = ["Base64"]
 uuid = "d6f4376e-aef5-505a-96c1-9c027394607a"
@@ -182,12 +152,6 @@ uuid = "3fa0cd96-eef1-5676-8a61-b3b8758bbffb"
 deps = ["Serialization"]
 uuid = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c"
 
-[[Reexport]]
-deps = ["Pkg"]
-git-tree-sha1 = "7b1d07f411bc8ddb7977ec7f377b97b158514fe0"
-uuid = "189a3867-3050-52da-a836-e630ba90ab69"
-version = "0.2.0"
-
 [[Rmath]]
 deps = ["Random", "Rmath_jll"]
 git-tree-sha1 = "86c5647b565873641538d8f812c04e4c9dbeb370"

Project.toml

@@ -6,7 +6,6 @@ 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"
@@ -19,6 +18,5 @@ Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
 [compat]
 Distributions = "0.22, 0.23"
 Documenter = "0.24, 0.25"
-FFTW = "1.2"
 QuadGK = "2.3"
 julia = "1.3, 1.4, 1.5"

docs/src/full_api.md

@@ -38,7 +38,6 @@ Pages = ["similarities.jl"]
 
 ```@docs
 MonteCarloHash
-ChebHash
 ```
 
 ## Miscellaneous

docs/src/function_hashing.md

@@ -22,6 +22,7 @@ julia> hashfn(x -> 5x^3 - 2x^2 - 9x + 1)
 LSHFunctions can hash functions in any [``L^p_{\mu}(\Omega)`` function space](https://en.wikipedia.org/wiki/Lp_space) so long as ``\Omega`` has finite volume (i.e., as long as ``\int_{\Omega} d\mu(x) < +\infty``).
 
 ## Similarity statistics in function spaces
+
 The LSHFunctions module currently supports hashing for the following similarity statistics in function spaces.
 
 ### ``L_{\mu}^p`` distance
@@ -39,49 +40,15 @@ The LSHFunctions module currently supports hashing for the following similarity
 When ``f`` and ``g`` are allowed to take on complex values, ``g(x)`` is replaced by ``\overline{g(x)}`` (the complex conjugate of ``g(x)``) in the formula above.
 
 ### Cosine similarity
+
 ```math
 \text{cossim}(f,g) = \frac{\left\langle f,g\right\rangle_{L_{\mu}^2}}{\|f\|_{L_{\mu}^2} \cdot \|g\|_{L_{\mu}^2}}
 ```
 
-## Function approximation-based hashing
+## Monte Carlo-based hashing
 
 !!! warning "API subject to change"
-    The API for both [`ChebHash`](@ref) and [`MonteCarloHash`](@ref), but especially the former, is being modified very quickly. As a result, the docs below may change radically for future versions of the LSHFunctions package.
-
-Create a hash function for cosine similarity for functions in ``L^2([-1,1])``:
-
-```
-julia> hashfn = ChebHash(cossim, 50; interval=@interval(-1 ≤ x ≤ 1));
-
-julia> n_hashes(hashfn)
-50
-
-julia> similarity(hashfn) == cossim
-true
-
-julia> hashtype(hashfn)
-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):
-
-```
-julia> hashfn = ChebHash(L2, 3; interval=@interval(0 ≤ x ≤ 2π));
-
-julia> hashfn(cos)
-3-element Array{Int32,1}:
-  3
- -1
- -2
-
-julia> hashfn(x -> x/(2π))
-3-element Array{Int32,1}:
- 0
- 1
- 0
-```
-
-## Monte Carlo-based hashing
+    The API for [`MonteCarloHash`](@ref) is still under heavy design. As a result, the docs below may change radically for future versions of the LSHFunctions package.
 
 Create a hash function for cosine similarity for functions in ``L^2([-1,1])``:
 
@@ -132,4 +99,5 @@ julia> length(hashfn.sample_points)
 ```
 
 ## References
+
 - Shand, William and Becker, Stephen. *Locality-sensitive hashing in function spaces*. [arXiv:2002.03909](https://arxiv.org/abs/2002.03909).

src/LSHFunctions.jl

@@ -30,7 +30,6 @@ include(joinpath("hashes", "lshfunction.jl"))
 Function hashing
 ========================#
 
-include(joinpath("function_hashing", "chebhash.jl"))
 include(joinpath("function_hashing", "monte_carlo.jl"))
 
 #========================
@@ -43,7 +42,7 @@ export cossim, inner_prod, ℓ1, ℓ2, ℓp, L1, L2, Lp, ℓ1_norm, ℓ2_norm,
 
 # Hash functions
 export SimHash, L1Hash, L2Hash, MIPSHash, SignALSH, MinHash,
-       LSHFunction, MonteCarloHash, ChebHash, SymmetricLSHFunction,
+       LSHFunction, MonteCarloHash, SymmetricLSHFunction,
        AsymmetricLSHFunction
 
 # Helper / utility functions for LSHFunctions