【PHP8.x】levenshtein関数の使い方

Copy
1<?php
2
3/**
4 * levenshtein関数の使用例を示すスクリプト。
5 * この関数は、2つの文字列間のレーベンシュタイン距離（編集距離）を計算します。
6 * レーベンシュタイン距離とは、一方の文字列をもう一方に変換するために必要な、
7 * 最小限の単一文字編集（挿入、削除、置換）操作の数を表します。
8 */
9
10// 比較する文字列を定義します。
11$string1 = "kitten";
12$string2 = "sitting";
13$string3 = "sittin";
14
15echo "--- 基本的なレーベンシュタイン距離の計算 (デフォルトコスト) ---" . PHP_EOL;
16
17// デフォルトのコスト（挿入、置換、削除がそれぞれ1）でレーベンシュタイン距離を計算します。
18// 'kitten' を 'sitting' にするには、'k'->'s', 'e'->'i', 'n'->'g' の3回の置換が必要です。
19$distanceDefault = levenshtein($string1, $string2);
20echo "文字列 '{$string1}' と '{$string2}' のレーベンシュタイン距離: {$distanceDefault}" . PHP_EOL;
21
22// 'kitten' を 'sittin' にするには、'k'->'s', 'e'->'i' の2回の置換が必要です。
23$distanceDefault2 = levenshtein($string1, $string3);
24echo "文字列 '{$string1}' と '{$string3}' のレーベンシュタイン距離: {$distanceDefault2}" . PHP_EOL;
25
26echo PHP_EOL . "--- カスタムコストでのレーベンシュタイン距離の計算 ---" . PHP_EOL;
27
28// カスタムコストを指定してレーベンシュタイン距離を計算します。
29// 例として、置換コストを高く設定し、置換操作の「重み」を増やしてみます。
30$insertionCost   = 1;  // 文字の挿入にかかるコスト
31$replacementCost = 10; // 文字の置換にかかるコスト
32$deletionCost    = 1;  // 文字の削除にかかるコスト
33
34$distanceCustom = levenshtein($string1, $string2, $insertionCost, $replacementCost, $deletionCost);
35echo "文字列 '{$string1}' と '{$string2}' のレーベンシュタイン距離 (カスタムコスト: 挿入={$insertionCost}, 置換={$replacementCost}, 削除={$deletionCost}): {$distanceCustom}" . PHP_EOL;
36
37echo PHP_EOL . "--- その他の例 ---" . PHP_EOL;
38
39// 同じ文字列の場合の距離は0になります。
40$strA = "php";
41$strB = "php";
42$distanceSame = levenshtein($strA, $strB);
43echo "文字列 '{$strA}' と '{$strB}' のレーベンシュタイン距離 (デフォルトコスト): {$distanceSame}" . PHP_EOL;
44
45// 挿入が必要な場合の例 ('php' から 'phps' へは 's' の挿入1回)
46$strC = "phps";
47$distanceInsert = levenshtein($strA, $strC);
48echo "文字列 '{$strA}' と '{$strC}' のレーベンシュタイン距離 (デフォルトコスト): {$distanceInsert}" . PHP_EOL;
49
50// 削除が必要な場合の例 ('phps' から 'php' へは 's' の削除1回)
51$distanceDelete = levenshtein($strC, $strA);
52echo "文字列 '{$strC}' と '{$strA}' のレーベンシュタイン距離 (デフォルトコスト): {$distanceDelete}" . PHP_EOL;

levenshtein関数は、PHP 8で利用できる文字列操作関数の一つで、二つの文字列間のレーベンシュタイン距離を計算します。レーベンシュタイン距離とは、一方の文字列をもう一方の文字列に変換するために必要な、最小限の単一文字編集操作（文字の挿入、削除、または置換）の数を指します。

この関数は、比較対象となるstring1とstring2の二つの文字列を引数として受け取ります。加えて、オプションでinsertion_cost（文字の挿入にかかるコスト）、replacement_cost（文字の置換にかかるコスト）、deletion_cost（文字の削除にかかるコスト）を整数値で指定できます。これらのコストを省略した場合、デフォルト値としてそれぞれ1が設定されます。関数の戻り値は、計算されたレーベンシュタイン距離を示す整数値です。

サンプルコードでは、「kitten」と「sitting」のように異なる文字列間の距離を計算し、一方をもう一方に変換するために必要な編集操作の回数を確認しています。デフォルトのコスト設定（すべての操作が1）では、3回の操作で「kitten」を「sitting」に変換できることが示されています。また、カスタムコストを設定する例では、例えば置換コストを高く設定することで、置換操作の「重み」を変えて距離の計算結果がどのように変化するかを把握できます。これにより、システムの要件に応じて特定の編集操作をより重要視した距離を算出することが可能です。同じ文字列同士の距離は0となり、文字の挿入や削除のみで変換できる場合の距離も明確に算出されます。