Skip to content

Commit

Permalink
entropies should export the search types
Browse files Browse the repository at this point in the history
  • Loading branch information
Datseris committed Jul 4, 2021
1 parent 7b132e0 commit 48d36f5
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 4 deletions.
2 changes: 1 addition & 1 deletion Project.toml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ name = "Entropies"
uuid = "ed8fcbec-b94c-44b6-89df-898894ad9591"
authors = "Kristian Agasøster Haaga <[email protected]>, George Datseries <[email protected]>"
repo = "https://github.com/juliadynamics/Entropies.jl.git"
version = "0.12.0"
version = "0.12.1"

[deps]
DelayEmbeddings = "5732040d-69e3-5649-938a-b6b4f237613f"
Expand Down
7 changes: 4 additions & 3 deletions src/kerneldensity/kerneldensity.jl
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
export NaiveKernel
using Neighborhood: Theiler, KDTree, bulkisearch, searchstructure
using Neighborhood: Theiler, KDTree, BruteForce, bulkisearch, searchstructure
using Distances: Metric, Euclidean
export NaiveKernel, KDTree, BruteForce

"""
NaiveKernel(ϵ::Real, ss = KDTree; w = 0, metric = Euclidean()) <: ProbabilitiesEstimator
Expand All @@ -18,7 +18,8 @@ P_i( X, \\epsilon) \\approx \\dfrac{1}{N} \\sum_{s} B(||X_i - X_j|| < \\epsilon)
where ``B`` gives 1 if the argument is `true`. Probabilities are then normalized.
The search structure `ss` is any search structure supported by Neighborhood.jl.
The search structure `ss` is any search structure supported by Neighborhood.jl,
e.g. `KDTree` or `BruteForce`.
The keyword `w` stands for the [Theiler window](@ref), and excludes indices ``s``
that are within ``|i - s| ≤ w`` from the given point ``X_i``.
Expand Down

0 comments on commit 48d36f5

Please sign in to comment.