From d98b23ad90cd25dbfb8b63b5bf380c27711121e0 Mon Sep 17 00:00:00 2001 From: Yuya Hamada Date: Wed, 19 Nov 2025 11:43:52 +0900 Subject: [PATCH] Add manual for grapheme_levenshtein function. --- .../intl/grapheme/grapheme-levenshtein.xml | 127 ++++++++++++++++++ 1 file changed, 127 insertions(+) create mode 100644 reference/intl/grapheme/grapheme-levenshtein.xml diff --git a/reference/intl/grapheme/grapheme-levenshtein.xml b/reference/intl/grapheme/grapheme-levenshtein.xml new file mode 100644 index 000000000000..0df9fa26a964 --- /dev/null +++ b/reference/intl/grapheme/grapheme-levenshtein.xml @@ -0,0 +1,127 @@ + + + + + grapheme_levenshtein + Calculate Levenshtein distance between two grapheme clusters + + + &reftitle.description; + + intgrapheme_levenshtein + stringstring1 + stringstring2 + intinsertion_cost1 + intreplacement_cost1 + intdeletion_cost1 + stringlocale"" + + + The Levenshtein distance is defined as the minimal number of + grapheme cluster you have to replace, insert or delete to transform + string1 into string2. + The complexity of the algorithm is O(m*n), + where n and m are the + length of string1 and + string2. + + + If insertion_cost, replacement_cost + and/or deletion_cost are unequal to 1, + the algorithm adapts to choose the cheapest transforms. + E.g. if $insertion_cost + $deletion_cost < $replacement_cost, + no replacements will be done, but rather inserts and deletions instead. + + + + + &reftitle.parameters; + + + string1 + + + One of the grapheme clusters being evaluated for Levenshtein distance. + string1 must be valid UTF-8. + + + + + string2 + + + One of the grapheme clusters being evaluated for Levenshtein distance. + string2 must be valid UTF-8. + + + + + insertion_cost + + + Defines the cost of insertion. + + + + + replacement_cost + + + Defines the cost of replacement. + + + + + deletion_cost + + + Defines the cost of deletion. + + + + + locale + + + Specifies a locale based on LDML. + + + + + + + + &reftitle.returnvalues; + + This function returns the Levenshtein-Distance between the + two argument grapheme clusters. + + + + + &reftitle.seealso; + + levenshtein + + + +