cache for elections

Author: jgibson517

src/votekit/elections/election_types.py

@@ -2,6 +2,7 @@
 import itertools as it
 import numpy as np
 from typing import Callable, Optional
+from functools import lru_cache
 
 from ..models import Election
 from ..election_state import ElectionState
@@ -18,6 +19,9 @@
     first_place_votes,
 )
 
+# add ballots attribute // remove preference profile so the original profile is
+# not modified in place everytime?
+
 
 class STV(Election):
     """
@@ -164,6 +168,7 @@ def run_step(self) -> ElectionState:
         )
         return self.state
 
+    @lru_cache
     def run_election(self) -> ElectionState:
         """
         Runs complete STV election
@@ -278,6 +283,7 @@ def run_step(self) -> ElectionState:
         self.state = new_state
         return self.state
 
+    @lru_cache
     def run_election(self) -> ElectionState:
         """
         Simulates a complete Limited election
@@ -340,6 +346,7 @@ def run_step(self) -> ElectionState:
         self.state = outcome
         return outcome
 
+    @lru_cache
     def run_election(self) -> ElectionState:
         """
         Runs complete Bloc election
@@ -398,6 +405,7 @@ def run_step(self) -> ElectionState:
         self.state = outcome
         return outcome
 
+    @lru_cache
     def run_election(self) -> ElectionState:
         """
         Runs complete SNTV election
@@ -513,6 +521,7 @@ def run_step(self, stage: str) -> ElectionState:
         self.state = new_state  # type: ignore
         return new_state  # type: ignore
 
+    @lru_cache
     def run_election(self) -> ElectionState:
         """
         Runs complete SNTV_STV election
@@ -574,6 +583,7 @@ def run_step(self) -> ElectionState:
         self.state = outcome
         return outcome
 
+    @lru_cache
     def run_election(self) -> ElectionState:
         """
         Simulates a complete TopTwo election
@@ -637,6 +647,7 @@ def run_step(self) -> ElectionState:
         self.state = new_state
         return new_state
 
+    @lru_cache
     def run_election(self) -> ElectionState:
         """
         Simulates a complete DominatingSets election
@@ -709,6 +720,7 @@ def run_step(self) -> ElectionState:
         self.state = new_state
         return new_state
 
+    @lru_cache
     def run_election(self) -> ElectionState:
         """
         Simulates a complete Conda-Borda election
@@ -784,6 +796,7 @@ def run_step(self, old_profile: PreferenceProfile) -> ElectionState:
         )
         return self.state
 
+    @lru_cache
     def run_election(self) -> ElectionState:
         """
         Simulates a complete sequential RCV contest.
@@ -873,6 +886,7 @@ def run_step(self) -> ElectionState:
         self.state = new_state
         return new_state
 
+    @lru_cache
     def run_election(self) -> ElectionState:
         """
         Simulates a complete Borda contest