Skip to content

Commit

Permalink
Add documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@feilur
feilur committed Jul 26, 2021
1 parent 4024e49 commit 8d2c1ed
Show file tree
Hide file tree
Showing 171 changed files with 12,296 additions and 1 deletion.
1 change: 1 addition & 0 deletions Documentation.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<meta http-equiv="REFRESH" content="0;URL=documentation/html/index.html">
2,581 changes: 2,581 additions & 0 deletions Doxyfile
View file

Large diffs are not rendered by default.

100 changes: 100 additions & 0 deletions documentation/html/QSMatrix_8cpp.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,100 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>State-Space Controller: src/QSMatrix.cpp 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="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">State-Space Controller
</div>
<div id="projectbrief">General use State-Space Controller class.</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</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_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#define-members">Macros</a> </div>
<div class="headertitle">
<div class="title">QSMatrix.cpp File Reference</div> </div>
</div><!--header-->
<div class="contents">

<p><a class="el" href="classQSMatrix.html" title="Class for matrices and vectors computation. ">QSMatrix</a> class source file.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &quot;<a class="el" href="QSMatrix_8h_source.html">QSMatrix.h</a>&quot;</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for QSMatrix.cpp:</div>
<div class="dyncontent">
<div class="center"><img src="QSMatrix_8cpp__incl.png" border="0" usemap="#src_2QSMatrix_8cpp" alt=""/></div>
<!-- MAP 0 -->
</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="QSMatrix_8cpp__dep__incl.png" border="0" usemap="#src_2QSMatrix_8cppdep" alt=""/></div>
<!-- MAP 1 -->
</div>
</div><a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p><a class="el" href="classQSMatrix.html" title="Class for matrices and vectors computation. ">QSMatrix</a> class source file. </p>
<dl class="section author"><dt>Author</dt><dd>quantstart.com, updated by Alexis Proux </dd></dl>
<dl class="section date"><dt>Date</dt><dd>1 July 2021 </dd></dl>
</div></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>
17 changes: 17 additions & 0 deletions documentation/html/QSMatrix_8cpp__dep__incl.dot
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
digraph "src/QSMatrix.cpp"
{
edge [fontname="Helvetica",fontsize="10",labelfontname="Helvetica",labelfontsize="10"];
node [fontname="Helvetica",fontsize="10",shape=record];
Node7 [label="src/QSMatrix.cpp",height=0.2,width=0.4,color="black", fillcolor="grey75", style="filled", fontcolor="black"];
Node7 -> Node8 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"];
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. "];
Node8 -> Node9 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"];
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. "];
Node9 -> Node10 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"];
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. "];
Node9 -> Node11 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"];
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. "];
Node11 -> Node9 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"];
Node8 -> Node7 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"];
Node8 -> Node10 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"];
}
1 change: 1 addition & 0 deletions documentation/html/QSMatrix_8cpp__dep__incl.md5
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
63dd5b28ffde8a169d94f655ea55bfbc
19 changes: 19 additions & 0 deletions documentation/html/QSMatrix_8cpp__incl.dot
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
digraph "src/QSMatrix.cpp"
{
edge [fontname="Helvetica",fontsize="10",labelfontname="Helvetica",labelfontsize="10"];
node [fontname="Helvetica",fontsize="10",shape=record];
Node0 [label="src/QSMatrix.cpp",height=0.2,width=0.4,color="black", fillcolor="grey75", style="filled", fontcolor="black"];
Node0 -> Node1 [color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"];
Node1 [label="QSMatrix.h",height=0.2,width=0.4,color="black", fillcolor="white", style="filled",URL="$QSMatrix_8h.html",tooltip="QSMatrix class header. "];
Node1 -> Node2 [color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"];
Node2 [label="vector",height=0.2,width=0.4,color="grey75", fillcolor="white", style="filled"];
Node1 -> Node3 [color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"];
Node3 [label="iostream",height=0.2,width=0.4,color="grey75", fillcolor="white", style="filled"];
Node1 -> Node4 [color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"];
Node4 [label="string",height=0.2,width=0.4,color="grey75", fillcolor="white", style="filled"];
Node1 -> Node5 [color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"];
Node5 [label="sstream",height=0.2,width=0.4,color="grey75", fillcolor="white", style="filled"];
Node1 -> Node6 [color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"];
Node6 [label="cmath",height=0.2,width=0.4,color="grey75", fillcolor="white", style="filled"];
Node1 -> Node0 [color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"];
}
1 change: 1 addition & 0 deletions documentation/html/QSMatrix_8cpp__incl.md5
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
39b36541173c82ac7e6f20295e533bed
114 changes: 114 additions & 0 deletions documentation/html/QSMatrix_8h.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,114 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>State-Space Controller: src/QSMatrix.h 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="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">State-Space Controller
</div>
<div id="projectbrief">General use State-Space Controller class.</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</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_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> </div>
<div class="headertitle">
<div class="title">QSMatrix.h File Reference</div> </div>
</div><!--header-->
<div class="contents">

<p><a class="el" href="classQSMatrix.html" title="Class for matrices and vectors computation. ">QSMatrix</a> class header.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;vector&gt;</code><br />
<code>#include &lt;iostream&gt;</code><br />
<code>#include &lt;string&gt;</code><br />
<code>#include &lt;sstream&gt;</code><br />
<code>#include &lt;cmath&gt;</code><br />
<code>#include &quot;<a class="el" href="QSMatrix_8cpp.html">QSMatrix.cpp</a>&quot;</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for QSMatrix.h:</div>
<div class="dyncontent">
<div class="center"><img src="QSMatrix_8h__incl.png" border="0" usemap="#src_2QSMatrix_8h" alt=""/></div>
<!-- MAP 0 -->
</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="QSMatrix_8h__dep__incl.png" border="0" usemap="#src_2QSMatrix_8hdep" alt=""/></div>
<!-- MAP 1 -->
</div>
</div>
<p><a href="QSMatrix_8h_source.html">Go to the source code of this file.</a></p>
<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="classQSMatrix.html">QSMatrix&lt; T &gt;</a></td></tr>
<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>
<tr class="separator:"><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><a class="el" href="classQSMatrix.html" title="Class for matrices and vectors computation. ">QSMatrix</a> class header. </p>
<dl class="section author"><dt>Author</dt><dd>quantstart.com, updated by Alexis Proux </dd></dl>
<dl class="section date"><dt>Date</dt><dd>1 July 2021 </dd></dl>
</div></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>
17 changes: 17 additions & 0 deletions documentation/html/QSMatrix_8h__dep__incl.dot
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
digraph "src/QSMatrix.h"
{
edge [fontname="Helvetica",fontsize="10",labelfontname="Helvetica",labelfontsize="10"];
node [fontname="Helvetica",fontsize="10",shape=record];
Node7 [label="src/QSMatrix.h",height=0.2,width=0.4,color="black", fillcolor="grey75", style="filled", fontcolor="black"];
Node7 -> Node8 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"];
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. "];
Node8 -> Node9 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"];
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. "];
Node8 -> Node10 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"];
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. "];
Node10 -> Node8 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"];
Node7 -> Node11 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"];
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. "];
Node11 -> Node7 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"];
Node7 -> Node9 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"];
}
1 change: 1 addition & 0 deletions documentation/html/QSMatrix_8h__dep__incl.md5
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
e4bfa35ffddc62f3b5231f5ed1670f48
19 changes: 19 additions & 0 deletions documentation/html/QSMatrix_8h__incl.dot
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
digraph "src/QSMatrix.h"
{
edge [fontname="Helvetica",fontsize="10",labelfontname="Helvetica",labelfontsize="10"];
node [fontname="Helvetica",fontsize="10",shape=record];
Node0 [label="src/QSMatrix.h",height=0.2,width=0.4,color="black", fillcolor="grey75", style="filled", fontcolor="black"];
Node0 -> Node1 [color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"];
Node1 [label="vector",height=0.2,width=0.4,color="grey75", fillcolor="white", style="filled"];
Node0 -> Node2 [color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"];
Node2 [label="iostream",height=0.2,width=0.4,color="grey75", fillcolor="white", style="filled"];
Node0 -> Node3 [color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"];
Node3 [label="string",height=0.2,width=0.4,color="grey75", fillcolor="white", style="filled"];
Node0 -> Node4 [color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"];
Node4 [label="sstream",height=0.2,width=0.4,color="grey75", fillcolor="white", style="filled"];
Node0 -> Node5 [color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"];
Node5 [label="cmath",height=0.2,width=0.4,color="grey75", fillcolor="white", style="filled"];
Node0 -> Node6 [color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"];
Node6 [label="QSMatrix.cpp",height=0.2,width=0.4,color="black", fillcolor="white", style="filled",URL="$QSMatrix_8cpp.html",tooltip="QSMatrix class source file. "];
Node6 -> Node0 [color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"];
}
1 change: 1 addition & 0 deletions documentation/html/QSMatrix_8h__incl.md5
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
af4be3d2097ae6695336dc64896cbf2e
Loading

0 comments on commit 8d2c1ed

Please sign in to comment.