Skip to content

Commit

Permalink
update Python docs to correct argument list errors
Browse files Browse the repository at this point in the history
  • Loading branch information
dalekopera committed Jun 16, 2024
1 parent a6b6dc4 commit 4c51543
Show file tree
Hide file tree
Showing 33 changed files with 168 additions and 162 deletions.
2 changes: 1 addition & 1 deletion html/Python/arc.html
Original file line number Diff line number Diff line change
Expand Up @@ -816,7 +816,7 @@ <h2>functions<a class="headerlink" href="#functions" title="Permalink to this he

<dl class="py function">
<dt class="sig sig-object py" id="galahad.arc.arc.solve">
<span class="sig-prename descclassname"><span class="pre">arc.</span></span><span class="sig-name descname"><span class="pre">solve</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">n</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">H_ne</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">x</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">g</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">eval_f</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">eval_g</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">eval_h)</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#galahad.arc.arc.solve" title="Permalink to this definition">#</a></dt>
<span class="sig-prename descclassname"><span class="pre">arc.</span></span><span class="sig-name descname"><span class="pre">solve</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">n</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">H_ne</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">x</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">eval_f</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">eval_g</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">eval_h)</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#galahad.arc.arc.solve" title="Permalink to this definition">#</a></dt>
<dd><p>Find an approximate local unconstrained minimizer of a given function
using a regularization method.</p>
<p><strong>Parameters:</strong></p>
Expand Down
2 changes: 1 addition & 1 deletion html/Python/bgo.html
Original file line number Diff line number Diff line change
Expand Up @@ -672,7 +672,7 @@ <h2>functions<a class="headerlink" href="#functions" title="Permalink to this he

<dl class="py function">
<dt class="sig sig-object py" id="galahad.bgo.bgo.solve">
<span class="sig-prename descclassname"><span class="pre">bgo.</span></span><span class="sig-name descname"><span class="pre">solve</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">n</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">H_ne</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">x</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">g</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">eval_f</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">eval_g</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">eval_h</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#galahad.bgo.bgo.solve" title="Permalink to this definition">#</a></dt>
<span class="sig-prename descclassname"><span class="pre">bgo.</span></span><span class="sig-name descname"><span class="pre">solve</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">n</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">H_ne</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">x</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">eval_f</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">eval_g</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">eval_h</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#galahad.bgo.bgo.solve" title="Permalink to this definition">#</a></dt>
<dd><p>Find an approximation to the global minimizer of a given function
subject to simple bounds on the variables using a multistart
trust-region method.</p>
Expand Down
6 changes: 3 additions & 3 deletions html/Python/blls.html
Original file line number Diff line number Diff line change
Expand Up @@ -739,7 +739,7 @@ <h2>functions<a class="headerlink" href="#functions" title="Permalink to this he

<dl class="py function">
<dt class="sig sig-object py" id="galahad.blls.blls.solve_ls">
<span class="sig-prename descclassname"><span class="pre">blls.</span></span><span class="sig-name descname"><span class="pre">solve_ls</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">n</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">o</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">w</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ao_ne</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Ao_val</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">b</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">x_l</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">x_u</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">x</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">z</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#galahad.blls.blls.solve_ls" title="Permalink to this definition">#</a></dt>
<span class="sig-prename descclassname"><span class="pre">blls.</span></span><span class="sig-name descname"><span class="pre">solve_ls</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">n</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">o</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">w</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Ao_ne</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Ao_val</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">b</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">x_l</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">x_u</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">x</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">z</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#galahad.blls.blls.solve_ls" title="Permalink to this definition">#</a></dt>
<dd><p>Find a solution to the bound-constraind regularized linear least-squares
problem involving the least-squares objective function <span class="math notranslate nohighlight">\(q(x)\)</span>.</p>
<p><strong>Parameters:</strong></p>
Expand All @@ -750,9 +750,9 @@ <h2>functions<a class="headerlink" href="#functions" title="Permalink to this he
</dd>
<dt>w<span class="classifier">ndarray(o)</span></dt><dd><p>holds the weights <span class="math notranslate nohighlight">\(w\)</span> in the objective function.</p>
</dd>
<dt>ao_ne<span class="classifier">int</span></dt><dd><p>holds the number of entries in the constraint Jacobian <span class="math notranslate nohighlight">\(A_o\)</span>.</p>
<dt>Ao_ne<span class="classifier">int</span></dt><dd><p>holds the number of entries in the constraint Jacobian <span class="math notranslate nohighlight">\(A_o\)</span>.</p>
</dd>
<dt>Ao_val<span class="classifier">ndarray(ao_ne)</span></dt><dd><p>holds the values of the nonzeros in the constraint Jacobian
<dt>Ao_val<span class="classifier">ndarray(Ao_ne)</span></dt><dd><p>holds the values of the nonzeros in the constraint Jacobian
<span class="math notranslate nohighlight">\(A_o\)</span> in the same order as specified in the sparsity pattern in
<code class="docutils literal notranslate"><span class="pre">blls.load</span></code>.</p>
</dd>
Expand Down
6 changes: 3 additions & 3 deletions html/Python/bllsb.html
Original file line number Diff line number Diff line change
Expand Up @@ -865,7 +865,7 @@ <h2>functions<a class="headerlink" href="#functions" title="Permalink to this he

<dl class="py function">
<dt class="sig sig-object py" id="galahad.bllsb.bllsb.solve_blls">
<span class="sig-prename descclassname"><span class="pre">bllsb.</span></span><span class="sig-name descname"><span class="pre">solve_blls</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">n</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">o</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ao_ne</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Ao_val</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">b</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sigma</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">x_l</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">x_u</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">x</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">z</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">w</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#galahad.bllsb.bllsb.solve_blls" title="Permalink to this definition">#</a></dt>
<span class="sig-prename descclassname"><span class="pre">bllsb.</span></span><span class="sig-name descname"><span class="pre">solve_blls</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">n</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">o</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Ao_ne</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Ao_val</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">b</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sigma</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">x_l</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">x_u</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">x</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">z</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">w</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#galahad.bllsb.bllsb.solve_blls" title="Permalink to this definition">#</a></dt>
<dd><p>Find a solution to the bound-constrained (regularized) linear
least-squares problem.</p>
<p><strong>Parameters:</strong></p>
Expand All @@ -874,9 +874,9 @@ <h2>functions<a class="headerlink" href="#functions" title="Permalink to this he
</dd>
<dt>o<span class="classifier">int</span></dt><dd><p>holds the number of residuals.</p>
</dd>
<dt>ao_ne<span class="classifier">int</span></dt><dd><p>holds the number of entries in the objective design matrix <span class="math notranslate nohighlight">\(A_o\)</span>.</p>
<dt>Ao_ne<span class="classifier">int</span></dt><dd><p>holds the number of entries in the objective design matrix <span class="math notranslate nohighlight">\(A_o\)</span>.</p>
</dd>
<dt>Ao_val<span class="classifier">ndarray(ao_ne)</span></dt><dd><p>holds the values of the nonzeros in <span class="math notranslate nohighlight">\(A_o\)</span> in the same order as
<dt>Ao_val<span class="classifier">ndarray(Ao_ne)</span></dt><dd><p>holds the values of the nonzeros in <span class="math notranslate nohighlight">\(A_o\)</span> in the same order as
specified in the sparsity pattern in <code class="docutils literal notranslate"><span class="pre">bllsb.load</span></code>.</p>
</dd>
<dt>b<span class="classifier">ndarray(m)</span></dt><dd><p>holds the values of the linear term <span class="math notranslate nohighlight">\(b\)</span> in the objective function.</p>
Expand Down
6 changes: 3 additions & 3 deletions html/Python/bqp.html
Original file line number Diff line number Diff line change
Expand Up @@ -682,7 +682,7 @@ <h2>functions<a class="headerlink" href="#functions" title="Permalink to this he

<dl class="py function">
<dt class="sig sig-object py" id="galahad.bqp.bqp.solve_qp">
<span class="sig-prename descclassname"><span class="pre">bqp.</span></span><span class="sig-name descname"><span class="pre">solve_qp</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">n</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">f</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">g</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">h_ne</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">H_val</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">x_l</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">x_u</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">x</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">z</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#galahad.bqp.bqp.solve_qp" title="Permalink to this definition">#</a></dt>
<span class="sig-prename descclassname"><span class="pre">bqp.</span></span><span class="sig-name descname"><span class="pre">solve_qp</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">n</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">f</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">g</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">H_ne</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">H_val</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">x_l</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">x_u</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">x</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">z</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#galahad.bqp.bqp.solve_qp" title="Permalink to this definition">#</a></dt>
<dd><p>Find a solution to the bound-constrained convex quadratic program
involving the quadratic objective function <span class="math notranslate nohighlight">\(q(x)\)</span>.</p>
<p><strong>Parameters:</strong></p>
Expand All @@ -693,10 +693,10 @@ <h2>functions<a class="headerlink" href="#functions" title="Permalink to this he
</dd>
<dt>g<span class="classifier">ndarray(n)</span></dt><dd><p>holds the values of the linear term <span class="math notranslate nohighlight">\(g\)</span> in the objective function.</p>
</dd>
<dt>h_ne<span class="classifier">int</span></dt><dd><p>holds the number of entries in the lower triangular part of
<dt>H_ne<span class="classifier">int</span></dt><dd><p>holds the number of entries in the lower triangular part of
the Hessian <span class="math notranslate nohighlight">\(H\)</span>.</p>
</dd>
<dt>H_val<span class="classifier">ndarray(h_ne)</span></dt><dd><p>holds the values of the nonzeros in the lower triangle of the Hessian
<dt>H_val<span class="classifier">ndarray(H_ne)</span></dt><dd><p>holds the values of the nonzeros in the lower triangle of the Hessian
<span class="math notranslate nohighlight">\(H\)</span> in the same order as specified in the sparsity pattern in
<code class="docutils literal notranslate"><span class="pre">bqp.load</span></code>.</p>
</dd>
Expand Down
6 changes: 3 additions & 3 deletions html/Python/bqpb.html
Original file line number Diff line number Diff line change
Expand Up @@ -870,7 +870,7 @@ <h2>functions<a class="headerlink" href="#functions" title="Permalink to this he

<dl class="py function">
<dt class="sig sig-object py" id="galahad.bqpb.bqpb.solve_qp">
<span class="sig-prename descclassname"><span class="pre">bqpb.</span></span><span class="sig-name descname"><span class="pre">solve_qp</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">n</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">f</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">g</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">h_ne</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">H_val</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">x_l</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">x_u</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">x</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">z</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#galahad.bqpb.bqpb.solve_qp" title="Permalink to this definition">#</a></dt>
<span class="sig-prename descclassname"><span class="pre">bqpb.</span></span><span class="sig-name descname"><span class="pre">solve_qp</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">n</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">f</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">g</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">H_ne</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">H_val</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">x_l</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">x_u</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">x</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">z</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#galahad.bqpb.bqpb.solve_qp" title="Permalink to this definition">#</a></dt>
<dd><p>Find a solution to the bound-constrained convex quadratic program
involving the quadratic objective function <span class="math notranslate nohighlight">\(q(x)\)</span>.</p>
<p><strong>Parameters:</strong></p>
Expand All @@ -881,10 +881,10 @@ <h2>functions<a class="headerlink" href="#functions" title="Permalink to this he
</dd>
<dt>g<span class="classifier">ndarray(n)</span></dt><dd><p>holds the values of the linear term <span class="math notranslate nohighlight">\(g\)</span> in the objective function.</p>
</dd>
<dt>h_ne<span class="classifier">int</span></dt><dd><p>holds the number of entries in the lower triangular part of
<dt>H_ne<span class="classifier">int</span></dt><dd><p>holds the number of entries in the lower triangular part of
the Hessian <span class="math notranslate nohighlight">\(H\)</span>.</p>
</dd>
<dt>H_val<span class="classifier">ndarray(h_ne)</span></dt><dd><p>holds the values of the nonzeros in the lower triangle of the Hessian
<dt>H_val<span class="classifier">ndarray(H_ne)</span></dt><dd><p>holds the values of the nonzeros in the lower triangle of the Hessian
<span class="math notranslate nohighlight">\(H\)</span> in the same order as specified in the sparsity pattern in
<code class="docutils literal notranslate"><span class="pre">bqpb.load</span></code>.</p>
</dd>
Expand Down
Loading

0 comments on commit 4c51543

Please sign in to comment.