Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update cross references and increment patch version #392

Merged
merged 1 commit into from
Jan 17, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Project.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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 = "3.4.0"
version = "3.4.1"

[deps]
Combinatorics = "861a8166-3701-5b0c-9a16-15d98fcdc6aa"
Expand Down
1 change: 1 addition & 0 deletions src/core/complexity.jl
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ any subtype of [`ComplexityEstimator`](@ref):
- [`MissingDispersionPatterns`](@ref).
- [`ReverseDispersion`](@ref).
- [`SampleEntropy`](@ref).
- [`BubbleEntropy`](@ref).
- [`StatisticalComplexity`](@ref).
"""
function complexity(c::ComplexityEstimator, x)
Expand Down
2 changes: 2 additions & 0 deletions src/core/encodings.jl
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ Current available encodings are:
- [`RelativeMeanEncoding`](@ref).
- [`RelativeFirstDifferenceEncoding`](@ref).
- [`UniqueElementsEncoding`](@ref).
- [`BubbleSortSwapsEncoding`](@ref).
- [`PairDistanceEncoding`](@ref).
- [`CombinationEncoding`](@ref), which can combine any of the above encodings.
"""
abstract type Encoding end
Expand Down
32 changes: 17 additions & 15 deletions src/core/outcome_spaces.jl
Original file line number Diff line number Diff line change
Expand Up @@ -24,21 +24,23 @@ discretize/encode the data directly.

## Implementations

| Outcome space | Principle | Input data | Counting-compatible |
| :-------------------------------------- | :--------------------------- | :------------------------ | :------------------ |
| [`UniqueElements`](@ref) | Count of unique elements | `Any` | ✔ |
| [`ValueBinning`](@ref) | Binning (histogram) | `Vector`, `StateSpaceSet` | ✔ |
| [`OrdinalPatterns`](@ref) | Ordinal patterns | `Vector`, `StateSpaceSet` | ✔ |
| [`SpatialOrdinalPatterns`](@ref) | Ordinal patterns in space | `Array` | ✔ |
| [`Dispersion`](@ref) | Dispersion patterns | `Vector` | ✔ |
| [`SpatialDispersion`](@ref) | Dispersion patterns in space | `Array` | ✔ |
| [`CosineSimilarityBinning`](@ref) | Cosine similarity | `Vector` | ✔ |
| [`TransferOperator`](@ref) | Binning (transfer operator) | `Vector`, `StateSpaceSet` | ✖ |
| [`NaiveKernel`](@ref) | Kernel density estimation | `StateSpaceSet` | ✖ |
| [`WeightedOrdinalPatterns`](@ref) | Ordinal patterns | `Vector`, `StateSpaceSet` | ✖ |
| [`AmplitudeAwareOrdinalPatterns`](@ref) | Ordinal patterns | `Vector`, `StateSpaceSet` | ✖ |
| [`WaveletOverlap`](@ref) | Wavelet transform | `Vector` | ✖ |
| [`PowerSpectrum`](@ref) | Fourier transform | `Vector` | ✖ |
| Outcome space | Principle | Input data | Counting-compatible |
| :-------------------------------------- | :-------------------------------- | :------------------------ | :------------------ |
| [`UniqueElements`](@ref) | Count of unique elements | `Any` | ✔ |
| [`ValueBinning`](@ref) | Binning (histogram) | `Vector`, `StateSpaceSet` | ✔ |
| [`OrdinalPatterns`](@ref) | Ordinal patterns | `Vector`, `StateSpaceSet` | ✔ |
| [`SpatialOrdinalPatterns`](@ref) | Ordinal patterns in space | `Array` | ✔ |
| [`Dispersion`](@ref) | Dispersion patterns | `Vector` | ✔ |
| [`SpatialDispersion`](@ref) | Dispersion patterns in space | `Array` | ✔ |
| [`CosineSimilarityBinning`](@ref) | Cosine similarity | `Vector` | ✔ |
| [`BubbleSortSwaps`](@ref) | Swap counts when sorting | `Vector` | ✔ |
| [`SequentialPairDistances`](@ref) | Sequential state vector distances | `Vector`, `StateSpaceSet` | ✔ |
| [`TransferOperator`](@ref) | Binning (transfer operator) | `Vector`, `StateSpaceSet` | ✖ |
| [`NaiveKernel`](@ref) | Kernel density estimation | `StateSpaceSet` | ✖ |
| [`WeightedOrdinalPatterns`](@ref) | Ordinal patterns | `Vector`, `StateSpaceSet` | ✖ |
| [`AmplitudeAwareOrdinalPatterns`](@ref) | Ordinal patterns | `Vector`, `StateSpaceSet` | ✖ |
| [`WaveletOverlap`](@ref) | Wavelet transform | `Vector` | ✖ |
| [`PowerSpectrum`](@ref) | Fourier transform | `Vector` | ✖ |

In the column "input data" it is assumed that the `eltype` of the input is `<: Real`.

Expand Down
Loading