Update documentation

CaseStudies/a_set_partitioning_problem.html

@@ -193,7 +193,7 @@
 
 <span class="n">seating_model</span><span class="o">.</span><span class="n">solve</span><span class="p">()</span>
 
-<span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;The choosen tables are out of a total of </span><span class="si">{</span><span class="nb">len</span><span class="p">(</span><span class="n">possible_tables</span><span class="p">)</span><span class="si">}</span><span class="s2">:&quot;</span><span class="p">)</span>
+<span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;The chosen tables are out of a total of </span><span class="si">{</span><span class="nb">len</span><span class="p">(</span><span class="n">possible_tables</span><span class="p">)</span><span class="si">}</span><span class="s2">:&quot;</span><span class="p">)</span>
 <span class="k">for</span> <span class="n">table</span> <span class="ow">in</span> <span class="n">possible_tables</span><span class="p">:</span>
     <span class="k">if</span> <span class="n">x</span><span class="p">[</span><span class="n">table</span><span class="p">]</span><span class="o">.</span><span class="n">value</span><span class="p">()</span> <span class="o">==</span> <span class="mf">1.0</span><span class="p">:</span>
         <span class="nb">print</span><span class="p">(</span><span class="n">table</span><span class="p">)</span>

_downloads/4de01d450895a988bf8d1ae0c3407a00/wedding_initial.py

@@ -64,7 +64,7 @@ def happiness(table):
 seating_model.solve(solver)
 
 
-print(f"The choosen tables are out of a total of {len(possible_tables)}:")
+print(f"The chosen tables are out of a total of {len(possible_tables)}:")
 for table in possible_tables:
     if x[table].value() == 1.0:
         print(table)

_downloads/787573ec11bb10ad2cd6781b0d2601ef/wedding.py

@@ -46,7 +46,7 @@ def happiness(table):
 
 seating_model.solve()
 
-print(f"The choosen tables are out of a total of {len(possible_tables)}:")
+print(f"The chosen tables are out of a total of {len(possible_tables)}:")
 for table in possible_tables:
     if x[table].value() == 1.0:
         print(table)

genindex.html

@@ -705,7 +705,7 @@ <h2 id="R">R</h2>
 </li>
         <li><a href="technical/solvers.html#pulp.apis.GUROBI_CMD.readsol">(pulp.apis.GUROBI_CMD method)</a>
 </li>
-        <li><a href="technical/solvers.html#pulp.apis.HiGHS_CMD.readsol">(pulp.apis.HiGHS_CMD static method)</a>
+        <li><a href="technical/solvers.html#pulp.apis.HiGHS_CMD.readsol">(pulp.apis.HiGHS_CMD method)</a>
 </li>
         <li><a href="technical/solvers.html#pulp.apis.MIPCL_CMD.readsol">(pulp.apis.MIPCL_CMD static method)</a>
 </li>
@@ -844,6 +844,8 @@ <h2 id="W">W</h2>
         <li><a href="technical/solvers.html#pulp.apis.CPLEX_CMD.writesol">(pulp.apis.CPLEX_CMD method)</a>
 </li>
         <li><a href="technical/solvers.html#pulp.apis.GUROBI_CMD.writesol">(pulp.apis.GUROBI_CMD method)</a>
+</li>
+        <li><a href="technical/solvers.html#pulp.apis.HiGHS_CMD.writesol">(pulp.apis.HiGHS_CMD method)</a>
 </li>
       </ul></li>
   </ul></td>

guides/how_to_mip_start.html

@@ -211,7 +211,7 @@ <h2>Whole Example<a class="headerlink" href="#whole-example" title="Link to this
 <span class="n">seating_model</span><span class="o">.</span><span class="n">solve</span><span class="p">(</span><span class="n">solver</span><span class="p">)</span>
 
 
-<span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;The choosen tables are out of a total of </span><span class="si">{</span><span class="nb">len</span><span class="p">(</span><span class="n">possible_tables</span><span class="p">)</span><span class="si">}</span><span class="s2">:&quot;</span><span class="p">)</span>
+<span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;The chosen tables are out of a total of </span><span class="si">{</span><span class="nb">len</span><span class="p">(</span><span class="n">possible_tables</span><span class="p">)</span><span class="si">}</span><span class="s2">:&quot;</span><span class="p">)</span>
 <span class="k">for</span> <span class="n">table</span> <span class="ow">in</span> <span class="n">possible_tables</span><span class="p">:</span>
     <span class="k">if</span> <span class="n">x</span><span class="p">[</span><span class="n">table</span><span class="p">]</span><span class="o">.</span><span class="n">value</span><span class="p">()</span> <span class="o">==</span> <span class="mf">1.0</span><span class="p">:</span>
         <span class="nb">print</span><span class="p">(</span><span class="n">table</span><span class="p">)</span>

technical/solvers.html

@@ -180,6 +180,7 @@
 <li class="toctree-l4"><a class="reference internal" href="#pulp.apis.HiGHS_CMD.defaultPath"><code class="docutils literal notranslate"><span class="pre">HiGHS_CMD.defaultPath()</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="#pulp.apis.HiGHS_CMD.name"><code class="docutils literal notranslate"><span class="pre">HiGHS_CMD.name</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="#pulp.apis.HiGHS_CMD.readsol"><code class="docutils literal notranslate"><span class="pre">HiGHS_CMD.readsol()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="#pulp.apis.HiGHS_CMD.writesol"><code class="docutils literal notranslate"><span class="pre">HiGHS_CMD.writesol()</span></code></a></li>
 </ul>
 </li>
 <li class="toctree-l3"><a class="reference internal" href="#pulp.apis.LpSolver"><code class="docutils literal notranslate"><span class="pre">LpSolver</span></code></a><ul>
@@ -1062,7 +1063,7 @@
 
 <dl class="py class">
 <dt class="sig sig-object py" id="pulp.apis.HiGHS_CMD">
-<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pulp.apis.</span></span><span class="sig-name descname"><span class="pre">HiGHS_CMD</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">path</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">keepFiles</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mip</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">msg</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">options</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">timeLimit</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">gapRel</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">gapAbs</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">threads</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">logPath</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pulp.apis.HiGHS_CMD" title="Link to this definition"></a></dt>
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pulp.apis.</span></span><span class="sig-name descname"><span class="pre">HiGHS_CMD</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">path</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">keepFiles</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mip</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">msg</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">options</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">timeLimit</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">gapRel</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">gapAbs</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">threads</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">logPath</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">warmStart</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pulp.apis.HiGHS_CMD" title="Link to this definition"></a></dt>
 <dd><p>Bases: <a class="reference internal" href="#pulp.apis.LpSolver_CMD" title="pulp.apis.core.LpSolver_CMD"><code class="xref py py-class docutils literal notranslate"><span class="pre">LpSolver_CMD</span></code></a></p>
 <p>The HiGHS_CMD solver</p>
 <dl class="field-list simple">
@@ -1078,6 +1079,7 @@
 <li><p><strong>path</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – path to the solver binary (you can get binaries for your platform from <a class="reference external" href="https://github.com/JuliaBinaryWrappers/HiGHS_jll.jl/releases">https://github.com/JuliaBinaryWrappers/HiGHS_jll.jl/releases</a>, or else compile from source - <a class="reference external" href="https://highs.dev">https://highs.dev</a>)</p></li>
 <li><p><strong>threads</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a>) – sets the maximum number of threads</p></li>
 <li><p><strong>logPath</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – path to the log file</p></li>
+<li><p><strong>warmStart</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><em>bool</em></a>) – if True, the solver will use the current value of variables as a start</p></li>
 </ul>
 </dd>
 </dl>
@@ -1110,10 +1112,16 @@
 
 <dl class="py method">
 <dt class="sig sig-object py" id="pulp.apis.HiGHS_CMD.readsol">
-<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">readsol</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">variables</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">filename</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pulp.apis.HiGHS_CMD.readsol" title="Link to this definition"></a></dt>
+<span class="sig-name descname"><span class="pre">readsol</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">filename</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pulp.apis.HiGHS_CMD.readsol" title="Link to this definition"></a></dt>
 <dd><p>Read a HiGHS solution file</p>
 </dd></dl>
 
+<dl class="py method">
+<dt class="sig sig-object py" id="pulp.apis.HiGHS_CMD.writesol">
+<span class="sig-name descname"><span class="pre">writesol</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">filename</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lp</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pulp.apis.HiGHS_CMD.writesol" title="Link to this definition"></a></dt>
+<dd><p>Writes a HiGHS solution file</p>
+</dd></dl>
+
 </dd></dl>
 
 <dl class="py class">