moving default implementation into Euclidean namespace

Author: bdelespierre

src/Algorithm.php

@@ -11,7 +11,7 @@
 use Kmeans\Interfaces\PointCollectionInterface;
 use Kmeans\Interfaces\PointInterface;
 
-class Algorithm implements AlgorithmInterface
+abstract class Algorithm implements AlgorithmInterface
 {
     private InitializationSchemeInterface $initScheme;
 
@@ -25,6 +25,10 @@ public function __construct(InitializationSchemeInterface $initScheme)
         $this->initScheme = $initScheme;
     }
 
+    abstract protected function getDistanceBetween(PointInterface $pointA, PointInterface $pointB): float;
+
+    abstract protected function findCentroid(PointCollectionInterface $points): PointInterface;
+
     public function registerIterationCallback(callable $callback): void
     {
         $this->iterationCallbacks[] = $callback;
@@ -48,18 +52,6 @@ public function clusterize(PointCollectionInterface $points, int $nbClusters): C
         return $clusters;
     }
 
-    protected function getDistanceBetween(PointInterface $pointA, PointInterface $pointB): float
-    {
-        return Math::euclideanDist($pointA->getCoordinates(), $pointB->getCoordinates());
-    }
-
-    protected function findCentroid(PointCollectionInterface $points): PointInterface
-    {
-        return new Point($points->getSpace(), Math::centroid(
-            array_map(fn (PointInterface $point) => $point->getCoordinates(), iterator_to_array($points))
-        ));
-    }
-
     private function iterate(ClusterCollectionInterface $clusters): bool
     {
         /** @var \SplObjectStorage<ClusterInterface, null> */
@@ -110,7 +102,7 @@ private function getClosestCluster(ClusterCollectionInterface $clusters, PointIn
         return $closest;
     }
 
-    protected function invokeIterationCallbacks(ClusterCollectionInterface $clusters): void
+    private function invokeIterationCallbacks(ClusterCollectionInterface $clusters): void
     {
         foreach ($this->iterationCallbacks as $callback) {
             $callback($this, $clusters);

src/Euclidean/Algorithm.php

@@ -0,0 +1,23 @@
+<?php
+
+namespace Kmeans\Euclidean;
+
+use Kmeans\Algorithm as BaseAlgorithm;
+use Kmeans\Interfaces\PointCollectionInterface;
+use Kmeans\Interfaces\PointInterface;
+use Kmeans\Math;
+
+class Algorithm extends BaseAlgorithm
+{
+    protected function getDistanceBetween(PointInterface $pointA, PointInterface $pointB): float
+    {
+        return Math::euclideanDist($pointA->getCoordinates(), $pointB->getCoordinates());
+    }
+
+    protected function findCentroid(PointCollectionInterface $points): PointInterface
+    {
+        return new Point($points->getSpace(), Math::centroid(
+            array_map(fn (PointInterface $point) => $point->getCoordinates(), iterator_to_array($points))
+        ));
+    }
+}

src/Point.php renamed to src/Euclidean/Point.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace Kmeans;
+namespace Kmeans\Euclidean;
 
 use Kmeans\Concerns\HasSpaceTrait;
 use Kmeans\Interfaces\PointInterface;
@@ -25,6 +25,12 @@ class Point implements PointInterface
      */
     public function __construct(SpaceInterface $space, array $coordinates)
     {
+        if (! $space instanceof Space) {
+            throw new \LogicException(
+                "An euclidean point must belong to an euclidean space."
+            );
+        }
+
         $this->setSpace($space);
         $this->coordinates = $this->sanitizeCoordinates($coordinates);
     }
@@ -50,6 +56,7 @@ public function setData($data): void
      */
     private function sanitizeCoordinates(array $coordinates): array
     {
+        assert($this->space instanceof Space);
         if (count($coordinates) != $this->space->getDimensions()) {
             throw new \InvalidArgumentException(sprintf(
                 "Invalid set of coordinates: %d coordinates expected, %d given",

src/Space.php renamed to src/Euclidean/Space.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace Kmeans;
+namespace Kmeans\Euclidean;
 
 use Kmeans\Interfaces\SpaceInterface;
 
@@ -14,7 +14,9 @@ class Space implements SpaceInterface
     public function __construct(int $dimensions)
     {
         if ($dimensions < 1) {
-            throw new \InvalidArgumentException("Invalid space dimentions: {$dimensions}");
+            throw new \InvalidArgumentException(
+                "Invalid space dimentions: {$dimensions}"
+            );
         }
 
         $this->dimensions = $dimensions;
@@ -27,6 +29,7 @@ public function getDimensions(): int
 
     public function isEqualTo(SpaceInterface $space): bool
     {
-        return $this->getDimensions() == $space->getDimensions();
+        return $space instanceof self
+            && $this->dimensions == $space->dimensions;
     }
 }

src/Gps/Point.php

@@ -2,7 +2,7 @@
 
 namespace Kmeans\Gps;
 
-use Kmeans\Point as BasePoint;
+use Kmeans\Euclidean\Point as BasePoint;
 
 /**
  * @method array{0: float, 1: float} getCoordinates()

src/Gps/Space.php

@@ -2,12 +2,12 @@
 
 namespace Kmeans\Gps;
 
-use Kmeans\Space as BaseSpace;
+use Kmeans\Interfaces\SpaceInterface;
 
-class Space extends BaseSpace
+class Space implements SpaceInterface
 {
-    public function __construct()
+    public function isEqualTo(SpaceInterface $other): bool
     {
-        parent::__construct(2);
+        return $other instanceof self;
     }
 }

src/Interfaces/SpaceInterface.php

@@ -4,10 +4,5 @@
 
 interface SpaceInterface
 {
-    /**
-     * @return int<1, max>
-     */
-    public function getDimensions(): int;
-
     public function isEqualTo(self $space): bool;
 }

tests/Unit/ClusterCollectionTest.php

@@ -4,26 +4,20 @@
 
 use Kmeans\Cluster;
 use Kmeans\ClusterCollection;
+use Kmeans\Euclidean\Point;
+use Kmeans\Euclidean\Space;
 use Kmeans\Interfaces\ClusterInterface;
-use Kmeans\Point;
-use Kmeans\Space;
 use PHPUnit\Framework\TestCase;
 
 /**
- * @coversDefaultClass \Kmeans\ClusterCollection
- * @uses \Kmeans\Space
+ * @covers \Kmeans\ClusterCollection
  * @uses \Kmeans\Cluster
- * @uses \Kmeans\Point
+ * @uses \Kmeans\Euclidean\Point
+ * @uses \Kmeans\Euclidean\Space
  * @uses \Kmeans\PointCollection
  */
 class ClusterCollectionTest extends TestCase
 {
-    /**
-     * @covers ::__construct
-     * @covers ::getSpace
-     * @covers ::attach
-     * @covers ::contains
-     */
     public function testConstructingClusterWithPoints(): void
     {
         $space = new Space(1);
@@ -40,12 +34,6 @@ public function testConstructingClusterWithPoints(): void
         );
     }
 
-    /**
-     * @covers ::__construct
-     * @covers ::attach
-     * @covers ::contains
-     * @covers ::detach
-     */
     public function testAddingAndRemovingClustersFromCollection(): void
     {
         $space = new Space(4);
@@ -77,10 +65,6 @@ public function testAddingAndRemovingClustersFromCollection(): void
         );
     }
 
-    /**
-     * @covers ::__construct
-     * @covers ::attach
-     */
     public function testAddingInvalidClusterToCollection(): void
     {
         $this->expectException(\InvalidArgumentException::class);
@@ -94,12 +78,6 @@ public function testAddingInvalidClusterToCollection(): void
         $collection->attach($cluster);
     }
 
-    /**
-     * @covers ::__construct
-     * @covers ::attach
-     * @covers ::detach
-     * @covers ::count
-     */
     public function testCount(): void
     {
         $space = new Space(4);
@@ -125,15 +103,6 @@ public function testCount(): void
         $this->assertEquals(0, count($collection));
     }
 
-    /**
-     * @covers ::__construct
-     * @covers ::attach
-     * @covers ::current
-     * @covers ::key
-     * @covers ::next
-     * @covers ::rewind
-     * @covers ::valid
-     */
     public function testIterator(): void
     {
         $space = new Space(4);