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

Changed README file #406

Merged
merged 4 commits into from
Sep 10, 2020
Merged

Changed README file #406

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
071fe44
Changed README file
cnegre Sep 9, 2020
2dbe8ac
Added API link
cnegre Sep 9, 2020
7950839
Added Contributors
cnegre Sep 10, 2020
c076943
Updated API and manual
cnegre Sep 10, 2020
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
  •  
  •  
  •  
20 changes: 13 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,12 @@ This website is intended to provide some guidance on how to get and install
the bml library. LA-UR number LA-UR-**17-27373**.

The basic matrix library (bml) is a collection of various matrix data formats
(in dense and sparse) and their associated algorithms for basic matrix
(for dense and sparse) and their associated algorithms for basic matrix
operations. Application programming interfaces (API) are available for both C
and FORTRAN. The current status of this library allows us to use two different
formats for representing matrix data: dense and ELLPACK.
formats for representing matrix data. Currently these formats are: dense, ELLPACK-R,
ELLBLOCK, ELLSORT, and CSR. For information on how to use the BML library can be find
in [BML-API](https://lanl.github.io/bml/API/developer_documentation.html).

# Mailing List

Expand All @@ -32,8 +34,10 @@ We are running the following mailing list for discussions on usage and features
The bml library supports the following matrix formats:

* dense
* ELLPACK
* ELLPACK-R
* ELLSORT
* ELLBLOCK
* CSR

# Binary Packages

Expand Down Expand Up @@ -115,7 +119,7 @@ files
# Developer Suggested Workflow

Our main development happens on the `master` branch and is continuously
verified for correctness. If you would like to contribute your work to the bml
verified for correctness. If you would like to contribute with your work to the bml
project, please follow the instructions at the GitHub help page ["About pull
requests"](https://help.github.com/articles/about-pull-requests/). To
summarize:
Expand Down Expand Up @@ -180,9 +184,11 @@ The core developers of the bml in alphabetical order:

# Contributors

* Jamaludin Mohd-Yusof <jamal@lanl.gov>
* Adedoyin Adetokunbo <adedoyin.adetokunbo@gmail.com>
* Adedoyin Adetokunbo <aadedoyin@lanl.gov>
* Bálint Aradi <aradi@uni-bremen.de>
* Daniel Osei-Kuffuor <oseikuffuor1@llnl.gov>
* Jamaludin Mohd-Yusof <jamal@lanl.gov>
* Jean-Luc Fattebert <fattebertj@ornl.gov>
* Mike Wall <mewall@lanl.gov>

# License
Expand Down Expand Up @@ -236,7 +242,7 @@ Matrix Library (bml), Version 0.x (C16006)*.
## ABSTRACT

The basic matrix library (bml) is a collection of various matrix data
formats (in dense and sparse) and their associated algorithms for basic
formats (for dense and sparse) and their associated algorithms for basic
matrix operations.

This code is unclassified and has been assigned LA-CC-**15-093**. Los Alamos
Expand Down
Binary file modified bml-manual.pdf
View file
Open in desktop
Binary file not shown.
42 changes: 28 additions & 14 deletions docs/API/C_usage.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="generator" content="Doxygen 1.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>bml: C Usage</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
Expand All @@ -13,9 +13,6 @@
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
Expand All @@ -24,7 +21,8 @@
extensions: ["tex2jax.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
</script>
<script type="text/javascript" async="async" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
Expand All @@ -35,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.0</span>
&#160;<span id="projectnumber">1.3.1</span>
</div>
<div id="projectbrief">Basic Matrix Library (bml): A matrix library for linear algebra operations, supporting several data structures.</div>
</td>
Expand All @@ -44,18 +42,21 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
Expand All @@ -69,7 +70,9 @@
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('C_usage.html','');});
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('C_usage.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
Expand All @@ -86,21 +89,32 @@
</iframe>
</div>

<div class="header">
<div class="PageDoc"><div class="header">
<div class="headertitle">
<div class="title">C Usage </div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p>In C, the following example code does the same as the above Fortran code:</p>
<div class="fragment"><div class="line"><span class="preprocessor">#include &lt;<a class="code" href="bml_8h.html">bml.h</a>&gt;</span></div><div class="line"></div><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#ga718ebeff21e6f671fa3aebf447273231">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><div class="line"><a class="code" href="group__allocate__group__C.html#gae442bd3e06e8f8ff92aad499f0d8ebf2">bml_deallocate</a>(&amp;A);</div></div><!-- fragment --><p>Back to the <a class="el" href="index.html">main page</a>. </p>
<div class="fragment"><div class="line"><span class="preprocessor">#include &lt;<a class="code" href="bml_8h.html">bml.h</a>&gt;</span></div>
<div class="line"> </div>
<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>
<div class="line"><a class="code" href="group__allocate__group__C.html#gae442bd3e06e8f8ff92aad499f0d8ebf2">bml_deallocate</a>(&amp;A);</div>
</div><!-- fragment --><p>Back to the <a class="el" href="index.html">main page</a>. </p>
</div></div><!-- contents -->
</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="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>
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated on Wed May 23 2018 06:11:40 for bml by
<li class="footer">Generated on Wed Sep 9 2020 19:37:59 for bml by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17 </li>
</ul>
</div>
</body>
Expand Down
28 changes: 16 additions & 12 deletions docs/API/annotated.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="generator" content="Doxygen 1.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>bml: Class List</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
Expand All @@ -13,9 +13,6 @@
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
Expand All @@ -24,7 +21,8 @@
extensions: ["tex2jax.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
</script>
<script type="text/javascript" async="async" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
Expand All @@ -35,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.0</span>
&#160;<span id="projectnumber">1.3.1</span>
</div>
<div id="projectbrief">Basic Matrix Library (bml): A matrix library for linear algebra operations, supporting several data structures.</div>
</td>
Expand All @@ -44,18 +42,21 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
Expand All @@ -69,7 +70,9 @@
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('annotated.html','');});
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('annotated.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
Expand All @@ -94,16 +97,17 @@
<div class="textblock">Here are the classes, structs, unions and interfaces with brief descriptions:</div><div class="directory">
<table class="directory">
<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>
<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>
</table>
</div><!-- directory -->
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated on Wed May 23 2018 06:11:40 for bml by
<li class="footer">Generated on Wed Sep 9 2020 19:37:59 for bml by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17 </li>
</ul>
</div>
</body>
Expand Down
3 changes: 2 additions & 1 deletion docs/API/annotated_dup.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
var annotated_dup =
[
[ "bml_domain_t", "structbml__domain__t.html", "structbml__domain__t" ]
[ "bml_domain_t", "structbml__domain__t.html", "structbml__domain__t" ],
[ "bml_matrix_dimension_t", "structbml__matrix__dimension__t.html", "structbml__matrix__dimension__t" ]
];
174 changes: 160 additions & 14 deletions docs/API/blas_8h_source.html
View file
Open in desktop

Large diffs are not rendered by default.

Loading