From 48d36f5c63d973512998345d2ee968b95a9b46ba Mon Sep 17 00:00:00 2001 From: Datseris Date: Sun, 4 Jul 2021 11:31:06 +0200 Subject: [PATCH] entropies should export the search types --- Project.toml | 2 +- src/kerneldensity/kerneldensity.jl | 7 ++++--- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/Project.toml b/Project.toml index 9db8470f9..0983389ee 100644 --- a/Project.toml +++ b/Project.toml @@ -2,7 +2,7 @@ name = "Entropies" uuid = "ed8fcbec-b94c-44b6-89df-898894ad9591" authors = "Kristian Agasøster Haaga , George Datseries " repo = "https://github.com/juliadynamics/Entropies.jl.git" -version = "0.12.0" +version = "0.12.1" [deps] DelayEmbeddings = "5732040d-69e3-5649-938a-b6b4f237613f" diff --git a/src/kerneldensity/kerneldensity.jl b/src/kerneldensity/kerneldensity.jl index 9b4de2481..419c22499 100644 --- a/src/kerneldensity/kerneldensity.jl +++ b/src/kerneldensity/kerneldensity.jl @@ -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 @@ -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``.