Skip to content

Commit

Permalink
Merge pull request #1208 from sys-bio/add-PT-docs
Browse files Browse the repository at this point in the history
Add some documentation for the GetPiecewiseTriggersCodeGen class.
  • Loading branch information
luciansmith authored Mar 27, 2024
2 parents 1a38325 + 8296add commit 92d063b
Show file tree
Hide file tree
Showing 328 changed files with 5,271 additions and 2,780 deletions.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file added docs/docs-build/.doctrees/accessing_model.doctree
Binary file not shown.
Binary file added docs/docs-build/.doctrees/bifurcation.doctree
Binary file not shown.
Binary file added docs/docs-build/.doctrees/environment.pickle
Binary file not shown.
Binary file added docs/docs-build/.doctrees/metabolic.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file added docs/docs-build/.doctrees/stability.doctree
Binary file not shown.
Binary file added docs/docs-build/.doctrees/steady_state.doctree
Binary file not shown.
Binary file added docs/docs-build/.doctrees/stochastic.doctree
Binary file not shown.
Binary file added docs/docs-build/.doctrees/stoichiometric.doctree
Binary file not shown.
Binary file not shown.
Binary file modified docs/docs-build/docs-build/.doctrees/environment.pickle
Binary file not shown.
143 changes: 143 additions & 0 deletions docs/doxygen-output/html/GetPiecewiseTriggerCodeGen_8h_source.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,143 @@
<!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.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>roadrunner: llvm/GetPiecewiseTriggerCodeGen.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">roadrunner
&#160;<span id="projectnumber">2.6.0</span>
</div>
<div id="projectbrief">Fast simulator for SBML models</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<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','.html');
/* @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_86ef421483dbf1ca9f08de3e5d2b2c52.html">llvm</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">GetPiecewiseTriggerCodeGen.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/*</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"> * GetPiecewiseTriggerCodeGen.h</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160; </div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="preprocessor">#ifndef RRLLVMGetPiecewiseTriggerCodeGen_H_</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="preprocessor">#define RRLLVMGetPiecewiseTriggerCodeGen_H_</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160; </div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="preprocessor">#include &quot;CodeGenBase.h&quot;</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="preprocessor">#include &quot;ModelGeneratorContext.h&quot;</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="preprocessor">#include &quot;SymbolForest.h&quot;</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="preprocessor">#include &quot;ASTNodeCodeGen.h&quot;</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="preprocessor">#include &quot;ASTNodeFactory.h&quot;</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="preprocessor">#include &quot;ModelDataIRBuilder.h&quot;</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="preprocessor">#include &quot;ModelDataSymbolResolver.h&quot;</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="preprocessor">#include &quot;LLVMException.h&quot;</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="preprocessor">#include &quot;rrLogger.h&quot;</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="preprocessor">#include &lt;sbml/Model.h&gt;</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="preprocessor">#include &lt;Poco/Logger.h&gt;</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#include &lt;vector&gt;</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="preprocessor">#include &lt;cstdio&gt;</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; </div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="keyword">namespace </span>rrllvm</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">//Based on GetEventTriggerCodeGen (-LS)</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; </div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; <span class="keyword">typedef</span> <span class="keywordtype">unsigned</span> char (*GetPiecewiseTriggerCodeGen_FunctionPtr)(LLVMModelData*, size_t);</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; </div>
<div class="line"><a name="l00032"></a><span class="lineno"><a class="line" href="classrrllvm_1_1GetPiecewiseTriggerCodeGen.html"> 32</a></span>&#160; <span class="keyword">class </span><a class="code" href="classrrllvm_1_1GetPiecewiseTriggerCodeGen.html">GetPiecewiseTriggerCodeGen</a> :</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; <span class="keyword">public</span> <a class="code" href="classrrllvm_1_1CodeGenBase.html">CodeGenBase</a>&lt;GetPiecewiseTriggerCodeGen_FunctionPtr&gt;</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; {</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; <span class="keyword">public</span>:</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; <a class="code" href="classrrllvm_1_1GetPiecewiseTriggerCodeGen.html">GetPiecewiseTriggerCodeGen</a>(<span class="keyword">const</span> <a class="code" href="classrrllvm_1_1ModelGeneratorContext.html">ModelGeneratorContext</a>&amp; mgc);</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; <span class="keyword">virtual</span> ~<a class="code" href="classrrllvm_1_1GetPiecewiseTriggerCodeGen.html">GetPiecewiseTriggerCodeGen</a>() {};</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; </div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; llvm::Value* <a class="code" href="classrrllvm_1_1GetPiecewiseTriggerCodeGen.html#abd60003c2ef224226f4cc1799f5fbb35">codeGen</a>();</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; </div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; <span class="keyword">typedef</span> GetPiecewiseTriggerCodeGen_FunctionPtr FunctionPtr;</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; </div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* FunctionName;</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* IndexArgName;</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; </div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; llvm::Type* <a class="code" href="classrrllvm_1_1GetPiecewiseTriggerCodeGen.html#a33342e6171e484cbdbccec15ad011d64">getRetType</a>();</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; </div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; llvm::Value* <a class="code" href="classrrllvm_1_1GetPiecewiseTriggerCodeGen.html#a2b6a29ab3b46c75c3465ac8da143ce14">createRet</a>(llvm::Value*);</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; </div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; <span class="keyword">private</span>:</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; <span class="keyword">const</span> std::vector&lt;libsbml::ASTNode*&gt;* piecewiseTriggers;</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; };</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; </div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; </div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160;} <span class="comment">/* namespace rr */</span></div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; </div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; </div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; </div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; </div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160;<span class="preprocessor">#endif </span><span class="comment">/* RRLLVMGETVALUECODEGENBASE_H_ */</span><span class="preprocessor"></span></div>
<div class="ttc" id="aclassrrllvm_1_1CodeGenBase_html"><div class="ttname"><a href="classrrllvm_1_1CodeGenBase.html">rrllvm::CodeGenBase</a></div><div class="ttdoc">a convenience class to pull the vars out of a context, and store them as ivars.</div><div class="ttdef"><b>Definition:</b> CodeGenBase.h:54</div></div>
<div class="ttc" id="aclassrrllvm_1_1GetPiecewiseTriggerCodeGen_html"><div class="ttname"><a href="classrrllvm_1_1GetPiecewiseTriggerCodeGen.html">rrllvm::GetPiecewiseTriggerCodeGen</a></div><div class="ttdoc">Class for getting piecewise trigger values.</div><div class="ttdef"><b>Definition:</b> GetPiecewiseTriggerCodeGen.h:34</div></div>
<div class="ttc" id="aclassrrllvm_1_1GetPiecewiseTriggerCodeGen_html_a2b6a29ab3b46c75c3465ac8da143ce14"><div class="ttname"><a href="classrrllvm_1_1GetPiecewiseTriggerCodeGen.html#a2b6a29ab3b46c75c3465ac8da143ce14">rrllvm::GetPiecewiseTriggerCodeGen::createRet</a></div><div class="ttdeci">llvm::Value * createRet(llvm::Value *)</div><div class="ttdoc">create a return type, a zero value should return the default type</div><div class="ttdef"><b>Definition:</b> GetPiecewiseTriggerCodeGen.cpp:90</div></div>
<div class="ttc" id="aclassrrllvm_1_1GetPiecewiseTriggerCodeGen_html_a33342e6171e484cbdbccec15ad011d64"><div class="ttname"><a href="classrrllvm_1_1GetPiecewiseTriggerCodeGen.html#a33342e6171e484cbdbccec15ad011d64">rrllvm::GetPiecewiseTriggerCodeGen::getRetType</a></div><div class="ttdeci">llvm::Type * getRetType()</div><div class="ttdoc">The ret type is a boolean, aka 'getInt8Ty'.</div><div class="ttdef"><b>Definition:</b> GetPiecewiseTriggerCodeGen.cpp:85</div></div>
<div class="ttc" id="aclassrrllvm_1_1GetPiecewiseTriggerCodeGen_html_abd60003c2ef224226f4cc1799f5fbb35"><div class="ttname"><a href="classrrllvm_1_1GetPiecewiseTriggerCodeGen.html#abd60003c2ef224226f4cc1799f5fbb35">rrllvm::GetPiecewiseTriggerCodeGen::codeGen</a></div><div class="ttdeci">llvm::Value * codeGen()</div><div class="ttdoc">The heart of the class, that creates code blocks for every piecewise trigger in the model.</div><div class="ttdef"><b>Definition:</b> GetPiecewiseTriggerCodeGen.cpp:29</div></div>
<div class="ttc" id="aclassrrllvm_1_1ModelGeneratorContext_html"><div class="ttname"><a href="classrrllvm_1_1ModelGeneratorContext.html">rrllvm::ModelGeneratorContext</a></div><div class="ttdoc">All LLVM code generating objects basically need at a minimum three things to operate:</div><div class="ttdef"><b>Definition:</b> ModelGeneratorContext.h:95</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
</small></address>
</body>
</html>
2 changes: 1 addition & 1 deletion docs/doxygen-output/html/annotated.html
Original file line number Diff line number Diff line change
Expand Up @@ -195,7 +195,7 @@
<tr id="row_1_28_" class="even" style="display:none;"><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="classrrllvm_1_1GetBoundarySpeciesInitAmountCodeGen.html" target="_self">GetBoundarySpeciesInitAmountCodeGen</a></td><td class="desc">Get the initial amount of a boundary species </td></tr>
<tr id="row_1_29_" class="even" style="display:none;"><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="classrrllvm_1_1GetCompartmentInitVolumeCodeGen.html" target="_self">GetCompartmentInitVolumeCodeGen</a></td><td class="desc">Get the initial volume of a compartment </td></tr>
<tr id="row_1_30_" class="even" style="display:none;"><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="classrrllvm_1_1GetGlobalParameterInitValueCodeGen.html" target="_self">GetGlobalParameterInitValueCodeGen</a></td><td class="desc">Get the initial value of a parameter </td></tr>
<tr id="row_1_31_" class="even" style="display:none;"><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="classrrllvm_1_1GetPiecewiseTriggerCodeGen.html" target="_self">GetPiecewiseTriggerCodeGen</a></td><td class="desc"></td></tr>
<tr id="row_1_31_" class="even" style="display:none;"><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="classrrllvm_1_1GetPiecewiseTriggerCodeGen.html" target="_self">GetPiecewiseTriggerCodeGen</a></td><td class="desc">Class for getting piecewise trigger values </td></tr>
<tr id="row_1_32_" class="even" style="display:none;"><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="classrrllvm_1_1GetValueCodeGenBase.html" target="_self">GetValueCodeGenBase</a></td><td class="desc">Base class for getting the current value of an element </td></tr>
<tr id="row_1_33_" class="even" style="display:none;"><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="classrrllvm_1_1GetBoundarySpeciesAmountCodeGen.html" target="_self">GetBoundarySpeciesAmountCodeGen</a></td><td class="desc">Get the current amount of a boundary species </td></tr>
<tr id="row_1_34_" class="even" style="display:none;"><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="classrrllvm_1_1GetFloatingSpeciesAmountCodeGen.html" target="_self">GetFloatingSpeciesAmountCodeGen</a></td><td class="desc">Get the current amount of a floating species </td></tr>
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 92d063b

Please sign in to comment.