Fix type-instability of Probabilities

Author: Datseris

CHANGELOG.md

@@ -2,6 +2,11 @@
 
 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.
 
+## 3.7.4
+
+- Critical performance fix: central type `Probabilities` was type unstable.
+  This fix should see 10-1000x fold performance across most library functions.
+
 ## 3.7
 
 - Updated to StateSpaceSets.jl v2.0

Project.toml

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

src/core/probabilities.jl

@@ -46,12 +46,12 @@ julia> c = Counts([12, 16, 12], ["out1", "out2", "out3"]); Probabilities(c)
  "out3"  0.3
 ```
 """
-struct Probabilities{T, N, S} <: AbstractArray{T, N}
+struct Probabilities{T, N, S, A<:AbstractArray{T, N}, O<:Tuple{Vararg{AbstractVector, N}}} <: AbstractArray{T, N}
     # The probabilities table.
-    p::AbstractArray{T, N}
+    p::A
 
     # outcomes[i] has the same number of elements as `cts` along dimension `i`.
-    outcomes::Tuple{Vararg{AbstractVector, N}}
+    outcomes::O
 
     # A label for each dimension
     dimlabels::NTuple{N, S}
@@ -83,7 +83,7 @@ struct Probabilities{T, N, S} <: AbstractArray{T, N}
             end
         end
 
-        return new{eltype(p), N, S}(p, outcomes, dimlabels)
+        return new{eltype(p), N, S, typeof(p), typeof(outcomes)}(p, outcomes, dimlabels)
     end
 
 end