Reviewing the Digraph3 documentation

rbisdorff · May 16, 2024 · ef53fca · ef53fca
1 parent 40b77e6
commit ef53fca
Show file tree

Hide file tree

Showing 38 changed files with 127 additions and 125 deletions.
diff --git a/docSphinx/_build/doctrees/environment.pickle b/docSphinx/_build/doctrees/environment.pickle
diff --git a/docSphinx/_build/doctrees/pearls.doctree b/docSphinx/_build/doctrees/pearls.doctree
diff --git a/docSphinx/_build/doctrees/techDoc.doctree b/docSphinx/_build/doctrees/techDoc.doctree
diff --git a/docSphinx/_build/html/_modules/arithmetics.html b/docSphinx/_build/html/_modules/arithmetics.html
@@ -30,7 +30,7 @@
         <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
         <script src="../_static/clipboard.min.js?v=a7894cd8"></script>
         <script src="../_static/copybutton.js?v=15d7cbb8"></script>
-        <script src="../_static/js/hoverxref.js?v=39f456b5"></script>
+        <script src="../_static/js/hoverxref.js?v=82c55261"></script>
         <script src="../_static/js/tooltipster.bundle.min.js?v=18bf091b"></script>
         <script src="../_static/js/micromodal.min.js?v=04d6302d"></script>
     <script src="../_static/js/theme.js"></script>
@@ -763,7 +763,7 @@ <h1>Source code for arithmetics</h1><div class="highlight"><pre>
 
   <div role="contentinfo">
     <p>&#169; Copyright 2012-2024, Raymond Bisdorff.
-      <span class="lastupdated">Last updated on May 14, 2024.
+      <span class="lastupdated">Last updated on May 16, 2024.
       </span></p>
   </div>
 

diff --git a/docSphinx/_build/html/_modules/digraphs.html b/docSphinx/_build/html/_modules/digraphs.html
@@ -30,7 +30,7 @@
         <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
         <script src="../_static/clipboard.min.js?v=a7894cd8"></script>
         <script src="../_static/copybutton.js?v=15d7cbb8"></script>
-        <script src="../_static/js/hoverxref.js?v=39f456b5"></script>
+        <script src="../_static/js/hoverxref.js?v=82c55261"></script>
         <script src="../_static/js/tooltipster.bundle.min.js?v=18bf091b"></script>
         <script src="../_static/js/micromodal.min.js?v=04d6302d"></script>
     <script src="../_static/js/theme.js"></script>
@@ -16192,7 +16192,7 @@ <h1>Source code for digraphs</h1><div class="highlight"><pre>
 
   <div role="contentinfo">
     <p>&#169; Copyright 2012-2024, Raymond Bisdorff.
-      <span class="lastupdated">Last updated on May 14, 2024.
+      <span class="lastupdated">Last updated on May 16, 2024.
       </span></p>
   </div>
 

diff --git a/docSphinx/_build/html/_modules/digraphsTools.html b/docSphinx/_build/html/_modules/digraphsTools.html
@@ -30,7 +30,7 @@
         <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
         <script src="../_static/clipboard.min.js?v=a7894cd8"></script>
         <script src="../_static/copybutton.js?v=15d7cbb8"></script>
-        <script src="../_static/js/hoverxref.js?v=39f456b5"></script>
+        <script src="../_static/js/hoverxref.js?v=82c55261"></script>
         <script src="../_static/js/tooltipster.bundle.min.js?v=18bf091b"></script>
         <script src="../_static/js/micromodal.min.js?v=04d6302d"></script>
     <script src="../_static/js/theme.js"></script>
@@ -1115,7 +1115,7 @@ <h1>Source code for digraphsTools</h1><div class="highlight"><pre>
 
   <div role="contentinfo">
     <p>&#169; Copyright 2012-2024, Raymond Bisdorff.
-      <span class="lastupdated">Last updated on May 14, 2024.
+      <span class="lastupdated">Last updated on May 16, 2024.
       </span></p>
   </div>
 

diff --git a/docSphinx/_build/html/_modules/graphs.html b/docSphinx/_build/html/_modules/graphs.html
@@ -30,7 +30,7 @@
         <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
         <script src="../_static/clipboard.min.js?v=a7894cd8"></script>
         <script src="../_static/copybutton.js?v=15d7cbb8"></script>
-        <script src="../_static/js/hoverxref.js?v=39f456b5"></script>
+        <script src="../_static/js/hoverxref.js?v=82c55261"></script>
         <script src="../_static/js/tooltipster.bundle.min.js?v=18bf091b"></script>
         <script src="../_static/js/micromodal.min.js?v=04d6302d"></script>
     <script src="../_static/js/theme.js"></script>
@@ -5341,7 +5341,7 @@ <h1>Source code for graphs</h1><div class="highlight"><pre>
 
   <div role="contentinfo">
     <p>&#169; Copyright 2012-2024, Raymond Bisdorff.
-      <span class="lastupdated">Last updated on May 14, 2024.
+      <span class="lastupdated">Last updated on May 16, 2024.
       </span></p>
   </div>
 

diff --git a/docSphinx/_build/html/_modules/index.html b/docSphinx/_build/html/_modules/index.html
@@ -30,7 +30,7 @@
         <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
         <script src="../_static/clipboard.min.js?v=a7894cd8"></script>
         <script src="../_static/copybutton.js?v=15d7cbb8"></script>
-        <script src="../_static/js/hoverxref.js?v=39f456b5"></script>
+        <script src="../_static/js/hoverxref.js?v=82c55261"></script>
         <script src="../_static/js/tooltipster.bundle.min.js?v=18bf091b"></script>
         <script src="../_static/js/micromodal.min.js?v=04d6302d"></script>
     <script src="../_static/js/theme.js"></script>
@@ -128,7 +128,7 @@ <h1>All modules for which code is available</h1>
 
   <div role="contentinfo">
     <p>&#169; Copyright 2012-2024, Raymond Bisdorff.
-      <span class="lastupdated">Last updated on May 14, 2024.
+      <span class="lastupdated">Last updated on May 16, 2024.
       </span></p>
   </div>
 

diff --git a/docSphinx/_build/html/_modules/linearOrders.html b/docSphinx/_build/html/_modules/linearOrders.html
@@ -30,7 +30,7 @@
         <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
         <script src="../_static/clipboard.min.js?v=a7894cd8"></script>
         <script src="../_static/copybutton.js?v=15d7cbb8"></script>
-        <script src="../_static/js/hoverxref.js?v=39f456b5"></script>
+        <script src="../_static/js/hoverxref.js?v=82c55261"></script>
         <script src="../_static/js/tooltipster.bundle.min.js?v=18bf091b"></script>
         <script src="../_static/js/micromodal.min.js?v=04d6302d"></script>
     <script src="../_static/js/theme.js"></script>
@@ -2010,7 +2010,7 @@ <h1>Source code for linearOrders</h1><div class="highlight"><pre>
 
   <div role="contentinfo">
     <p>&#169; Copyright 2012-2024, Raymond Bisdorff.
-      <span class="lastupdated">Last updated on May 14, 2024.
+      <span class="lastupdated">Last updated on May 16, 2024.
       </span></p>
   </div>
 

diff --git a/docSphinx/_build/html/_modules/outrankingDigraphs.html b/docSphinx/_build/html/_modules/outrankingDigraphs.html
@@ -30,7 +30,7 @@
         <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
         <script src="../_static/clipboard.min.js?v=a7894cd8"></script>
         <script src="../_static/copybutton.js?v=15d7cbb8"></script>
-        <script src="../_static/js/hoverxref.js?v=39f456b5"></script>
+        <script src="../_static/js/hoverxref.js?v=82c55261"></script>
         <script src="../_static/js/tooltipster.bundle.min.js?v=18bf091b"></script>
         <script src="../_static/js/micromodal.min.js?v=04d6302d"></script>
     <script src="../_static/js/theme.js"></script>
@@ -10610,7 +10610,7 @@ <h1>Source code for outrankingDigraphs</h1><div class="highlight"><pre>
 
   <div role="contentinfo">
     <p>&#169; Copyright 2012-2024, Raymond Bisdorff.
-      <span class="lastupdated">Last updated on May 14, 2024.
+      <span class="lastupdated">Last updated on May 16, 2024.
       </span></p>
   </div>
 

diff --git a/docSphinx/_build/html/_modules/perfTabs.html b/docSphinx/_build/html/_modules/perfTabs.html
@@ -30,7 +30,7 @@
         <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
         <script src="../_static/clipboard.min.js?v=a7894cd8"></script>
         <script src="../_static/copybutton.js?v=15d7cbb8"></script>
-        <script src="../_static/js/hoverxref.js?v=39f456b5"></script>
+        <script src="../_static/js/hoverxref.js?v=82c55261"></script>
         <script src="../_static/js/tooltipster.bundle.min.js?v=18bf091b"></script>
         <script src="../_static/js/micromodal.min.js?v=04d6302d"></script>
     <script src="../_static/js/theme.js"></script>
@@ -2418,7 +2418,7 @@ <h1>Source code for perfTabs</h1><div class="highlight"><pre>
                                 <span class="n">pageTitle</span><span class="o">=</span><span class="s1">&#39;Performance Heatmap&#39;</span><span class="p">,</span>
                                 <span class="n">Correlations</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span>
                                 <span class="n">Threading</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span>
-                                <span class="n">nbrOfCPUs</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span>
+                                <span class="n">nbrOfCPUs</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
                                 <span class="n">Debug</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
 <span class="w">        </span><span class="sd">&quot;&quot;&quot;       </span>
 <span class="sd">        Renders the Brewer RdYlGn 3, 5, 7, or 9 levels colored heatmap of the performance table</span>
@@ -5468,7 +5468,7 @@ <h1>Source code for perfTabs</h1><div class="highlight"><pre>
 
   <div role="contentinfo">
     <p>&#169; Copyright 2012-2024, Raymond Bisdorff.
-      <span class="lastupdated">Last updated on May 14, 2024.
+      <span class="lastupdated">Last updated on May 16, 2024.
       </span></p>
   </div>
 

diff --git a/docSphinx/_build/html/_modules/performanceQuantiles.html b/docSphinx/_build/html/_modules/performanceQuantiles.html
@@ -30,7 +30,7 @@
         <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
         <script src="../_static/clipboard.min.js?v=a7894cd8"></script>
         <script src="../_static/copybutton.js?v=15d7cbb8"></script>
-        <script src="../_static/js/hoverxref.js?v=39f456b5"></script>
+        <script src="../_static/js/hoverxref.js?v=82c55261"></script>
         <script src="../_static/js/tooltipster.bundle.min.js?v=18bf091b"></script>
         <script src="../_static/js/micromodal.min.js?v=04d6302d"></script>
     <script src="../_static/js/theme.js"></script>
@@ -1225,7 +1225,7 @@ <h1>Source code for performanceQuantiles</h1><div class="highlight"><pre>
 
   <div role="contentinfo">
     <p>&#169; Copyright 2012-2024, Raymond Bisdorff.
-      <span class="lastupdated">Last updated on May 14, 2024.
+      <span class="lastupdated">Last updated on May 16, 2024.
       </span></p>
   </div>
 

diff --git a/docSphinx/_build/html/_modules/randomDigraphs.html b/docSphinx/_build/html/_modules/randomDigraphs.html
@@ -30,7 +30,7 @@
         <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
         <script src="../_static/clipboard.min.js?v=a7894cd8"></script>
         <script src="../_static/copybutton.js?v=15d7cbb8"></script>
-        <script src="../_static/js/hoverxref.js?v=39f456b5"></script>
+        <script src="../_static/js/hoverxref.js?v=82c55261"></script>
         <script src="../_static/js/tooltipster.bundle.min.js?v=18bf091b"></script>
         <script src="../_static/js/micromodal.min.js?v=04d6302d"></script>
     <script src="../_static/js/theme.js"></script>
@@ -1102,7 +1102,7 @@ <h1>Source code for randomDigraphs</h1><div class="highlight"><pre>
 
   <div role="contentinfo">
     <p>&#169; Copyright 2012-2024, Raymond Bisdorff.
-      <span class="lastupdated">Last updated on May 14, 2024.
+      <span class="lastupdated">Last updated on May 16, 2024.
       </span></p>
   </div>
 

diff --git a/docSphinx/_build/html/_modules/randomNumbers.html b/docSphinx/_build/html/_modules/randomNumbers.html
@@ -30,7 +30,7 @@
         <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
         <script src="../_static/clipboard.min.js?v=a7894cd8"></script>
         <script src="../_static/copybutton.js?v=15d7cbb8"></script>
-        <script src="../_static/js/hoverxref.js?v=39f456b5"></script>
+        <script src="../_static/js/hoverxref.js?v=82c55261"></script>
         <script src="../_static/js/tooltipster.bundle.min.js?v=18bf091b"></script>
         <script src="../_static/js/micromodal.min.js?v=04d6302d"></script>
     <script src="../_static/js/theme.js"></script>
@@ -1478,7 +1478,7 @@ <h1>Source code for randomNumbers</h1><div class="highlight"><pre>
 
   <div role="contentinfo">
     <p>&#169; Copyright 2012-2024, Raymond Bisdorff.
-      <span class="lastupdated">Last updated on May 14, 2024.
+      <span class="lastupdated">Last updated on May 16, 2024.
       </span></p>
   </div>
 

diff --git a/docSphinx/_build/html/_modules/randomPerfTabs.html b/docSphinx/_build/html/_modules/randomPerfTabs.html
@@ -30,7 +30,7 @@
         <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
         <script src="../_static/clipboard.min.js?v=a7894cd8"></script>
         <script src="../_static/copybutton.js?v=15d7cbb8"></script>
-        <script src="../_static/js/hoverxref.js?v=39f456b5"></script>
+        <script src="../_static/js/hoverxref.js?v=82c55261"></script>
         <script src="../_static/js/tooltipster.bundle.min.js?v=18bf091b"></script>
         <script src="../_static/js/micromodal.min.js?v=04d6302d"></script>
     <script src="../_static/js/theme.js"></script>
@@ -3952,7 +3952,7 @@ <h1>Source code for randomPerfTabs</h1><div class="highlight"><pre>
 
   <div role="contentinfo">
     <p>&#169; Copyright 2012-2024, Raymond Bisdorff.
-      <span class="lastupdated">Last updated on May 14, 2024.
+      <span class="lastupdated">Last updated on May 16, 2024.
       </span></p>
   </div>
 

diff --git a/docSphinx/_build/html/_modules/ratingDigraphs.html b/docSphinx/_build/html/_modules/ratingDigraphs.html
@@ -30,7 +30,7 @@
         <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
         <script src="../_static/clipboard.min.js?v=a7894cd8"></script>
         <script src="../_static/copybutton.js?v=15d7cbb8"></script>
-        <script src="../_static/js/hoverxref.js?v=39f456b5"></script>
+        <script src="../_static/js/hoverxref.js?v=82c55261"></script>
         <script src="../_static/js/tooltipster.bundle.min.js?v=18bf091b"></script>
         <script src="../_static/js/micromodal.min.js?v=04d6302d"></script>
     <script src="../_static/js/theme.js"></script>
@@ -648,7 +648,7 @@ <h1>Source code for ratingDigraphs</h1><div class="highlight"><pre>
                                              <span class="n">rankingRule</span><span class="o">=</span><span class="n">rankingRule</span><span class="p">,</span>
                                              <span class="n">Correlations</span><span class="o">=</span><span class="n">Correlations</span><span class="p">,</span>
                                              <span class="n">Threading</span><span class="o">=</span><span class="n">Threading</span><span class="p">,</span>
-                                             <span class="n">nbrOfCPUs</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span>
+                                             <span class="n">nbrOfCPUs</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
                                              <span class="n">Debug</span><span class="o">=</span><span class="n">Debug</span><span class="p">))</span>
         <span class="n">fo</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
         <span class="n">url</span> <span class="o">=</span> <span class="s1">&#39;file://&#39;</span><span class="o">+</span><span class="n">fileName</span>
@@ -2517,7 +2517,7 @@ <h1>Source code for ratingDigraphs</h1><div class="highlight"><pre>
 
   <div role="contentinfo">
     <p>&#169; Copyright 2012-2024, Raymond Bisdorff.
-      <span class="lastupdated">Last updated on May 14, 2024.
+      <span class="lastupdated">Last updated on May 16, 2024.
       </span></p>
   </div>
 

diff --git a/docSphinx/_build/html/_modules/sortingDigraphs.html b/docSphinx/_build/html/_modules/sortingDigraphs.html
@@ -30,7 +30,7 @@
         <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
         <script src="../_static/clipboard.min.js?v=a7894cd8"></script>
         <script src="../_static/copybutton.js?v=15d7cbb8"></script>
-        <script src="../_static/js/hoverxref.js?v=39f456b5"></script>
+        <script src="../_static/js/hoverxref.js?v=82c55261"></script>
         <script src="../_static/js/tooltipster.bundle.min.js?v=18bf091b"></script>
         <script src="../_static/js/micromodal.min.js?v=04d6302d"></script>
     <script src="../_static/js/theme.js"></script>
@@ -4767,7 +4767,7 @@ <h1>Source code for sortingDigraphs</h1><div class="highlight"><pre>
                                <span class="n">rankingRule</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
                                <span class="n">Correlations</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span>
                                <span class="n">Threading</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span>
-                               <span class="n">nbrOfCPUs</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span>
+                               <span class="n">nbrOfCPUs</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
                                <span class="n">Debug</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
 <span class="w">        </span><span class="sd">&quot;&quot;&quot;       </span>
 <span class="sd">        Renders the Brewer RdYlGn 5,7, or 9 levels colored heatmap of the performance table</span>
@@ -5114,7 +5114,7 @@ <h1>Source code for sortingDigraphs</h1><div class="highlight"><pre>
                                              <span class="n">rankingRule</span><span class="o">=</span><span class="n">rankingRule</span><span class="p">,</span>
                                              <span class="n">Correlations</span><span class="o">=</span><span class="n">Correlations</span><span class="p">,</span>
                                              <span class="n">Threading</span><span class="o">=</span><span class="n">Threading</span><span class="p">,</span>
-                                             <span class="n">nbrOfCPUs</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span>
+                                             <span class="n">nbrOfCPUs</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
                                              <span class="n">Debug</span><span class="o">=</span><span class="n">Debug</span><span class="p">))</span>
         <span class="n">fo</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
         <span class="n">url</span> <span class="o">=</span> <span class="s1">&#39;file://&#39;</span><span class="o">+</span><span class="n">fileName</span>
@@ -5284,10 +5284,12 @@ <h1>Source code for sortingDigraphs</h1><div class="highlight"><pre>
 
     <span class="c1"># from randomPerfTabs import RandomPerformanceTableau</span>
     <span class="c1"># from randomPerfTabs import RandomPerformanceGenerator as PerfTabGenerator</span>
-    <span class="c1"># nbrActions=1000</span>
-    <span class="c1"># nbrCrit = 13</span>
-    <span class="c1"># tp1 = RandomCBPerformanceTableau(numberOfActions=nbrActions,</span>
-    <span class="c1">#             numberOfCriteria=nbrCrit,seed=seed,NA=-1,missingDataProbability=0.1)</span>
+    <span class="n">nbrActions</span><span class="o">=</span><span class="mi">1000</span>
+    <span class="n">nbrCrit</span> <span class="o">=</span> <span class="mi">13</span>
+    <span class="n">tp1</span> <span class="o">=</span> <span class="n">RandomCBPerformanceTableau</span><span class="p">(</span><span class="n">numberOfActions</span><span class="o">=</span><span class="n">nbrActions</span><span class="p">,</span>
+                 <span class="n">numberOfCriteria</span><span class="o">=</span><span class="n">nbrCrit</span><span class="p">,</span><span class="n">seed</span><span class="o">=</span><span class="n">seed</span><span class="p">,</span><span class="n">NA</span><span class="o">=-</span><span class="mi">1</span><span class="p">,</span><span class="n">missingDataProbability</span><span class="o">=</span><span class="mf">0.1</span><span class="p">)</span>
+    <span class="n">qs</span> <span class="o">=</span> <span class="n">QuantilesSortingDigraph</span><span class="p">(</span><span class="n">tp1</span><span class="p">,</span><span class="n">Threading</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span><span class="n">startMethod</span><span class="o">=</span><span class="s1">&#39;fork&#39;</span><span class="p">)</span>
+    <span class="nb">print</span><span class="p">(</span><span class="n">qs</span><span class="p">)</span>
     <span class="c1"># print(tp1.NA)</span>
     <span class="c1"># pq1 = PerformanceQuantiles(tp1,5,LowerClosed=False,Debug=False)</span>
     <span class="c1"># tpg1 = PerfTabGenerator(tp1,instanceCounter=0,seed=seed)</span>
@@ -5323,7 +5325,7 @@ <h1>Source code for sortingDigraphs</h1><div class="highlight"><pre>
 
   <div role="contentinfo">
     <p>&#169; Copyright 2012-2024, Raymond Bisdorff.
-      <span class="lastupdated">Last updated on May 14, 2024.
+      <span class="lastupdated">Last updated on May 16, 2024.
       </span></p>
   </div>