cardy 0.0.1__tar.gz

cardy-0.0.1/PKG-INFO

@@ -0,0 +1,16 @@
+Metadata-Version: 2.1
+Name: cardy
+Version: 0.0.1
+Summary: Card Sorting Utilities
+Project-URL: repository, https://github.com/Programming-Education-Research/cardy
+Classifier: Development Status :: 1 - Planning
+Classifier: Topic :: Utilities
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+Requires-Dist: munkres~=1.1.4
+
+# Cardy
+
+Various card sorting utilities.

cardy-0.0.1/README.md

@@ -0,0 +1,3 @@
+# Cardy
+
+Various card sorting utilities.

cardy-0.0.1/pyproject.toml

@@ -0,0 +1,28 @@
+[build-system]
+requires = ["setuptools>=65.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "cardy"
+version = "0.0.1"
+description = "Card Sorting Utilities"
+
+readme = "README.md"
+requires-python = ">=3.12"
+license = { file = "LICENSE" }
+classifiers = [
+    "Development Status :: 1 - Planning",
+    "Topic :: Utilities",
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+]
+dynamic = ["dependencies"]
+
+[project.urls]
+repository = "https://github.com/Programming-Education-Research/cardy"
+
+[tool.setuptools.dynamic]
+dependencies = { file = ["requirements.txt"] }
+
+[tool.setuptools.packages.find]
+where = ["src"]

cardy-0.0.1/requirements.txt

@@ -0,0 +1 @@
+munkres~=1.1.4

cardy-0.0.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

cardy-0.0.1/src/cardy/__init__.py

@@ -0,0 +1 @@
+from .distance import *

cardy-0.0.1/src/cardy/distance.py

@@ -0,0 +1,28 @@
+from collections.abc import Set
+
+from munkres import Munkres, make_cost_matrix
+
+
+__all__ = ("CardSort", "edit_distance")
+
+
+type CardSort = tuple[Set[int], ...]
+
+
+def edit_distance(sort1: CardSort, sort2: CardSort) -> int:
+    if not sort1 and not sort2:
+        return 0
+
+    matching_weights = [[] for _ in range(len(sort1))]
+    for i, group1 in enumerate(sort1):
+        for group2 in sort2:
+            intersection = len(group1 & group2)
+            matching_weights[i].append(intersection)
+
+    cost_matrix = make_cost_matrix(matching_weights)
+
+    running_sum = 0
+    for row, col in Munkres().compute(cost_matrix):
+        running_sum += matching_weights[row][col]
+
+    return sum(len(g) for g in sort1) - running_sum

cardy-0.0.1/src/cardy.egg-info/PKG-INFO

@@ -0,0 +1,16 @@
+Metadata-Version: 2.1
+Name: cardy
+Version: 0.0.1
+Summary: Card Sorting Utilities
+Project-URL: repository, https://github.com/Programming-Education-Research/cardy
+Classifier: Development Status :: 1 - Planning
+Classifier: Topic :: Utilities
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+Requires-Dist: munkres~=1.1.4
+
+# Cardy
+
+Various card sorting utilities.

cardy-0.0.1/src/cardy.egg-info/SOURCES.txt

@@ -0,0 +1,11 @@
+README.md
+pyproject.toml
+requirements.txt
+src/cardy/__init__.py
+src/cardy/distance.py
+src/cardy.egg-info/PKG-INFO
+src/cardy.egg-info/SOURCES.txt
+src/cardy.egg-info/dependency_links.txt
+src/cardy.egg-info/requires.txt
+src/cardy.egg-info/top_level.txt
+tests/test_edit_distance.py

cardy-0.0.1/src/cardy.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

cardy-0.0.1/src/cardy.egg-info/requires.txt

@@ -0,0 +1 @@
+munkres~=1.1.4

cardy-0.0.1/src/cardy.egg-info/top_level.txt

@@ -0,0 +1 @@
+cardy

cardy-0.0.1/tests/test_edit_distance.py

@@ -0,0 +1,39 @@
+from cardy import edit_distance
+from utils import test
+
+
+@test
+def empty_card_sorts_have_a_distance_of_zero():
+    assert edit_distance((), ()) == 0
+
+
+@test
+def equivalent_card_sorts_have_an_edit_distance_of_zero():
+    assert edit_distance(({1},), ({1},)) == 0
+    assert edit_distance(({1}, {2}), ({1}, {2})) == 0
+    assert edit_distance(({2}, {1}), ({1}, {2})) == 0
+    assert edit_distance(
+        ({1, 2, 3}, {4}, {5, 6}),
+        ({4}, {1, 2, 3}, {5, 6}),
+    ) == 0
+
+
+@test
+def empty_groups_are_ignored_when_computing_distances():
+    assert edit_distance(({1}, {2}, set()), ({1}, {2})) == 0
+    assert edit_distance(({1}, {2}), ({1}, set(), {2})) == 0
+
+
+@test
+def single_card_displacements_have_an_edit_distance_of_one():
+    assert edit_distance(({1, 2}, {3}), ({1}, {2, 3})) == 1
+    assert edit_distance(({1}, {2}, {3}), ({1}, {2, 3})) == 1
+    assert edit_distance(({1}, {2, 3}), ({1, 2, 3},)) == 1
+
+
+@test
+def distance_between_card_sorts():
+    assert edit_distance(
+        ({1, 2, 3}, {4, 5, 6}, {7, 8, 9}),
+        ({1, 2}, {3, 4}, {5, 6, 7}, {8, 9}),
+    ) == 3