Complete re-write of rectangular binnings to use ranges (#246)

* allow bin width to be given to fixed rect bin directly

* remove incorrect edge application of nextfloat for given edge

* better doc for fixed rect bin

* better docuemnt and clarify bins

* compelte rewrite of binnings based on ranges

* make compilable

* super simple outcome space

* move deprecations to their appropriate file

* more clear docs for rect bin

* move deprecations to file

* allow geting FRB from RB

* use `nextfloat` to ensure promise

* increase performance of inprecise version

* correct extraction of length of range

* re-write tests

* more clarity in tests

* fix diversityy

* remove `transferoperatorencoder` in favor of `RectangularBinEncoding`

* add catesian bin index internal function

* actually call the function

* fix diversity: given bins + 1 to the range

* allow dispatch to encoding

* fix incorrect definition of outcome_space in TrOp

* fix some tests of TrOp...

* remove completely unused computations from function in TrOp...

* remove more completely unused codfe from TrOp...

* remove more unused code and comments

* ensre ranges are large enough to cover data in fixed witdth

* add changelog entry

Author: Datseris

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 Changelog is kept with respect to version 0.11 of Entropies.jl. From version v2.0 onwards, this package has been renamed to ComplexityMeasures.jl.
 
+## 2.4
+- Rectangular binnings have been reformed to operate based on ranges. This leads to much more intuitive bin sizes and edges. For `RectangularBinning` nothing changes, while for `FixedRectangularBinning` the ranges should be given explicitly. Backwards compatible deprecations have been added.
+- This also allows for a new `precise` option that utilizes Base Julia `TwinPrecision` to make more accurate mapping of points to bins at the cost of performance.
+
 ## 2.3
 - Like differential entropies, discrete entropies now also have their own estimator type.
 - The approach of giving both an entropy definition, and an entropy estimator to `entropy` has been dropped. Now the entropy estimators know what definitions they are applied for. This change is a deprecation, i.e., backwards compatible.

Project.toml

@@ -2,7 +2,7 @@ name = "ComplexityMeasures"
 uuid = "ab4b797d-85ee-42ba-b621-05d793b346a2"
 authors = "Kristian Agasøster Haaga <kahaaga@gmail.com>, George Datseries <datseris.george@gmail.com>"
 repo = "https://github.com/juliadynamics/ComplexityMeasures.jl.git"
-version = "2.3.2"
+version = "2.4.0"
 
 [deps]
 Combinatorics = "861a8166-3701-5b0c-9a16-15d98fcdc6aa"

src/ComplexityMeasures.jl

@@ -21,7 +21,6 @@ include("encodings.jl")
 include("complexity.jl")
 include("multiscale.jl")
 include("convenience.jl")
-include("deprecations.jl")
 
 # Library implementations (files include other files)
 include("encoding_implementations/encoding_implementations.jl")
@@ -30,6 +29,9 @@ include("entropies_definitions/entropies_definitions.jl")
 include("entropies_estimators/entropies_estimators.jl")
 include("complexity_measures/complexity_measures.jl")
 
+# deprecations (must be after all declarations)
+include("deprecations.jl")
+
 # Update messages:
 using Scratch
 display_update = false

src/deprecations.jl

@@ -1,3 +1,16 @@
+# from before histogram-from-ranges rework
+function FixedRectangularBinning(ϵmin::NTuple{D,T}, ϵmax::NTuple{D,T}, N::Int) where {D, T}
+    FixedRectangularBinning(ntuple(x->range(ϵmin[i],ϵmax[i];length=N), D))
+end
+function FixedRectangularBinning(ϵmin::Real, ϵmax::Real, N, D::Int = 1)
+    if N isa Int
+        FixedRectangularBinning(ntuple(x-> range(ϵmin, nextfloat(float(ϵmax)); length = N), D))
+    else
+        FixedRectangularBinning(ntuple(x-> range(ϵmin, nextfloat(float(ϵmax)); step = N), D))
+    end
+end
+
+
 # from before https://github.com/JuliaDynamics/ComplexityMeasures.jl/pull/239
 function entropy(e::EntropyDefinition, est::DiffEntropyEst, x)
     if e isa Shannon