Skip to content

Commit

Permalink
updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@Grufoony
Grufoony committed Dec 14, 2023
1 parent 4078a11 commit 9f99c17
Show file tree
Hide file tree
Showing 137 changed files with 10,265 additions and 12,555 deletions.
102 changes: 53 additions & 49 deletions docs/html/Agent_8hpp.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,14 @@
<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>Dynamical System Framework: src/dsm/headers/Agent.hpp File Reference</title>
<title>Dynamical system model: src/dsm/headers/Agent.hpp File Reference</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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.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>
Expand All @@ -21,7 +25,7 @@
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Dynamical System Framework
<div id="projectname">Dynamical system model
</div>
</td>
</tr>
Expand All @@ -45,6 +49,23 @@
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('Agent_8hpp.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
Expand All @@ -59,74 +80,57 @@
</iframe>
</div>

<div id="nav-path" class="navpath">
<ul>
<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> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> </div>
<a href="#nested-classes">Classes</a> &#124;
<a href="#func-members">Functions</a> &#124;
<a href="#var-members">Variables</a> </div>
<div class="headertitle">
<div class="title">Agent.hpp File Reference</div> </div>
</div><!--header-->
<div class="contents">

<p>Defines the Agent class.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &quot;<a class="el" href="Itinerary_8hpp_source.html">Itinerary.hpp</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="SparseMatrix_8hpp_source.html">SparseMatrix.hpp</a>&quot;</code><br />
<div class="textblock"><code>#include &quot;<a class="el" href="Itinerary_8hpp.html">Itinerary.hpp</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="SparseMatrix_8hpp.html">SparseMatrix.hpp</a>&quot;</code><br />
<code>#include &quot;../utility/TypeTraits/is_numeric.hpp&quot;</code><br />
<code>#include &lt;concepts&gt;</code><br />
<code>#include &lt;stdexcept&gt;</code><br />
<code>#include &lt;string&gt;</code><br />
<code>#include &lt;limits&gt;</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for Agent.hpp:</div>
<div class="dyncontent">
<div class="center"><img src="Agent_8hpp__incl.png" border="0" usemap="#asrc_2dsm_2headers_2Agent_8hpp" alt=""/></div>
<map name="asrc_2dsm_2headers_2Agent_8hpp" id="asrc_2dsm_2headers_2Agent_8hpp">
<area shape="rect" title="Defines the Agent class." alt="" coords="375,5,574,32"/>
<area shape="rect" href="Itinerary_8hpp.html" title="Defines the Itinerary class." alt="" coords="251,87,354,114"/>
<area shape="rect" href="SparseMatrix_8hpp.html" title="Defines the SparseMatrix class." alt="" coords="328,169,464,196"/>
<area shape="rect" title=" " alt="" coords="5,244,64,271"/>
<area shape="rect" title=" " alt="" coords="631,244,718,271"/>
<area shape="rect" title=" " alt="" coords="743,244,801,271"/>
<area shape="rect" title=" " alt="" coords="589,80,731,121"/>
<area shape="rect" title=" " alt="" coords="88,244,168,271"/>
<area shape="rect" title=" " alt="" coords="243,169,303,196"/>
<area shape="rect" title=" " alt="" coords="192,244,272,271"/>
<area shape="rect" title=" " alt="" coords="297,244,373,271"/>
<area shape="rect" title=" " alt="" coords="397,244,521,271"/>
<area shape="rect" title=" " alt="" coords="545,244,607,271"/>
</map>
</div>
</div><div class="textblock"><div class="dynheader">
This graph shows which files directly or indirectly include this file:</div>
<div class="dyncontent">
<div class="center"><img src="Agent_8hpp__dep__incl.png" border="0" usemap="#asrc_2dsm_2headers_2Agent_8hppdep" alt=""/></div>
<map name="asrc_2dsm_2headers_2Agent_8hppdep" id="asrc_2dsm_2headers_2Agent_8hppdep">
<area shape="rect" title="Defines the Agent class." alt="" coords="19,5,218,32"/>
<area shape="rect" href="Dynamics_8hpp.html" title="Defines the Dynamics class." alt="" coords="5,229,232,256"/>
<area shape="rect" href="Street_8hpp.html" title="Defines the Street class." alt="" coords="88,80,288,107"/>
<area shape="rect" href="Graph_8hpp.html" title="Defines the Graph class." alt="" coords="88,155,288,181"/>
</map>
</div>
</div>
<p><a href="Agent_8hpp_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<code>#include &lt;optional&gt;</code><br />
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<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; Id &gt;</a></td></tr>
<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; Id, Size, Delay &gt;</a></td></tr>
<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>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a76566af5379cba731a8b2ab784c1fec5"><td class="memTemplParams" colspan="2"><a id="a76566af5379cba731a8b2ab784c1fec5"></a>
template&lt;typename Id , typename Size , typename Delay &gt; </td></tr>
<tr class="memitem:a76566af5379cba731a8b2ab784c1fec5"><td class="memTemplItemLeft" align="right" valign="top">&#160;</td><td class="memTemplItemRight" valign="bottom"><b>dsm::requires</b> (std::unsigned_integral&lt; Id &gt; &amp;&amp;std::unsigned_integral&lt; Size &gt; &amp;&amp;is_numeric_v&lt; Delay &gt;) Agent&lt; Id</td></tr>
<tr class="separator:a76566af5379cba731a8b2ab784c1fec5"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:a0320c90f75b8c4b4d54b39296041e96d"><td class="memItemLeft" align="right" valign="top"><a id="a0320c90f75b8c4b4d54b39296041e96d"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>dsm::Size</b></td></tr>
<tr class="separator:a0320c90f75b8c4b4d54b39296041e96d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Defines the Agent class. </p>
<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. The agent's id must be an unsigned integral type. </p>
<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 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>
</div></div><!-- contents -->
</div><!-- doc-content -->
<!-- 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>
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<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>
<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.9.1 </li>
</ul>
</div>
</body>
</html>
6 changes: 6 additions & 0 deletions docs/html/Agent_8hpp.js
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
var Agent_8hpp =
[
[ "Agent", "classdsm_1_1Agent.html", "classdsm_1_1Agent" ],
[ "requires", "Agent_8hpp.html#a76566af5379cba731a8b2ab784c1fec5", null ],
[ "Size", "Agent_8hpp.html#a0320c90f75b8c4b4d54b39296041e96d", null ]
];
Loading

0 comments on commit 9f99c17

Please sign in to comment.