Skip to content

Commit

Permalink
updated docs for nls to correct order of inform structure
Browse files Browse the repository at this point in the history
  • Loading branch information
dalekopera committed Jun 19, 2024
1 parent 94c5ed9 commit f12eabb
Show file tree
Hide file tree
Showing 106 changed files with 1,161 additions and 1,124 deletions.
2 changes: 1 addition & 1 deletion html/C/auxiliary.html
Original file line number Diff line number Diff line change
Expand Up @@ -728,7 +728,7 @@
<section id="auxiliary-procedures">
<h1>Auxiliary Procedures<a class="headerlink" href="#auxiliary-procedures" title="Permalink to this heading">#</a></h1>
<p><strong>Release:</strong> 1.0</p>
<p><strong>Date:</strong> Aug 24, 2023</p>
<p><strong>Date:</strong> Jun 19, 2024</p>
<p><strong>Author:</strong> <a class="reference external" href="mailto:jaroslav&#46;fowkes&#37;&#52;&#48;stfc&#46;ac&#46;uk">Jaroslav Fowkes</a> and <a class="reference external" href="mailto:nick&#46;gould&#37;&#52;&#48;stfc&#46;ac&#46;uk">Nick Gould</a></p>
<p>GALAHAD <a class="footnote-reference superscript" href="#id2" id="id1" role="doc-noteref"><span class="fn-bracket">[</span>1<span class="fn-bracket">]</span></a> is a suite of open-source routines for large-scale continuous
optimization. This is supported by a number of auxiliary procedures that
Expand Down
2 changes: 1 addition & 1 deletion html/C/bco.html
Original file line number Diff line number Diff line change
Expand Up @@ -432,7 +432,7 @@
<section id="bound-constrained-optimization">
<h1>Bound-constrained Optimization<a class="headerlink" href="#bound-constrained-optimization" title="Permalink to this heading">#</a></h1>
<p><strong>Release:</strong> 1.0</p>
<p><strong>Date:</strong> Aug 24, 2023</p>
<p><strong>Date:</strong> Jun 19, 2024</p>
<p><strong>Author:</strong> <a class="reference external" href="mailto:jaroslav&#46;fowkes&#37;&#52;&#48;stfc&#46;ac&#46;uk">Jaroslav Fowkes</a> and <a class="reference external" href="mailto:nick&#46;gould&#37;&#52;&#48;stfc&#46;ac&#46;uk">Nick Gould</a></p>
<p>GALAHAD <a class="footnote-reference superscript" href="#id2" id="id1" role="doc-noteref"><span class="fn-bracket">[</span>1<span class="fn-bracket">]</span></a> is a suite of open-source routines for large-scale continuous
optimization. Currently there is a single package designed to find a local
Expand Down
14 changes: 14 additions & 0 deletions html/C/bgo.html
Original file line number Diff line number Diff line change
Expand Up @@ -2055,6 +2055,7 @@ <h3>components<a class="headerlink" href="#id8" title="Permalink to this heading

<span class="c1">#include &lt;stdio.h&gt;</span>
<span class="c1">#include &lt;math.h&gt;</span>
<span class="c1">#include &lt;string.h&gt;</span>
<span class="c1">#include &quot;galahad_precision.h&quot;</span>
<span class="c1">#include &quot;galahad_cfunctions.h&quot;</span>
<span class="c1">#include &quot;galahad_bgo.h&quot;</span>
Expand Down Expand Up @@ -2124,6 +2125,9 @@ <h3>components<a class="headerlink" href="#id8" title="Permalink to this heading

<span class="o">//</span> <span class="n">Initialize</span> <span class="n">BGO</span>
<span class="n">bgo_initialize</span><span class="p">(</span> <span class="o">&amp;</span><span class="n">data</span><span class="p">,</span> <span class="o">&amp;</span><span class="n">control</span><span class="p">,</span> <span class="o">&amp;</span><span class="n">status</span> <span class="p">);</span>
<span class="n">strcpy</span><span class="p">(</span><span class="n">control</span><span class="o">.</span><span class="n">trb_control</span><span class="o">.</span><span class="n">trs_control</span><span class="o">.</span><span class="n">symmetric_linear_solver</span><span class="p">,</span><span class="s2">&quot;sytr &quot;</span><span class="p">);</span>
<span class="n">strcpy</span><span class="p">(</span><span class="n">control</span><span class="o">.</span><span class="n">trb_control</span><span class="o">.</span><span class="n">trs_control</span><span class="o">.</span><span class="n">definite_linear_solver</span><span class="p">,</span><span class="s2">&quot;potr &quot;</span><span class="p">);</span>
<span class="n">strcpy</span><span class="p">(</span><span class="n">control</span><span class="o">.</span><span class="n">trb_control</span><span class="o">.</span><span class="n">psls_control</span><span class="o">.</span><span class="n">definite_linear_solver</span><span class="p">,</span><span class="s2">&quot;potr &quot;</span><span class="p">);</span>

<span class="o">//</span> <span class="n">Set</span> <span class="n">user</span><span class="o">-</span><span class="n">defined</span> <span class="n">control</span> <span class="n">options</span>
<span class="n">control</span><span class="o">.</span><span class="n">f_indexing</span> <span class="o">=</span> <span class="n">false</span><span class="p">;</span> <span class="o">//</span> <span class="n">C</span> <span class="n">sparse</span> <span class="n">matrix</span> <span class="n">indexing</span>
Expand Down Expand Up @@ -2208,6 +2212,9 @@ <h3>components<a class="headerlink" href="#id8" title="Permalink to this heading

<span class="o">//</span> <span class="n">Initialize</span> <span class="n">BGO</span>
<span class="n">bgo_initialize</span><span class="p">(</span> <span class="o">&amp;</span><span class="n">data</span><span class="p">,</span> <span class="o">&amp;</span><span class="n">control</span><span class="p">,</span> <span class="o">&amp;</span><span class="n">status</span> <span class="p">);</span>
<span class="n">strcpy</span><span class="p">(</span><span class="n">control</span><span class="o">.</span><span class="n">trb_control</span><span class="o">.</span><span class="n">trs_control</span><span class="o">.</span><span class="n">symmetric_linear_solver</span><span class="p">,</span><span class="s2">&quot;sytr &quot;</span><span class="p">);</span>
<span class="n">strcpy</span><span class="p">(</span><span class="n">control</span><span class="o">.</span><span class="n">trb_control</span><span class="o">.</span><span class="n">trs_control</span><span class="o">.</span><span class="n">definite_linear_solver</span><span class="p">,</span><span class="s2">&quot;potr &quot;</span><span class="p">);</span>
<span class="n">strcpy</span><span class="p">(</span><span class="n">control</span><span class="o">.</span><span class="n">trb_control</span><span class="o">.</span><span class="n">psls_control</span><span class="o">.</span><span class="n">definite_linear_solver</span><span class="p">,</span><span class="s2">&quot;potr &quot;</span><span class="p">);</span>

<span class="o">//</span> <span class="n">Set</span> <span class="n">user</span><span class="o">-</span><span class="n">defined</span> <span class="n">control</span> <span class="n">options</span>
<span class="n">control</span><span class="o">.</span><span class="n">f_indexing</span> <span class="o">=</span> <span class="n">false</span><span class="p">;</span> <span class="o">//</span> <span class="n">C</span> <span class="n">sparse</span> <span class="n">matrix</span> <span class="n">indexing</span>
Expand Down Expand Up @@ -2728,6 +2735,7 @@ <h3>components<a class="headerlink" href="#id8" title="Permalink to this heading

<span class="c1">#include &lt;stdio.h&gt;</span>
<span class="c1">#include &lt;math.h&gt;</span>
<span class="c1">#include &lt;string.h&gt;</span>
<span class="c1">#include &quot;galahad_precision.h&quot;</span>
<span class="c1">#include &quot;galahad_cfunctions.h&quot;</span>
<span class="c1">#include &quot;galahad_bgo.h&quot;</span>
Expand Down Expand Up @@ -2798,6 +2806,9 @@ <h3>components<a class="headerlink" href="#id8" title="Permalink to this heading

<span class="o">//</span> <span class="n">Initialize</span> <span class="n">BGO</span>
<span class="n">bgo_initialize</span><span class="p">(</span> <span class="o">&amp;</span><span class="n">data</span><span class="p">,</span> <span class="o">&amp;</span><span class="n">control</span><span class="p">,</span> <span class="o">&amp;</span><span class="n">status</span> <span class="p">);</span>
<span class="n">strcpy</span><span class="p">(</span><span class="n">control</span><span class="o">.</span><span class="n">trb_control</span><span class="o">.</span><span class="n">trs_control</span><span class="o">.</span><span class="n">symmetric_linear_solver</span><span class="p">,</span><span class="s2">&quot;sytr &quot;</span><span class="p">);</span>
<span class="n">strcpy</span><span class="p">(</span><span class="n">control</span><span class="o">.</span><span class="n">trb_control</span><span class="o">.</span><span class="n">trs_control</span><span class="o">.</span><span class="n">definite_linear_solver</span><span class="p">,</span><span class="s2">&quot;potr &quot;</span><span class="p">);</span>
<span class="n">strcpy</span><span class="p">(</span><span class="n">control</span><span class="o">.</span><span class="n">trb_control</span><span class="o">.</span><span class="n">psls_control</span><span class="o">.</span><span class="n">definite_linear_solver</span><span class="p">,</span><span class="s2">&quot;potr &quot;</span><span class="p">);</span>

<span class="o">//</span> <span class="n">Set</span> <span class="n">user</span><span class="o">-</span><span class="n">defined</span> <span class="n">control</span> <span class="n">options</span>
<span class="n">control</span><span class="o">.</span><span class="n">f_indexing</span> <span class="o">=</span> <span class="n">true</span><span class="p">;</span> <span class="o">//</span> <span class="n">Fortran</span> <span class="n">sparse</span> <span class="n">matrix</span> <span class="n">indexing</span>
Expand Down Expand Up @@ -2882,6 +2893,9 @@ <h3>components<a class="headerlink" href="#id8" title="Permalink to this heading

<span class="o">//</span> <span class="n">Initialize</span> <span class="n">BGO</span>
<span class="n">bgo_initialize</span><span class="p">(</span> <span class="o">&amp;</span><span class="n">data</span><span class="p">,</span> <span class="o">&amp;</span><span class="n">control</span><span class="p">,</span> <span class="o">&amp;</span><span class="n">status</span> <span class="p">);</span>
<span class="n">strcpy</span><span class="p">(</span><span class="n">control</span><span class="o">.</span><span class="n">trb_control</span><span class="o">.</span><span class="n">trs_control</span><span class="o">.</span><span class="n">symmetric_linear_solver</span><span class="p">,</span><span class="s2">&quot;sytr &quot;</span><span class="p">);</span>
<span class="n">strcpy</span><span class="p">(</span><span class="n">control</span><span class="o">.</span><span class="n">trb_control</span><span class="o">.</span><span class="n">trs_control</span><span class="o">.</span><span class="n">definite_linear_solver</span><span class="p">,</span><span class="s2">&quot;potr &quot;</span><span class="p">);</span>
<span class="n">strcpy</span><span class="p">(</span><span class="n">control</span><span class="o">.</span><span class="n">trb_control</span><span class="o">.</span><span class="n">psls_control</span><span class="o">.</span><span class="n">definite_linear_solver</span><span class="p">,</span><span class="s2">&quot;potr &quot;</span><span class="p">);</span>

<span class="o">//</span> <span class="n">Set</span> <span class="n">user</span><span class="o">-</span><span class="n">defined</span> <span class="n">control</span> <span class="n">options</span>
<span class="n">control</span><span class="o">.</span><span class="n">f_indexing</span> <span class="o">=</span> <span class="n">true</span><span class="p">;</span> <span class="o">//</span> <span class="n">Fortran</span> <span class="n">sparse</span> <span class="n">matrix</span> <span class="n">indexing</span>
Expand Down
4 changes: 4 additions & 0 deletions html/C/blls.html
Original file line number Diff line number Diff line change
Expand Up @@ -1988,6 +1988,8 @@ <h3>components<a class="headerlink" href="#id14" title="Permalink to this headin

// Initialize BLLS
blls_initialize( &amp;data, &amp;control, &amp;status );
strcpy(control.sbls_control.symmetric_linear_solver, &quot;sytr &quot;) ;
strcpy(control.sbls_control.definite_linear_solver, &quot;potr &quot;) ;

// Set user-defined control options
control.f_indexing = false; // C sparse matrix indexing
Expand Down Expand Up @@ -2331,6 +2333,8 @@ <h3>components<a class="headerlink" href="#id14" title="Permalink to this headin

// Initialize BLLS
blls_initialize( &amp;data, &amp;control, &amp;status );
strcpy(control.sbls_control.symmetric_linear_solver, &quot;sytr &quot;) ;
strcpy(control.sbls_control.definite_linear_solver, &quot;potr &quot;) ;

// Set user-defined control options
control.f_indexing = true; // fortran sparse matrix indexing
Expand Down
Loading

0 comments on commit f12eabb

Please sign in to comment.