Page MenuHomeDevCentral
Files F3780080

D2661.id6726.diff
No OneTemporary
Actions

D2661.id6726.diff
View Options

diff --git a/omnitools/src/Strings/SorensenDiceCoefficient.php b/omnitools/src/Strings/SorensenDiceCoefficient.php
--- a/omnitools/src/Strings/SorensenDiceCoefficient.php
+++ b/omnitools/src/Strings/SorensenDiceCoefficient.php
@@ -5,27 +5,43 @@
use Keruald\OmniTools\Strings\Multibyte\OmniString;
+/**
+ * Computes the Sørensen–Dice coefficient, a statistic used to evaluate
+ * the similarity between two strings.
+ */
class SorensenDiceCoefficient {
/**
* @var string[]
*/
- private $x;
+ private array $x;
/**
* @var string[]
*/
- private $y;
+ private array $y;
///
/// Constructors
///
+ /**
+ * @param string $left The first string to compare
+ * @param string $right The second string to compare
+ */
public function __construct (string $left, string $right) {
$this->x = (new OmniString($left))->getBigrams();
$this->y = (new OmniString($right))->getBigrams();
}
+ /**
+ * Allows to directly compute the coefficient between two strings.
+ *
+ * @param string $left The first string to compare
+ * @param string $right The second string to compare
+ *
+ * @return float The Sørensen–Dice coefficient for the two specified strings.
+ */
public static function computeFor(string $left, string $right) : float {
$instance = new self($left, $right);
@@ -36,6 +52,9 @@
/// Sørensen formula
///
+ /**
+ * @return float The Sørensen–Dice coefficient.
+ */
public function compute() : float {
return 2 * $this->countIntersect()
/
diff --git a/omnitools/tests/Strings/SorensenDiceCoefficientTest.php b/omnitools/tests/Strings/SorensenDiceCoefficientTest.php
--- a/omnitools/tests/Strings/SorensenDiceCoefficientTest.php
+++ b/omnitools/tests/Strings/SorensenDiceCoefficientTest.php
@@ -14,4 +14,11 @@
$this->assertEquals(0.25, $actual->compute());
}
+ public function testComputeFor () : void {
+ $score = SorensenDiceCoefficient::computeFor('night', 'nacht');
+
+ $this->assertGreaterThan(0, $score);
+ $this->assertLessThan(1, $score);
+ }
+
}

File Metadata

Mime Type
text/plain
Expires
Tue, Nov 26, 11:40 (21 h, 57 m)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
2264453
Default Alt Text
D2661.id6726.diff (2 KB)

Event Timeline

Nasqueron DevCentral · If it had been much bigger the moon would have had a core of ice. · Powered by Phabricator