Differential entropy estimators: various fixes

[kahaaga]

Improvements:

• Use Shannon(; base = 2) as default for both discrete and differential entropy.
• Document that the default base is 2 and instruct the user to provide an Entropy instance if they want to specify the logarithm.
• Add small example for differential entropy in docstring for entropy.
• Conform to Entropy API: base is given to the Entropy, not the EntropyEstimator.
• All EntropyEstimator docstrings now explicitly explain what they compute (ref #209).
• Tests for all subtypes of EntropyEstimator re-done and standardized (ref #209).

Bug fix

• Fixed scaling issue for order statistic estimators (use natural log in formulas, only scale after the entropy has been computed). Thus, tests also can be much stricter, because they are not biased by erroneous scaling.

[codecov[bot]]

Codecov Report

Merging #211 (1bf58e1) into main (c77d9ae) will increase coverage by 0.01%. The diff coverage is 92.30%.

@@            Coverage Diff             @@
##             main     #211      +/-   ##
==========================================
+ Coverage   84.62%   84.63%   +0.01%     
==========================================
  Files          49       49              
  Lines        1190     1191       +1     
==========================================
+ Hits         1007     1008       +1     
  Misses        183      183              

Impacted Files	Coverage Δ
src/entropies/estimators/nearest_neighbors/Zhu.jl	100.00% <ø> (ø)
...entropies/estimators/nearest_neighbors/ZhuSingh.jl	100.00% <ø> (ø)
src/entropy.jl	67.64% <50.00%> (ø)
...estimators/nearest_neighbors/KozachenkoLeonenko.jl	100.00% <100.00%> (ø)
.../entropies/estimators/nearest_neighbors/Kraskov.jl	100.00% <100.00%> (ø)
...ies/estimators/order_statistics/AlizadehArghami.jl	100.00% <100.00%> (ø)
...rc/entropies/estimators/order_statistics/Correa.jl	100.00% <100.00%> (ø)
.../entropies/estimators/order_statistics/Ebrahimi.jl	100.00% <100.00%> (ø)
...c/entropies/estimators/order_statistics/Vasicek.jl	100.00% <100.00%> (ø)

:mega: We’re building smart automated test selection to slash your CI/CD build times. Learn more