Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed Jan 16, 2024
1 parent 13ee01d commit a891fc6
Show file tree
Hide file tree
Showing 4 changed files with 33 additions and 3 deletions.
10 changes: 8 additions & 2 deletions genindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -160,16 +160,22 @@ <h2 id="A">A</h2>
<li><a href="technical/solvers.html#pulp.apis.XPRESS_PY.actualSolve">(pulp.apis.XPRESS_PY method)</a>
</li>
<li><a href="technical/solvers.html#pulp.apis.YAPOSIB.actualSolve">(pulp.apis.YAPOSIB method)</a>
</li>
</ul></li>
<li><a href="technical/pulp.html#pulp.LpAffineExpression.addInPlace">addInPlace() (pulp.LpAffineExpression method)</a>

<ul>
<li><a href="technical/pulp.html#pulp.LpConstraint.addInPlace">(pulp.LpConstraint method)</a>
</li>
</ul></li>
<li><a href="technical/pulp.html#pulp.LpVariable.addVariableToConstraints">addVariableToConstraints() (pulp.LpVariable method)</a>
</li>
<li><a href="technical/pulp.html#pulp.allcombinations">allcombinations() (in module pulp)</a>
</li>
<li><a href="technical/pulp.html#pulp.allpermutations">allpermutations() (in module pulp)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="technical/pulp.html#pulp.allpermutations">allpermutations() (in module pulp)</a>
</li>
<li><a href="technical/pulp.html#pulp.FixedElasticSubProblem.alterName">alterName() (pulp.FixedElasticSubProblem method)</a>
</li>
<li><a href="technical/constants.html#pulp.constants.PulpError.args">args (pulp.constants.PulpError attribute)</a>
Expand Down
Binary file modified objects.inv
Binary file not shown.
2 changes: 1 addition & 1 deletion searchindex.js

Large diffs are not rendered by default.

24 changes: 24 additions & 0 deletions technical/pulp.html
Original file line number Diff line number Diff line change
Expand Up @@ -548,6 +548,18 @@ <h2>Variables and Expressions<a class="headerlink" href="#variables-and-expressi
<li><p><code class="docutils literal notranslate"><span class="pre">a[i]</span></code> is a numerical coefficient.</p></li>
</ul>
</div></blockquote>
<dl class="py method">
<dt class="sig sig-object py" id="pulp.LpAffineExpression.addInPlace">
<span class="sig-name descname"><span class="pre">addInPlace</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">other</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sign</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pulp.LpAffineExpression.addInPlace" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>sign</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a>) – the sign of the operation to do other.
if we add other =&gt; 1
if we subtract other =&gt; -1</p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="pulp.LpAffineExpression.asCplexLpAffineExpression">
<span class="sig-name descname"><span class="pre">asCplexLpAffineExpression</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">constant</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pulp.LpAffineExpression.asCplexLpAffineExpression" title="Link to this definition"></a></dt>
Expand Down Expand Up @@ -634,6 +646,18 @@ <h2>Constraints<a class="headerlink" href="#constraints" title="Link to this hea
</ul>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="pulp.LpConstraint.addInPlace">
<span class="sig-name descname"><span class="pre">addInPlace</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">other</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sign</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pulp.LpConstraint.addInPlace" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>sign</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a>) – the sign of the operation to do other.
if we add other =&gt; 1
if we subtract other =&gt; -1</p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="pulp.LpConstraint.asCplexLpConstraint">
<span class="sig-name descname"><span class="pre">asCplexLpConstraint</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pulp.LpConstraint.asCplexLpConstraint" title="Link to this definition"></a></dt>
Expand Down

0 comments on commit a891fc6

Please sign in to comment.