Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update API documentation #726

Merged
merged 1 commit into from
Aug 11, 2023
Merged

Update API documentation #726

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
8 changes: 4 additions & 4 deletions docs/API/C_usage.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">bml
&#160;<span id="projectnumber">1.3.1</span>
&#160;<span id="projectnumber">2.3.0</span>
</div>
<div id="projectbrief">Basic Matrix Library (bml): A matrix library for linear algebra operations, supporting several data structures.</div>
</td>
Expand Down Expand Up @@ -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:380</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="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:159</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 Wed Sep 9 2020 19:37:59 for bml by
<li class="footer">Generated on Fri Aug 11 2023 18:45:31 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>
Expand Down
4 changes: 2 additions & 2 deletions docs/API/annotated.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">bml
&#160;<span id="projectnumber">1.3.1</span>
&#160;<span id="projectnumber">2.3.0</span>
</div>
<div id="projectbrief">Basic Matrix Library (bml): A matrix library for linear algebra operations, supporting several data structures.</div>
</td>
Expand Down Expand Up @@ -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 Wed Sep 9 2020 19:37:59 for bml by
<li class="footer">Generated on Fri Aug 11 2023 18:45:31 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>
Expand Down
46 changes: 23 additions & 23 deletions docs/API/blas_8h_source.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>bml: /tmp/bml/src/C-interface/blas.h Source File</title>
<title>bml: /bml/src/C-interface/blas.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
Expand Down Expand Up @@ -33,7 +33,7 @@
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">bml
&#160;<span id="projectnumber">1.3.1</span>
&#160;<span id="projectnumber">2.3.0</span>
</div>
<div id="projectbrief">Basic Matrix Library (bml): A matrix library for linear algebra operations, supporting several data structures.</div>
</td>
Expand Down Expand Up @@ -113,13 +113,13 @@
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160; <span class="keyword">const</span> <span class="keywordtype">int</span> *incx);</div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="keywordtype">void</span> C_CSCAL(</div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; <span class="keyword">const</span> <span class="keywordtype">int</span> *n,</div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160; <span class="keyword">const</span> <span class="keywordtype">float</span> complex * a,</div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160; <span class="keywordtype">float</span> complex * x,</div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160; <span class="keyword">const</span> <span class="keywordtype">float</span> complex *a,</div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160; <span class="keywordtype">float</span> complex *x,</div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; <span class="keyword">const</span> <span class="keywordtype">int</span> *incx);</div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="keywordtype">void</span> C_ZSCAL(</div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; <span class="keyword">const</span> <span class="keywordtype">int</span> *n,</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; <span class="keyword">const</span> <span class="keywordtype">double</span> complex * a,</div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; <span class="keywordtype">double</span> complex * x,</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; <span class="keyword">const</span> <span class="keywordtype">double</span> complex *a,</div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; <span class="keywordtype">double</span> complex *x,</div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; <span class="keyword">const</span> <span class="keywordtype">int</span> *incx);</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="keywordtype">void</span> C_SGEMM(</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; <span class="keyword">const</span> <span class="keywordtype">char</span> *transa,</div>
Expand Down Expand Up @@ -155,27 +155,27 @@
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; <span class="keyword">const</span> <span class="keywordtype">int</span> *m,</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; <span class="keyword">const</span> <span class="keywordtype">int</span> *n,</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; <span class="keyword">const</span> <span class="keywordtype">int</span> *k,</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; <span class="keyword">const</span> <span class="keywordtype">float</span> complex * alpha,</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; <span class="keyword">const</span> <span class="keywordtype">float</span> complex * a,</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; <span class="keyword">const</span> <span class="keywordtype">float</span> complex *alpha,</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; <span class="keyword">const</span> <span class="keywordtype">float</span> complex *a,</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; <span class="keyword">const</span> <span class="keywordtype">int</span> *lda,</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; <span class="keyword">const</span> <span class="keywordtype">float</span> complex * b,</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; <span class="keyword">const</span> <span class="keywordtype">float</span> complex *b,</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; <span class="keyword">const</span> <span class="keywordtype">int</span> *ldb,</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; <span class="keyword">const</span> <span class="keywordtype">float</span> complex * beta,</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; <span class="keywordtype">float</span> complex * c,</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; <span class="keyword">const</span> <span class="keywordtype">float</span> complex *beta,</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; <span class="keywordtype">float</span> complex *c,</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; <span class="keyword">const</span> <span class="keywordtype">int</span> *ldc);</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160;<span class="keywordtype">void</span> C_ZGEMM(</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; <span class="keyword">const</span> <span class="keywordtype">char</span> *transa,</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; <span class="keyword">const</span> <span class="keywordtype">char</span> *transb,</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; <span class="keyword">const</span> <span class="keywordtype">int</span> *m,</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; <span class="keyword">const</span> <span class="keywordtype">int</span> *n,</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; <span class="keyword">const</span> <span class="keywordtype">int</span> *k,</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; <span class="keyword">const</span> <span class="keywordtype">double</span> complex * alpha,</div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; <span class="keyword">const</span> <span class="keywordtype">double</span> complex * a,</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; <span class="keyword">const</span> <span class="keywordtype">double</span> complex *alpha,</div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; <span class="keyword">const</span> <span class="keywordtype">double</span> complex *a,</div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; <span class="keyword">const</span> <span class="keywordtype">int</span> *lda,</div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; <span class="keyword">const</span> <span class="keywordtype">double</span> complex * b,</div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; <span class="keyword">const</span> <span class="keywordtype">double</span> complex *b,</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; <span class="keyword">const</span> <span class="keywordtype">int</span> *ldb,</div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; <span class="keyword">const</span> <span class="keywordtype">double</span> complex * beta,</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; <span class="keywordtype">double</span> complex * c,</div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; <span class="keyword">const</span> <span class="keywordtype">double</span> complex *beta,</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; <span class="keywordtype">double</span> complex *c,</div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; <span class="keyword">const</span> <span class="keywordtype">int</span> *ldc);</div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160;<span class="keywordtype">void</span> C_SAXPY(</div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; <span class="keyword">const</span> <span class="keywordtype">int</span> *n,</div>
Expand All @@ -193,17 +193,17 @@
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160; <span class="keyword">const</span> <span class="keywordtype">int</span> *incy);</div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160;<span class="keywordtype">void</span> C_CAXPY(</div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160; <span class="keyword">const</span> <span class="keywordtype">int</span> *n,</div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160; <span class="keyword">const</span> <span class="keywordtype">float</span> complex * alpha,</div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160; <span class="keyword">const</span> <span class="keywordtype">float</span> complex * x,</div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160; <span class="keyword">const</span> <span class="keywordtype">float</span> complex *alpha,</div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160; <span class="keyword">const</span> <span class="keywordtype">float</span> complex *x,</div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160; <span class="keyword">const</span> <span class="keywordtype">int</span> *incx,</div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160; <span class="keywordtype">float</span> complex * y,</div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160; <span class="keywordtype">float</span> complex *y,</div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160; <span class="keyword">const</span> <span class="keywordtype">int</span> *incy);</div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160;<span class="keywordtype">void</span> C_ZAXPY(</div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>&#160; <span class="keyword">const</span> <span class="keywordtype">int</span> *n,</div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160; <span class="keyword">const</span> <span class="keywordtype">double</span> complex * alpha,</div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160; <span class="keyword">const</span> <span class="keywordtype">double</span> complex * x,</div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160; <span class="keyword">const</span> <span class="keywordtype">double</span> complex *alpha,</div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160; <span class="keyword">const</span> <span class="keywordtype">double</span> complex *x,</div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160; <span class="keyword">const</span> <span class="keywordtype">int</span> *incx,</div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160; <span class="keywordtype">double</span> complex * y,</div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160; <span class="keywordtype">double</span> complex *y,</div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160; <span class="keyword">const</span> <span class="keywordtype">int</span> *incy);</div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160; </div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160;<span class="keywordtype">void</span> XSMM(</div>
Expand Down Expand Up @@ -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 Wed Sep 9 2020 19:37:59 for bml by
<li class="footer">Generated on Fri Aug 11 2023 18:45:31 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>
Expand Down
Loading