Skip to content

Commit c076943

Browse files
cnegrecnegre
committed
Updated API and manual
1 parent 7950839 commit c076943

File tree

629 files changed

+27108
-20
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

629 files changed

+27108
-20
lines changed

‎bml-manual.pdf

1.2 MB
Binary file not shown.

‎docs/API/C_usage.html

+121
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,121 @@
1+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2+
<html xmlns="http://www.w3.org/1999/xhtml">
3+
<head>
4+
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5+
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
6+
<meta name="generator" content="Doxygen 1.8.17"/>
7+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
8+
<title>bml: C Usage</title>
9+
<link href="tabs.css" rel="stylesheet" type="text/css"/>
10+
<script type="text/javascript" src="jquery.js"></script>
11+
<script type="text/javascript" src="dynsections.js"></script>
12+
<link href="navtree.css" rel="stylesheet" type="text/css"/>
13+
<script type="text/javascript" src="resize.js"></script>
14+
<script type="text/javascript" src="navtreedata.js"></script>
15+
<script type="text/javascript" src="navtree.js"></script>
16+
<link href="search/search.css" rel="stylesheet" type="text/css"/>
17+
<script type="text/javascript" src="search/searchdata.js"></script>
18+
<script type="text/javascript" src="search/search.js"></script>
19+
<script type="text/x-mathjax-config">
20+
MathJax.Hub.Config({
21+
extensions: ["tex2jax.js"],
22+
jax: ["input/TeX","output/HTML-CSS"],
23+
});
24+
</script>
25+
<script type="text/javascript" async="async" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
26+
<link href="doxygen.css" rel="stylesheet" type="text/css" />
27+
</head>
28+
<body>
29+
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
30+
<div id="titlearea">
31+
<table cellspacing="0" cellpadding="0">
32+
<tbody>
33+
<tr style="height: 56px;">
34+
<td id="projectalign" style="padding-left: 0.5em;">
35+
<div id="projectname">bml
36+
&#160;<span id="projectnumber">1.3.1</span>
37+
</div>
38+
<div id="projectbrief">Basic Matrix Library (bml): A matrix library for linear algebra operations, supporting several data structures.</div>
39+
</td>
40+
</tr>
41+
</tbody>
42+
</table>
43+
</div>
44+
<!-- end header part -->
45+
<!-- Generated by Doxygen 1.8.17 -->
46+
<script type="text/javascript">
47+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
48+
var searchBox = new SearchBox("searchBox", "search",false,'Search');
49+
/* @license-end */
50+
</script>
51+
<script type="text/javascript" src="menudata.js"></script>
52+
<script type="text/javascript" src="menu.js"></script>
53+
<script type="text/javascript">
54+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
55+
$(function() {
56+
initMenu('',true,false,'search.php','Search');
57+
$(document).ready(function() { init_search(); });
58+
});
59+
/* @license-end */</script>
60+
<div id="main-nav"></div>
61+
</div><!-- top -->
62+
<div id="side-nav" class="ui-resizable side-nav-resizable">
63+
<div id="nav-tree">
64+
<div id="nav-tree-contents">
65+
<div id="nav-sync" class="sync"></div>
66+
</div>
67+
</div>
68+
<div id="splitbar" style="-moz-user-select:none;"
69+
class="ui-resizable-handle">
70+
</div>
71+
</div>
72+
<script type="text/javascript">
73+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
74+
$(document).ready(function(){initNavTree('C_usage.html',''); initResizable(); });
75+
/* @license-end */
76+
</script>
77+
<div id="doc-content">
78+
<!-- window showing the filter options -->
79+
<div id="MSearchSelectWindow"
80+
onmouseover="return searchBox.OnSearchSelectShow()"
81+
onmouseout="return searchBox.OnSearchSelectHide()"
82+
onkeydown="return searchBox.OnSearchSelectKey(event)">
83+
</div>
84+
85+
<!-- iframe showing the search results (closed by default) -->
86+
<div id="MSearchResultsWindow">
87+
<iframe src="javascript:void(0)" frameborder="0"
88+
name="MSearchResults" id="MSearchResults">
89+
</iframe>
90+
</div>
91+
92+
<div class="PageDoc"><div class="header">
93+
<div class="headertitle">
94+
<div class="title">C Usage </div> </div>
95+
</div><!--header-->
96+
<div class="contents">
97+
<div class="textblock"><p>In C, the following example code does the same as the above Fortran code:</p>
98+
<div class="fragment"><div class="line"><span class="preprocessor">#include &lt;<a class="code" href="bml_8h.html">bml.h</a>&gt;</span></div>
99+
<div class="line"> </div>
100+
<div class="line"><a class="code" href="bml__types_8h.html#afe10f3a7e985a8627616dfda2dec6fc9">bml_matrix_t</a> *A = <a class="code" href="group__allocate__group__C.html#ga1db50ac5b32a15d261d36da2c6415898">bml_zero_matrix</a>(<a class="code" href="bml__types_8h.html#ab7d3c21318898af00e7c28712f369842ae8716347cc7fdaf9fc25cc0e20c2ab26">dense</a>, <a class="code" href="bml__types_8h.html#a8d762ed64876f48d5eb687cb62f20d5cab1dee362b4b8fac13bfc3e3df1d88af0">single_real</a>, 100);</div>
101+
<div class="line"><a class="code" href="group__allocate__group__C.html#gae442bd3e06e8f8ff92aad499f0d8ebf2">bml_deallocate</a>(&amp;A);</div>
102+
</div><!-- fragment --><p>Back to the <a class="el" href="index.html">main page</a>. </p>
103+
</div></div><!-- contents -->
104+
</div><!-- PageDoc -->
105+
</div><!-- doc-content -->
106+
<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>
107+
<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>
108+
<div class="ttc" id="abml_8h_html"><div class="ttname"><a href="bml_8h.html">bml.h</a></div></div>
109+
<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>
110+
<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>
111+
<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>
112+
<!-- start footer part -->
113+
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
114+
<ul>
115+
<li class="footer">Generated on Wed Sep 9 2020 19:37:59 for bml by
116+
<a href="http://www.doxygen.org/index.html">
117+
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17 </li>
118+
</ul>
119+
</div>
120+
</body>
121+
</html>

‎docs/API/annotated.html

+114
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,114 @@
1+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2+
<html xmlns="http://www.w3.org/1999/xhtml">
3+
<head>
4+
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5+
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
6+
<meta name="generator" content="Doxygen 1.8.17"/>
7+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
8+
<title>bml: Class List</title>
9+
<link href="tabs.css" rel="stylesheet" type="text/css"/>
10+
<script type="text/javascript" src="jquery.js"></script>
11+
<script type="text/javascript" src="dynsections.js"></script>
12+
<link href="navtree.css" rel="stylesheet" type="text/css"/>
13+
<script type="text/javascript" src="resize.js"></script>
14+
<script type="text/javascript" src="navtreedata.js"></script>
15+
<script type="text/javascript" src="navtree.js"></script>
16+
<link href="search/search.css" rel="stylesheet" type="text/css"/>
17+
<script type="text/javascript" src="search/searchdata.js"></script>
18+
<script type="text/javascript" src="search/search.js"></script>
19+
<script type="text/x-mathjax-config">
20+
MathJax.Hub.Config({
21+
extensions: ["tex2jax.js"],
22+
jax: ["input/TeX","output/HTML-CSS"],
23+
});
24+
</script>
25+
<script type="text/javascript" async="async" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
26+
<link href="doxygen.css" rel="stylesheet" type="text/css" />
27+
</head>
28+
<body>
29+
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
30+
<div id="titlearea">
31+
<table cellspacing="0" cellpadding="0">
32+
<tbody>
33+
<tr style="height: 56px;">
34+
<td id="projectalign" style="padding-left: 0.5em;">
35+
<div id="projectname">bml
36+
&#160;<span id="projectnumber">1.3.1</span>
37+
</div>
38+
<div id="projectbrief">Basic Matrix Library (bml): A matrix library for linear algebra operations, supporting several data structures.</div>
39+
</td>
40+
</tr>
41+
</tbody>
42+
</table>
43+
</div>
44+
<!-- end header part -->
45+
<!-- Generated by Doxygen 1.8.17 -->
46+
<script type="text/javascript">
47+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
48+
var searchBox = new SearchBox("searchBox", "search",false,'Search');
49+
/* @license-end */
50+
</script>
51+
<script type="text/javascript" src="menudata.js"></script>
52+
<script type="text/javascript" src="menu.js"></script>
53+
<script type="text/javascript">
54+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
55+
$(function() {
56+
initMenu('',true,false,'search.php','Search');
57+
$(document).ready(function() { init_search(); });
58+
});
59+
/* @license-end */</script>
60+
<div id="main-nav"></div>
61+
</div><!-- top -->
62+
<div id="side-nav" class="ui-resizable side-nav-resizable">
63+
<div id="nav-tree">
64+
<div id="nav-tree-contents">
65+
<div id="nav-sync" class="sync"></div>
66+
</div>
67+
</div>
68+
<div id="splitbar" style="-moz-user-select:none;"
69+
class="ui-resizable-handle">
70+
</div>
71+
</div>
72+
<script type="text/javascript">
73+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
74+
$(document).ready(function(){initNavTree('annotated.html',''); initResizable(); });
75+
/* @license-end */
76+
</script>
77+
<div id="doc-content">
78+
<!-- window showing the filter options -->
79+
<div id="MSearchSelectWindow"
80+
onmouseover="return searchBox.OnSearchSelectShow()"
81+
onmouseout="return searchBox.OnSearchSelectHide()"
82+
onkeydown="return searchBox.OnSearchSelectKey(event)">
83+
</div>
84+
85+
<!-- iframe showing the search results (closed by default) -->
86+
<div id="MSearchResultsWindow">
87+
<iframe src="javascript:void(0)" frameborder="0"
88+
name="MSearchResults" id="MSearchResults">
89+
</iframe>
90+
</div>
91+
92+
<div class="header">
93+
<div class="headertitle">
94+
<div class="title">Class List</div> </div>
95+
</div><!--header-->
96+
<div class="contents">
97+
<div class="textblock">Here are the classes, structs, unions and interfaces with brief descriptions:</div><div class="directory">
98+
<table class="directory">
99+
<tr id="row_0_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structbml__domain__t.html" target="_self">bml_domain_t</a></td><td class="desc"></td></tr>
100+
<tr id="row_1_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structbml__matrix__dimension__t.html" target="_self">bml_matrix_dimension_t</a></td><td class="desc"></td></tr>
101+
</table>
102+
</div><!-- directory -->
103+
</div><!-- contents -->
104+
</div><!-- doc-content -->
105+
<!-- start footer part -->
106+
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
107+
<ul>
108+
<li class="footer">Generated on Wed Sep 9 2020 19:37:59 for bml by
109+
<a href="http://www.doxygen.org/index.html">
110+
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17 </li>
111+
</ul>
112+
</div>
113+
</body>
114+
</html>

‎docs/API/annotated_dup.js

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
var annotated_dup =
2+
[
3+
[ "bml_domain_t", "structbml__domain__t.html", "structbml__domain__t" ],
4+
[ "bml_matrix_dimension_t", "structbml__matrix__dimension__t.html", "structbml__matrix__dimension__t" ]
5+
];

‎docs/API/bc_s.png

676 Bytes
Loading

‎docs/API/bdwn.png

147 Bytes
Loading

0 commit comments

Comments
 (0)