JuliaDynamics/ComplexityMeasures.jl

The function `lt` in `OrdinalPatternEncoding` isn't actually used

开放

#378 创建于 2024年1月13日

 (1 条评论) (0 个反应) (0 位负责人)Julia (19 个派生)auto 404
buggood first issue

仓库指标

星标
 (79 个星标)
PR 合并指标
 (PR 指标待抓取)

描述

The OrdinalPatterns documentation string promises that the user can provide a comparator function (defaults to lt = isless) to determine how two elements of a state are deemed to be "equal" (useful to prevent bias when there are tied values).

This function lt gets stored in the encoding::OrdinalPatternEncoding field of the OrdinalPatterns struct. However, the function isn't actually used in encode. We did use it before, but after we transitioned to the formal encode/decode interface, we forgot to pass the argument on to the underlying sortperm! call.

The fix is easy. Here's the source code:

function encode(encoding::OrdinalPatternEncoding{m}, χ::AbstractVector) where {m}
    if m != length(χ)
        throw(ArgumentError("Permutation order and length of input must match!"))
    end
    perm = sortperm!(encoding.perm, χ)
    return permutation_to_integer(perm)
end

TODO:

  • Pass on lt to sortperm! when computing the permutation pattern.

贡献者指南