feature: Add method `$microplateSet->positionFromLocation($location, …

CHANGELOG.md

@@ -9,7 +9,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Unreleased
 
-## v6.3.0
+## v6.4.0
+
+### Added
+
+- Add method `$microplateSet->positionFromLocation($location, $direction)`
+
+- ## v6.3.0
 
 ### Added
 

src/MicroplateSet/MicroplateSet.php

@@ -20,7 +20,7 @@ public function __construct(CoordinateSystem $coordinateSystem)
         $this->coordinateSystem = $coordinateSystem;
     }
 
-    /** @return list<string> */
+    /** @return array<int,string> */
     abstract public function plateIDs(): array;
 
     public function plateCount(): int
@@ -50,4 +50,18 @@ public function locationFromPosition(int $setPosition, FlowDirection $direction)
             $this->plateIDs()[$plateIndex]
         );
     }
+
+    /**
+     * @param Location<TCoordinateSystem> $location
+     */
+    public function positionFromLocation(Location $location, FlowDirection $direction): int
+    {
+        $positionOnPlate = $location->coordinates
+            ->position($direction);
+
+        $positionOnSet = $positionOnPlate * array_keys($this->plateIDs())[$location->plateID];
+        assert(is_int($positionOnSet));
+
+        return $positionOnSet;
+    }
 }

tests/Unit/MicroplateSet/MicroplateSetABCDTest.php

@@ -99,6 +99,8 @@ public function testSetLocationFromSetPositionFor96Wells(int $position, string $
         $location = $microplateSet->locationFromPosition($position, FlowDirection::COLUMN());
         self::assertSame($coordinatesString, $location->coordinates->toString());
         self::assertSame($plateID, $location->plateID);
+
+        self::assertSame($position, $microplateSet->positionFromLocation($location, FlowDirection::COLUMN()));
     }
 
     /** @return iterable<array{position: int, coordinatesString: string, plateID: string}> */