Refactoring Thiele

Author: Simon-Rey

docs-source/source/reference/rules/index.rst

@@ -3,12 +3,34 @@ Rules module
 
 .. automodule:: trivoting.rules
 
+Meta Rule
+---------
+
+.. automodule:: trivoting.rules.ilp_schemes
+
+.. autoclass:: trivoting.rules.ilp_schemes.ILPNotOptimalError
+    :members:
+    :show-inheritance:
+
+.. autoclass:: trivoting.rules.ilp_schemes.ILPBuilder
+    :members:
+    :show-inheritance:
+
+.. autoclass:: trivoting.rules.ilp_schemes.PuLPSolvers
+    :members:
+    :show-inheritance:
+
+.. autofunction:: trivoting.rules.ilp_schemes.ilp_optimiser_rule
+
+
 Thiele Methods
 --------------
 
 .. automodule:: trivoting.rules.thiele
 
 .. autoclass:: trivoting.rules.thiele.ThieleScore
+    :members:
+    :show-inheritance:
 
 .. autoclass:: trivoting.rules.thiele.PAVScoreKraiczy2025
 
@@ -38,6 +60,8 @@ Tax-Based Rules
 .. automodule:: trivoting.rules.tax_rules
 
 .. autoclass:: trivoting.rules.tax_rules.TaxFunction
+    :members:
+    :show-inheritance:
 
 .. autoclass:: trivoting.rules.tax_rules.TaxKraiczy2025
 

docs/.doctrees/environment.pickle

@@ -290,6 +290,7 @@ <h1>All modules for which code is available</h1>
 <li><a href="trivoting/election/trichotomous_ballot.html">trivoting.election.trichotomous_ballot</a></li>
 <li><a href="trivoting/election/trichotomous_profile.html">trivoting.election.trichotomous_profile</a></li>
 <li><a href="trivoting/fractions.html">trivoting.fractions</a></li>
+<li><a href="trivoting/rules/ilp_schemes.html">trivoting.rules.ilp_schemes</a></li>
 <li><a href="trivoting/rules/phragmen.html">trivoting.rules.phragmen</a></li>
 <li><a href="trivoting/rules/tax_rules.html">trivoting.rules.tax_rules</a></li>
 <li><a href="trivoting/rules/thiele.html">trivoting.rules.thiele</a></li>

docs/.doctrees/reference/election/index.doctree

@@ -387,7 +387,7 @@ <h1>Source code for trivoting.election.generate</h1><div class="highlight"><pre>
 <span class="sd">    TrichotomousProfile</span>
 <span class="sd">        A profile containing randomly generated trichotomous ballots.</span>
 <span class="sd">    &quot;&quot;&quot;</span>
-    <span class="n">alternatives</span> <span class="o">=</span> <span class="p">[</span><span class="n">Alternative</span><span class="p">(</span><span class="n">i</span><span class="p">)</span> <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">num_alternatives</span><span class="p">)]</span>
+    <span class="n">alternatives</span> <span class="o">=</span> <span class="p">[</span><span class="n">Alternative</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">i</span><span class="p">))</span> <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">num_alternatives</span><span class="p">)]</span>
     <span class="n">profile</span> <span class="o">=</span> <span class="n">TrichotomousProfile</span><span class="p">(</span><span class="n">alternatives</span><span class="o">=</span><span class="n">alternatives</span><span class="p">)</span>
     <span class="k">for</span> <span class="n">_</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">num_voters</span><span class="p">):</span>
         <span class="n">ballot</span> <span class="o">=</span> <span class="n">generate_random_ballot</span><span class="p">(</span>

docs/.doctrees/reference/rules/index.doctree

@@ -282,14 +282,14 @@ <h1>Source code for trivoting.election.trichotomous_ballot</h1><div class="highl
 <span></span><span class="kn">from</span><span class="w"> </span><span class="nn">__future__</span><span class="w"> </span><span class="kn">import</span> <span class="n">annotations</span>
 
 <span class="kn">from</span><span class="w"> </span><span class="nn">abc</span><span class="w"> </span><span class="kn">import</span> <span class="n">ABC</span><span class="p">,</span> <span class="n">abstractmethod</span>
-<span class="kn">from</span><span class="w"> </span><span class="nn">collections.abc</span><span class="w"> </span><span class="kn">import</span> <span class="n">Iterable</span><span class="p">,</span> <span class="n">Collection</span>
+<span class="kn">from</span><span class="w"> </span><span class="nn">collections.abc</span><span class="w"> </span><span class="kn">import</span> <span class="n">Iterable</span><span class="p">,</span> <span class="n">Collection</span><span class="p">,</span> <span class="n">Container</span>
 
 <span class="kn">from</span><span class="w"> </span><span class="nn">trivoting.election.alternative</span><span class="w"> </span><span class="kn">import</span> <span class="n">Alternative</span>
 
 
 <div class="viewcode-block" id="AbstractTrichotomousBallot">
 <a class="viewcode-back" href="../../../reference/election/index.html#trivoting.election.trichotomous_ballot.AbstractTrichotomousBallot">[docs]</a>
-<span class="k">class</span><span class="w"> </span><span class="nc">AbstractTrichotomousBallot</span><span class="p">(</span><span class="n">ABC</span><span class="p">):</span>
+<span class="k">class</span><span class="w"> </span><span class="nc">AbstractTrichotomousBallot</span><span class="p">(</span><span class="n">ABC</span><span class="p">,</span> <span class="n">Container</span><span class="p">):</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">    Abstract base class for a trichotomous ballot.</span>
 

docs/_modules/index.html

@@ -1017,7 +1017,7 @@ <h1>Source code for trivoting.election.trichotomous_profile</h1><div class="high
 
 <div class="viewcode-block" id="TrichotomousMultiProfile.support_dict">
 <a class="viewcode-back" href="../../../reference/election/index.html#trivoting.election.trichotomous_profile.TrichotomousMultiProfile.support_dict">[docs]</a>
-    <span class="k">def</span><span class="w"> </span><span class="nf">support_dict</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">defaultdict</span><span class="p">[</span><span class="n">Alternative</span><span class="p">,</span> <span class="nb">int</span><span class="p">]:</span>
+    <span class="k">def</span><span class="w"> </span><span class="nf">support_dict</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">dict</span><span class="p">[</span><span class="n">Alternative</span><span class="p">,</span> <span class="nb">int</span><span class="p">]:</span>
         <span class="n">res</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">()</span>
         <span class="k">for</span> <span class="n">ballot</span><span class="p">,</span> <span class="n">count</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
             <span class="k">for</span> <span class="n">alt</span> <span class="ow">in</span> <span class="n">ballot</span><span class="o">.</span><span class="n">approved</span><span class="p">:</span>