update C documentation to highlight ipc_ and rpc_ real/integer kinds

ralna · Feb 18, 2024 · 933ca9e · 933ca9e
1 parent 7fbaaf2
commit 933ca9e
Show file tree

Hide file tree

Showing 259 changed files with 26,434 additions and 24,851 deletions.
diff --git a/html/C/arc.html b/html/C/arc.html
diff --git a/html/C/arc_functions.html b/html/C/arc_functions.html
diff --git a/html/C/bgo.html b/html/C/bgo.html
diff --git a/html/C/bgo_functions.html b/html/C/bgo_functions.html
diff --git a/html/C/blls.html b/html/C/blls.html
diff --git a/html/C/blls_functions.html b/html/C/blls_functions.html
diff --git a/html/C/bllsb.html b/html/C/bllsb.html
diff --git a/html/C/bllsb_functions.html b/html/C/bllsb_functions.html
diff --git a/html/C/bqp.html b/html/C/bqp.html
diff --git a/html/C/bqp_functions.html b/html/C/bqp_functions.html
diff --git a/html/C/bqpb.html b/html/C/bqpb.html
diff --git a/html/C/bqpb_functions.html b/html/C/bqpb_functions.html
diff --git a/html/C/bsc.html b/html/C/bsc.html
diff --git a/html/C/bsc_functions.html b/html/C/bsc_functions.html
diff --git a/html/C/clls.html b/html/C/clls.html
diff --git a/html/C/clls_functions.html b/html/C/clls_functions.html
diff --git a/html/C/convert.html b/html/C/convert.html
diff --git a/html/C/convert_functions.html b/html/C/convert_functions.html
diff --git a/html/C/cqp.html b/html/C/cqp.html
diff --git a/html/C/cqp_functions.html b/html/C/cqp_functions.html
diff --git a/html/C/cro.html b/html/C/cro.html
diff --git a/html/C/cro_functions.html b/html/C/cro_functions.html
diff --git a/html/C/dgo.html b/html/C/dgo.html
diff --git a/html/C/dgo_functions.html b/html/C/dgo_functions.html
diff --git a/html/C/dps.html b/html/C/dps.html
diff --git a/html/C/dps_functions.html b/html/C/dps_functions.html
diff --git a/html/C/dqp.html b/html/C/dqp.html
diff --git a/html/C/dqp_functions.html b/html/C/dqp_functions.html
diff --git a/html/C/eqp.html b/html/C/eqp.html
diff --git a/html/C/eqp_functions.html b/html/C/eqp_functions.html
diff --git a/html/C/fdc.html b/html/C/fdc.html
diff --git a/html/C/fdc_functions.html b/html/C/fdc_functions.html
diff --git a/html/C/fit.html b/html/C/fit.html
diff --git a/html/C/fit_functions.html b/html/C/fit_functions.html
diff --git a/html/C/genindex.html b/html/C/genindex.html
diff --git a/html/C/glrt.html b/html/C/glrt.html
diff --git a/html/C/glrt_functions.html b/html/C/glrt_functions.html
diff --git a/html/C/gls.html b/html/C/gls.html
diff --git a/html/C/gls_functions.html b/html/C/gls_functions.html
diff --git a/html/C/gltr.html b/html/C/gltr.html
diff --git a/html/C/gltr_functions.html b/html/C/gltr_functions.html
diff --git a/html/C/hash.html b/html/C/hash.html
diff --git a/html/C/hash_functions.html b/html/C/hash_functions.html
diff --git a/html/C/ir.html b/html/C/ir.html
diff --git a/html/C/ir_functions.html b/html/C/ir_functions.html
diff --git a/html/C/l2rt.html b/html/C/l2rt.html
diff --git a/html/C/l2rt_functions.html b/html/C/l2rt_functions.html
diff --git a/html/C/lhs.html b/html/C/lhs.html
diff --git a/html/C/lhs_functions.html b/html/C/lhs_functions.html
diff --git a/html/C/llsr.html b/html/C/llsr.html
diff --git a/html/C/llsr_functions.html b/html/C/llsr_functions.html
diff --git a/html/C/llst.html b/html/C/llst.html
diff --git a/html/C/llst_functions.html b/html/C/llst_functions.html
diff --git a/html/C/lms.html b/html/C/lms.html
diff --git a/html/C/lms_functions.html b/html/C/lms_functions.html
diff --git a/html/C/lpa.html b/html/C/lpa.html
diff --git a/html/C/lpa_functions.html b/html/C/lpa_functions.html
diff --git a/html/C/lpb.html b/html/C/lpb.html
diff --git a/html/C/lpb_functions.html b/html/C/lpb_functions.html
diff --git a/html/C/lsqp.html b/html/C/lsqp.html
diff --git a/html/C/lsqp_functions.html b/html/C/lsqp_functions.html
diff --git a/html/C/lsrt.html b/html/C/lsrt.html
diff --git a/html/C/lsrt_functions.html b/html/C/lsrt_functions.html
diff --git a/html/C/lstr.html b/html/C/lstr.html
diff --git a/html/C/lstr_functions.html b/html/C/lstr_functions.html
diff --git a/html/C/nls.html b/html/C/nls.html
diff --git a/html/C/nls_functions.html b/html/C/nls_functions.html
diff --git a/html/C/objects.inv b/html/C/objects.inv
diff --git a/html/C/presolve.html b/html/C/presolve.html
diff --git a/html/C/presolve_functions.html b/html/C/presolve_functions.html
diff --git a/html/C/psls.html b/html/C/psls.html
diff --git a/html/C/psls_functions.html b/html/C/psls_functions.html
diff --git a/html/C/qpa.html b/html/C/qpa.html
diff --git a/html/C/qpa_functions.html b/html/C/qpa_functions.html
diff --git a/html/C/qpb.html b/html/C/qpb.html
diff --git a/html/C/qpb_functions.html b/html/C/qpb_functions.html
diff --git a/html/C/roots.html b/html/C/roots.html
diff --git a/html/C/roots_functions.html b/html/C/roots_functions.html
@@ -735,47 +735,52 @@
 
 <span class="c1">// typedefs</span>
 
-<span class="k">typedef</span> <span class="kt">float</span> <a class="reference internal" href="wcp_functions.html#doxid-galahad-precision-8h-1a3455cab03087949fd428a31cf302f98b"><span class="std std-ref">real_sp_</span></a><span></span><span class="p">;</span>
-<span class="k">typedef</span> <span class="kt">double</span> <a class="reference internal" href="wcp_functions.html#doxid-galahad-precision-8h-1ab82133d435678ff159433d2e50cf295e"><span class="std std-ref">real_wp_</span></a><span></span><span class="p">;</span>
+<span class="k">typedef</span> <span class="kt">float</span> <a class="reference internal" href="wcp_functions.html#doxid-galahad-spc-8h"><span class="std std-ref">spc_</span></a><span></span><span class="p">;</span>
+<span class="k">typedef</span> <span class="kt">double</span> <a class="reference internal" href="wcp_functions.html#doxid-galahad-rpc-8h"><span class="std std-ref">rpc_</span></a><span></span><span class="p">;</span>
+<span class="k">typedef</span> <span class="kt">int</span> <a class="reference internal" href="wcp_functions.html#doxid-galahad-ipc-8h"><span class="std std-ref">ipc_</span></a><span></span><span class="p">;</span>
 
 <span class="c1">// structs</span>
 
 <span class="k">struct</span> <a class="reference internal" href="roots.html#doxid-structroots-control-type"><span class="std std-ref">roots_control_type</span></a><span></span><span class="p">;</span>
-<span class="k">struct</span> <a class="reference internal" href="struct_roots_inform_type.html#doxid-structroots-inform-type"><span class="std std-ref">roots_inform_type</span></a><span></span><span class="p">;</span>
+<span class="k">struct</span> <a class="reference internal" href="roots.html#doxid-structroots-inform-type"><span class="std std-ref">roots_inform_type</span></a><span></span><span class="p">;</span>
 
 <span class="c1">// global functions</span>
 
 <span class="kt">void</span> <a class="reference internal" href="#doxid-galahad-roots-8h-1ac504c30e3b55ef425516ad7cf1638a76"><span class="std std-ref">roots_initialize</span></a><span></span><span class="p">(</span>
-    <span class="kt">void</span><span class="o">**</span> <span class="n">data</span><span class="p">,</span>
+    <span class="kt">void</span> <span class="o">**</span><span class="n">data</span><span class="p">,</span>
     <span class="k">struct</span> <a class="reference internal" href="roots.html#doxid-structroots-control-type"><span class="std std-ref">roots_control_type</span></a><span></span><span class="o">*</span> <span class="n">control</span><span class="p">,</span>
-    <span class="kt">int</span><span class="o">*</span> <span class="n">status</span>
+    <a class="reference internal" href="wcp_functions.html#doxid-galahad-ipc-8h"><span class="std std-ref">ipc_</span></a><span></span> <span class="o">*</span><span class="n">status</span>
 <span class="p">);</span>
 
 <span class="kt">void</span> <a class="reference internal" href="#doxid-galahad-roots-8h-1ac63ef195952ae821d6966a8f25ac2513"><span class="std std-ref">roots_information</span></a><span></span><span class="p">(</span>
-    <span class="kt">void</span><span class="o">**</span> <span class="n">data</span><span class="p">,</span>
-    <span class="k">struct</span> <a class="reference internal" href="struct_roots_inform_type.html#doxid-structroots-inform-type"><span class="std std-ref">roots_inform_type</span></a><span></span><span class="o">*</span> <span class="n">inform</span><span class="p">,</span>
-    <span class="kt">int</span><span class="o">*</span> <span class="n">status</span>
+    <span class="kt">void</span> <span class="o">**</span><span class="n">data</span><span class="p">,</span>
+    <span class="k">struct</span> <a class="reference internal" href="roots.html#doxid-structroots-inform-type"><span class="std std-ref">roots_inform_type</span></a><span></span><span class="o">*</span> <span class="n">inform</span><span class="p">,</span>
+    <a class="reference internal" href="wcp_functions.html#doxid-galahad-ipc-8h"><span class="std std-ref">ipc_</span></a><span></span> <span class="o">*</span><span class="n">status</span>
 <span class="p">);</span>
 
 <span class="kt">void</span> <a class="reference internal" href="#doxid-galahad-roots-8h-1a4e81f4ac6c1119dfeb3a81729c3ec997"><span class="std std-ref">roots_terminate</span></a><span></span><span class="p">(</span>
-    <span class="kt">void</span><span class="o">**</span> <span class="n">data</span><span class="p">,</span>
+    <span class="kt">void</span> <span class="o">**</span><span class="n">data</span><span class="p">,</span>
     <span class="k">struct</span> <a class="reference internal" href="roots.html#doxid-structroots-control-type"><span class="std std-ref">roots_control_type</span></a><span></span><span class="o">*</span> <span class="n">control</span><span class="p">,</span>
-    <span class="k">struct</span> <a class="reference internal" href="struct_roots_inform_type.html#doxid-structroots-inform-type"><span class="std std-ref">roots_inform_type</span></a><span></span><span class="o">*</span> <span class="n">inform</span>
+    <span class="k">struct</span> <a class="reference internal" href="roots.html#doxid-structroots-inform-type"><span class="std std-ref">roots_inform_type</span></a><span></span><span class="o">*</span> <span class="n">inform</span>
 <span class="p">);</span></pre>
 </section>
 <section id="typedefs">
 <span id="details-global"></span><h1>typedefs<a class="headerlink" href="#typedefs" title="Permalink to this heading">#</a></h1>
-<pre class="highlight doxyrest-title-code-block literal-block" id="doxid-galahad-precision-8h-1a3455cab03087949fd428a31cf302f98b"><span id="index-0"></span><span></span><span class="k">typedef</span> <span class="kt">float</span> <span class="n">real_sp_</span></pre>
-<p><code class="docutils literal notranslate"><span class="pre">real_sp_</span></code> is real single precision</p>
-<pre class="highlight doxyrest-title-code-block literal-block" id="doxid-galahad-precision-8h-1ab82133d435678ff159433d2e50cf295e"><span id="index-1"></span><span></span><span class="k">typedef</span> <span class="kt">double</span> <span class="n">real_wp_</span></pre>
-<p><code class="docutils literal notranslate"><span class="pre">real_wp_</span></code> is the real working precision used</p>
+<pre class="highlight doxyrest-title-code-block literal-block" id="doxid-galahad-spc-8h"><span id="index-0"></span><span></span><span class="k">typedef</span> <span class="kt">float</span> <span class="n">spc_</span></pre>
+<p><code class="docutils literal notranslate"><span class="pre">spc_</span></code> is real single precision</p>
+<pre class="highlight doxyrest-title-code-block literal-block" id="doxid-galahad-rpc-8h"><span id="index-1"></span><span></span><span class="k">typedef</span> <span class="kt">double</span> <span class="n">rpc_</span></pre>
+<p><code class="docutils literal notranslate"><span class="pre">rpc_</span></code> is the real working precision used, but may be changed to <code class="docutils literal notranslate"><span class="pre">float</span></code> by
+defining the  preprocessor variable <code class="docutils literal notranslate"><span class="pre">SINGLE</span></code>.</p>
+<pre class="highlight doxyrest-title-code-block literal-block" id="doxid-galahad-ipc-8h"><span id="index-2"></span><span></span><span class="k">typedef</span> <span class="kt">int</span> <span class="n">ipc_</span></pre>
+<p><code class="docutils literal notranslate"><span class="pre">ipc_</span></code> is the default integer word length used, but may be changed to
+<code class="docutils literal notranslate"><span class="pre">int64_t</span></code> by defining the  preprocessor variable <code class="docutils literal notranslate"><span class="pre">INTEGER_64</span></code>.</p>
 </section>
 <section id="function-calls">
 <h1>function calls<a class="headerlink" href="#function-calls" title="Permalink to this heading">#</a></h1>
-<pre class="highlight doxyrest-title-code-block literal-block" id="doxid-galahad-roots-8h-1ac504c30e3b55ef425516ad7cf1638a76"><span id="index-2"></span><span></span><span class="kt">void</span> <span class="n">roots_initialize</span><span class="p">(</span>
-    <span class="kt">void</span><span class="o">**</span> <span class="n">data</span><span class="p">,</span>
+<pre class="highlight doxyrest-title-code-block literal-block" id="doxid-galahad-roots-8h-1ac504c30e3b55ef425516ad7cf1638a76"><span id="index-3"></span><span></span><span class="kt">void</span> <span class="n">roots_initialize</span><span class="p">(</span>
+    <span class="kt">void</span> <span class="o">**</span><span class="n">data</span><span class="p">,</span>
     <span class="k">struct</span> <a class="reference internal" href="roots.html#doxid-structroots-control-type"><span class="std std-ref">roots_control_type</span></a><span></span><span class="o">*</span> <span class="n">control</span><span class="p">,</span>
-    <span class="kt">int</span><span class="o">*</span> <span class="n">status</span>
+    <a class="reference internal" href="wcp_functions.html#doxid-galahad-ipc-8h"><span class="std std-ref">ipc_</span></a><span></span> <span class="o">*</span><span class="n">status</span>
 <span class="p">)</span></pre>
 <p>Set default control values and initialize private data</p>
 <p class="rubric">Parameters:</p>
@@ -792,7 +797,7 @@ <h1>function calls<a class="headerlink" href="#function-calls" title="Permalink
 <td><p>is a struct containing control information (see <a class="reference internal" href="roots.html#doxid-structroots-control-type"><span class="std std-ref">roots_control_type</span></a>)</p></td>
 </tr>
 <tr class="row-odd"><td><p>status</p></td>
-<td><p>is a scalar variable of type int, that gives the exit status from the package. Possible values are (currently):</p>
+<td><p>is a scalar variable of type <a class="reference internal" href="wcp_functions.html#doxid-galahad-ipc-8h"><span class="std std-ref">ipc_</span></a>, that gives the exit status from the package. Possible values are (currently):</p>
 <ul class="simple">
 <li><dl class="simple">
 <dt><strong>0</strong></dt><dd><p>The initialization was successful.</p>
@@ -804,10 +809,10 @@ <h1>function calls<a class="headerlink" href="#function-calls" title="Permalink
 </tr>
 </tbody>
 </table>
-<pre class="highlight doxyrest-title-code-block literal-block" id="doxid-galahad-roots-8h-1ac63ef195952ae821d6966a8f25ac2513"><span id="index-3"></span><span></span><span class="kt">void</span> <span class="n">roots_information</span><span class="p">(</span>
-    <span class="kt">void</span><span class="o">**</span> <span class="n">data</span><span class="p">,</span>
-    <span class="k">struct</span> <a class="reference internal" href="struct_roots_inform_type.html#doxid-structroots-inform-type"><span class="std std-ref">roots_inform_type</span></a><span></span><span class="o">*</span> <span class="n">inform</span><span class="p">,</span>
-    <span class="kt">int</span><span class="o">*</span> <span class="n">status</span>
+<pre class="highlight doxyrest-title-code-block literal-block" id="doxid-galahad-roots-8h-1ac63ef195952ae821d6966a8f25ac2513"><span id="index-4"></span><span></span><span class="kt">void</span> <span class="n">roots_information</span><span class="p">(</span>
+    <span class="kt">void</span> <span class="o">**</span><span class="n">data</span><span class="p">,</span>
+    <span class="k">struct</span> <a class="reference internal" href="roots.html#doxid-structroots-inform-type"><span class="std std-ref">roots_inform_type</span></a><span></span><span class="o">*</span> <span class="n">inform</span><span class="p">,</span>
+    <a class="reference internal" href="wcp_functions.html#doxid-galahad-ipc-8h"><span class="std std-ref">ipc_</span></a><span></span> <span class="o">*</span><span class="n">status</span>
 <span class="p">)</span></pre>
 <p>Provides output information</p>
 <p class="rubric">Parameters:</p>
@@ -821,10 +826,10 @@ <h1>function calls<a class="headerlink" href="#function-calls" title="Permalink
 <td><p>holds private internal data</p></td>
 </tr>
 <tr class="row-even"><td><p>inform</p></td>
-<td><p>is a struct containing output information (see <a class="reference internal" href="struct_roots_inform_type.html#doxid-structroots-inform-type"><span class="std std-ref">roots_inform_type</span></a>)</p></td>
+<td><p>is a struct containing output information (see <a class="reference internal" href="roots.html#doxid-structroots-inform-type"><span class="std std-ref">roots_inform_type</span></a>)</p></td>
 </tr>
 <tr class="row-odd"><td><p>status</p></td>
-<td><p>is a scalar variable of type int, that gives the exit status from the package. Possible values are (currently):</p>
+<td><p>is a scalar variable of type <a class="reference internal" href="wcp_functions.html#doxid-galahad-ipc-8h"><span class="std std-ref">ipc_</span></a>, that gives the exit status from the package. Possible values are (currently):</p>
 <ul class="simple">
 <li><dl class="simple">
 <dt><strong>0</strong></dt><dd><p>The values were recorded successfully</p>
@@ -836,10 +841,10 @@ <h1>function calls<a class="headerlink" href="#function-calls" title="Permalink
 </tr>
 </tbody>
 </table>
-<pre class="highlight doxyrest-title-code-block literal-block" id="doxid-galahad-roots-8h-1a4e81f4ac6c1119dfeb3a81729c3ec997"><span id="index-4"></span><span></span><span class="kt">void</span> <span class="n">roots_terminate</span><span class="p">(</span>
-    <span class="kt">void</span><span class="o">**</span> <span class="n">data</span><span class="p">,</span>
+<pre class="highlight doxyrest-title-code-block literal-block" id="doxid-galahad-roots-8h-1a4e81f4ac6c1119dfeb3a81729c3ec997"><span id="index-5"></span><span></span><span class="kt">void</span> <span class="n">roots_terminate</span><span class="p">(</span>
+    <span class="kt">void</span> <span class="o">**</span><span class="n">data</span><span class="p">,</span>
     <span class="k">struct</span> <a class="reference internal" href="roots.html#doxid-structroots-control-type"><span class="std std-ref">roots_control_type</span></a><span></span><span class="o">*</span> <span class="n">control</span><span class="p">,</span>
-    <span class="k">struct</span> <a class="reference internal" href="struct_roots_inform_type.html#doxid-structroots-inform-type"><span class="std std-ref">roots_inform_type</span></a><span></span><span class="o">*</span> <span class="n">inform</span>
+    <span class="k">struct</span> <a class="reference internal" href="roots.html#doxid-structroots-inform-type"><span class="std std-ref">roots_inform_type</span></a><span></span><span class="o">*</span> <span class="n">inform</span>
 <span class="p">)</span></pre>
 <p>Deallocate all internal private storage</p>
 <p class="rubric">Parameters:</p>
@@ -856,7 +861,7 @@ <h1>function calls<a class="headerlink" href="#function-calls" title="Permalink
 <td><p>is a struct containing control information (see <a class="reference internal" href="roots.html#doxid-structroots-control-type"><span class="std std-ref">roots_control_type</span></a>)</p></td>
 </tr>
 <tr class="row-odd"><td><p>inform</p></td>
-<td><p>is a struct containing output information (see <a class="reference internal" href="struct_roots_inform_type.html#doxid-structroots-inform-type"><span class="std std-ref">roots_inform_type</span></a>)</p></td>
+<td><p>is a struct containing output information (see <a class="reference internal" href="roots.html#doxid-structroots-inform-type"><span class="std std-ref">roots_inform_type</span></a>)</p></td>
 </tr>
 </tbody>
 </table>