Skip to content

Commit 37a9a74

Browse files
committed
Auto-deploy documentation
1 parent 770c363 commit 37a9a74

File tree

255 files changed

+31717
-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.

255 files changed

+31717
-0
lines changed

docs/Agent_8hpp.html

Lines changed: 144 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,144 @@
1+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2+
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
3+
<head>
4+
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5+
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
6+
<meta name="generator" content="Doxygen 1.13.1"/>
7+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
8+
<title>Dynamical system model: src/dsm/headers/Agent.hpp File Reference</title>
9+
<link href="tabs.css" rel="stylesheet" type="text/css"/>
10+
<script type="text/javascript" src="jquery.js"></script>
11+
<script type="text/javascript" src="dynsections.js"></script>
12+
<script type="text/javascript" src="clipboard.js"></script>
13+
<link href="navtree.css" rel="stylesheet" type="text/css"/>
14+
<script type="text/javascript" src="navtreedata.js"></script>
15+
<script type="text/javascript" src="navtree.js"></script>
16+
<script type="text/javascript" src="resize.js"></script>
17+
<script type="text/javascript" src="cookie.js"></script>
18+
<link href="search/search.css" rel="stylesheet" type="text/css"/>
19+
<script type="text/javascript" src="search/searchdata.js"></script>
20+
<script type="text/javascript" src="search/search.js"></script>
21+
<link href="doxygen.css" rel="stylesheet" type="text/css" />
22+
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
23+
</head>
24+
<body>
25+
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
26+
<div id="titlearea">
27+
<table cellspacing="0" cellpadding="0">
28+
<tbody>
29+
<tr id="projectrow">
30+
<td id="projectalign">
31+
<div id="projectname">Dynamical system model
32+
</div>
33+
</td>
34+
</tr>
35+
</tbody>
36+
</table>
37+
</div>
38+
<!-- end header part -->
39+
<!-- Generated by Doxygen 1.13.1 -->
40+
<script type="text/javascript">
41+
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
42+
var searchBox = new SearchBox("searchBox", "search/",'.html');
43+
/* @license-end */
44+
</script>
45+
<script type="text/javascript">
46+
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
47+
$(function() { codefold.init(0); });
48+
/* @license-end */
49+
</script>
50+
<script type="text/javascript" src="menudata.js"></script>
51+
<script type="text/javascript" src="menu.js"></script>
52+
<script type="text/javascript">
53+
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
54+
$(function() {
55+
initMenu('',true,false,'search.php','Search',true);
56+
$(function() { init_search(); });
57+
});
58+
/* @license-end */
59+
</script>
60+
<div id="main-nav"></div>
61+
</div><!-- top -->
62+
<div id="side-nav" class="ui-resizable side-nav-resizable">
63+
<div id="nav-tree">
64+
<div id="nav-tree-contents">
65+
<div id="nav-sync" class="sync"></div>
66+
</div>
67+
</div>
68+
<div id="splitbar" style="-moz-user-select:none;"
69+
class="ui-resizable-handle">
70+
</div>
71+
</div>
72+
<script type="text/javascript">
73+
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
74+
$(function(){initNavTree('Agent_8hpp.html',''); initResizable(true); });
75+
/* @license-end */
76+
</script>
77+
<div id="doc-content">
78+
<!-- window showing the filter options -->
79+
<div id="MSearchSelectWindow"
80+
onmouseover="return searchBox.OnSearchSelectShow()"
81+
onmouseout="return searchBox.OnSearchSelectHide()"
82+
onkeydown="return searchBox.OnSearchSelectKey(event)">
83+
</div>
84+
85+
<!-- iframe showing the search results (closed by default) -->
86+
<div id="MSearchResultsWindow">
87+
<div id="MSearchResults">
88+
<div class="SRPage">
89+
<div id="SRIndex">
90+
<div id="SRResults"></div>
91+
<div class="SRStatus" id="Loading">Loading...</div>
92+
<div class="SRStatus" id="Searching">Searching...</div>
93+
<div class="SRStatus" id="NoMatches">No Matches</div>
94+
</div>
95+
</div>
96+
</div>
97+
</div>
98+
99+
<div class="header">
100+
<div class="summary">
101+
<a href="#nested-classes">Classes</a> &#124;
102+
<a href="#namespaces">Namespaces</a> </div>
103+
<div class="headertitle"><div class="title">Agent.hpp File Reference</div></div>
104+
</div><!--header-->
105+
<div class="contents">
106+
107+
<p>Defines the Agent class.
108+
<a href="#details">More...</a></p>
109+
<div class="textblock"><code>#include &quot;<a class="el" href="Itinerary_8hpp.html">Itinerary.hpp</a>&quot;</code><br />
110+
<code>#include &quot;<a class="el" href="SparseMatrix_8hpp.html">SparseMatrix.hpp</a>&quot;</code><br />
111+
<code>#include &quot;../utility/TypeTraits/is_numeric.hpp&quot;</code><br />
112+
<code>#include &quot;../utility/Logger.hpp&quot;</code><br />
113+
<code>#include &quot;../utility/Typedef.hpp&quot;</code><br />
114+
<code>#include &lt;concepts&gt;</code><br />
115+
<code>#include &lt;limits&gt;</code><br />
116+
<code>#include &lt;optional&gt;</code><br />
117+
<code>#include &lt;stdexcept&gt;</code><br />
118+
<code>#include &lt;vector&gt;</code><br />
119+
</div><table class="memberdecls">
120+
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
121+
Classes</h2></td></tr>
122+
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdsm_1_1Agent.html">dsm::Agent&lt; delay_t &gt;</a></td></tr>
123+
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">The <a class="el" href="classdsm_1_1Agent.html" title="The Agent class represents an agent in the network.">Agent</a> class represents an agent in the network. <a href="classdsm_1_1Agent.html#details">More...</a><br /></td></tr>
124+
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
125+
</table><table class="memberdecls">
126+
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="namespaces" name="namespaces"></a>
127+
Namespaces</h2></td></tr>
128+
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacedsm.html">dsm</a></td></tr>
129+
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
130+
</table>
131+
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
132+
<div class="textblock"><p>Defines the Agent class. </p>
133+
<p>This file contains the definition of the Agent class. The Agent class represents an agent in the network. It is templated by the type of the agent's id and the size of agents, which must both be unsigned integrals. It is also templated by the delay_t type, which must be a numeric (see utility/TypeTraits/is_numeric.hpp) and represents the spatial or temporal (depending on the type of the template) distance between the agent and the one in front of it. </p>
134+
</div></div><!-- contents -->
135+
</div><!-- doc-content -->
136+
<!-- start footer part -->
137+
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
138+
<ul>
139+
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_d0634b18ebbf3f30a60770e3162e8bd8.html">dsm</a></li><li class="navelem"><a class="el" href="dir_5f3c2da6cfa74439aaedc98709fe5cec.html">headers</a></li><li class="navelem"><a class="el" href="Agent_8hpp.html">Agent.hpp</a></li>
140+
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.13.1 </li>
141+
</ul>
142+
</div>
143+
</body>
144+
</html>

docs/Agent_8hpp.js

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
var Agent_8hpp =
2+
[
3+
[ "dsm::Agent< delay_t >", "classdsm_1_1Agent.html", "classdsm_1_1Agent" ]
4+
];

docs/Dynamics_8hpp.html

Lines changed: 157 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,157 @@
1+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2+
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
3+
<head>
4+
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5+
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
6+
<meta name="generator" content="Doxygen 1.13.1"/>
7+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
8+
<title>Dynamical system model: src/dsm/headers/Dynamics.hpp File Reference</title>
9+
<link href="tabs.css" rel="stylesheet" type="text/css"/>
10+
<script type="text/javascript" src="jquery.js"></script>
11+
<script type="text/javascript" src="dynsections.js"></script>
12+
<script type="text/javascript" src="clipboard.js"></script>
13+
<link href="navtree.css" rel="stylesheet" type="text/css"/>
14+
<script type="text/javascript" src="navtreedata.js"></script>
15+
<script type="text/javascript" src="navtree.js"></script>
16+
<script type="text/javascript" src="resize.js"></script>
17+
<script type="text/javascript" src="cookie.js"></script>
18+
<link href="search/search.css" rel="stylesheet" type="text/css"/>
19+
<script type="text/javascript" src="search/searchdata.js"></script>
20+
<script type="text/javascript" src="search/search.js"></script>
21+
<link href="doxygen.css" rel="stylesheet" type="text/css" />
22+
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
23+
</head>
24+
<body>
25+
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
26+
<div id="titlearea">
27+
<table cellspacing="0" cellpadding="0">
28+
<tbody>
29+
<tr id="projectrow">
30+
<td id="projectalign">
31+
<div id="projectname">Dynamical system model
32+
</div>
33+
</td>
34+
</tr>
35+
</tbody>
36+
</table>
37+
</div>
38+
<!-- end header part -->
39+
<!-- Generated by Doxygen 1.13.1 -->
40+
<script type="text/javascript">
41+
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
42+
var searchBox = new SearchBox("searchBox", "search/",'.html');
43+
/* @license-end */
44+
</script>
45+
<script type="text/javascript">
46+
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
47+
$(function() { codefold.init(0); });
48+
/* @license-end */
49+
</script>
50+
<script type="text/javascript" src="menudata.js"></script>
51+
<script type="text/javascript" src="menu.js"></script>
52+
<script type="text/javascript">
53+
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
54+
$(function() {
55+
initMenu('',true,false,'search.php','Search',true);
56+
$(function() { init_search(); });
57+
});
58+
/* @license-end */
59+
</script>
60+
<div id="main-nav"></div>
61+
</div><!-- top -->
62+
<div id="side-nav" class="ui-resizable side-nav-resizable">
63+
<div id="nav-tree">
64+
<div id="nav-tree-contents">
65+
<div id="nav-sync" class="sync"></div>
66+
</div>
67+
</div>
68+
<div id="splitbar" style="-moz-user-select:none;"
69+
class="ui-resizable-handle">
70+
</div>
71+
</div>
72+
<script type="text/javascript">
73+
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
74+
$(function(){initNavTree('Dynamics_8hpp.html',''); initResizable(true); });
75+
/* @license-end */
76+
</script>
77+
<div id="doc-content">
78+
<!-- window showing the filter options -->
79+
<div id="MSearchSelectWindow"
80+
onmouseover="return searchBox.OnSearchSelectShow()"
81+
onmouseout="return searchBox.OnSearchSelectHide()"
82+
onkeydown="return searchBox.OnSearchSelectKey(event)">
83+
</div>
84+
85+
<!-- iframe showing the search results (closed by default) -->
86+
<div id="MSearchResultsWindow">
87+
<div id="MSearchResults">
88+
<div class="SRPage">
89+
<div id="SRIndex">
90+
<div id="SRResults"></div>
91+
<div class="SRStatus" id="Loading">Loading...</div>
92+
<div class="SRStatus" id="Searching">Searching...</div>
93+
<div class="SRStatus" id="NoMatches">No Matches</div>
94+
</div>
95+
</div>
96+
</div>
97+
</div>
98+
99+
<div class="header">
100+
<div class="summary">
101+
<a href="#nested-classes">Classes</a> &#124;
102+
<a href="#namespaces">Namespaces</a> </div>
103+
<div class="headertitle"><div class="title">Dynamics.hpp File Reference</div></div>
104+
</div><!--header-->
105+
<div class="contents">
106+
107+
<p>Defines the Dynamics class.
108+
<a href="#details">More...</a></p>
109+
<div class="textblock"><code>#include &lt;algorithm&gt;</code><br />
110+
<code>#include &lt;cassert&gt;</code><br />
111+
<code>#include &lt;concepts&gt;</code><br />
112+
<code>#include &lt;vector&gt;</code><br />
113+
<code>#include &lt;random&gt;</code><br />
114+
<code>#include &lt;span&gt;</code><br />
115+
<code>#include &lt;numeric&gt;</code><br />
116+
<code>#include &lt;unordered_map&gt;</code><br />
117+
<code>#include &lt;cmath&gt;</code><br />
118+
<code>#include &lt;format&gt;</code><br />
119+
<code>#include &lt;thread&gt;</code><br />
120+
<code>#include &lt;exception&gt;</code><br />
121+
<code>#include &quot;DijkstraWeights.hpp&quot;</code><br />
122+
<code>#include &quot;<a class="el" href="Itinerary_8hpp.html">Itinerary.hpp</a>&quot;</code><br />
123+
<code>#include &quot;<a class="el" href="Graph_8hpp.html">Graph.hpp</a>&quot;</code><br />
124+
<code>#include &quot;<a class="el" href="SparseMatrix_8hpp.html">SparseMatrix.hpp</a>&quot;</code><br />
125+
<code>#include &quot;../utility/TypeTraits/is_agent.hpp&quot;</code><br />
126+
<code>#include &quot;../utility/TypeTraits/is_itinerary.hpp&quot;</code><br />
127+
<code>#include &quot;../utility/Logger.hpp&quot;</code><br />
128+
<code>#include &quot;../utility/Typedef.hpp&quot;</code><br />
129+
</div><table class="memberdecls">
130+
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
131+
Classes</h2></td></tr>
132+
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structdsm_1_1Measurement.html">dsm::Measurement&lt; T &gt;</a></td></tr>
133+
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">The <a class="el" href="structdsm_1_1Measurement.html" title="The Measurement struct represents the mean of a quantity and its standard deviation.">Measurement</a> struct represents the mean of a quantity and its standard deviation. <a href="structdsm_1_1Measurement.html#details">More...</a><br /></td></tr>
134+
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
135+
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdsm_1_1Dynamics.html">dsm::Dynamics&lt; agent_t &gt;</a></td></tr>
136+
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">The <a class="el" href="classdsm_1_1Dynamics.html" title="The Dynamics class represents the dynamics of the network.">Dynamics</a> class represents the dynamics of the network. <a href="classdsm_1_1Dynamics.html#details">More...</a><br /></td></tr>
137+
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
138+
</table><table class="memberdecls">
139+
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="namespaces" name="namespaces"></a>
140+
Namespaces</h2></td></tr>
141+
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacedsm.html">dsm</a></td></tr>
142+
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
143+
</table>
144+
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
145+
<div class="textblock"><p>Defines the Dynamics class. </p>
146+
<p>This file contains the definition of the Dynamics class. The Dynamics class represents the dynamics of the network. It is templated by the type of the graph's id and the type of the graph's capacity. The graph's id and capacity must be unsigned integral types. </p>
147+
</div></div><!-- contents -->
148+
</div><!-- doc-content -->
149+
<!-- start footer part -->
150+
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
151+
<ul>
152+
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_d0634b18ebbf3f30a60770e3162e8bd8.html">dsm</a></li><li class="navelem"><a class="el" href="dir_5f3c2da6cfa74439aaedc98709fe5cec.html">headers</a></li><li class="navelem"><a class="el" href="Dynamics_8hpp.html">Dynamics.hpp</a></li>
153+
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.13.1 </li>
154+
</ul>
155+
</div>
156+
</body>
157+
</html>

docs/Dynamics_8hpp.js

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
var Dynamics_8hpp =
2+
[
3+
[ "dsm::Measurement< T >", "structdsm_1_1Measurement.html", null ],
4+
[ "dsm::Dynamics< agent_t >", "classdsm_1_1Dynamics.html", "classdsm_1_1Dynamics" ]
5+
];

0 commit comments

Comments
 (0)