Update API documentation

Signed-off-by: Nicolas Bock <[email protected]>

Author: nicolasbock

bml-manual.pdf

@@ -33,7 +33,7 @@
  <tr style="height: 56px;">
   <td id="projectalign" style="padding-left: 0.5em;">
    <div id="projectname">bml
-   &#160;<span id="projectnumber">2.3.0</span>
+   &#160;<span id="projectnumber">2.4.0</span>
    </div>
    <div id="projectbrief">Basic Matrix Library (bml):  A matrix library for linear algebra operations,  supporting several data structures.</div>
   </td>
@@ -104,15 +104,15 @@
 </div><!-- PageDoc -->
 </div><!-- doc-content -->
 <div class="ttc" id="abml__types_8h_html_a8d762ed64876f48d5eb687cb62f20d5cab1dee362b4b8fac13bfc3e3df1d88af0"><div class="ttname"><a href="bml__types_8h.html#a8d762ed64876f48d5eb687cb62f20d5cab1dee362b4b8fac13bfc3e3df1d88af0">single_real</a></div><div class="ttdeci">@ single_real</div><div class="ttdef"><b>Definition:</b> bml_types.h:29</div></div>
-<div class="ttc" id="agroup__allocate__group__C_html_ga1db50ac5b32a15d261d36da2c6415898"><div class="ttname"><a href="group__allocate__group__C.html#ga1db50ac5b32a15d261d36da2c6415898">bml_zero_matrix</a></div><div class="ttdeci">bml_matrix_t * bml_zero_matrix(bml_matrix_type_t matrix_type, bml_matrix_precision_t matrix_precision, int N, int M, bml_distribution_mode_t distrib_mode)</div><div class="ttdef"><b>Definition:</b> bml_allocate.c:391</div></div>
+<div class="ttc" id="agroup__allocate__group__C_html_ga1db50ac5b32a15d261d36da2c6415898"><div class="ttname"><a href="group__allocate__group__C.html#ga1db50ac5b32a15d261d36da2c6415898">bml_zero_matrix</a></div><div class="ttdeci">bml_matrix_t * bml_zero_matrix(bml_matrix_type_t matrix_type, bml_matrix_precision_t matrix_precision, int N, int M, bml_distribution_mode_t distrib_mode)</div><div class="ttdef"><b>Definition:</b> bml_allocate.c:374</div></div>
 <div class="ttc" id="abml_8h_html"><div class="ttname"><a href="bml_8h.html">bml.h</a></div></div>
 <div class="ttc" id="abml__types_8h_html_ab7d3c21318898af00e7c28712f369842ae8716347cc7fdaf9fc25cc0e20c2ab26"><div class="ttname"><a href="bml__types_8h.html#ab7d3c21318898af00e7c28712f369842ae8716347cc7fdaf9fc25cc0e20c2ab26">dense</a></div><div class="ttdeci">@ dense</div><div class="ttdef"><b>Definition:</b> bml_types.h:12</div></div>
 <div class="ttc" id="abml__types_8h_html_afe10f3a7e985a8627616dfda2dec6fc9"><div class="ttname"><a href="bml__types_8h.html#afe10f3a7e985a8627616dfda2dec6fc9">bml_matrix_t</a></div><div class="ttdeci">void bml_matrix_t</div><div class="ttdef"><b>Definition:</b> bml_types.h:51</div></div>
 <div class="ttc" id="agroup__allocate__group__C_html_gae442bd3e06e8f8ff92aad499f0d8ebf2"><div class="ttname"><a href="group__allocate__group__C.html#gae442bd3e06e8f8ff92aad499f0d8ebf2">bml_deallocate</a></div><div class="ttdeci">void bml_deallocate(bml_matrix_t **A)</div><div class="ttdef"><b>Definition:</b> bml_allocate.c:161</div></div>
 <!-- start footer part -->
 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
   <ul>
-    <li class="footer">Generated on Fri Aug 11 2023 18:45:31 for bml by
+    <li class="footer">Generated on Fri Sep 22 2023 15:28:10 for bml by
     <a href="http://www.doxygen.org/index.html">
     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17 </li>
   </ul>

docs/API/C_usage.html

@@ -33,7 +33,7 @@
  <tr style="height: 56px;">
   <td id="projectalign" style="padding-left: 0.5em;">
    <div id="projectname">bml
-   &#160;<span id="projectnumber">2.3.0</span>
+   &#160;<span id="projectnumber">2.4.0</span>
    </div>
    <div id="projectbrief">Basic Matrix Library (bml):  A matrix library for linear algebra operations,  supporting several data structures.</div>
   </td>
@@ -105,7 +105,7 @@
 <!-- start footer part -->
 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
   <ul>
-    <li class="footer">Generated on Fri Aug 11 2023 18:45:31 for bml by
+    <li class="footer">Generated on Fri Sep 22 2023 15:28:10 for bml by
     <a href="http://www.doxygen.org/index.html">
     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17 </li>
   </ul>

docs/API/annotated.html

@@ -33,7 +33,7 @@
  <tr style="height: 56px;">
   <td id="projectalign" style="padding-left: 0.5em;">
    <div id="projectname">bml
-   &#160;<span id="projectnumber">2.3.0</span>
+   &#160;<span id="projectnumber">2.4.0</span>
    </div>
    <div id="projectbrief">Basic Matrix Library (bml):  A matrix library for linear algebra operations,  supporting several data structures.</div>
   </td>
@@ -243,7 +243,7 @@
 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
   <ul>
     <li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_40f4bd1e0d79afce1878e17dca4050b7.html">C-interface</a></li><li class="navelem"><b>blas.h</b></li>
-    <li class="footer">Generated on Fri Aug 11 2023 18:45:31 for bml by
+    <li class="footer">Generated on Fri Sep 22 2023 15:28:10 for bml by
     <a href="http://www.doxygen.org/index.html">
     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17 </li>
   </ul>

docs/API/blas_8h_source.html

@@ -33,7 +33,7 @@
  <tr style="height: 56px;">
   <td id="projectalign" style="padding-left: 0.5em;">
    <div id="projectname">bml
-   &#160;<span id="projectnumber">2.3.0</span>
+   &#160;<span id="projectnumber">2.4.0</span>
    </div>
    <div id="projectbrief">Basic Matrix Library (bml):  A matrix library for linear algebra operations,  supporting several data structures.</div>
   </td>
@@ -134,7 +134,7 @@
 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
   <ul>
     <li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_40f4bd1e0d79afce1878e17dca4050b7.html">C-interface</a></li><li class="navelem"><a class="el" href="bml_8h.html">bml.h</a></li>
-    <li class="footer">Generated on Fri Aug 11 2023 18:45:31 for bml by
+    <li class="footer">Generated on Fri Sep 22 2023 15:28:10 for bml by
     <a href="http://www.doxygen.org/index.html">
     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17 </li>
   </ul>

docs/API/bml_8h.html

@@ -33,7 +33,7 @@
  <tr style="height: 56px;">
   <td id="projectalign" style="padding-left: 0.5em;">
    <div id="projectname">bml
-   &#160;<span id="projectnumber">2.3.0</span>
+   &#160;<span id="projectnumber">2.4.0</span>
    </div>
    <div id="projectbrief">Basic Matrix Library (bml):  A matrix library for linear algebra operations,  supporting several data structures.</div>
   </td>
@@ -155,7 +155,7 @@
 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
   <ul>
     <li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_40f4bd1e0d79afce1878e17dca4050b7.html">C-interface</a></li><li class="navelem"><a class="el" href="bml_8h.html">bml.h</a></li>
-    <li class="footer">Generated on Fri Aug 11 2023 18:45:31 for bml by
+    <li class="footer">Generated on Fri Sep 22 2023 15:28:10 for bml by
     <a href="http://www.doxygen.org/index.html">
     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17 </li>
   </ul>

docs/API/bml_8h_source.html

@@ -33,7 +33,7 @@
  <tr style="height: 56px;">
   <td id="projectalign" style="padding-left: 0.5em;">
    <div id="projectname">bml
-   &#160;<span id="projectnumber">2.3.0</span>
+   &#160;<span id="projectnumber">2.4.0</span>
    </div>
    <div id="projectbrief">Basic Matrix Library (bml):  A matrix library for linear algebra operations,  supporting several data structures.</div>
   </td>
@@ -117,7 +117,7 @@
 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
   <ul>
     <li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_40f4bd1e0d79afce1878e17dca4050b7.html">C-interface</a></li><li class="navelem"><a class="el" href="bml__add_8h.html">bml_add.h</a></li>
-    <li class="footer">Generated on Fri Aug 11 2023 18:45:31 for bml by
+    <li class="footer">Generated on Fri Sep 22 2023 15:28:10 for bml by
     <a href="http://www.doxygen.org/index.html">
     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17 </li>
   </ul>

docs/API/bml__add_8h.html

@@ -33,7 +33,7 @@
  <tr style="height: 56px;">
   <td id="projectalign" style="padding-left: 0.5em;">
    <div id="projectname">bml
-   &#160;<span id="projectnumber">2.3.0</span>
+   &#160;<span id="projectnumber">2.4.0</span>
    </div>
    <div id="projectbrief">Basic Matrix Library (bml):  A matrix library for linear algebra operations,  supporting several data structures.</div>
   </td>
@@ -148,7 +148,7 @@
 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
   <ul>
     <li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_40f4bd1e0d79afce1878e17dca4050b7.html">C-interface</a></li><li class="navelem"><a class="el" href="bml__add_8h.html">bml_add.h</a></li>
-    <li class="footer">Generated on Fri Aug 11 2023 18:45:31 for bml by
+    <li class="footer">Generated on Fri Sep 22 2023 15:28:10 for bml by
     <a href="http://www.doxygen.org/index.html">
     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17 </li>
   </ul>

docs/API/bml__add_8h_source.html

@@ -33,7 +33,7 @@
  <tr style="height: 56px;">
   <td id="projectalign" style="padding-left: 0.5em;">
    <div id="projectname">bml
-   &#160;<span id="projectnumber">2.3.0</span>
+   &#160;<span id="projectnumber">2.4.0</span>
    </div>
    <div id="projectbrief">Basic Matrix Library (bml):  A matrix library for linear algebra operations,  supporting several data structures.</div>
   </td>
@@ -148,7 +148,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a0492e26f185d843e14877c71
 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
   <ul>
     <li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_40f4bd1e0d79afce1878e17dca4050b7.html">C-interface</a></li><li class="navelem"><a class="el" href="bml__adjungate__triangle_8h.html">bml_adjungate_triangle.h</a></li>
-    <li class="footer">Generated on Fri Aug 11 2023 18:45:31 for bml by
+    <li class="footer">Generated on Fri Sep 22 2023 15:28:10 for bml by
     <a href="http://www.doxygen.org/index.html">
     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17 </li>
   </ul>

docs/API/bml__adjungate__triangle_8h.html

@@ -33,7 +33,7 @@
  <tr style="height: 56px;">
   <td id="projectalign" style="padding-left: 0.5em;">
    <div id="projectname">bml
-   &#160;<span id="projectnumber">2.3.0</span>
+   &#160;<span id="projectnumber">2.4.0</span>
    </div>
    <div id="projectbrief">Basic Matrix Library (bml):  A matrix library for linear algebra operations,  supporting several data structures.</div>
   </td>
@@ -122,7 +122,7 @@
 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
   <ul>
     <li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_40f4bd1e0d79afce1878e17dca4050b7.html">C-interface</a></li><li class="navelem"><a class="el" href="bml__adjungate__triangle_8h.html">bml_adjungate_triangle.h</a></li>
-    <li class="footer">Generated on Fri Aug 11 2023 18:45:31 for bml by
+    <li class="footer">Generated on Fri Sep 22 2023 15:28:10 for bml by
     <a href="http://www.doxygen.org/index.html">
     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17 </li>
   </ul>

docs/API/bml__adjungate__triangle_8h_source.html

@@ -33,7 +33,7 @@
  <tr style="height: 56px;">
   <td id="projectalign" style="padding-left: 0.5em;">
    <div id="projectname">bml
-   &#160;<span id="projectnumber">2.3.0</span>
+   &#160;<span id="projectnumber">2.4.0</span>
    </div>
    <div id="projectbrief">Basic Matrix Library (bml):  A matrix library for linear algebra operations,  supporting several data structures.</div>
   </td>
@@ -117,8 +117,6 @@
 <tr class="separator:ga2f0194cf4cbe9c1ca4b0942fb1899817"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:gae442bd3e06e8f8ff92aad499f0d8ebf2"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__allocate__group__C.html#gae442bd3e06e8f8ff92aad499f0d8ebf2">bml_deallocate</a> (<a class="el" href="bml__types_8h.html#afe10f3a7e985a8627616dfda2dec6fc9">bml_matrix_t</a> **A)</td></tr>
 <tr class="separator:gae442bd3e06e8f8ff92aad499f0d8ebf2"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:ga6c2e37764bcf2f56ed1c1f961afe68b1"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__allocate__group__C.html#ga6c2e37764bcf2f56ed1c1f961afe68b1">bml_deallocate_domain</a> (<a class="el" href="structbml__domain__t.html">bml_domain_t</a> *D)</td></tr>
-<tr class="separator:ga6c2e37764bcf2f56ed1c1f961afe68b1"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:ga8288b14bbf2a5643efbd95858945eaa4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__allocate__group__C.html#ga8288b14bbf2a5643efbd95858945eaa4">bml_clear</a> (<a class="el" href="bml__types_8h.html#afe10f3a7e985a8627616dfda2dec6fc9">bml_matrix_t</a> *A)</td></tr>
 <tr class="separator:ga8288b14bbf2a5643efbd95858945eaa4"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:gab01d44950e5fe6e57deedfe6c386bbfe"><td class="memItemLeft" align="right" valign="top"><a class="el" href="bml__types_8h.html#afe10f3a7e985a8627616dfda2dec6fc9">bml_matrix_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__allocate__group__C.html#gab01d44950e5fe6e57deedfe6c386bbfe">bml_noinit_rectangular_matrix</a> (<a class="el" href="bml__types_8h.html#ab7d3c21318898af00e7c28712f369842">bml_matrix_type_t</a> matrix_type, <a class="el" href="bml__types_8h.html#a8d762ed64876f48d5eb687cb62f20d5c">bml_matrix_precision_t</a> matrix_precision, <a class="el" href="structbml__matrix__dimension__t.html">bml_matrix_dimension_t</a> matrix_dimension, <a class="el" href="bml__types_8h.html#a4bed60baf88d95c03a021ed4b166a522">bml_distribution_mode_t</a> distrib_mode)</td></tr>
@@ -133,18 +131,16 @@
 <tr class="separator:ga1f53fbac8a09265cb395bff7820198b6"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:gadbc4d5780e61668fdde647efcb880394"><td class="memItemLeft" align="right" valign="top"><a class="el" href="bml__types_8h.html#afe10f3a7e985a8627616dfda2dec6fc9">bml_matrix_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__allocate__group__C.html#gadbc4d5780e61668fdde647efcb880394">bml_identity_matrix</a> (<a class="el" href="bml__types_8h.html#ab7d3c21318898af00e7c28712f369842">bml_matrix_type_t</a> matrix_type, <a class="el" href="bml__types_8h.html#a8d762ed64876f48d5eb687cb62f20d5c">bml_matrix_precision_t</a> matrix_precision, int N, int M, <a class="el" href="bml__types_8h.html#a4bed60baf88d95c03a021ed4b166a522">bml_distribution_mode_t</a> distrib_mode)</td></tr>
 <tr class="separator:gadbc4d5780e61668fdde647efcb880394"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:ga8a04f072d6870a3091a6cc743873f490"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structbml__domain__t.html">bml_domain_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__allocate__group__C.html#ga8a04f072d6870a3091a6cc743873f490">bml_default_domain</a> (int N, int M, <a class="el" href="bml__types_8h.html#a4bed60baf88d95c03a021ed4b166a522">bml_distribution_mode_t</a> distrib_mode)</td></tr>
-<tr class="separator:ga8a04f072d6870a3091a6cc743873f490"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:ga1c157462f6aae21159412d8c9bf5e3f3"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__allocate__group__C.html#ga1c157462f6aae21159412d8c9bf5e3f3">bml_update_domain</a> (<a class="el" href="bml__types_8h.html#afe10f3a7e985a8627616dfda2dec6fc9">bml_matrix_t</a> *A, int *localPartMin, int *localPartMax, int *nnodesInPart)</td></tr>
-<tr class="separator:ga1c157462f6aae21159412d8c9bf5e3f3"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ga0e6e5e7cc1449b285b55a6696a61f85f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__allocate__group__C.html#ga0e6e5e7cc1449b285b55a6696a61f85f">bml_update_domain_matrix</a> (<a class="el" href="bml__types_8h.html#afe10f3a7e985a8627616dfda2dec6fc9">bml_matrix_t</a> *A, int *localPartMin, int *localPartMax, int *nnodesInPart)</td></tr>
+<tr class="separator:ga0e6e5e7cc1449b285b55a6696a61f85f"><td class="memSeparator" colspan="2">&#160;</td></tr>
 </table>
 </div><!-- contents -->
 </div><!-- doc-content -->
 <!-- start footer part -->
 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
   <ul>
     <li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_40f4bd1e0d79afce1878e17dca4050b7.html">C-interface</a></li><li class="navelem"><a class="el" href="bml__allocate_8h.html">bml_allocate.h</a></li>
-    <li class="footer">Generated on Fri Aug 11 2023 18:45:31 for bml by
+    <li class="footer">Generated on Fri Sep 22 2023 15:28:10 for bml by
     <a href="http://www.doxygen.org/index.html">
     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17 </li>
   </ul>

docs/API/bml__allocate_8h.html

@@ -5,8 +5,6 @@ var bml__allocate_8h =
     [ "bml_banded_matrix", "group__allocate__group__C.html#ga1f53fbac8a09265cb395bff7820198b6", null ],
     [ "bml_clear", "group__allocate__group__C.html#ga8288b14bbf2a5643efbd95858945eaa4", null ],
     [ "bml_deallocate", "group__allocate__group__C.html#gae442bd3e06e8f8ff92aad499f0d8ebf2", null ],
-    [ "bml_deallocate_domain", "group__allocate__group__C.html#ga6c2e37764bcf2f56ed1c1f961afe68b1", null ],
-    [ "bml_default_domain", "group__allocate__group__C.html#ga8a04f072d6870a3091a6cc743873f490", null ],
     [ "bml_free_memory", "group__allocate__group__C.html#ga511db66cb871701e1620f85b307d0157", null ],
     [ "bml_free_ptr", "group__allocate__group__C.html#ga2f0194cf4cbe9c1ca4b0942fb1899817", null ],
     [ "bml_identity_matrix", "group__allocate__group__C.html#gadbc4d5780e61668fdde647efcb880394", null ],
@@ -15,6 +13,6 @@ var bml__allocate_8h =
     [ "bml_noinit_rectangular_matrix", "group__allocate__group__C.html#gab01d44950e5fe6e57deedfe6c386bbfe", null ],
     [ "bml_random_matrix", "group__allocate__group__C.html#ga5526b653e3bee9064caa6d9ed3a2a298", null ],
     [ "bml_reallocate_memory", "group__allocate__group__C.html#gaafb1484decc24bb0e1c20b9dfe7bfe11", null ],
-    [ "bml_update_domain", "group__allocate__group__C.html#ga1c157462f6aae21159412d8c9bf5e3f3", null ],
+    [ "bml_update_domain_matrix", "group__allocate__group__C.html#ga0e6e5e7cc1449b285b55a6696a61f85f", null ],
     [ "bml_zero_matrix", "group__allocate__group__C.html#ga1db50ac5b32a15d261d36da2c6415898", null ]
 ];