Merge pull request #12 from PatrickOHara/name_changes

🚚  name changes

.gitignore

@@ -2,6 +2,7 @@
 # python cache
 *.egg-info
 __pycache__
+.eggs
 
 # misc
 .vscode

requirements.txt

@@ -6,4 +6,4 @@ mkdocs-material>=6.0.2
 mypy>=0.782
 pylint>=2.6.0
 pytest>=6.1.1
-pytest-tspwplib>=0.2.0b1
+pytest-tspwplib>=0.2.3

tests/test_complete.py

@@ -25,9 +25,9 @@ def test_is_complete_with_self_loops():
         assert is_complete_with_self_loops(graph)
 
 
-def test_tsplib_is_complete(tsplib_root, instance_name):
+def test_tsplib_is_complete(tsplib_root, graph_name):
     """Test each instance of TSPLIB95 is a complete graph"""
-    filepath = build_path_to_tsplib_instance(tsplib_root, instance_name)
+    filepath = build_path_to_tsplib_instance(tsplib_root, graph_name)
     problem = tsplib95.load(filepath)
     graph = problem.get_graph()
     assert is_complete_with_self_loops(graph)

tests/test_profits_problem.py

@@ -7,10 +7,10 @@
 from tspwplib.utils import build_path_to_oplib_instance
 
 
-def test_parse_profits_problem(oplib_root, generation, instance_name, alpha):
+def test_parse_profits_problem(oplib_root, generation, graph_name, alpha):
     """Test an OP instance can be parsed"""
     filepath = build_path_to_oplib_instance(
-        oplib_root, generation, instance_name, alpha=alpha
+        oplib_root, generation, graph_name, alpha=alpha
     )
     assert "COST_LIMIT" in ProfitsProblem.fields_by_keyword
     assert "NODE_SCORE_SECTION" in ProfitsProblem.fields_by_keyword
@@ -19,22 +19,22 @@ def test_parse_profits_problem(oplib_root, generation, instance_name, alpha):
     assert problem.is_complete()
 
 
-def test_get_cost_limit(oplib_root, generation, instance_name, alpha):
+def test_get_cost_limit(oplib_root, generation, graph_name, alpha):
     """Test we can get the cost limit"""
     filepath = build_path_to_oplib_instance(
-        oplib_root, generation, instance_name, alpha=alpha
+        oplib_root, generation, graph_name, alpha=alpha
     )
     problem = ProfitsProblem.load(filepath)
     expected_cost_limit = math.ceil(
-        OptimalSolutionTSP[instance_name] * (alpha.value / 100.0)
+        OptimalSolutionTSP[graph_name] * (alpha.value / 100.0)
     )
     assert problem.get_cost_limit() == expected_cost_limit
 
 
-def test_get_node_score(oplib_root, generation, instance_name, alpha):
+def test_get_node_score(oplib_root, generation, graph_name, alpha):
     """Test every node has a prize"""
     filepath = build_path_to_oplib_instance(
-        oplib_root, generation, instance_name, alpha=alpha
+        oplib_root, generation, graph_name, alpha=alpha
     )
     problem = ProfitsProblem.load(filepath)
     node_scores = problem.get_node_score()
@@ -45,10 +45,10 @@ def test_get_node_score(oplib_root, generation, instance_name, alpha):
         assert value >= 0
 
 
-def test_get_graph(oplib_root, generation, instance_name, alpha):
+def test_get_graph(oplib_root, generation, graph_name, alpha):
     """Test we can load a graph with prizes"""
     filepath = build_path_to_oplib_instance(
-        oplib_root, generation, instance_name, alpha=alpha
+        oplib_root, generation, graph_name, alpha=alpha
     )
     problem = ProfitsProblem.load(filepath)
     graph = problem.get_graph()

tests/test_sparsity.py

@@ -8,10 +8,10 @@
 
 
 def test_remove_random_edges_from_graph(
-    tsplib_root, instance_name, edge_removal_probability
+    tsplib_root, graph_name, edge_removal_probability
 ):
     """Test the right number of edges are removed"""
-    filepath = build_path_to_tsplib_instance(tsplib_root, instance_name)
+    filepath = build_path_to_tsplib_instance(tsplib_root, graph_name)
     problem = StandardProblem.load(filepath)
     complete_graph = problem.get_graph()
     assert is_complete_with_self_loops(complete_graph)

tests/test_utils.py

@@ -3,13 +3,13 @@
 from tspwplib.utils import build_path_to_oplib_instance, build_path_to_tsplib_instance
 
 
-def test_build_path_to_oplib_instance(oplib_root, generation, instance_name, alpha):
+def test_build_path_to_oplib_instance(oplib_root, generation, graph_name, alpha):
     """Test path building"""
     assert build_path_to_oplib_instance(
-        oplib_root, generation, instance_name, alpha=alpha
+        oplib_root, generation, graph_name, alpha=alpha
     ).exists()
 
 
-def test_build_path_to_tsplib_instance(tsplib_root, instance_name):
+def test_build_path_to_tsplib_instance(tsplib_root, graph_name):
     """Test path building for tsplib"""
-    assert build_path_to_tsplib_instance(tsplib_root, instance_name).exists()
+    assert build_path_to_tsplib_instance(tsplib_root, graph_name).exists()

tspwplib/types.py

@@ -17,7 +17,7 @@ class EdgeFunctionName(str, Enum):
     weight = "weight"
 
 
-class InstanceName(str, Enum):
+class GraphName(str, Enum):
     """Names of TSPlib instances"""
 
     eil76 = "eil76"
@@ -26,16 +26,16 @@ class InstanceName(str, Enum):
     vm1748 = "vm1748"
 
 
-class Generation(Enum):
+class Generation(str, Enum):
     """Generations of TSPwP problem instances"""
 
-    one = "gen1"
-    two = "gen2"
-    three = "gen3"
-    four = "gen4"
+    gen1 = "gen1"
+    gen2 = "gen2"
+    gen3 = "gen3"
+    gen4 = "gen4"
 
 
-class Alpha(Enum):
+class Alpha(IntEnum):
     """Ratio between profit/cost limit and profit/cost of TSP solution"""
 
     fifty = 50

tspwplib/utils.py

@@ -1,21 +1,21 @@
 """Useful functions for parsing"""
 
 from pathlib import Path
-from .types import Alpha, Generation, InstanceName
+from .types import Alpha, Generation, GraphName
 
 
 def build_path_to_oplib_instance(
     oplib_root: Path,
     generation: Generation,
-    name: InstanceName,
+    name: GraphName,
     alpha: Alpha = Alpha.fifty,
 ) -> Path:
     """Build a filepath to a oplib instance"""
     filename: str = name + "-" + generation.value + "-" + str(alpha.value) + ".oplib"
     return oplib_root / "instances" / generation.value / filename
 
 
-def build_path_to_tsplib_instance(tsplib_root: Path, name: InstanceName) -> Path:
+def build_path_to_tsplib_instance(tsplib_root: Path, name: GraphName) -> Path:
     """Build a filepath to a tsplib instance"""
     filename = name.value + ".tsp"
     return tsplib_root / filename