tspy.functions.matchers module

main entry point for all sequence and item-set matchers

tspy.functions.matchers.seq()

Creates a matcher that matches an array of string values (the pattern) with an entire string time series exactly and in sequence

Returns
matcher

a new matcher

tspy.functions.matchers.sublist(threshold=0.0)

Creates a matcher that matches an array of string values (the pattern) with a sublist of a string time series, to within the specified coverage threshold.

Parameters
thresholdfloat, optional

indicates the minimum ratio by matcher_threshold type. (default is 0.0)

Returns
matcher

a new matcher

tspy.functions.matchers.subseq(threshold=0.0, matcher_threshold='PS')

Creates a matcher that matches an array of string values (the pattern) with a sub-sequence of a string time series, to within the specified coverage threshold.

Parameters
thresholdfloat, optional

indicates the minimum ratio by matcher_threshold type. (default is 0.0)

matcher_thresholdstr, optional

the threshold type, one of PS (pattern / sequence), PM (pattern / match), MS (match / sequence). (default is PS)

Returns
matcher

a new matcher

tspy.functions.matchers.subset(threshold=0.0, matcher_threshold='PS')

Creates a matcher that matches an array of string values (the pattern) with a string time series, regardless of the order in which the items in the pattern occur in the time series.

Parameters
thresholdfloat, optional

indicates the minimum ratio by matcher_threshold type. (default is 0.0)

matcher_thresholdstr, optional

the threshold type, one of PS (pattern / sequence), PM (pattern / match), MS (match / sequence). (default is PS)

Returns
matcher

a new matcher