Skip to content

Commit

Permalink
Update api and impl docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@Bo-Yuan-Huang
Bo-Yuan-Huang committed Feb 14, 2018
1 parent 5dae75d commit df4fa91
Show file tree
Hide file tree
Showing 999 changed files with 46,249 additions and 2,574 deletions.
3 changes: 2 additions & 1 deletion README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,8 @@ For some examples, see the [examples](https://github.com/Bo-Yuan-Huang/ILA-Tools
cmake .. -L -DZ3_INCLUDE_DIR=/usr/include
```

For API documentations, see the page [ILA-Tools-API](https://rawgit.com/Bo-Yuan-Huang/ILA-Tools/master/docs/html/namespaceila.html).
For API documentation, see the page [ILA-Tools-API](https://rawgit.com/Bo-Yuan-Huang/ILA-Tools/master/docs/api-html/namespaceila.html).
For developers, implementation details can be found on [ILA-Tools-Impl](https://rawgit.com/Bo-Yuan-Huang/ILA-Tools/master/docs/impl-html/namespaceila.html).


### Publications:
Expand Down
84 changes: 84 additions & 0 deletions docs/api-html/annotated.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Instruction-Level Abstraction (ILA): Class List</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>
<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>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Instruction-Level Abstraction (ILA)
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<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(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
<div class="headertitle">
<div class="title">Class List</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock">Here are the classes, structs, unions and interfaces with brief descriptions:</div><div class="directory">
<div class="levels">[detail level <span onclick="javascript:toggleLevel(1);">1</span><span onclick="javascript:toggleLevel(2);">2</span>]</div><table class="directory">
<tr id="row_0_" class="even"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_0_" class="arrow" onclick="toggleFolder('0_')">&#9660;</span><span class="icona"><span class="icon">N</span></span><b>ila</b></td><td class="desc"></td></tr>
<tr id="row_0_0_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classila_1_1_expr_ref.html" target="_self">ExprRef</a></td><td class="desc">The wrapper of Expr (e.g. state var, var relation, constant, etc) </td></tr>
<tr id="row_0_1_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classila_1_1_ila.html" target="_self">Ila</a></td><td class="desc">The wrapper of InstrLvlAbs (ILA) </td></tr>
<tr id="row_0_2_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classila_1_1_instr_ref.html" target="_self">InstrRef</a></td><td class="desc">The wrapper of Instr (instruction) </td></tr>
</table>
</div><!-- directory -->
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.14
</small></address>
</body>
</html>
0 docs/html/ast_8h.html → docs/api-html/ast_8h.html
View file
File renamed without changes.
91 changes: 91 additions & 0 deletions docs/api-html/ast_8h_source.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Instruction-Level Abstraction (ILA): ast.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>
<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>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Instruction-Level Abstraction (ILA)
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<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(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_1d4c2ac98f65408aa2107c1b7aa8cf4e.html">ila</a></li><li class="navelem"><a class="el" href="dir_208ed2a1cf436e31b62d5525d9105147.html">ast</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">ast.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="ast_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;</div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="preprocessor">#ifndef AST_H__</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="preprocessor">#define AST_H__</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;</div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="object_8h.html">ila/object.h</a>&quot;</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="preprocessor">#include &quot;z3++.h&quot;</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="preprocessor">#include &lt;memory&gt;</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="preprocessor">#include &lt;string&gt;</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;</div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespaceila.html">ila</a> {</div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;</div><div class="line"><a name="l00017"></a><span class="lineno"><a class="line" href="classila_1_1_ast.html"> 17</a></span>&#160;<span class="keyword">class </span><a class="code" href="classila_1_1_ast.html">Ast</a> : <span class="keyword">public</span> <a class="code" href="classila_1_1_object.html">Object</a> {</div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="keyword">public</span>:</div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; <span class="comment">// ------------------------- CONSTRUCTOR/DESTRUCTOR ----------------------- //</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="comment"></span> <a class="code" href="classila_1_1_ast.html#af78f2889fb8c3ddd84d8242806931be9">Ast</a>();</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; <span class="keyword">virtual</span> <a class="code" href="classila_1_1_ast.html#a15196e2239c77e59664515976ed712c9">~Ast</a>();</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; <span class="comment">// ------------------------- ACCESSORS/MUTATORS --------------------------- //</span></div><div class="line"><a name="l00027"></a><span class="lineno"><a class="line" href="classila_1_1_ast.html#a52684b06145dd797133a4363b7309ef5"> 27</a></span>&#160;<span class="comment"></span> <span class="keywordtype">bool</span> <a class="code" href="classila_1_1_ast.html#a52684b06145dd797133a4363b7309ef5">is_ast</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <span class="keyword">true</span>; }</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;</div><div class="line"><a name="l00030"></a><span class="lineno"><a class="line" href="classila_1_1_ast.html#aaa853bd982ecf54826c7208ce30551cf"> 30</a></span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classila_1_1_ast.html#aaa853bd982ecf54826c7208ce30551cf">is_sort</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <span class="keyword">false</span>; }</div><div class="line"><a name="l00032"></a><span class="lineno"><a class="line" href="classila_1_1_ast.html#a487c10d9960f7b639c0ea0992881cfb1"> 32</a></span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classila_1_1_ast.html#a487c10d9960f7b639c0ea0992881cfb1">is_expr</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <span class="keyword">false</span>; }</div><div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="classila_1_1_ast.html#afb266da2036c520a369da09090b91b99"> 34</a></span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classila_1_1_ast.html#afb266da2036c520a369da09090b91b99">is_func</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <span class="keyword">false</span>; }</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; <span class="comment">// ------------------------- METHODS -------------------------------------- //</span></div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; <span class="keyword">virtual</span> std::ostream&amp; <a class="code" href="classila_1_1_ast.html#a0206864a2b1cc2f603fefa64f4525e56">Print</a>(std::ostream&amp; out) <span class="keyword">const</span> = 0;</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;<span class="keyword">private</span>:</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; <span class="comment">// ------------------------- MEMBERS -------------------------------------- //</span></div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; <span class="comment">// ------------------------- HELPERS -------------------------------------- //</span></div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;}; <span class="comment">// class Ast</span></div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;} <span class="comment">// namespace ila</span></div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;<span class="preprocessor">#endif // AST_H__</span></div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;</div><div class="ttc" id="classila_1_1_ast_html_a15196e2239c77e59664515976ed712c9"><div class="ttname"><a href="classila_1_1_ast.html#a15196e2239c77e59664515976ed712c9">ila::Ast::~Ast</a></div><div class="ttdeci">virtual ~Ast()</div><div class="ttdoc">Default destructor. </div></div>
<div class="ttc" id="classila_1_1_ast_html_af78f2889fb8c3ddd84d8242806931be9"><div class="ttname"><a href="classila_1_1_ast.html#af78f2889fb8c3ddd84d8242806931be9">ila::Ast::Ast</a></div><div class="ttdeci">Ast()</div><div class="ttdoc">Default constructor. </div></div>
<div class="ttc" id="classila_1_1_ast_html_a487c10d9960f7b639c0ea0992881cfb1"><div class="ttname"><a href="classila_1_1_ast.html#a487c10d9960f7b639c0ea0992881cfb1">ila::Ast::is_expr</a></div><div class="ttdeci">virtual bool is_expr() const</div><div class="ttdoc">Is type Ast::Expr. </div><div class="ttdef"><b>Definition:</b> ast.h:32</div></div>
<div class="ttc" id="classila_1_1_ast_html_afb266da2036c520a369da09090b91b99"><div class="ttname"><a href="classila_1_1_ast.html#afb266da2036c520a369da09090b91b99">ila::Ast::is_func</a></div><div class="ttdeci">virtual bool is_func() const</div><div class="ttdoc">Is type Ast::Func. </div><div class="ttdef"><b>Definition:</b> ast.h:34</div></div>
<div class="ttc" id="classila_1_1_ast_html_a52684b06145dd797133a4363b7309ef5"><div class="ttname"><a href="classila_1_1_ast.html#a52684b06145dd797133a4363b7309ef5">ila::Ast::is_ast</a></div><div class="ttdeci">bool is_ast() const</div><div class="ttdoc">Is type Ast. </div><div class="ttdef"><b>Definition:</b> ast.h:27</div></div>
<div class="ttc" id="classila_1_1_ast_html"><div class="ttname"><a href="classila_1_1_ast.html">ila::Ast</a></div><div class="ttdoc">The class for the Abstract Syntax Tree. An Ast object can be an expression or function definition (in...</div><div class="ttdef"><b>Definition:</b> ast.h:17</div></div>
<div class="ttc" id="object_8h_html"><div class="ttname"><a href="object_8h.html">object.h</a></div></div>
<div class="ttc" id="namespaceila_html"><div class="ttname"><a href="namespaceila.html">ila</a></div></div>
<div class="ttc" id="classila_1_1_ast_html_a0206864a2b1cc2f603fefa64f4525e56"><div class="ttname"><a href="classila_1_1_ast.html#a0206864a2b1cc2f603fefa64f4525e56">ila::Ast::Print</a></div><div class="ttdeci">virtual std::ostream &amp; Print(std::ostream &amp;out) const =0</div><div class="ttdoc">Output function. </div></div>
<div class="ttc" id="classila_1_1_ast_html_aaa853bd982ecf54826c7208ce30551cf"><div class="ttname"><a href="classila_1_1_ast.html#aaa853bd982ecf54826c7208ce30551cf">ila::Ast::is_sort</a></div><div class="ttdeci">virtual bool is_sort() const</div><div class="ttdoc">Is type Ast::Sort. </div><div class="ttdef"><b>Definition:</b> ast.h:30</div></div>
<div class="ttc" id="classila_1_1_object_html"><div class="ttname"><a href="classila_1_1_object.html">ila::Object</a></div><div class="ttdoc">The basest type in the ILA structure. It can be either Ast, Instr, or InstrLvlAbs. </div><div class="ttdef"><b>Definition:</b> object.h:16</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.14
</small></address>
</body>
</html>
0 docs/html/bc_s.png → docs/api-html/bc_s.png
View file
File renamed without changes
0 docs/html/bdwn.png → docs/api-html/bdwn.png
View file
File renamed without changes
0 docs/html/bmc_8h.html → docs/api-html/bmc_8h.html
View file
File renamed without changes.
Loading

0 comments on commit df4fa91

Please sign in to comment.