forked from AndySomogyi/sbmlsolver
-
Notifications
You must be signed in to change notification settings - Fork 25
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1208 from sys-bio/add-PT-docs
Add some documentation for the GetPiecewiseTriggersCodeGen class.
- Loading branch information
Showing
328 changed files
with
5,271 additions
and
2,780 deletions.
There are no files selected for viewing
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file added
BIN
+25.9 KB
docs/docs-build/.doctrees/C++APIReference/ExecutableModelFactory.doctree
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
BIN
+37.4 KB
docs/docs-build/.doctrees/C++APIReference/llvm/ASTNodeFactory.doctree
Binary file not shown.
Binary file added
BIN
+19 KB
docs/docs-build/.doctrees/C++APIReference/llvm/AssignmentRuleEvaluator.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file added
BIN
+18.4 KB
docs/docs-build/.doctrees/C++APIReference/llvm/EvalConversionFactorCodeGen.doctree
Binary file not shown.
Binary file added
BIN
+53.4 KB
docs/docs-build/.doctrees/C++APIReference/llvm/EvalInitialConditionsCodeGen.doctree
Binary file not shown.
Binary file added
BIN
+20.8 KB
docs/docs-build/.doctrees/C++APIReference/llvm/EvalRateRuleRatesCodeGen.doctree
Binary file not shown.
Binary file added
BIN
+20.8 KB
docs/docs-build/.doctrees/C++APIReference/llvm/EvalReactionRatesCodeGen.doctree
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
BIN
+3.4 KB
docs/docs-build/.doctrees/C++APIReference/rrSBMLModelSimulation.doctree
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.
143 changes: 143 additions & 0 deletions
143
docs/doxygen-output/html/GetPiecewiseTriggerCodeGen_8h_source.html
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
 <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&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&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> <span class="comment">/*</span></div> | ||
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * GetPiecewiseTriggerCodeGen.h</span></div> | ||
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> *</span></div> | ||
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> */</span></div> | ||
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>  </div> | ||
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="preprocessor">#ifndef RRLLVMGetPiecewiseTriggerCodeGen_H_</span></div> | ||
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="preprocessor">#define RRLLVMGetPiecewiseTriggerCodeGen_H_</span></div> | ||
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>  </div> | ||
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="preprocessor">#include "CodeGenBase.h"</span></div> | ||
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="preprocessor">#include "ModelGeneratorContext.h"</span></div> | ||
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor">#include "SymbolForest.h"</span></div> | ||
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="preprocessor">#include "ASTNodeCodeGen.h"</span></div> | ||
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#include "ASTNodeFactory.h"</span></div> | ||
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#include "ModelDataIRBuilder.h"</span></div> | ||
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#include "ModelDataSymbolResolver.h"</span></div> | ||
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor">#include "LLVMException.h"</span></div> | ||
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#include "rrLogger.h"</span></div> | ||
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#include <sbml/Model.h></span></div> | ||
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#include <Poco/Logger.h></span></div> | ||
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#include <vector></span></div> | ||
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#include <cstdio></span></div> | ||
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  </div> | ||
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="keyword">namespace </span>rrllvm</div> | ||
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> {</div> | ||
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  <span class="comment">//Based on GetEventTriggerCodeGen (-LS)</span></div> | ||
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  </div> | ||
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  <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>  </div> | ||
<div class="line"><a name="l00032"></a><span class="lineno"><a class="line" href="classrrllvm_1_1GetPiecewiseTriggerCodeGen.html"> 32</a></span>  <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>  <span class="keyword">public</span> <a class="code" href="classrrllvm_1_1CodeGenBase.html">CodeGenBase</a><GetPiecewiseTriggerCodeGen_FunctionPtr></div> | ||
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  {</div> | ||
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  <span class="keyword">public</span>:</div> | ||
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  <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>& mgc);</div> | ||
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  <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>  </div> | ||
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  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>  </div> | ||
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <span class="keyword">typedef</span> GetPiecewiseTriggerCodeGen_FunctionPtr FunctionPtr;</div> | ||
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  </div> | ||
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <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>  <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>  </div> | ||
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  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>  </div> | ||
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  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>  </div> | ||
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="keyword">private</span>:</div> | ||
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="keyword">const</span> std::vector<libsbml::ASTNode*>* piecewiseTriggers;</div> | ||
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  };</div> | ||
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  </div> | ||
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  </div> | ||
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> } <span class="comment">/* namespace rr */</span></div> | ||
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  </div> | ||
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  </div> | ||
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  </div> | ||
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  </div> | ||
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <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 <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> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Oops, something went wrong.