Skip to content

Commit 8d2c1ed

Browse files
feilurfeilur
committed
Add documentation
1 parent 4024e49 commit 8d2c1ed

171 files changed

Lines changed: 12296 additions & 1 deletion

File tree

Some content is hidden

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

‎Documentation.html‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
<meta http-equiv="REFRESH" content="0;URL=documentation/html/index.html">

‎Doxyfile‎

Lines changed: 2581 additions & 0 deletions
Large diffs are not rendered by default.

‎documentation/html/QSMatrix_8cpp.html‎

Lines changed: 100 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
1+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2+
<html xmlns="http://www.w3.org/1999/xhtml">
3+
<head>
4+
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5+
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
6+
<meta name="generator" content="Doxygen 1.8.13"/>
7+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
8+
<title>State-Space Controller: src/QSMatrix.cpp 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+
<link href="search/search.css" rel="stylesheet" type="text/css"/>
13+
<script type="text/javascript" src="search/searchdata.js"></script>
14+
<script type="text/javascript" src="search/search.js"></script>
15+
<link href="doxygen.css" rel="stylesheet" type="text/css" />
16+
</head>
17+
<body>
18+
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
19+
<div id="titlearea">
20+
<table cellspacing="0" cellpadding="0">
21+
<tbody>
22+
<tr style="height: 56px;">
23+
<td id="projectalign" style="padding-left: 0.5em;">
24+
<div id="projectname">State-Space Controller
25+
</div>
26+
<div id="projectbrief">General use State-Space Controller class.</div>
27+
</td>
28+
</tr>
29+
</tbody>
30+
</table>
31+
</div>
32+
<!-- end header part -->
33+
<!-- Generated by Doxygen 1.8.13 -->
34+
<script type="text/javascript">
35+
var searchBox = new SearchBox("searchBox", "search",false,'Search');
36+
</script>
37+
<script type="text/javascript" src="menudata.js"></script>
38+
<script type="text/javascript" src="menu.js"></script>
39+
<script type="text/javascript">
40+
$(function() {
41+
initMenu('',true,false,'search.php','Search');
42+
$(document).ready(function() { init_search(); });
43+
});
44+
</script>
45+
<div id="main-nav"></div>
46+
<!-- window showing the filter options -->
47+
<div id="MSearchSelectWindow"
48+
onmouseover="return searchBox.OnSearchSelectShow()"
49+
onmouseout="return searchBox.OnSearchSelectHide()"
50+
onkeydown="return searchBox.OnSearchSelectKey(event)">
51+
</div>
52+
53+
<!-- iframe showing the search results (closed by default) -->
54+
<div id="MSearchResultsWindow">
55+
<iframe src="javascript:void(0)" frameborder="0"
56+
name="MSearchResults" id="MSearchResults">
57+
</iframe>
58+
</div>
59+
60+
<div id="nav-path" class="navpath">
61+
<ul>
62+
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li> </ul>
63+
</div>
64+
</div><!-- top -->
65+
<div class="header">
66+
<div class="summary">
67+
<a href="#define-members">Macros</a> </div>
68+
<div class="headertitle">
69+
<div class="title">QSMatrix.cpp File Reference</div> </div>
70+
</div><!--header-->
71+
<div class="contents">
72+
73+
<p><a class="el" href="classQSMatrix.html" title="Class for matrices and vectors computation. ">QSMatrix</a> class source file.
74+
<a href="#details">More...</a></p>
75+
<div class="textblock"><code>#include &quot;<a class="el" href="QSMatrix_8h_source.html">QSMatrix.h</a>&quot;</code><br />
76+
</div><div class="textblock"><div class="dynheader">
77+
Include dependency graph for QSMatrix.cpp:</div>
78+
<div class="dyncontent">
79+
<div class="center"><img src="QSMatrix_8cpp__incl.png" border="0" usemap="#src_2QSMatrix_8cpp" alt=""/></div>
80+
<!-- MAP 0 -->
81+
</div>
82+
</div><div class="textblock"><div class="dynheader">
83+
This graph shows which files directly or indirectly include this file:</div>
84+
<div class="dyncontent">
85+
<div class="center"><img src="QSMatrix_8cpp__dep__incl.png" border="0" usemap="#src_2QSMatrix_8cppdep" alt=""/></div>
86+
<!-- MAP 1 -->
87+
</div>
88+
</div><a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
89+
<div class="textblock"><p><a class="el" href="classQSMatrix.html" title="Class for matrices and vectors computation. ">QSMatrix</a> class source file. </p>
90+
<dl class="section author"><dt>Author</dt><dd>quantstart.com, updated by Alexis Proux </dd></dl>
91+
<dl class="section date"><dt>Date</dt><dd>1 July 2021 </dd></dl>
92+
</div></div><!-- contents -->
93+
<!-- start footer part -->
94+
<hr class="footer"/><address class="footer"><small>
95+
Generated by &#160;<a href="http://www.doxygen.org/index.html">
96+
<img class="footer" src="doxygen.png" alt="doxygen"/>
97+
</a> 1.8.13
98+
</small></address>
99+
</body>
100+
</html>

‎documentation/html/QSMatrix_8cpp__dep__incl.dot‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
digraph "src/QSMatrix.cpp"
2+
{
3+
edge [fontname="Helvetica",fontsize="10",labelfontname="Helvetica",labelfontsize="10"];
4+
node [fontname="Helvetica",fontsize="10",shape=record];
5+
Node7 [label="src/QSMatrix.cpp",height=0.2,width=0.4,color="black", fillcolor="grey75", style="filled", fontcolor="black"];
6+
Node7 -> Node8 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"];
7+
Node8 [label="src/QSMatrix.h",height=0.2,width=0.4,color="black", fillcolor="white", style="filled",URL="$QSMatrix_8h.html",tooltip="QSMatrix class header. "];
8+
Node8 -> Node9 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"];
9+
Node9 [label="src/stateSpaceController.h",height=0.2,width=0.4,color="black", fillcolor="white", style="filled",URL="$stateSpaceController_8h.html",tooltip="StateSpaceController class header. "];
10+
Node9 -> Node10 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"];
11+
Node10 [label="src/example_StateSpaceController.cpp",height=0.2,width=0.4,color="black", fillcolor="white", style="filled",URL="$example__StateSpaceController_8cpp.html",tooltip="This script demonstrates some StateSpaceController functions. "];
12+
Node9 -> Node11 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"];
13+
Node11 [label="src/stateSpaceController.cpp",height=0.2,width=0.4,color="black", fillcolor="white", style="filled",URL="$stateSpaceController_8cpp.html",tooltip="StateSpaceController class source file. "];
14+
Node11 -> Node9 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"];
15+
Node8 -> Node7 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"];
16+
Node8 -> Node10 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"];
17+
}

‎documentation/html/QSMatrix_8cpp__dep__incl.md5‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
63dd5b28ffde8a169d94f655ea55bfbc

‎documentation/html/QSMatrix_8cpp__incl.dot‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
digraph "src/QSMatrix.cpp"
2+
{
3+
edge [fontname="Helvetica",fontsize="10",labelfontname="Helvetica",labelfontsize="10"];
4+
node [fontname="Helvetica",fontsize="10",shape=record];
5+
Node0 [label="src/QSMatrix.cpp",height=0.2,width=0.4,color="black", fillcolor="grey75", style="filled", fontcolor="black"];
6+
Node0 -> Node1 [color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"];
7+
Node1 [label="QSMatrix.h",height=0.2,width=0.4,color="black", fillcolor="white", style="filled",URL="$QSMatrix_8h.html",tooltip="QSMatrix class header. "];
8+
Node1 -> Node2 [color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"];
9+
Node2 [label="vector",height=0.2,width=0.4,color="grey75", fillcolor="white", style="filled"];
10+
Node1 -> Node3 [color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"];
11+
Node3 [label="iostream",height=0.2,width=0.4,color="grey75", fillcolor="white", style="filled"];
12+
Node1 -> Node4 [color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"];
13+
Node4 [label="string",height=0.2,width=0.4,color="grey75", fillcolor="white", style="filled"];
14+
Node1 -> Node5 [color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"];
15+
Node5 [label="sstream",height=0.2,width=0.4,color="grey75", fillcolor="white", style="filled"];
16+
Node1 -> Node6 [color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"];
17+
Node6 [label="cmath",height=0.2,width=0.4,color="grey75", fillcolor="white", style="filled"];
18+
Node1 -> Node0 [color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"];
19+
}

‎documentation/html/QSMatrix_8cpp__incl.md5‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
39b36541173c82ac7e6f20295e533bed

‎documentation/html/QSMatrix_8h.html‎

Lines changed: 114 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,114 @@
1+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2+
<html xmlns="http://www.w3.org/1999/xhtml">
3+
<head>
4+
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5+
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
6+
<meta name="generator" content="Doxygen 1.8.13"/>
7+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
8+
<title>State-Space Controller: src/QSMatrix.h 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+
<link href="search/search.css" rel="stylesheet" type="text/css"/>
13+
<script type="text/javascript" src="search/searchdata.js"></script>
14+
<script type="text/javascript" src="search/search.js"></script>
15+
<link href="doxygen.css" rel="stylesheet" type="text/css" />
16+
</head>
17+
<body>
18+
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
19+
<div id="titlearea">
20+
<table cellspacing="0" cellpadding="0">
21+
<tbody>
22+
<tr style="height: 56px;">
23+
<td id="projectalign" style="padding-left: 0.5em;">
24+
<div id="projectname">State-Space Controller
25+
</div>
26+
<div id="projectbrief">General use State-Space Controller class.</div>
27+
</td>
28+
</tr>
29+
</tbody>
30+
</table>
31+
</div>
32+
<!-- end header part -->
33+
<!-- Generated by Doxygen 1.8.13 -->
34+
<script type="text/javascript">
35+
var searchBox = new SearchBox("searchBox", "search",false,'Search');
36+
</script>
37+
<script type="text/javascript" src="menudata.js"></script>
38+
<script type="text/javascript" src="menu.js"></script>
39+
<script type="text/javascript">
40+
$(function() {
41+
initMenu('',true,false,'search.php','Search');
42+
$(document).ready(function() { init_search(); });
43+
});
44+
</script>
45+
<div id="main-nav"></div>
46+
<!-- window showing the filter options -->
47+
<div id="MSearchSelectWindow"
48+
onmouseover="return searchBox.OnSearchSelectShow()"
49+
onmouseout="return searchBox.OnSearchSelectHide()"
50+
onkeydown="return searchBox.OnSearchSelectKey(event)">
51+
</div>
52+
53+
<!-- iframe showing the search results (closed by default) -->
54+
<div id="MSearchResultsWindow">
55+
<iframe src="javascript:void(0)" frameborder="0"
56+
name="MSearchResults" id="MSearchResults">
57+
</iframe>
58+
</div>
59+
60+
<div id="nav-path" class="navpath">
61+
<ul>
62+
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li> </ul>
63+
</div>
64+
</div><!-- top -->
65+
<div class="header">
66+
<div class="summary">
67+
<a href="#nested-classes">Classes</a> </div>
68+
<div class="headertitle">
69+
<div class="title">QSMatrix.h File Reference</div> </div>
70+
</div><!--header-->
71+
<div class="contents">
72+
73+
<p><a class="el" href="classQSMatrix.html" title="Class for matrices and vectors computation. ">QSMatrix</a> class header.
74+
<a href="#details">More...</a></p>
75+
<div class="textblock"><code>#include &lt;vector&gt;</code><br />
76+
<code>#include &lt;iostream&gt;</code><br />
77+
<code>#include &lt;string&gt;</code><br />
78+
<code>#include &lt;sstream&gt;</code><br />
79+
<code>#include &lt;cmath&gt;</code><br />
80+
<code>#include &quot;<a class="el" href="QSMatrix_8cpp.html">QSMatrix.cpp</a>&quot;</code><br />
81+
</div><div class="textblock"><div class="dynheader">
82+
Include dependency graph for QSMatrix.h:</div>
83+
<div class="dyncontent">
84+
<div class="center"><img src="QSMatrix_8h__incl.png" border="0" usemap="#src_2QSMatrix_8h" alt=""/></div>
85+
<!-- MAP 0 -->
86+
</div>
87+
</div><div class="textblock"><div class="dynheader">
88+
This graph shows which files directly or indirectly include this file:</div>
89+
<div class="dyncontent">
90+
<div class="center"><img src="QSMatrix_8h__dep__incl.png" border="0" usemap="#src_2QSMatrix_8hdep" alt=""/></div>
91+
<!-- MAP 1 -->
92+
</div>
93+
</div>
94+
<p><a href="QSMatrix_8h_source.html">Go to the source code of this file.</a></p>
95+
<table class="memberdecls">
96+
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
97+
Classes</h2></td></tr>
98+
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classQSMatrix.html">QSMatrix&lt; T &gt;</a></td></tr>
99+
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Class for matrices and vectors computation. <a href="classQSMatrix.html#details">More...</a><br /></td></tr>
100+
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
101+
</table>
102+
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
103+
<div class="textblock"><p><a class="el" href="classQSMatrix.html" title="Class for matrices and vectors computation. ">QSMatrix</a> class header. </p>
104+
<dl class="section author"><dt>Author</dt><dd>quantstart.com, updated by Alexis Proux </dd></dl>
105+
<dl class="section date"><dt>Date</dt><dd>1 July 2021 </dd></dl>
106+
</div></div><!-- contents -->
107+
<!-- start footer part -->
108+
<hr class="footer"/><address class="footer"><small>
109+
Generated by &#160;<a href="http://www.doxygen.org/index.html">
110+
<img class="footer" src="doxygen.png" alt="doxygen"/>
111+
</a> 1.8.13
112+
</small></address>
113+
</body>
114+
</html>

‎documentation/html/QSMatrix_8h__dep__incl.dot‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
digraph "src/QSMatrix.h"
2+
{
3+
edge [fontname="Helvetica",fontsize="10",labelfontname="Helvetica",labelfontsize="10"];
4+
node [fontname="Helvetica",fontsize="10",shape=record];
5+
Node7 [label="src/QSMatrix.h",height=0.2,width=0.4,color="black", fillcolor="grey75", style="filled", fontcolor="black"];
6+
Node7 -> Node8 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"];
7+
Node8 [label="src/stateSpaceController.h",height=0.2,width=0.4,color="black", fillcolor="white", style="filled",URL="$stateSpaceController_8h.html",tooltip="StateSpaceController class header. "];
8+
Node8 -> Node9 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"];
9+
Node9 [label="src/example_StateSpaceController.cpp",height=0.2,width=0.4,color="black", fillcolor="white", style="filled",URL="$example__StateSpaceController_8cpp.html",tooltip="This script demonstrates some StateSpaceController functions. "];
10+
Node8 -> Node10 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"];
11+
Node10 [label="src/stateSpaceController.cpp",height=0.2,width=0.4,color="black", fillcolor="white", style="filled",URL="$stateSpaceController_8cpp.html",tooltip="StateSpaceController class source file. "];
12+
Node10 -> Node8 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"];
13+
Node7 -> Node11 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"];
14+
Node11 [label="src/QSMatrix.cpp",height=0.2,width=0.4,color="black", fillcolor="white", style="filled",URL="$QSMatrix_8cpp.html",tooltip="QSMatrix class source file. "];
15+
Node11 -> Node7 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"];
16+
Node7 -> Node9 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"];
17+
}

‎documentation/html/QSMatrix_8h__dep__incl.md5‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
e4bfa35ffddc62f3b5231f5ed1670f48

0 commit comments

Comments
 (0)