instance instCoeStringSubstring : Coe String Substring

theorem String.Pos.ne_zero_of_lt {a : String.Pos} {b : String.Pos} : a < b → b ≠ 0

structure String.Matcherextends Array.Matcher : Type

• table : Array.PrefixTable Char
• state : Fin (Array.PrefixTable.size s.toMatcher.table + 1)
• pattern : Substring

  The pattern for the matcher

Knuth-Morris-Pratt matcher type

This type is used to keep data for running the Knuth-Morris-Pratt (KMP) string matching algorithm. KMP is a linear time algorithm to locate all substrings of a string that match a given pattern. Generating the algorithm data is also linear in the length of the pattern but the data can be re-used to match the same pattern over different strings.

The KMP data for a pattern string can be generated using Matcher.ofString. Then Matcher.find? and Matcher.findAll can be used to run the algorithm on an input string.

def m := Matcher.ofString "abba"

#eval Option.isSome <| m.find? "AbbabbA" -- false
#eval Option.isSome <| m.find? "aabbaa" -- true

#eval Array.size <| m.findAll "abbabba" -- 2
#eval Array.size <| m.findAll "abbabbabba" -- 3

@[inline]

def String.Matcher.ofSubstring (pattern : Substring) : String.Matcher

Make KMP matcher from pattern substring

@[inline]

def String.Matcher.ofString (pattern : String) : String.Matcher

Make KMP matcher from pattern string

@[inline, reducible]

abbrev String.Matcher.patternSize (m : String.Matcher) : Nat

The byte size of the string pattern for the matcher

def String.Matcher.findAll (m : String.Matcher) (s : Substring) : Array Substring

Find all substrings of s matching m.pattern.

partial def String.Matcher.findAll.loop (m : String.Matcher) (s : Substring) (am : Array.Matcher Char) (occs : Array Substring) : Array Substring

Accumulator loop for String.Matcher.findAll

def String.Matcher.find? (m : String.Matcher) (s : Substring) : Option Substring

Find the first substring of s matching m.pattern, or none if no such substring exists.

def Substring.commonPrefix (s : Substring) (t : Substring) : Substring

Returns the longest common prefix of two substrings. The returned substring will use the same underlying string as s.

def Substring.commonPrefix.loop (s : Substring) (t : Substring) (spos : String.Pos) (tpos : String.Pos) : String.Pos

Returns the ending position of the common prefix, working up from spos, tpos.

Equations

• One or more equations did not get rendered due to their size.

def Substring.commonSuffix (s : Substring) (t : Substring) : Substring

Returns the longest common suffix of two substrings. The returned substring will use the same underlying string as s.

def Substring.commonSuffix.loop (s : Substring) (t : Substring) (spos : String.Pos) (tpos : String.Pos) : String.Pos

Returns the starting position of the common prefix, working down from spos, tpos.

Equations

• One or more equations did not get rendered due to their size.

def Substring.dropPrefix? (s : Substring) (pre : Substring) : Option Substring

If pre is a prefix of s, i.e. s = pre ++ t, returns the remainder t.

def Substring.dropSuffix? (s : Substring) (suff : Substring) : Option Substring

If suff is a suffix of s, i.e. s = t ++ suff, returns the remainder t.

@[inline]

def Substring.findAllSubstr (s : Substring) (pattern : Substring) : Array Substring

Returns all the substrings of s that match pattern.

@[inline]

def Substring.findSubstr? (s : Substring) (pattern : Substring) : Option Substring

Returns the first substring of s that matches pattern, or none if there is no such substring.

@[inline]

def Substring.containsSubstr (s : Substring) (pattern : Substring) : Bool

Returns true iff pattern occurs as a substring of s.

@[inline, reducible]

abbrev String.findAllSubstr (s : String) (pattern : Substring) : Array Substring

Returns all the substrings of s that match pattern.

@[inline, reducible]

abbrev String.findSubstr? (s : String) (pattern : Substring) : Option Substring

Returns the first substring of s that matches pattern, or none if there is no such substring.

@[inline, reducible]

abbrev String.containsSubstr (s : String) (pattern : Substring) : Bool

Returns true iff pattern occurs as a substring of s.

def String.dropPrefix? (s : String) (pre : Substring) : Option Substring

If pre is a prefix of s, i.e. s = pre ++ t, returns the remainder t.

def String.dropSuffix? (s : String) (suff : Substring) : Option Substring

If suff is a suffix of s, i.e. s = t ++ suff, returns the remainder t.

def String.stripPrefix (s : String) (pre : Substring) : String

s.stripPrefix pre will remove pre from the beginning of s if it occurs there, or otherwise return s.

def String.stripSuffix (s : String) (suff : Substring) : String

s.stripSuffix suff will remove suff from the end of s if it occurs there, or otherwise return s.

def String.count (s : String) (c : Char) : Nat

Count the occurrences of a character in a string.