Checkpoint initial implementation

tungston/core/fauna/group.py

@@ -0,0 +1,50 @@
+# Class ############################################################################################
+
+class Group:
+    """
+    How many individuals are commonly present when encountering a creature.
+    """
+
+    def __init__(self, name, smallest, largest):
+        self.name = name
+        self.smallest = smallest
+        self.largest = largest
+
+    def __eq__(self, other) -> bool:
+        if type(other) != type(self): return False
+        if other.largest != self.largest: return False
+        if other.smallest != self.smallest: return False
+        return True
+
+    def __hash__(self) -> int:
+        return hash((self.smallest, self.largest))
+
+    def __str__(self) -> str:
+        return self.name
+
+    def __repr__(self) -> str:
+        return str(self) + f"<{self.smallest} to {self.largest}>"
+
+
+# Constants ########################################################################################
+
+SOLO   = Group("solo",   1, 1)
+PAIR   = Group("pair",   2, 2)
+FAMILY = Group("family", 2, 4)
+TROUP  = Group("troup",  3, 6)
+HERD   = Group("herd",   4, 8)
+
+ALL = [SOLO, PAIR, FAMILY, TROUP, HERD]
+
+
+# Helper Functions #################################################################################
+
+def merge(*groups):
+    if not groups: return SOLO
+
+    result = Group(f"", HERD.largest, SOLO.smallest)
+    for group in groups:
+        result.smallest = min(result.smallest, group.smallest)
+        result.largest = max(result.largest, group.largest)
+
+    return result