build based on 659b72e

dev/.documenter-siteinfo.json

@@ -1 +1 @@
-{"documenter":{"julia_version":"1.8.5","generation_timestamp":"2023-09-17T17:26:27","documenter_version":"1.0.0"}}
+{"documenter":{"julia_version":"1.8.5","generation_timestamp":"2024-04-14T11:23:13","documenter_version":"1.0.0"}}

dev/contributer_guide/index.html

@@ -9,4 +9,4 @@
 - `system::VotingSystem`: a voting system object
 - `criterion::Majority`: majority criterion object 
 - `rankings::Ranks`: a rank choice voting object consisting of rank counts and unique ranks 
-&quot;&quot;&quot;</code></pre><p>Add any additional information that might be relevant to the user. </p><h1 id="API-2"><a class="docs-heading-anchor" href="#API-2">API</a><a class="docs-heading-anchor-permalink" href="#API-2" title="Permalink"></a></h1><p>Only export (make public) types and methods that are intended for users. Other methods are implementational details for interal use. </p><h1 id="Unit-tests"><a class="docs-heading-anchor" href="#Unit-tests">Unit tests</a><a id="Unit-tests-1"></a><a class="docs-heading-anchor-permalink" href="#Unit-tests" title="Permalink"></a></h1><p>Provide unit tests for most (if not all) methods. When possible, programatically test a method over a wide range of inputs. If you find a bug, write a unit test for the bug to prevent regressions. When possible, compare methods to those defined in established and trusted packages in other languages.  </p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../api_criteria/">« Criteria</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.0.0 on <span class="colophon-date" title="Sunday 17 September 2023 17:26">Sunday 17 September 2023</span>. Using Julia version 1.8.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+&quot;&quot;&quot;</code></pre><p>Add any additional information that might be relevant to the user. </p><h1 id="API-2"><a class="docs-heading-anchor" href="#API-2">API</a><a class="docs-heading-anchor-permalink" href="#API-2" title="Permalink"></a></h1><p>Only export (make public) types and methods that are intended for users. Other methods are implementational details for interal use. </p><h1 id="Unit-tests"><a class="docs-heading-anchor" href="#Unit-tests">Unit tests</a><a id="Unit-tests-1"></a><a class="docs-heading-anchor-permalink" href="#Unit-tests" title="Permalink"></a></h1><p>Provide unit tests for most (if not all) methods. When possible, programatically test a method over a wide range of inputs. If you find a bug, write a unit test for the bug to prevent regressions. When possible, compare methods to those defined in established and trusted packages in other languages.  </p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../api_criteria/">« Criteria</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.0.0 on <span class="colophon-date" title="Sunday 14 April 2024 11:23">Sunday 14 April 2024</span>. Using Julia version 1.8.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

dev/criteria/IIA/index.html

@@ -25,4 +25,4 @@
 └────────┴──────────────┘
 </span></code></pre><p>Now, create an Bucklin voting system object:</p><pre><code class="language-julia hljs">system = Bucklin()</code></pre><pre class="documenter-example-output"><code class="nohighlight hljs ansi">Bucklin()</code></pre><p>In the code block below, we can determine the winner of the election with the function <code>evaluate_winner</code> as follows:</p><pre><code class="language-julia hljs">evaluate_winner(system, rankings)</code></pre><pre class="documenter-example-output"><code class="nohighlight hljs ansi">1-element Vector{Symbol}:
  :a</code></pre><p>In the next code block, we will use the function <code>satisifies</code> to determine whether the Bucklin system complies with the IIA criterion for the preference profile above.</p><pre><code class="language-julia hljs">criterion = IIA()
-satisfies(system, criterion, rankings)</code></pre><pre class="documenter-example-output"><code class="nohighlight hljs ansi">false</code></pre><p>The results indicate that the Bucklin voting system violates IIA for this preference profile. </p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../reversalsymmetry/">« Reversal Symmetry</a><a class="docs-footer-nextpage" href="../../simulations/spatial_model/">Spatial Model »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.0.0 on <span class="colophon-date" title="Sunday 17 September 2023 17:26">Sunday 17 September 2023</span>. Using Julia version 1.8.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+satisfies(system, criterion, rankings)</code></pre><pre class="documenter-example-output"><code class="nohighlight hljs ansi">false</code></pre><p>The results indicate that the Bucklin voting system violates IIA for this preference profile. </p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../reversalsymmetry/">« Reversal Symmetry</a><a class="docs-footer-nextpage" href="../../simulations/spatial_model/">Spatial Model »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.0.0 on <span class="colophon-date" title="Sunday 14 April 2024 11:23">Sunday 14 April 2024</span>. Using Julia version 1.8.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

dev/criteria/condorcet_loser/index.html

@@ -28,4 +28,4 @@
 └────────┴──────────────┘
 </span></code></pre><p>Now, create an Bucklin voting system object:</p><pre><code class="language-julia hljs">system = Bucklin()</code></pre><pre class="documenter-example-output"><code class="nohighlight hljs ansi">Bucklin()</code></pre><p>In the code block below, we can determine the winner of the election with the function <code>evaluate_winner</code> as follows:</p><pre><code class="language-julia hljs">evaluate_winner(system, rankings)</code></pre><pre class="documenter-example-output"><code class="nohighlight hljs ansi">1-element Vector{Symbol}:
  :a</code></pre><p>In the next code block, we will use the function <code>satisifies</code> to determine whether the Bucklin system complies with the Condorcet loser criterion for the preference profile above.</p><pre><code class="language-julia hljs">criterion = CondorcetLoser()
-satisfies(system, criterion, rankings)</code></pre><pre class="documenter-example-output"><code class="nohighlight hljs ansi">true</code></pre><p>Although the Bucklin system does not satisfy the Condorcet loser criterion in general, it does satisfy it in this specific example.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../../systems/plurality/">« Plurality</a><a class="docs-footer-nextpage" href="../condorcet_winner/">Condorcet Winner »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.0.0 on <span class="colophon-date" title="Sunday 17 September 2023 17:26">Sunday 17 September 2023</span>. Using Julia version 1.8.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+satisfies(system, criterion, rankings)</code></pre><pre class="documenter-example-output"><code class="nohighlight hljs ansi">true</code></pre><p>Although the Bucklin system does not satisfy the Condorcet loser criterion in general, it does satisfy it in this specific example.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../../systems/plurality/">« Plurality</a><a class="docs-footer-nextpage" href="../condorcet_winner/">Condorcet Winner »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.0.0 on <span class="colophon-date" title="Sunday 14 April 2024 11:23">Sunday 14 April 2024</span>. Using Julia version 1.8.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

dev/criteria/condorcet_winner/index.html

@@ -27,4 +27,4 @@
 └────────┴──────────────┘
 </span></code></pre><p>Now, create an Bucklin voting system object:</p><pre><code class="language-julia hljs">system = Bucklin()</code></pre><pre class="documenter-example-output"><code class="nohighlight hljs ansi">Bucklin()</code></pre><p>In the code block below, we can determine the winner of the election with the function <code>evaluate_winner</code> as follows:</p><pre><code class="language-julia hljs">evaluate_winner(system, rankings)</code></pre><pre class="documenter-example-output"><code class="nohighlight hljs ansi">1-element Vector{Symbol}:
  :a</code></pre><p>In the next code block, we will use the function <code>satisifies</code> to determine whether the Bucklin system complies with the Condorcet winner criterion for the preference profile above.</p><pre><code class="language-julia hljs">criterion = CondorcetWinner()
-satisfies(system, criterion, rankings)</code></pre><pre class="documenter-example-output"><code class="nohighlight hljs ansi">true</code></pre><p>Although the Bucklin system does not satisfy the Condorcet winner criterion in general, it does satisfy it in this specific example.</p><h1 id="References"><a class="docs-heading-anchor" href="#References">References</a><a id="References-1"></a><a class="docs-heading-anchor-permalink" href="#References" title="Permalink"></a></h1></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../condorcet_loser/">« Condorcet Loser</a><a class="docs-footer-nextpage" href="../consistency/">Consistency »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.0.0 on <span class="colophon-date" title="Sunday 17 September 2023 17:26">Sunday 17 September 2023</span>. Using Julia version 1.8.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+satisfies(system, criterion, rankings)</code></pre><pre class="documenter-example-output"><code class="nohighlight hljs ansi">true</code></pre><p>Although the Bucklin system does not satisfy the Condorcet winner criterion in general, it does satisfy it in this specific example.</p><h1 id="References"><a class="docs-heading-anchor" href="#References">References</a><a id="References-1"></a><a class="docs-heading-anchor-permalink" href="#References" title="Permalink"></a></h1></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../condorcet_loser/">« Condorcet Loser</a><a class="docs-footer-nextpage" href="../consistency/">Consistency »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.0.0 on <span class="colophon-date" title="Sunday 14 April 2024 11:23">Sunday 14 April 2024</span>. Using Julia version 1.8.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>