Completed
Pull Request — master (#14)
by Mischa ter
01:33
created
src/DamerauLevenshtein.php 2 patches
Spacing   +10 added lines, -10 removed lines patch added patch discarded remove patch
@@ -100,9 +100,9 @@  discard block
 block discarded – undo
100 100
     ) {
101 101
         if (!empty($firstString) || !empty($secondString)) {
102 102
             $this->compOne = $firstString;
103
-            $this->compOneLength = (int)mb_strlen($this->compOne, 'UTF-8');
103
+            $this->compOneLength = (int) mb_strlen($this->compOne, 'UTF-8');
104 104
             $this->compTwo = $secondString;
105
-            $this->compTwoLength = (int)mb_strlen($this->compTwo, 'UTF-8');
105
+            $this->compTwoLength = (int) mb_strlen($this->compTwo, 'UTF-8');
106 106
         }
107 107
 
108 108
         $this->insCost = $insCost;
@@ -164,10 +164,10 @@  discard block
 block discarded – undo
164 164
 
165 165
         for ($i = 1; $i <= $oneSize; $i += 1) {
166 166
             // Curchar for the first string
167
-            $cOne = (string)mb_substr($this->compOne, $i - 1, 1, 'UTF-8');
167
+            $cOne = (string) mb_substr($this->compOne, $i - 1, 1, 'UTF-8');
168 168
             for ($j = 1; $j <= $twoSize; $j += 1) {
169 169
                 // Curchar for the second string
170
-                $cTwo = (string)mb_substr($this->compTwo, $j - 1, 1, 'UTF-8');
170
+                $cTwo = (string) mb_substr($this->compTwo, $j - 1, 1, 'UTF-8');
171 171
 
172 172
                 // Compute substitution cost
173 173
                 if ($this->compare($cOne, $cTwo) === 0) {
@@ -196,9 +196,9 @@  discard block
 block discarded – undo
196 196
                 if ($i > 1 && $j > 1) {
197 197
                     // Last two
198 198
                     // @phan-suppress-next-line PhanPartialTypeMismatchArgumentInternal
199
-                    $ccOne = (string)mb_substr($this->compOne, $i - 2, 1, 'UTF-8');
199
+                    $ccOne = (string) mb_substr($this->compOne, $i - 2, 1, 'UTF-8');
200 200
                     // @phan-suppress-next-line PhanPartialTypeMismatchArgumentInternal
201
-                    $ccTwo = (string)mb_substr($this->compTwo, $j - 2, 1, 'UTF-8');
201
+                    $ccTwo = (string) mb_substr($this->compTwo, $j - 2, 1, 'UTF-8');
202 202
 
203 203
                     if ($this->compare($cOne, $ccTwo) === 0 && $this->compare($ccOne, $cTwo) === 0) {
204 204
                         // Transposition cost is computed as minimal of two
@@ -244,7 +244,7 @@  discard block
 block discarded – undo
244 244
             $maxCost += $extraSize * $this->insCost;
245 245
         }
246 246
 
247
-        return (int)$maxCost;
247
+        return (int) $maxCost;
248 248
     }
249 249
 
250 250
     /**
@@ -258,7 +258,7 @@  discard block
 block discarded – undo
258 258
             $this->setupMatrix();
259 259
         }
260 260
 
261
-        return (float)(1 - ($this->getSimilarity() / $this->getMaximalDistance()));
261
+        return (float) (1 - ($this->getSimilarity() / $this->getMaximalDistance()));
262 262
     }
263 263
 
264 264
     /**
@@ -287,12 +287,12 @@  discard block
 block discarded – undo
287 287
         $oneSize = $this->compOneLength;
288 288
         $twoSize = $this->compTwoLength;
289 289
 
290
-        $out = '  ' . $this->compOne . PHP_EOL;
290
+        $out = '  '.$this->compOne.PHP_EOL;
291 291
         for ($y = 0; $y <= $twoSize; $y += 1) {
292 292
             if ($y - 1 < 0) {
293 293
                 $out .= ' ';
294 294
             } else {
295
-                $out .= (string)mb_substr($this->compTwo, $y - 1, 1, 'UTF-8');
295
+                $out .= (string) mb_substr($this->compTwo, $y - 1, 1, 'UTF-8');
296 296
             }
297 297
 
298 298
             for ($x = 0; $x <= $oneSize; $x += 1) {
Please login to merge, or discard this patch.
Indentation   +385 added lines, -385 removed lines patch added patch discarded remove patch
@@ -10,389 +10,389 @@
 block discarded – undo
10 10
 class DamerauLevenshtein
11 11
 {
12 12
 
13
-    /**
14
-     * First string.
15
-     *
16
-     * @var String
17
-     */
18
-    private $compOne;
19
-
20
-    /**
21
-     * Second string.
22
-     *
23
-     * @var String
24
-     */
25
-    private $compTwo;
26
-
27
-    /**
28
-     * Length of first string.
29
-     *
30
-     * @var int
31
-     */
32
-    private $compOneLength = 0;
33
-
34
-    /**
35
-     * Length of second string.
36
-     *
37
-     * @var int
38
-     */
39
-    private $compTwoLength = 0;
40
-
41
-    /**
42
-     * Matrix for Damerau Levenshtein distance dynamic programming computation.
43
-     *
44
-     * @var int[][]
45
-     */
46
-    private $matrix;
47
-
48
-    /**
49
-     * Boolean flag determining whether is matrix computed for input strings.
50
-     *
51
-     * @var bool
52
-     */
53
-    private $calculated = false;
54
-
55
-    /**
56
-     * Cost of character insertion (to first string to match second string).
57
-     *
58
-     * @var int
59
-     */
60
-    private $insCost = 1;
61
-
62
-    /**
63
-     * Cost of character deletion (from first string to match second string).
64
-     *
65
-     * @var int
66
-     */
67
-    private $delCost = 1;
68
-
69
-    /**
70
-     * Substitution cost.
71
-     *
72
-     * @var int
73
-     */
74
-    private $subCost = 1;
75
-
76
-    /**
77
-     * Transposition cost.
78
-     *
79
-     * @var int
80
-     */
81
-    private $transCost = 1;
82
-
83
-    /**
84
-     * Constructor.
85
-     *
86
-     * @param string $firstString first string to compute distance
87
-     * @param string $secondString second string to compute distance
88
-     * @param int $insCost Cost of character insertion
89
-     * @param int $delCost Cost of character deletion
90
-     * @param int $subCost Substitution cost
91
-     * @param int $transCost Transposition cost
92
-     */
93
-    public function __construct(
94
-        string $firstString,
95
-        string $secondString,
96
-        int $insCost = 1,
97
-        int $delCost = 1,
98
-        int $subCost = 1,
99
-        int $transCost = 1
100
-    ) {
101
-        if (!empty($firstString) || !empty($secondString)) {
102
-            $this->compOne = $firstString;
103
-            $this->compOneLength = (int)mb_strlen($this->compOne, 'UTF-8');
104
-            $this->compTwo = $secondString;
105
-            $this->compTwoLength = (int)mb_strlen($this->compTwo, 'UTF-8');
106
-        }
107
-
108
-        $this->insCost = $insCost;
109
-        $this->delCost = $delCost;
110
-        $this->subCost = $subCost;
111
-        $this->transCost = $transCost;
112
-    }
113
-
114
-    /**
115
-     * Returns computed matrix for given input strings.
116
-     *
117
-     * @return int[][] matrix
118
-     */
119
-    public function getMatrix(): array
120
-    {
121
-        if (!$this->calculated) {
122
-            $this->setupMatrix();
123
-        }
124
-
125
-        return $this->matrix;
126
-    }
127
-
128
-    /**
129
-     * Returns similarity of strings, absolute number = Damerau Levenshtein distance.
130
-     *
131
-     * @return int
132
-     */
133
-    public function getSimilarity(): int
134
-    {
135
-        if (!$this->calculated) {
136
-            $this->setupMatrix();
137
-        }
138
-
139
-        return $this->matrix[$this->compOneLength][$this->compTwoLength];
140
-    }
141
-
142
-    /**
143
-     * Procedure to compute matrix for given input strings.
144
-     *
145
-     * @return void
146
-     * @SuppressWarnings(PHPMD.CyclomaticComplexity)
147
-     */
148
-    private function setupMatrix(): void
149
-    {
150
-        $this->matrix = [[]];
151
-
152
-        $oneSize = $this->compOneLength;
153
-        $twoSize = $this->compTwoLength;
154
-
155
-        for ($i = 0; $i <= $oneSize; $i += 1) {
156
-            // @phan-suppress-next-line PhanTypeInvalidDimOffset
157
-            $this->matrix[$i][0] = $i > 0 ? $this->matrix[$i - 1][0] + $this->delCost : 0;
158
-        }
159
-
160
-        for ($i = 0; $i <= $twoSize; $i += 1) {
161
-            // Insertion actualy
162
-            $this->matrix[0][$i] = $i > 0 ? $this->matrix[0][$i - 1] + $this->insCost : 0;
163
-        }
164
-
165
-        for ($i = 1; $i <= $oneSize; $i += 1) {
166
-            // Curchar for the first string
167
-            $cOne = (string)mb_substr($this->compOne, $i - 1, 1, 'UTF-8');
168
-            for ($j = 1; $j <= $twoSize; $j += 1) {
169
-                // Curchar for the second string
170
-                $cTwo = (string)mb_substr($this->compTwo, $j - 1, 1, 'UTF-8');
171
-
172
-                // Compute substitution cost
173
-                if ($this->compare($cOne, $cTwo) === 0) {
174
-                    $cost = 0;
175
-                    $trans = 0;
176
-                } else {
177
-                    $cost = $this->subCost;
178
-                    $trans = $this->transCost;
179
-                }
180
-
181
-                // Deletion cost
182
-                // @phan-suppress-next-line PhanTypeInvalidDimOffset, PhanTypeInvalidLeftOperandOfAdd
183
-                $del = $this->matrix[$i - 1][$j] + $this->delCost;
184
-
185
-                // Insertion cost
186
-
187
-                // phpcs:ignore Generic.Files.LineLength
188
-                // @phan-suppress-next-line PhanTypeArraySuspiciousNull, PhanTypeInvalidDimOffset, PhanTypeInvalidLeftOperandOfAdd
189
-                $ins = $this->matrix[$i][$j - 1] + $this->insCost;
190
-
191
-                // Substitution cost, 0 if same
192
-                $sub = $this->matrix[$i - 1][$j - 1] + $cost;
193
-
194
-                // Compute optimal
195
-                $this->matrix[$i][$j] = min($del, $ins, $sub);
196
-
197
-                // Transposition cost
198
-                if ($i > 1 && $j > 1) {
199
-                    // Last two
200
-                    // @phan-suppress-next-line PhanPartialTypeMismatchArgumentInternal
201
-                    $ccOne = (string)mb_substr($this->compOne, $i - 2, 1, 'UTF-8');
202
-                    // @phan-suppress-next-line PhanPartialTypeMismatchArgumentInternal
203
-                    $ccTwo = (string)mb_substr($this->compTwo, $j - 2, 1, 'UTF-8');
204
-
205
-                    if ($this->compare($cOne, $ccTwo) === 0 && $this->compare($ccOne, $cTwo) === 0) {
206
-                        // Transposition cost is computed as minimal of two
207
-                        // @phan-suppress-next-line PhanPartialTypeMismatchArgumentInternal
208
-                        $this->matrix[$i][$j] = min($this->matrix[$i][$j], $this->matrix[$i - 2][$j - 2] + $trans);
209
-                    }
210
-                }
211
-            }
212
-        }
213
-
214
-        $this->calculated = true;
215
-    }
216
-
217
-    /**
218
-     * Returns maximal possible edit Damerau Levenshtein distance between texts.
219
-     *
220
-     * On common substring of same length perform substitution / insert + delete
221
-     * (depends on what is cheaper), then on extra characters perform insertion / deletion
222
-     *
223
-     * @return int
224
-     */
225
-    public function getMaximalDistance(): int
226
-    {
227
-        $oneSize = $this->compOneLength;
228
-        $twoSize = $this->compTwoLength;
229
-
230
-        // Is substitution cheaper that delete + insert?
231
-        $subCost = min($this->subCost, $this->delCost + $this->insCost);
232
-
233
-        // Get common size
234
-        $minSize = min($oneSize, $twoSize);
235
-        $maxSize = max($oneSize, $twoSize);
236
-        $extraSize = $maxSize - $minSize;
237
-
238
-        // On common size perform substitution / delete + insert, what is cheaper
239
-        $maxCost = $subCost * $minSize;
240
-
241
-        // On resulting do insert/delete
242
-        if ($oneSize > $twoSize) {
243
-            // Delete extra characters
244
-            $maxCost += $extraSize * $this->delCost;
245
-        } else {
246
-            // Insert extra characters
247
-            $maxCost += $extraSize * $this->insCost;
248
-        }
249
-
250
-        return (int)$maxCost;
251
-    }
252
-
253
-    /**
254
-     * Returns relative distance of input strings (computed with maximal possible distance).
255
-     *
256
-     * @return float
257
-     */
258
-    public function getRelativeDistance(): float
259
-    {
260
-        if (!$this->calculated) {
261
-            $this->setupMatrix();
262
-        }
263
-
264
-        return (float)(1 - ($this->getSimilarity() / $this->getMaximalDistance()));
265
-    }
266
-
267
-    /**
268
-     * Compares two characters from string (this method may be overridden in child class).
269
-     *
270
-     * @param string $firstCharacter First character
271
-     * @param string $secondCharacter Second character
272
-     * @return int
273
-     */
274
-    protected function compare(string $firstCharacter, string $secondCharacter): int
275
-    {
276
-        return strcmp($firstCharacter, $secondCharacter);
277
-    }
278
-
279
-    /**
280
-     * Returns computed matrix for given input strings (For debugging purposes).
281
-     *
282
-     * @return string
283
-     */
284
-    public function displayMatrix(): string
285
-    {
286
-        if (!$this->calculated) {
287
-            $this->setupMatrix();
288
-        }
289
-
290
-        $oneSize = $this->compOneLength;
291
-        $twoSize = $this->compTwoLength;
292
-
293
-        $out = '  ' . $this->compOne . PHP_EOL;
294
-        for ($y = 0; $y <= $twoSize; $y += 1) {
295
-            if ($y - 1 < 0) {
296
-                $out .= ' ';
297
-            } else {
298
-                $out .= (string)mb_substr($this->compTwo, $y - 1, 1, 'UTF-8');
299
-            }
300
-
301
-            for ($x = 0; $x <= $oneSize; $x += 1) {
302
-                $out .= $this->matrix[$x][$y];
303
-            }
304
-
305
-            $out .= PHP_EOL;
306
-        }
307
-
308
-        return $out;
309
-    }
310
-
311
-    /**
312
-     * Returns current cost of insertion operation.
313
-     *
314
-     * @return int
315
-     */
316
-    public function getInsCost(): int
317
-    {
318
-        return $this->insCost;
319
-    }
320
-
321
-    /**
322
-     * Sets cost of insertion operation (insert characters to first string to match second string).
323
-     *
324
-     * @param int $insCost Cost of character insertion
325
-     * @return void
326
-     */
327
-    public function setInsCost(int $insCost): void
328
-    {
329
-        $this->calculated = $insCost === $this->insCost ? $this->calculated : false;
330
-        $this->insCost = $insCost;
331
-    }
332
-
333
-    /**
334
-     * Returns current cost of deletion operation.
335
-     *
336
-     * @return int
337
-     */
338
-    public function getDelCost(): int
339
-    {
340
-        return $this->delCost;
341
-    }
342
-
343
-    /**
344
-     * Sets cost of deletion operation (delete characters from first string to match second string).
345
-     *
346
-     * @param int $delCost Cost of character deletion
347
-     * @return void
348
-     */
349
-    public function setDelCost(int $delCost): void
350
-    {
351
-        $this->calculated = $delCost === $this->delCost ? $this->calculated : false;
352
-        $this->delCost = $delCost;
353
-    }
354
-
355
-    /**
356
-     * Returns current cost of substitution operation.
357
-     *
358
-     * @return int
359
-     */
360
-    public function getSubCost(): int
361
-    {
362
-        return $this->subCost;
363
-    }
364
-
365
-    /**
366
-     * Sets cost of substitution operation.
367
-     *
368
-     * @param int $subCost Cost of character substitution
369
-     * @return void
370
-     */
371
-    public function setSubCost(int $subCost): void
372
-    {
373
-        $this->calculated = $subCost === $this->subCost ? $this->calculated : false;
374
-        $this->subCost = $subCost;
375
-    }
376
-
377
-    /**
378
-     * Returns current cost of transposition operation.
379
-     *
380
-     * @return int
381
-     */
382
-    public function getTransCost(): int
383
-    {
384
-        return $this->transCost;
385
-    }
386
-
387
-    /**
388
-     * Sets cost of transposition operation.
389
-     *
390
-     * @param int $transCost Cost of character transposition
391
-     * @return void
392
-     */
393
-    public function setTransCost(int $transCost): void
394
-    {
395
-        $this->calculated = $transCost === $this->transCost ? $this->calculated : false;
396
-        $this->transCost = $transCost;
397
-    }
13
+	/**
14
+	 * First string.
15
+	 *
16
+	 * @var String
17
+	 */
18
+	private $compOne;
19
+
20
+	/**
21
+	 * Second string.
22
+	 *
23
+	 * @var String
24
+	 */
25
+	private $compTwo;
26
+
27
+	/**
28
+	 * Length of first string.
29
+	 *
30
+	 * @var int
31
+	 */
32
+	private $compOneLength = 0;
33
+
34
+	/**
35
+	 * Length of second string.
36
+	 *
37
+	 * @var int
38
+	 */
39
+	private $compTwoLength = 0;
40
+
41
+	/**
42
+	 * Matrix for Damerau Levenshtein distance dynamic programming computation.
43
+	 *
44
+	 * @var int[][]
45
+	 */
46
+	private $matrix;
47
+
48
+	/**
49
+	 * Boolean flag determining whether is matrix computed for input strings.
50
+	 *
51
+	 * @var bool
52
+	 */
53
+	private $calculated = false;
54
+
55
+	/**
56
+	 * Cost of character insertion (to first string to match second string).
57
+	 *
58
+	 * @var int
59
+	 */
60
+	private $insCost = 1;
61
+
62
+	/**
63
+	 * Cost of character deletion (from first string to match second string).
64
+	 *
65
+	 * @var int
66
+	 */
67
+	private $delCost = 1;
68
+
69
+	/**
70
+	 * Substitution cost.
71
+	 *
72
+	 * @var int
73
+	 */
74
+	private $subCost = 1;
75
+
76
+	/**
77
+	 * Transposition cost.
78
+	 *
79
+	 * @var int
80
+	 */
81
+	private $transCost = 1;
82
+
83
+	/**
84
+	 * Constructor.
85
+	 *
86
+	 * @param string $firstString first string to compute distance
87
+	 * @param string $secondString second string to compute distance
88
+	 * @param int $insCost Cost of character insertion
89
+	 * @param int $delCost Cost of character deletion
90
+	 * @param int $subCost Substitution cost
91
+	 * @param int $transCost Transposition cost
92
+	 */
93
+	public function __construct(
94
+		string $firstString,
95
+		string $secondString,
96
+		int $insCost = 1,
97
+		int $delCost = 1,
98
+		int $subCost = 1,
99
+		int $transCost = 1
100
+	) {
101
+		if (!empty($firstString) || !empty($secondString)) {
102
+			$this->compOne = $firstString;
103
+			$this->compOneLength = (int)mb_strlen($this->compOne, 'UTF-8');
104
+			$this->compTwo = $secondString;
105
+			$this->compTwoLength = (int)mb_strlen($this->compTwo, 'UTF-8');
106
+		}
107
+
108
+		$this->insCost = $insCost;
109
+		$this->delCost = $delCost;
110
+		$this->subCost = $subCost;
111
+		$this->transCost = $transCost;
112
+	}
113
+
114
+	/**
115
+	 * Returns computed matrix for given input strings.
116
+	 *
117
+	 * @return int[][] matrix
118
+	 */
119
+	public function getMatrix(): array
120
+	{
121
+		if (!$this->calculated) {
122
+			$this->setupMatrix();
123
+		}
124
+
125
+		return $this->matrix;
126
+	}
127
+
128
+	/**
129
+	 * Returns similarity of strings, absolute number = Damerau Levenshtein distance.
130
+	 *
131
+	 * @return int
132
+	 */
133
+	public function getSimilarity(): int
134
+	{
135
+		if (!$this->calculated) {
136
+			$this->setupMatrix();
137
+		}
138
+
139
+		return $this->matrix[$this->compOneLength][$this->compTwoLength];
140
+	}
141
+
142
+	/**
143
+	 * Procedure to compute matrix for given input strings.
144
+	 *
145
+	 * @return void
146
+	 * @SuppressWarnings(PHPMD.CyclomaticComplexity)
147
+	 */
148
+	private function setupMatrix(): void
149
+	{
150
+		$this->matrix = [[]];
151
+
152
+		$oneSize = $this->compOneLength;
153
+		$twoSize = $this->compTwoLength;
154
+
155
+		for ($i = 0; $i <= $oneSize; $i += 1) {
156
+			// @phan-suppress-next-line PhanTypeInvalidDimOffset
157
+			$this->matrix[$i][0] = $i > 0 ? $this->matrix[$i - 1][0] + $this->delCost : 0;
158
+		}
159
+
160
+		for ($i = 0; $i <= $twoSize; $i += 1) {
161
+			// Insertion actualy
162
+			$this->matrix[0][$i] = $i > 0 ? $this->matrix[0][$i - 1] + $this->insCost : 0;
163
+		}
164
+
165
+		for ($i = 1; $i <= $oneSize; $i += 1) {
166
+			// Curchar for the first string
167
+			$cOne = (string)mb_substr($this->compOne, $i - 1, 1, 'UTF-8');
168
+			for ($j = 1; $j <= $twoSize; $j += 1) {
169
+				// Curchar for the second string
170
+				$cTwo = (string)mb_substr($this->compTwo, $j - 1, 1, 'UTF-8');
171
+
172
+				// Compute substitution cost
173
+				if ($this->compare($cOne, $cTwo) === 0) {
174
+					$cost = 0;
175
+					$trans = 0;
176
+				} else {
177
+					$cost = $this->subCost;
178
+					$trans = $this->transCost;
179
+				}
180
+
181
+				// Deletion cost
182
+				// @phan-suppress-next-line PhanTypeInvalidDimOffset, PhanTypeInvalidLeftOperandOfAdd
183
+				$del = $this->matrix[$i - 1][$j] + $this->delCost;
184
+
185
+				// Insertion cost
186
+
187
+				// phpcs:ignore Generic.Files.LineLength
188
+				// @phan-suppress-next-line PhanTypeArraySuspiciousNull, PhanTypeInvalidDimOffset, PhanTypeInvalidLeftOperandOfAdd
189
+				$ins = $this->matrix[$i][$j - 1] + $this->insCost;
190
+
191
+				// Substitution cost, 0 if same
192
+				$sub = $this->matrix[$i - 1][$j - 1] + $cost;
193
+
194
+				// Compute optimal
195
+				$this->matrix[$i][$j] = min($del, $ins, $sub);
196
+
197
+				// Transposition cost
198
+				if ($i > 1 && $j > 1) {
199
+					// Last two
200
+					// @phan-suppress-next-line PhanPartialTypeMismatchArgumentInternal
201
+					$ccOne = (string)mb_substr($this->compOne, $i - 2, 1, 'UTF-8');
202
+					// @phan-suppress-next-line PhanPartialTypeMismatchArgumentInternal
203
+					$ccTwo = (string)mb_substr($this->compTwo, $j - 2, 1, 'UTF-8');
204
+
205
+					if ($this->compare($cOne, $ccTwo) === 0 && $this->compare($ccOne, $cTwo) === 0) {
206
+						// Transposition cost is computed as minimal of two
207
+						// @phan-suppress-next-line PhanPartialTypeMismatchArgumentInternal
208
+						$this->matrix[$i][$j] = min($this->matrix[$i][$j], $this->matrix[$i - 2][$j - 2] + $trans);
209
+					}
210
+				}
211
+			}
212
+		}
213
+
214
+		$this->calculated = true;
215
+	}
216
+
217
+	/**
218
+	 * Returns maximal possible edit Damerau Levenshtein distance between texts.
219
+	 *
220
+	 * On common substring of same length perform substitution / insert + delete
221
+	 * (depends on what is cheaper), then on extra characters perform insertion / deletion
222
+	 *
223
+	 * @return int
224
+	 */
225
+	public function getMaximalDistance(): int
226
+	{
227
+		$oneSize = $this->compOneLength;
228
+		$twoSize = $this->compTwoLength;
229
+
230
+		// Is substitution cheaper that delete + insert?
231
+		$subCost = min($this->subCost, $this->delCost + $this->insCost);
232
+
233
+		// Get common size
234
+		$minSize = min($oneSize, $twoSize);
235
+		$maxSize = max($oneSize, $twoSize);
236
+		$extraSize = $maxSize - $minSize;
237
+
238
+		// On common size perform substitution / delete + insert, what is cheaper
239
+		$maxCost = $subCost * $minSize;
240
+
241
+		// On resulting do insert/delete
242
+		if ($oneSize > $twoSize) {
243
+			// Delete extra characters
244
+			$maxCost += $extraSize * $this->delCost;
245
+		} else {
246
+			// Insert extra characters
247
+			$maxCost += $extraSize * $this->insCost;
248
+		}
249
+
250
+		return (int)$maxCost;
251
+	}
252
+
253
+	/**
254
+	 * Returns relative distance of input strings (computed with maximal possible distance).
255
+	 *
256
+	 * @return float
257
+	 */
258
+	public function getRelativeDistance(): float
259
+	{
260
+		if (!$this->calculated) {
261
+			$this->setupMatrix();
262
+		}
263
+
264
+		return (float)(1 - ($this->getSimilarity() / $this->getMaximalDistance()));
265
+	}
266
+
267
+	/**
268
+	 * Compares two characters from string (this method may be overridden in child class).
269
+	 *
270
+	 * @param string $firstCharacter First character
271
+	 * @param string $secondCharacter Second character
272
+	 * @return int
273
+	 */
274
+	protected function compare(string $firstCharacter, string $secondCharacter): int
275
+	{
276
+		return strcmp($firstCharacter, $secondCharacter);
277
+	}
278
+
279
+	/**
280
+	 * Returns computed matrix for given input strings (For debugging purposes).
281
+	 *
282
+	 * @return string
283
+	 */
284
+	public function displayMatrix(): string
285
+	{
286
+		if (!$this->calculated) {
287
+			$this->setupMatrix();
288
+		}
289
+
290
+		$oneSize = $this->compOneLength;
291
+		$twoSize = $this->compTwoLength;
292
+
293
+		$out = '  ' . $this->compOne . PHP_EOL;
294
+		for ($y = 0; $y <= $twoSize; $y += 1) {
295
+			if ($y - 1 < 0) {
296
+				$out .= ' ';
297
+			} else {
298
+				$out .= (string)mb_substr($this->compTwo, $y - 1, 1, 'UTF-8');
299
+			}
300
+
301
+			for ($x = 0; $x <= $oneSize; $x += 1) {
302
+				$out .= $this->matrix[$x][$y];
303
+			}
304
+
305
+			$out .= PHP_EOL;
306
+		}
307
+
308
+		return $out;
309
+	}
310
+
311
+	/**
312
+	 * Returns current cost of insertion operation.
313
+	 *
314
+	 * @return int
315
+	 */
316
+	public function getInsCost(): int
317
+	{
318
+		return $this->insCost;
319
+	}
320
+
321
+	/**
322
+	 * Sets cost of insertion operation (insert characters to first string to match second string).
323
+	 *
324
+	 * @param int $insCost Cost of character insertion
325
+	 * @return void
326
+	 */
327
+	public function setInsCost(int $insCost): void
328
+	{
329
+		$this->calculated = $insCost === $this->insCost ? $this->calculated : false;
330
+		$this->insCost = $insCost;
331
+	}
332
+
333
+	/**
334
+	 * Returns current cost of deletion operation.
335
+	 *
336
+	 * @return int
337
+	 */
338
+	public function getDelCost(): int
339
+	{
340
+		return $this->delCost;
341
+	}
342
+
343
+	/**
344
+	 * Sets cost of deletion operation (delete characters from first string to match second string).
345
+	 *
346
+	 * @param int $delCost Cost of character deletion
347
+	 * @return void
348
+	 */
349
+	public function setDelCost(int $delCost): void
350
+	{
351
+		$this->calculated = $delCost === $this->delCost ? $this->calculated : false;
352
+		$this->delCost = $delCost;
353
+	}
354
+
355
+	/**
356
+	 * Returns current cost of substitution operation.
357
+	 *
358
+	 * @return int
359
+	 */
360
+	public function getSubCost(): int
361
+	{
362
+		return $this->subCost;
363
+	}
364
+
365
+	/**
366
+	 * Sets cost of substitution operation.
367
+	 *
368
+	 * @param int $subCost Cost of character substitution
369
+	 * @return void
370
+	 */
371
+	public function setSubCost(int $subCost): void
372
+	{
373
+		$this->calculated = $subCost === $this->subCost ? $this->calculated : false;
374
+		$this->subCost = $subCost;
375
+	}
376
+
377
+	/**
378
+	 * Returns current cost of transposition operation.
379
+	 *
380
+	 * @return int
381
+	 */
382
+	public function getTransCost(): int
383
+	{
384
+		return $this->transCost;
385
+	}
386
+
387
+	/**
388
+	 * Sets cost of transposition operation.
389
+	 *
390
+	 * @param int $transCost Cost of character transposition
391
+	 * @return void
392
+	 */
393
+	public function setTransCost(int $transCost): void
394
+	{
395
+		$this->calculated = $transCost === $this->transCost ? $this->calculated : false;
396
+		$this->transCost = $transCost;
397
+	}
398 398
 }
Please login to merge, or discard this patch.