Skip to content

Commit 10a5fd2

Browse files
traviscibottraviscibot
committed
Deploy bat/bat-docs to github.com/bat/bat-docs.git:master
0 parents  commit 10a5fd2

File tree

1,055 files changed

+147493
-0
lines changed

Some content is hidden

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

1,055 files changed

+147493
-0
lines changed

‎master/manual/BAT-manual.pdf

873 KB
Binary file not shown.

‎master/manual/html/INSTALL_8md_source.html

+122
Large diffs are not rendered by default.

‎master/manual/html/arrowdown.png

244 Bytes
Loading

‎master/manual/html/arrowright.png

227 Bytes
Loading

‎master/manual/html/bat.svg

+54
Loading

‎master/manual/html/bayes_8md_source.html

+122
Large diffs are not rendered by default.

‎master/manual/html/bc_s.png

663 Bytes
Loading

‎master/manual/html/bdwn.png

143 Bytes
Loading

‎master/manual/html/cha-Bayes.html

+166
Large diffs are not rendered by default.

‎master/manual/html/cha-basics.html

+285
Large diffs are not rendered by default.

‎master/manual/html/cha-code-structure.html

+134
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,134 @@
1+
<!-- HTML header for doxygen 1.8.8-->
2+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3+
<html xmlns="http://www.w3.org/1999/xhtml">
4+
<head>
5+
<meta http-equiv="X-UA-Compatible" content="IE=edge">
6+
<!-- For Mobile Devices -->
7+
<meta name="viewport" content="width=device-width, initial-scale=1">
8+
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
9+
<meta name="generator" content="Doxygen 1.8.11"/>
10+
<script type="text/javascript" src="https://code.jquery.com/jquery-2.1.1.min.js"></script>
11+
<title>BAT manual: Structure of the Code</title>
12+
<!--<link href="tabs.css" rel="stylesheet" type="text/css"/>-->
13+
<script type="text/javascript" src="dynsections.js"></script>
14+
<link href="search/search.css" rel="stylesheet" type="text/css"/>
15+
<script type="text/javascript" src="search/searchdata.js"></script>
16+
<script type="text/javascript" src="search/search.js"></script>
17+
<script type="text/javascript">
18+
$(document).ready(function() { init_search(); });
19+
</script>
20+
<script type="text/x-mathjax-config">
21+
MathJax.Hub.Config({
22+
extensions: ["tex2jax.js", "TeX/AMSmath.js", "TeX/AMSsymbols.js"],
23+
jax: ["input/TeX","output/HTML-CSS"],
24+
});
25+
MathJax.Hub.Config({
26+
TeX: {
27+
Macros: {
28+
cond: ["{\\,|\\,}"],
29+
diag: ["{\\mbox{diag}}"],
30+
matsig: ["{\\boldsymbol{\\Sigma}}"],
31+
rmdx: ["{\\mbox{d}#1\\,}",1],
32+
scath: ["{\\theta}"],
33+
vecmu: ["{\\boldsymbol{\\mu}}"],
34+
vecth: ["{\\boldsymbol{\\theta}}"],
35+
order: ["{\\mathcal{O}(#1)}",1],
36+
}
37+
}
38+
});
39+
</script><script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.4/latest.js?config=TeX-MML-AM_CHTML/MathJax.js"></script>
40+
<link href="doxygen.css" rel="stylesheet" type="text/css" />
41+
<link href="customdoxygen.css" rel="stylesheet" type="text/css"/>
42+
<link href='https://fonts.googleapis.com/css?family=Roboto+Slab' rel='stylesheet' type='text/css'>
43+
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.1/css/bootstrap.min.css">
44+
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.1/js/bootstrap.min.js"></script>
45+
<script type="text/javascript" src="doxy-boot.js"></script>
46+
</head>
47+
<body>
48+
<nav class="navbar navbar-default" role="navigation">
49+
<div class="container">
50+
<div class="navbar-header">
51+
<a class="navbar-brand">BAT manual 1.0.0</a>
52+
</div>
53+
</div>
54+
</nav>
55+
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
56+
<div class="content" id="content">
57+
<div class="container">
58+
<div class="row">
59+
<div class="col-sm-12 panel " style="padding-bottom: 15px;">
60+
<div style="margin-bottom: 15px;">
61+
<!-- end header part -->
62+
<!-- Generated by Doxygen 1.8.11 -->
63+
<script type="text/javascript">
64+
var searchBox = new SearchBox("searchBox", "search",false,'Search');
65+
</script>
66+
<div id="navrow1" class="tabs">
67+
<ul class="tablist">
68+
<li><a href="index.html"><span>Overview</span></a></li>
69+
<li class="current"><a href="pages.html"><span>Chapters</span></a></li>
70+
<li>
71+
<div id="MSearchBox" class="MSearchBoxInactive">
72+
<span class="left">
73+
<img id="MSearchSelect" src="search/mag_sel.png"
74+
onmouseover="return searchBox.OnSearchSelectShow()"
75+
onmouseout="return searchBox.OnSearchSelectHide()"
76+
alt=""/>
77+
<input type="text" id="MSearchField" value="Search" accesskey="S"
78+
onfocus="searchBox.OnSearchFieldFocus(true)"
79+
onblur="searchBox.OnSearchFieldFocus(false)"
80+
onkeyup="searchBox.OnSearchFieldChange(event)"/>
81+
</span><span class="right">
82+
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
83+
</span>
84+
</div>
85+
</li>
86+
</ul>
87+
</div>
88+
<!-- window showing the filter options -->
89+
<div id="MSearchSelectWindow"
90+
onmouseover="return searchBox.OnSearchSelectShow()"
91+
onmouseout="return searchBox.OnSearchSelectHide()"
92+
onkeydown="return searchBox.OnSearchSelectKey(event)">
93+
</div>
94+
95+
<!-- iframe showing the search results (closed by default) -->
96+
<div id="MSearchResultsWindow">
97+
<iframe src="javascript:void(0)" frameborder="0"
98+
name="MSearchResults" id="MSearchResults">
99+
</iframe>
100+
</div>
101+
102+
</div><!-- top -->
103+
<div class="header">
104+
<div class="headertitle">
105+
<div class="title">Structure of the Code </div> </div>
106+
</div><!--header-->
107+
<div class="contents">
108+
<div class="textblock"><p>BAT is object-oriented and uses inheritance for code reuse. The single most important hierarchy is that of <code><a class="elRef" doxygen="/root/bat/doc/ref-guide/bat-ref.tag:../../ref-guide/html/" href="../../ref-guide/html/classBCModel.html">BCModel</a></code>. In most applications, a user would implement a model <code>MyModel</code> by either inheriting from <code><a class="elRef" doxygen="/root/bat/doc/ref-guide/bat-ref.tag:../../ref-guide/html/" href="../../ref-guide/html/classBCModel.html">BCModel</a></code> directly or creating an instance of one of the <a class="el" href="cha-predefined-models.html">Predefined Models</a> and thus would inherit from <code><a class="elRef" doxygen="/root/bat/doc/ref-guide/bat-ref.tag:../../ref-guide/html/" href="../../ref-guide/html/classBCModel.html">BCModel</a></code> indirectly.</p>
109+
<div align="center">
110+
<iframe scrolling="no" frameborder="0" src="dot_inline_dotgraph_1.svg" width="166" height="251"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
111+
<p>
112+
The boxes on the diagram are links to the reference guide for the respective classes.
113+
</p>
114+
<p>This structure has the benefit that <code>MyModel</code> has native access to all things related to Markov chains due to <code><a class="elRef" doxygen="/root/bat/doc/ref-guide/bat-ref.tag:../../ref-guide/html/" href="../../ref-guide/html/classBCEngineMCMC.html">BCEngineMCMC</a></code> and one can immediately optimize or integrate the posterior with the methods in <code><a class="elRef" doxygen="/root/bat/doc/ref-guide/bat-ref.tag:../../ref-guide/html/" href="../../ref-guide/html/classBCIntegrate.html">BCIntegrate</a></code>. However, one has to keep in mind that multiple Markov chains for the <em>same</em> instance of <code>MyModel</code> share the entire state of the object. This can lead to complications when <code>MyModel::LogLikelihood</code> is called concurrently; see <a class="el" href="cha-threading.html">Multithreading and Thread Safety</a> for more details.</p>
115+
<p>
116+
<br/><br/>
117+
Return to the <a href="cha-predefined-models.html">previous</a> section or go to the
118+
<a href="cha-output.html">next</a> section.
119+
</p>
120+
</div></div><!-- contents -->
121+
<!-- HTML footer for doxygen 1.8.8-->
122+
<!-- start footer part -->
123+
</div>
124+
</div>
125+
</div>
126+
</div>
127+
</div>
128+
<!-- <hr class="footer"/><address class="footer"><small> -->
129+
<!-- Generated on Fri May 18 2018 12:43:13 for BAT manual by &#160;<a href="http://www.doxygen.org/index.html"> -->
130+
<!-- <img class="footer" src="doxygen.png" alt="doxygen"/> -->
131+
<!-- </a> 1.8.11 -->
132+
<!-- </small></address> -->
133+
</body>
134+
</html>

0 commit comments

Comments
 (0)