Fix #22: rename start_size to start(#25)

Conflicted generated docs were removed, will have to be regenerated

docs/essays/example-jewels/index.html

@@ -1285,7 +1285,7 @@
 </div>
 <div class="jp-InputArea jp-Cell-inputArea"><div class="jp-InputPrompt jp-InputArea-prompt">
 </div><div class="jp-RenderedHTMLCommon jp-RenderedMarkdown jp-MarkdownOutput" data-mime-type="text/markdown">
-<h1 id="jewels-and-stones">Jewels and Stones<a class="anchor-link" href="#jewels-and-stones">¶</a></h1><p><em>Michel Wermelinger</em>, 23 January 2024</p>
+<h1 id="jewels-and-stones">Jewels and Stones<a class="anchor-link" href="#jewels-and-stones">¶</a></h1><p><em>Michel Wermelinger</em>, 23 January 2024, last updated 13 March 2024</p>
 </div>
 </div>
 </div>
@@ -2260,10 +2260,10 @@ <h3 id="42-best-normal-and-worst-run-times">4.2 Best, normal and worst run-times
 </clipboard-copy>
 </div>
 <div class="highlight-ipynb hl-python"><pre><span></span><span class="n">cases</span> <span class="o">=</span> <span class="p">[</span><span class="n">best_case</span><span class="p">,</span> <span class="n">normal_case</span><span class="p">,</span> <span class="n">worst_case</span><span class="p">]</span>
-<span class="n">time_cases</span><span class="p">(</span><span class="n">count_in_string</span><span class="p">,</span> <span class="n">cases</span><span class="p">,</span> <span class="n">start_size</span><span class="o">=</span><span class="mi">10</span><span class="p">,</span> <span class="n">double</span><span class="o">=</span><span class="mi">4</span><span class="p">)</span>
+<span class="n">time_cases</span><span class="p">(</span><span class="n">count_in_string</span><span class="p">,</span> <span class="n">cases</span><span class="p">,</span> <span class="n">start</span><span class="o">=</span><span class="mi">10</span><span class="p">,</span> <span class="n">double</span><span class="o">=</span><span class="mi">4</span><span class="p">)</span>
 </pre></div>
 <div class="clipboard-copy-txt" id="cell-11">cases = [best_case, normal_case, worst_case]
-time_cases(count_in_string, cases, start_size=10, double=4)</div>
+time_cases(count_in_string, cases, start=10, double=4)</div>
 </div>
 </div>
 </div>
@@ -2334,9 +2334,9 @@ <h3 id="42-best-normal-and-worst-run-times">4.2 Best, normal and worst run-times
 </div>
 </clipboard-copy>
 </div>
-<div class="highlight-ipynb hl-python"><pre><span></span><span class="n">time_cases</span><span class="p">(</span><span class="n">count_in_string</span><span class="p">,</span> <span class="n">cases</span><span class="p">,</span> <span class="n">start_size</span><span class="o">=</span><span class="mi">1000</span><span class="p">,</span> <span class="n">double</span><span class="o">=</span><span class="mi">4</span><span class="p">,</span> <span class="n">chart</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
+<div class="highlight-ipynb hl-python"><pre><span></span><span class="n">time_cases</span><span class="p">(</span><span class="n">count_in_string</span><span class="p">,</span> <span class="n">cases</span><span class="p">,</span> <span class="n">start</span><span class="o">=</span><span class="mi">1000</span><span class="p">,</span> <span class="n">double</span><span class="o">=</span><span class="mi">4</span><span class="p">,</span> <span class="n">chart</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
 </pre></div>
-<div class="clipboard-copy-txt" id="cell-12">time_cases(count_in_string, cases, start_size=1000, double=4, chart=True)</div>
+<div class="clipboard-copy-txt" id="cell-12">time_cases(count_in_string, cases, start=1000, double=4, chart=True)</div>
 </div>
 </div>
 </div>

docs/essays/example-two-sum-3/index.html

@@ -1309,7 +1309,7 @@
 </div>
 <div class="jp-InputArea jp-Cell-inputArea"><div class="jp-InputPrompt jp-InputArea-prompt">
 </div><div class="jp-RenderedHTMLCommon jp-RenderedMarkdown jp-MarkdownOutput" data-mime-type="text/markdown">
-<h1 id="two-sum-three-solutions">Two sum (three solutions)<a class="anchor-link" href="#two-sum-three-solutions">¶</a></h1><p><em>Michael Snowden</em>, 25 January 2024</p>
+<h1 id="two-sum-three-solutions">Two sum (three solutions)<a class="anchor-link" href="#two-sum-three-solutions">¶</a></h1><p><em>Michael Snowden</em>, 25 January 2024, last updated 13 March 2024</p>
 </div>
 </div>
 </div>
@@ -2193,10 +2193,10 @@ <h3 id="42-best-normal-and-worst-case-run-times">4.2 Best, normal and worst case
 </clipboard-copy>
 </div>
 <div class="highlight-ipynb hl-python"><pre><span></span><span class="n">input_generators</span> <span class="o">=</span> <span class="p">[</span><span class="n">worst</span><span class="p">,</span> <span class="n">normal</span><span class="p">,</span> <span class="n">best</span><span class="p">]</span>
-<span class="n">time_cases</span><span class="p">(</span><span class="n">two_sum_bf</span><span class="p">,</span> <span class="n">input_generators</span><span class="p">,</span> <span class="n">start_size</span><span class="o">=</span><span class="mi">100</span><span class="p">,</span> <span class="n">double</span><span class="o">=</span><span class="mi">4</span><span class="p">,</span> <span class="n">chart</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
+<span class="n">time_cases</span><span class="p">(</span><span class="n">two_sum_bf</span><span class="p">,</span> <span class="n">input_generators</span><span class="p">,</span> <span class="n">start</span><span class="o">=</span><span class="mi">100</span><span class="p">,</span> <span class="n">double</span><span class="o">=</span><span class="mi">4</span><span class="p">,</span> <span class="n">chart</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
 </pre></div>
 <div class="clipboard-copy-txt" id="cell-8">input_generators = [worst, normal, best]
-time_cases(two_sum_bf, input_generators, start_size=100, double=4, chart=True)</div>
+time_cases(two_sum_bf, input_generators, start=100, double=4, chart=True)</div>
 </div>
 </div>
 </div>
@@ -2263,10 +2263,10 @@ <h3 id="42-best-normal-and-worst-case-run-times">4.2 Best, normal and worst case
 </clipboard-copy>
 </div>
 <div class="highlight-ipynb hl-python"><pre><span></span><span class="n">input_generators</span> <span class="o">=</span> <span class="p">[</span><span class="n">worst</span><span class="p">,</span> <span class="n">normal</span><span class="p">,</span> <span class="n">best</span><span class="p">]</span>
-<span class="n">time_cases</span><span class="p">(</span><span class="n">two_sum_map</span><span class="p">,</span> <span class="n">input_generators</span><span class="p">,</span> <span class="n">start_size</span><span class="o">=</span><span class="mi">100</span><span class="p">,</span> <span class="n">double</span><span class="o">=</span><span class="mi">4</span><span class="p">,</span> <span class="n">chart</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
+<span class="n">time_cases</span><span class="p">(</span><span class="n">two_sum_map</span><span class="p">,</span> <span class="n">input_generators</span><span class="p">,</span> <span class="n">start</span><span class="o">=</span><span class="mi">100</span><span class="p">,</span> <span class="n">double</span><span class="o">=</span><span class="mi">4</span><span class="p">,</span> <span class="n">chart</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
 </pre></div>
 <div class="clipboard-copy-txt" id="cell-9">input_generators = [worst, normal, best]
-time_cases(two_sum_map, input_generators, start_size=100, double=4, chart=True)</div>
+time_cases(two_sum_map, input_generators, start=100, double=4, chart=True)</div>
 </div>
 </div>
 </div>

docs/essays/template-data-structures/index.html

@@ -1750,11 +1750,11 @@ <h3 id="42-best-normal-and-worst-run-times">4.2 Best, normal and worst run-times
 </div>
 <div class="highlight-ipynb hl-python"><pre><span></span><span class="n">cases</span> <span class="o">=</span> <span class="p">[</span><span class="n">best_case</span><span class="p">,</span> <span class="n">normal_case</span><span class="p">,</span> <span class="n">worst_case</span><span class="p">]</span>
 <span class="c1"># Change solution_n to the name of your solution.</span>
-<span class="n">time_cases</span><span class="p">(</span><span class="n">solution_n</span><span class="p">,</span> <span class="n">cases</span><span class="p">,</span> <span class="n">start_size</span><span class="o">=</span><span class="mi">10</span><span class="p">,</span> <span class="n">double</span><span class="o">=</span><span class="mi">4</span><span class="p">)</span>
+<span class="n">time_cases</span><span class="p">(</span><span class="n">solution_n</span><span class="p">,</span> <span class="n">cases</span><span class="p">,</span> <span class="n">start</span><span class="o">=</span><span class="mi">10</span><span class="p">,</span> <span class="n">double</span><span class="o">=</span><span class="mi">4</span><span class="p">)</span>
 </pre></div>
 <div class="clipboard-copy-txt" id="cell-10">cases = [best_case, normal_case, worst_case]
 # Change solution_n to the name of your solution.
-time_cases(solution_n, cases, start_size=10, double=4)</div>
+time_cases(solution_n, cases, start=10, double=4)</div>
 </div>
 </div>
 </div>

docs/library/index.html

@@ -1282,7 +1282,7 @@ <h3 id="algoesup.time.time_cases" class="doc doc-heading">
 
 
 </h3>
-<div class="doc-signature highlight"><pre><span></span><code><span class="n">time_cases</span><span class="p">(</span><span class="n">function</span><span class="p">:</span> <span class="n">Callable</span><span class="p">,</span> <span class="n">cases</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="n">Callable</span><span class="p">],</span> <span class="n">start_size</span><span class="p">:</span> <span class="nb">int</span><span class="p">,</span> <span class="n">double</span><span class="p">:</span> <span class="nb">int</span><span class="p">,</span> <span class="n">text</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">True</span><span class="p">,</span> <span class="n">chart</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span>
+<div class="doc-signature highlight"><pre><span></span><code><span class="n">time_cases</span><span class="p">(</span><span class="n">function</span><span class="p">:</span> <span class="n">Callable</span><span class="p">,</span> <span class="n">cases</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="n">Callable</span><span class="p">],</span> <span class="n">start</span><span class="p">:</span> <span class="nb">int</span><span class="p">,</span> <span class="n">double</span><span class="p">:</span> <span class="nb">int</span><span class="p">,</span> <span class="n">text</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">True</span><span class="p">,</span> <span class="n">chart</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span>
 </code></pre></div>
 
   <div class="doc doc-contents ">
@@ -1312,7 +1312,7 @@ <h3 id="algoesup.time.time_cases" class="doc doc-heading">
           </td>
           <td>
             <div class="doc-md-description">
-              <p>A functions whose run-times will be measured.</p>
+              <p>A function whose run-times will be measured.</p>
             </div>
           </td>
           <td>
@@ -1326,16 +1326,16 @@ <h3 id="algoesup.time.time_cases" class="doc doc-heading">
           </td>
           <td>
             <div class="doc-md-description">
-              <p>A list of functions to generate inputs of different cases.
-E.g best- normal- and worst-case.</p>
+              <p>A list of 1 to 6 functions to generate inputs of different cases,
+e.g. best-, normal- and worst-case.</p>
             </div>
           </td>
           <td>
               <em>required</em>
           </td>
         </tr>
         <tr>
-          <td><code>start_size</code></td>
+          <td><code>start</code></td>
           <td>
                 <code>int</code>
           </td>
@@ -1383,7 +1383,7 @@ <h3 id="algoesup.time.time_cases" class="doc doc-heading">
           </td>
           <td>
             <div class="doc-md-description">
-              <p>If True plot the run-times using a chart.</p>
+              <p>If True, plot the run-times using a chart.</p>
             </div>
           </td>
           <td>
@@ -1431,7 +1431,7 @@ <h3 id="algoesup.time.time_functions_int" class="doc doc-heading">
 
 
 </h3>
-<div class="doc-signature highlight"><pre><span></span><code><span class="n">time_functions_int</span><span class="p">(</span><span class="n">functions</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="n">Callable</span><span class="p">],</span> <span class="n">generator</span><span class="p">:</span> <span class="n">Callable</span> <span class="o">=</span> <span class="n">int_value</span><span class="p">,</span> <span class="n">start_size</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">1</span><span class="p">,</span> <span class="n">double</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">10</span><span class="p">,</span> <span class="n">text</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">True</span><span class="p">,</span> <span class="n">chart</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">True</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span>
+<div class="doc-signature highlight"><pre><span></span><code><span class="n">time_functions_int</span><span class="p">(</span><span class="n">functions</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="n">Callable</span><span class="p">],</span> <span class="n">generator</span><span class="p">:</span> <span class="n">Callable</span> <span class="o">=</span> <span class="n">int_value</span><span class="p">,</span> <span class="n">start</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">1</span><span class="p">,</span> <span class="n">double</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">10</span><span class="p">,</span> <span class="n">text</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">True</span><span class="p">,</span> <span class="n">chart</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">True</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span>
 </code></pre></div>
 
   <div class="doc doc-contents ">
@@ -1478,15 +1478,15 @@ <h3 id="algoesup.time.time_functions_int" class="doc doc-heading">
           <td>
             <div class="doc-md-description">
               <p>A function to generate integer inputs. Defaults to
-<code>int_value</code>, which should generate an integer based on the input size.</p>
+<code>int_value</code>, which returns a tuple containing the input integer.</p>
             </div>
           </td>
           <td>
                 <code><span title="algoesup.time.int_value">int_value</span></code>
           </td>
         </tr>
         <tr>
-          <td><code>start_size</code></td>
+          <td><code>start</code></td>
           <td>
                 <code>int</code>
           </td>

docs/writing/index.html

@@ -1537,7 +1537,7 @@ <h3 id="comparing-cases">Comparing cases</h3>
 <p>Here&rsquo;s how we could measure the run-times for selection sort on ascending and descending lists.
 <div class="highlight"><pre><span></span><code><span class="kn">from</span> <span class="nn">algoesup</span> <span class="kn">import</span> <span class="n">time_cases</span>
 
-<span class="n">time_cases</span><span class="p">(</span><span class="n">selection_sort</span><span class="p">,</span> <span class="p">[</span><span class="n">ascending</span><span class="p">,</span> <span class="n">descending</span><span class="p">],</span> <span class="n">start_size</span><span class="o">=</span><span class="mi">100</span><span class="p">,</span> <span class="n">double</span><span class="o">=</span><span class="mi">4</span><span class="p">)</span>
+<span class="n">time_cases</span><span class="p">(</span><span class="n">selection_sort</span><span class="p">,</span> <span class="p">[</span><span class="n">ascending</span><span class="p">,</span> <span class="n">descending</span><span class="p">],</span> <span class="n">start</span><span class="o">=</span><span class="mi">100</span><span class="p">,</span> <span class="n">double</span><span class="o">=</span><span class="mi">4</span><span class="p">)</span>
 </code></pre></div></p>
 <div class="admonition success">
 <p class="admonition-title">Output</p>
@@ -1577,7 +1577,7 @@ <h3 id="comparing-functions">Comparing functions</h3>
 <p>Here&rsquo;s a comparison of the built-in <code>sorted</code> function against selection sort, on descending lists.
 <div class="highlight"><pre><span></span><code><span class="kn">from</span> <span class="nn">algoesup</span> <span class="kn">import</span> <span class="n">time_functions</span>
 
-<span class="n">time_functions</span><span class="p">([</span><span class="n">selection_sort</span><span class="p">,</span> <span class="nb">sorted</span><span class="p">],</span> <span class="n">descending</span><span class="p">,</span> <span class="n">start_size</span><span class="o">=</span><span class="mi">100</span><span class="p">,</span> <span class="n">double</span><span class="o">=</span><span class="mi">4</span><span class="p">)</span>
+<span class="n">time_functions</span><span class="p">([</span><span class="n">selection_sort</span><span class="p">,</span> <span class="nb">sorted</span><span class="p">],</span> <span class="n">descending</span><span class="p">,</span> <span class="n">start</span><span class="o">=</span><span class="mi">100</span><span class="p">,</span> <span class="n">double</span><span class="o">=</span><span class="mi">4</span><span class="p">)</span>
 </code></pre></div></p>
 <div class="admonition success">
 <p class="admonition-title">Output</p>
@@ -1643,7 +1643,7 @@ <h3 id="interpreting-run-times">Interpreting run-times</h3>
 which is counter-intuitive because it does have to reverse them.</p>
 <p>If you can&rsquo;t see any trend in the run-times, or they aren&rsquo;t what you expect,
 one possible cause is that the input sizes are too small.
-Increase <code>start_size</code> and run again the code cell.</p>
+Increase <code>start</code> and run again the code cell.</p>
 <p>If after increasing the start size several times you still don&rsquo;t get the run-times
 you expect from your complexity analysis, then there might be other explanations:</p>
 <ul>