Skip to content

Commit

Permalink
deploy: 92f413b
Browse files Browse the repository at this point in the history
  • Loading branch information
domire8 committed Apr 30, 2024
1 parent 8e19741 commit 9487363
Show file tree
Hide file tree
Showing 1,974 changed files with 385,782 additions and 0 deletions.
241 changes: 241 additions & 0 deletions versions/8.0.0/_analog_i_o_state_8cpp_source.html

Large diffs are not rendered by default.

156 changes: 156 additions & 0 deletions versions/8.0.0/_analog_i_o_state_8hpp_source.html

Large diffs are not rendered by default.

327 changes: 327 additions & 0 deletions versions/8.0.0/_angle_8hpp_source.html

Large diffs are not rendered by default.

414 changes: 414 additions & 0 deletions versions/8.0.0/_cartesian_acceleration_8cpp_source.html

Large diffs are not rendered by default.

278 changes: 278 additions & 0 deletions versions/8.0.0/_cartesian_acceleration_8hpp_source.html

Large diffs are not rendered by default.

425 changes: 425 additions & 0 deletions versions/8.0.0/_cartesian_pose_8cpp_source.html

Large diffs are not rendered by default.

277 changes: 277 additions & 0 deletions versions/8.0.0/_cartesian_pose_8hpp_source.html

Large diffs are not rendered by default.

1,178 changes: 1,178 additions & 0 deletions versions/8.0.0/_cartesian_state_8cpp_source.html

Large diffs are not rendered by default.

392 changes: 392 additions & 0 deletions versions/8.0.0/_cartesian_state_8hpp_source.html

Large diffs are not rendered by default.

438 changes: 438 additions & 0 deletions versions/8.0.0/_cartesian_twist_8cpp_source.html

Large diffs are not rendered by default.

280 changes: 280 additions & 0 deletions versions/8.0.0/_cartesian_twist_8hpp_source.html

Large diffs are not rendered by default.

370 changes: 370 additions & 0 deletions versions/8.0.0/_cartesian_wrench_8cpp_source.html

Large diffs are not rendered by default.

269 changes: 269 additions & 0 deletions versions/8.0.0/_cartesian_wrench_8hpp_source.html

Large diffs are not rendered by default.

240 changes: 240 additions & 0 deletions versions/8.0.0/_circular_8cpp_source.html

Large diffs are not rendered by default.

136 changes: 136 additions & 0 deletions versions/8.0.0/_circular_8hpp_source.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,136 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Control Libraries: /github/workspace/source/dynamical_systems/include/dynamical_systems/Circular.hpp Source File</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 id="projectrow">
<td id="projectalign">
<div id="projectname">Control Libraries<span id="projectnumber">&#160;8.0.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function() { init_codefold(0); });
/* @license-end */
</script>
<!-- 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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_b2f33c71d4aa5e7af42a1ca61ff5af1b.html">source</a></li><li class="navelem"><a class="el" href="dir_431c084fba2ec3b5a17bb23524aa3c67.html">dynamical_systems</a></li><li class="navelem"><a class="el" href="dir_8fcf195fc79a6d31480c400ed23d4f92.html">include</a></li><li class="navelem"><a class="el" href="dir_319c5ea94b50bddc5bd454fb99d36348.html">dynamical_systems</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">Circular.hpp</div></div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="preprocessor">#pragma once</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span> </div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="preprocessor">#include &quot;dynamical_systems/IDynamicalSystem.hpp&quot;</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="preprocessor">#include &quot;state_representation/geometry/Ellipsoid.hpp&quot;</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="preprocessor">#include &quot;state_representation/parameters/Parameter.hpp&quot;</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span> </div>
<div class="foldopen" id="foldopen00007" data-start="{" data-end="}">
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"><a class="line" href="namespacedynamical__systems.html"> 7</a></span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespacedynamical__systems.html">dynamical_systems</a> {</div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span> </div>
<div class="foldopen" id="foldopen00013" data-start="{" data-end="};">
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"><a class="line" href="classdynamical__systems_1_1_circular.html"> 13</a></span><span class="keyword">class </span><a class="code hl_class" href="classdynamical__systems_1_1_circular.html">Circular</a> : <span class="keyword">public</span> <a class="code hl_class" href="classdynamical__systems_1_1_i_dynamical_system.html">IDynamicalSystem</a>&lt;state_representation::CartesianState&gt; {</div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="keyword">public</span>:</div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> <a class="code hl_function" href="classdynamical__systems_1_1_circular.html#aa6f0879ef85ec83a45465b48b733459d">Circular</a>();</div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> </div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> <span class="keyword">explicit</span> <a class="code hl_function" href="classdynamical__systems_1_1_circular.html#aa6f0879ef85ec83a45465b48b733459d">Circular</a>(<span class="keyword">const</span> std::list&lt;std::shared_ptr&lt;state_representation::ParameterInterface&gt;&gt;&amp; parameters);</div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> </div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classdynamical__systems_1_1_circular.html#a022f7cb771e266a1964db7b8bcf16210">set_base_frame</a>(<span class="keyword">const</span> <a class="code hl_class" href="classstate__representation_1_1_cartesian_state.html">state_representation::CartesianState</a>&amp; base_frame) <span class="keyword">override</span>;</div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> </div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> [[nodiscard]] <a class="code hl_class" href="classstate__representation_1_1_cartesian_state.html">state_representation::CartesianState</a></div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> <a class="code hl_function" href="classdynamical__systems_1_1_circular.html#a6918d883a7b2af982c564e8e6104f100">compute_dynamics</a>(<span class="keyword">const</span> <a class="code hl_class" href="classstate__representation_1_1_cartesian_state.html">state_representation::CartesianState</a>&amp; state) <span class="keyword">const override</span>;</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> </div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span><span class="keyword">private</span>:</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> <span class="keywordtype">void</span> validate_and_set_parameter(<span class="keyword">const</span> std::shared_ptr&lt;state_representation::ParameterInterface&gt;&amp; parameter) <span class="keyword">override</span>;</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> </div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> <span class="keywordtype">void</span> set_limit_cycle(<a class="code hl_class" href="classstate__representation_1_1_ellipsoid.html">state_representation::Ellipsoid</a>&amp; limit_cycle);</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> </div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> std::shared_ptr&lt;state_representation::Parameter&lt;state_representation::Ellipsoid&gt;&gt;</div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> limit_cycle_;</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> std::shared_ptr&lt;state_representation::Parameter&lt;double&gt;&gt;</div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> planar_gain_;</div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> std::shared_ptr&lt;state_representation::Parameter&lt;double&gt;&gt;</div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> normal_gain_;</div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> std::shared_ptr&lt;state_representation::Parameter&lt;double&gt;&gt;</div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> circular_velocity_;</div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span>};</div>
</div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span>}<span class="comment">// namespace dynamical_systems</span></div>
</div>
<div class="ttc" id="aclassdynamical__systems_1_1_circular_html"><div class="ttname"><a href="classdynamical__systems_1_1_circular.html">dynamical_systems::Circular</a></div><div class="ttdoc">Represent a Circular dynamical system to move around an center.</div><div class="ttdef"><b>Definition</b> <a href="_circular_8hpp_source.html#l00013">Circular.hpp:13</a></div></div>
<div class="ttc" id="aclassdynamical__systems_1_1_circular_html_a022f7cb771e266a1964db7b8bcf16210"><div class="ttname"><a href="classdynamical__systems_1_1_circular.html#a022f7cb771e266a1964db7b8bcf16210">dynamical_systems::Circular::set_base_frame</a></div><div class="ttdeci">void set_base_frame(const state_representation::CartesianState &amp;base_frame) override</div><div class="ttdoc">Set a parameter.</div><div class="ttdef"><b>Definition</b> <a href="_circular_8cpp_source.html#l00051">Circular.cpp:51</a></div></div>
<div class="ttc" id="aclassdynamical__systems_1_1_circular_html_a6918d883a7b2af982c564e8e6104f100"><div class="ttname"><a href="classdynamical__systems_1_1_circular.html#a6918d883a7b2af982c564e8e6104f100">dynamical_systems::Circular::compute_dynamics</a></div><div class="ttdeci">state_representation::CartesianState compute_dynamics(const state_representation::CartesianState &amp;state) const override</div><div class="ttdoc">Compute the dynamics of the input state. Internal function, to be redefined based on the type of dyna...</div><div class="ttdef"><b>Definition</b> <a href="_circular_8cpp_source.html#l00084">Circular.cpp:84</a></div></div>
<div class="ttc" id="aclassdynamical__systems_1_1_circular_html_aa6f0879ef85ec83a45465b48b733459d"><div class="ttname"><a href="classdynamical__systems_1_1_circular.html#aa6f0879ef85ec83a45465b48b733459d">dynamical_systems::Circular::Circular</a></div><div class="ttdeci">Circular()</div><div class="ttdoc">Empty constructor.</div><div class="ttdef"><b>Definition</b> <a href="_circular_8cpp_source.html#l00012">Circular.cpp:12</a></div></div>
<div class="ttc" id="aclassdynamical__systems_1_1_i_dynamical_system_html"><div class="ttname"><a href="classdynamical__systems_1_1_i_dynamical_system.html">dynamical_systems::IDynamicalSystem</a></div><div class="ttdoc">Abstract class for a dynamical system.</div><div class="ttdef"><b>Definition</b> <a href="_i_dynamical_system_8hpp_source.html#l00021">IDynamicalSystem.hpp:21</a></div></div>
<div class="ttc" id="aclassstate__representation_1_1_cartesian_state_html"><div class="ttname"><a href="classstate__representation_1_1_cartesian_state.html">state_representation::CartesianState</a></div><div class="ttdoc">Class to represent a state in Cartesian space.</div><div class="ttdef"><b>Definition</b> <a href="_cartesian_state_8hpp_source.html#l00048">CartesianState.hpp:48</a></div></div>
<div class="ttc" id="aclassstate__representation_1_1_ellipsoid_html"><div class="ttname"><a href="classstate__representation_1_1_ellipsoid.html">state_representation::Ellipsoid</a></div><div class="ttdef"><b>Definition</b> <a href="_ellipsoid_8hpp_source.html#l00012">Ellipsoid.hpp:12</a></div></div>
<div class="ttc" id="anamespacedynamical__systems_html"><div class="ttname"><a href="namespacedynamical__systems.html">dynamical_systems</a></div><div class="ttdoc">Systems of equations relating state variables to their derivatives.</div><div class="ttdef"><b>Definition</b> <a href="_circular_8hpp_source.html#l00007">Circular.hpp:7</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- 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.8
</small></address>
</body>
</html>
Loading

0 comments on commit 9487363

Please sign in to comment.