Major source code cleanup (#77)

* reduce transfer entropy docstring * delete a bunch of old and unecessary files * bump version
JuliaDynamics · Oct 22, 2021 · a6d7d7f · a6d7d7f
1 parent e1106b1
commit a6d7d7f
Show file tree

Hide file tree

Showing 15 changed files with 28 additions and 1,565 deletions.
diff --git a/Project.toml b/Project.toml
@@ -1,7 +1,7 @@
 name = "TransferEntropy"
 uuid = "ea221983-52f3-5440-99c7-13ea201cd633"
 repo = "https://github.com/kahaaga/TransferEntropy.jl.git"
-version = "1.3.0"
+version = "1.3.1"
 
 [deps]
 DSP = "717857b8-e6f2-59f4-9121-6e50c889abd2"

diff --git a/docs/src/index.md b/docs/src/index.md
@@ -40,6 +40,15 @@ Kraskov2
 SymbolicPermutation
 ```
 
+There is a possible performance optimization to be made with this method:
+```julia
+transferentropy!(symb_s, symb_t, s, t, [c], est::SymbolicPermutation; 
+        base = 2, q = 1, m::Int = 3, τ::Int = 1, ...) → Float64
+```
+You can optionally provide pre-allocated (integer) symbol vectors `symb_s` and `symb_t` (and `symb_c`),
+where `length(symb_s) == length(symb_t) == length(symb_c) == N - (est.m-1)*est.τ`. This is useful for saving 
+memory allocations for repeated computations.
+
 ### Hilbert
 
 ```@docs

diff --git a/src/TransferEntropy.jl b/src/TransferEntropy.jl
@@ -1,6 +1,4 @@
 module TransferEntropy
-using Reexport
-@reexport using Entropies
 include("core.jl")
 include("mutualinfo/interface.jl")
 include("transferentropy/interface.jl")