Skip to content

Commit

Permalink
deploy: b27cebb
Browse files Browse the repository at this point in the history
  • Loading branch information
FrancoisCarouge committed Sep 22, 2024
1 parent 307983e commit 5896d03
Show file tree
Hide file tree
Showing 34 changed files with 161 additions and 191 deletions.
2 changes: 1 addition & 1 deletion classfcarouge_1_1kalman.xhtml
Original file line number Diff line number Diff line change
Expand Up @@ -995,7 +995,7 @@ template&lt;<a class="el" href="namespacefcarouge.xhtml#a6f496dc857f8b172efc57e3
</dl>
<dl class="section return"><dt>Returns</dt><dd>The reference value of this implicit object filter parameter, i.e. <code>*this</code>.</dd></dl>
<dl class="section user"><dt>Complexity</dt><dd>Constant.</dd></dl>
<dl class="todo"><dt><b><a class="el" href="todo.xhtml#_todo000037">Todo:</a></b></dt><dd>Implement and test. </dd></dl>
<dl class="todo"><dt><b><a class="el" href="todo.xhtml#_todo000038">Todo:</a></b></dt><dd>Implement and test. </dd></dl>

</div>
</div>
Expand Down
13 changes: 0 additions & 13 deletions eigen_2fcarouge_2linalg_8hpp.xhtml
Original file line number Diff line number Diff line change
Expand Up @@ -122,17 +122,6 @@ Namespaces</h2></td></tr>
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="typedef-members" name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">Algebraic Types</div></td></tr>
<tr><td colspan="2"><div class="groupText"><p>Naive matrix.</p>
<p>An array-of-arrays naive implementation matrix. The implementation is constexpr compatible.</p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">Type</td><td>The matrix element type. </td></tr>
<tr><td class="paramname">Row</td><td>The number of rows of the matrix. </td></tr>
<tr><td class="paramname">Column</td><td>The number of columns of the matrix. </td></tr>
</table>
</dd>
</dl>
</div></td></tr>
<tr class="memitem:a91e1f8a82696aa85761b7c29666235e6" id="r_a91e1f8a82696aa85761b7c29666235e6"><td class="memTemplParams" colspan="2">template&lt;<a class="el" href="namespacefcarouge.xhtml#a6f496dc857f8b172efc57e3ba9bfdbf8">typename</a> <a class="el" href="namespacefcarouge.xhtml#a6f496dc857f8b172efc57e3ba9bfdbf8">Type</a> = double, <a class="el" href="namespacefcarouge.xhtml#a6f496dc857f8b172efc57e3ba9bfdbf8">auto</a> Row = 1, <a class="el" href="namespacefcarouge.xhtml#a6f496dc857f8b172efc57e3ba9bfdbf8">auto</a> Column = 1&gt; </td></tr>
<tr class="memitem:a91e1f8a82696aa85761b7c29666235e6"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="namespacefcarouge.xhtml#a6f496dc857f8b172efc57e3ba9bfdbf8">using</a>&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacefcarouge.xhtml#a91e1f8a82696aa85761b7c29666235e6">fcarouge::matrix</a> = Eigen::Matrix&lt; <a class="el" href="namespacefcarouge.xhtml#a6f496dc857f8b172efc57e3ba9bfdbf8">Type</a>, Row, Column &gt;</td></tr>
<tr class="memdesc:a91e1f8a82696aa85761b7c29666235e6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compile-time sized Eigen3 matrix. <br /></td></tr>
Expand All @@ -149,8 +138,6 @@ Typedefs</h2></td></tr>
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="var-members" name="var-members"></a>
Variables</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">Algebraic Named Values</div></td></tr>
<tr><td colspan="2"><div class="groupText"><p>The identity matrix naive specialization. </p>
</div></td></tr>
<tr class="memitem:a86526ddb6bfec8982d096d3d47fae040" id="r_a86526ddb6bfec8982d096d3d47fae040"><td class="memTemplParams" colspan="2">template&lt;eigen Matrix&gt; </td></tr>
<tr class="memitem:a86526ddb6bfec8982d096d3d47fae040"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="namespacefcarouge.xhtml#a6f496dc857f8b172efc57e3ba9bfdbf8">const</a> <a class="el" href="namespacefcarouge.xhtml#a6f496dc857f8b172efc57e3ba9bfdbf8">auto</a>&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacefcarouge.xhtml#a86526ddb6bfec8982d096d3d47fae040">fcarouge::identity_v&lt; Matrix &gt;</a> {Matrix::Identity()}</td></tr>
<tr class="memdesc:a86526ddb6bfec8982d096d3d47fae040"><td class="mdescLeft">&#160;</td><td class="mdescRight">The identity matrix Eigen specialization. <br /></td></tr>
Expand Down
2 changes: 0 additions & 2 deletions lazy_2fcarouge_2linalg_8hpp.xhtml
Original file line number Diff line number Diff line change
Expand Up @@ -200,8 +200,6 @@ Variables</h2></td></tr>
<tr class="memitem:a7fe918283834c2c859a7325fc8d3a563"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="namespacefcarouge.xhtml#a6f496dc857f8b172efc57e3ba9bfdbf8">auto</a>&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacefcarouge.xhtml#a7fe918283834c2c859a7325fc8d3a563">fcarouge::make_zero_generator</a></td></tr>
<tr class="separator:a7fe918283834c2c859a7325fc8d3a563"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr><td colspan="2"><div class="groupHeader">Algebraic Named Values</div></td></tr>
<tr><td colspan="2"><div class="groupText"><p>The identity matrix naive specialization. </p>
</div></td></tr>
<tr class="memitem:a1ea35424b203a1ba2ab287785e36b753" id="r_a1ea35424b203a1ba2ab287785e36b753"><td class="memTemplParams" colspan="2">template&lt;<a class="el" href="namespacefcarouge.xhtml#a6f496dc857f8b172efc57e3ba9bfdbf8">typename</a> <a class="el" href="namespacefcarouge.xhtml#a6f496dc857f8b172efc57e3ba9bfdbf8">Type</a> , <a class="el" href="namespacefcarouge.xhtml#a6f496dc857f8b172efc57e3ba9bfdbf8">auto</a> Row, <a class="el" href="namespacefcarouge.xhtml#a6f496dc857f8b172efc57e3ba9bfdbf8">auto</a> Column&gt; </td></tr>
<tr class="memitem:a1ea35424b203a1ba2ab287785e36b753"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="namespacefcarouge.xhtml#a6f496dc857f8b172efc57e3ba9bfdbf8">auto</a>&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacefcarouge.xhtml#a1ea35424b203a1ba2ab287785e36b753">fcarouge::identity_v&lt; matrix&lt; Type, Row, Column &gt; &gt;</a></td></tr>
<tr class="memdesc:a1ea35424b203a1ba2ab287785e36b753"><td class="mdescLeft">&#160;</td><td class="mdescRight">The identity matrix lazy specialization. <br /></td></tr>
Expand Down
15 changes: 1 addition & 14 deletions namespacefcarouge.xhtml
Original file line number Diff line number Diff line change
Expand Up @@ -162,17 +162,6 @@ Concepts</h2></td></tr>
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="typedef-members" name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">Algebraic Types</div></td></tr>
<tr><td colspan="2"><div class="groupText"><p>Naive matrix.</p>
<p>An array-of-arrays naive implementation matrix. The implementation is constexpr compatible.</p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">Type</td><td>The matrix element type. </td></tr>
<tr><td class="paramname">Row</td><td>The number of rows of the matrix. </td></tr>
<tr><td class="paramname">Column</td><td>The number of columns of the matrix. </td></tr>
</table>
</dd>
</dl>
</div></td></tr>
<tr class="memitem:a91e1f8a82696aa85761b7c29666235e6" id="r_a91e1f8a82696aa85761b7c29666235e6"><td class="memTemplParams" colspan="2">template&lt;<a class="el" href="namespacefcarouge.xhtml#a6f496dc857f8b172efc57e3ba9bfdbf8">typename</a> <a class="el" href="namespacefcarouge.xhtml#a6f496dc857f8b172efc57e3ba9bfdbf8">Type</a> = double, <a class="el" href="namespacefcarouge.xhtml#a6f496dc857f8b172efc57e3ba9bfdbf8">auto</a> Row = 1, <a class="el" href="namespacefcarouge.xhtml#a6f496dc857f8b172efc57e3ba9bfdbf8">auto</a> Column = 1&gt; </td></tr>
<tr class="memitem:a91e1f8a82696aa85761b7c29666235e6"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="namespacefcarouge.xhtml#a6f496dc857f8b172efc57e3ba9bfdbf8">using</a>&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacefcarouge.xhtml#a91e1f8a82696aa85761b7c29666235e6">matrix</a> = Eigen::Matrix&lt; <a class="el" href="namespacefcarouge.xhtml#a6f496dc857f8b172efc57e3ba9bfdbf8">Type</a>, Row, Column &gt;</td></tr>
<tr class="memdesc:a91e1f8a82696aa85761b7c29666235e6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compile-time sized Eigen3 matrix. <br /></td></tr>
Expand Down Expand Up @@ -298,8 +287,6 @@ Variables</h2></td></tr>
<tr class="memitem:a7fe918283834c2c859a7325fc8d3a563"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="namespacefcarouge.xhtml#a6f496dc857f8b172efc57e3ba9bfdbf8">auto</a>&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacefcarouge.xhtml#a7fe918283834c2c859a7325fc8d3a563">make_zero_generator</a></td></tr>
<tr class="separator:a7fe918283834c2c859a7325fc8d3a563"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr><td colspan="2"><div class="groupHeader">Algebraic Named Values</div></td></tr>
<tr><td colspan="2"><div class="groupText"><p>The identity matrix naive specialization. </p>
</div></td></tr>
<tr class="memitem:af5d9207021a8118ac46558fd9a453d6d" id="r_af5d9207021a8118ac46558fd9a453d6d"><td class="memTemplParams" colspan="2">template&lt;<a class="el" href="namespacefcarouge.xhtml#a6f496dc857f8b172efc57e3ba9bfdbf8">typename</a> <a class="el" href="namespacefcarouge.xhtml#a6f496dc857f8b172efc57e3ba9bfdbf8">Type</a> = double&gt; </td></tr>
<tr class="memitem:af5d9207021a8118ac46558fd9a453d6d"><td class="memTemplItemLeft" align="right" valign="top">constexpr <a class="el" href="namespacefcarouge.xhtml#a6f496dc857f8b172efc57e3ba9bfdbf8">Type</a>&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacefcarouge.xhtml#af5d9207021a8118ac46558fd9a453d6d">identity_v</a></td></tr>
<tr class="memdesc:af5d9207021a8118ac46558fd9a453d6d"><td class="mdescLeft">&#160;</td><td class="mdescRight">The identity matrix. <br /></td></tr>
Expand Down Expand Up @@ -389,7 +376,7 @@ Units for Matrices" by Daniel Withopf and record the lesson learned: both usage
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Francois Carouge's projects namespace. </p>
<p>The definitions and implementations of the library intended for public usage. Lowers the name conflict probability in large projects. Use using-declarations or namespace-alias-definition per your project guidelines.</p>
<dl class="todo"><dt><b><a class="el" href="todo.xhtml#_todo000031">Todo:</a></b></dt><dd>Remove the dependency on <code>std::initializer_list</code> if possible? </dd></dl>
<dl class="todo"><dt><b><a class="el" href="todo.xhtml#_todo000030">Todo:</a></b></dt><dd>Remove the dependency on <code>std::initializer_list</code> if possible? </dd></dl>
</div><h2 class="groupheader">Typedef Documentation</h2>
<a id="a6f496dc857f8b172efc57e3ba9bfdbf8" name="a6f496dc857f8b172efc57e3ba9bfdbf8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6f496dc857f8b172efc57e3ba9bfdbf8">&#9670;&#160;</a></span>column_vector</h2>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,7 @@ template&lt;<a class="el" href="namespacefcarouge.xhtml#a6f496dc857f8b172efc57e3
</tr>
</table>
</div><div class="memdoc">
<dl class="test"><dt><b><a class="el" href="test.xhtml#_test000001">Test:</a></b></dt><dd>Verifies the multi-dimension filter is move-assignable. </dd></dl>
<dl class="test"><dt><b><a class="el" href="test.xhtml#_test000002">Test:</a></b></dt><dd>Verifies the multi-dimension filter is move-assignable. </dd></dl>

<p class="definition">Definition at line <a class="el" href="kalman__assign__move__5x4x3_8cpp_source.xhtml#l00051">51</a> of file <a class="el" href="kalman__assign__move__5x4x3_8cpp_source.xhtml">kalman_assign_move_5x4x3.cpp</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 51</span> {[] {</div>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ Variables</h2></td></tr>
<div class="line"> <span class="keywordflow">return</span> 0;</div>
<div class="line">}()}</div>
<div class="ttc" id="anamespacefcarouge_xhtml_a6fcefc6a3f548e5225223c8594e62b65"><div class="ttname"><a href="namespacefcarouge.xhtml#a6fcefc6a3f548e5225223c8594e62b65">fcarouge::kalman</a></div><div class="ttdeci">kalman(Arguments... arguments) -&gt; kalman&lt; internal::filter_t&lt; Arguments... &gt; &gt;</div></div>
</div><!-- fragment --><dl class="test"><dt><b><a class="el" href="test.xhtml#_test000002">Test:</a></b></dt><dd>Verifies default values are initialized for single-dimension filters without input control. </dd></dl>
</div><!-- fragment --><dl class="test"><dt><b><a class="el" href="test.xhtml#_test000001">Test:</a></b></dt><dd>Verifies default values are initialized for single-dimension filters without input control. </dd></dl>

<p class="definition">Definition at line <a class="el" href="kalman__constructor__default_8cpp_source.xhtml#l00047">47</a> of file <a class="el" href="kalman__constructor__default_8cpp_source.xhtml">kalman_constructor_default.cpp</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 47</span> {[] {</div>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -195,7 +195,7 @@ template&lt;<a class="el" href="namespacefcarouge.xhtml#a6f496dc857f8b172efc57e3
<div class="ttc" id="anamespacefcarouge_1_1internal_xhtml_a20aafbaa1ca1e63d87200afec6d43cc9"><div class="ttname"><a href="namespacefcarouge_1_1internal.xhtml#a20aafbaa1ca1e63d87200afec6d43cc9">fcarouge::internal::filter</a></div><div class="ttdeci">constexpr make_filter&lt; Filter &gt; filter</div><div class="ttdef"><b>Definition</b> <a href="factory_8hpp_source.xhtml#l00268">factory.hpp:268</a></div></div>
<div class="ttc" id="anamespacefcarouge_xhtml_a6f496dc857f8b172efc57e3ba9bfdbf8"><div class="ttname"><a href="namespacefcarouge.xhtml#a6f496dc857f8b172efc57e3ba9bfdbf8">fcarouge::column_vector</a></div><div class="ttdeci">Eigen::Vector&lt; Type, Row &gt; column_vector</div><div class="ttdoc">Compile-time sized Eigen3 column vector.</div><div class="ttdef"><b>Definition</b> <a href="eigen_2fcarouge_2linalg_8hpp_source.xhtml#l00073">linalg.hpp:73</a></div></div>
<div class="ttc" id="anamespacefcarouge_xhtml_a6fcefc6a3f548e5225223c8594e62b65"><div class="ttname"><a href="namespacefcarouge.xhtml#a6fcefc6a3f548e5225223c8594e62b65">fcarouge::kalman</a></div><div class="ttdeci">kalman(Arguments... arguments) -&gt; kalman&lt; internal::filter_t&lt; Arguments... &gt; &gt;</div></div>
</div><!-- fragment --><dl class="test"><dt><b><a class="el" href="test.xhtml#_test000010">Test:</a></b></dt><dd>Verifies default values are initialized for multi-dimension filters, single input edge case. </dd></dl>
</div><!-- fragment --><dl class="test"><dt><b><a class="el" href="test.xhtml#_test000009">Test:</a></b></dt><dd>Verifies default values are initialized for multi-dimension filters, single input edge case. </dd></dl>

<p class="definition">Definition at line <a class="el" href="kalman__constructor__default__5x4x1_8cpp_source.xhtml#l00051">51</a> of file <a class="el" href="kalman__constructor__default__5x4x1_8cpp_source.xhtml">kalman_constructor_default_5x4x1.cpp</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 51</span> {[] {</div>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -196,7 +196,7 @@ template&lt;<a class="el" href="namespacefcarouge.xhtml#a6f496dc857f8b172efc57e3
<div class="ttc" id="anamespacefcarouge_1_1internal_xhtml_a20aafbaa1ca1e63d87200afec6d43cc9"><div class="ttname"><a href="namespacefcarouge_1_1internal.xhtml#a20aafbaa1ca1e63d87200afec6d43cc9">fcarouge::internal::filter</a></div><div class="ttdeci">constexpr make_filter&lt; Filter &gt; filter</div><div class="ttdef"><b>Definition</b> <a href="factory_8hpp_source.xhtml#l00268">factory.hpp:268</a></div></div>
<div class="ttc" id="anamespacefcarouge_xhtml_a6f496dc857f8b172efc57e3ba9bfdbf8"><div class="ttname"><a href="namespacefcarouge.xhtml#a6f496dc857f8b172efc57e3ba9bfdbf8">fcarouge::column_vector</a></div><div class="ttdeci">Eigen::Vector&lt; Type, Row &gt; column_vector</div><div class="ttdoc">Compile-time sized Eigen3 column vector.</div><div class="ttdef"><b>Definition</b> <a href="eigen_2fcarouge_2linalg_8hpp_source.xhtml#l00073">linalg.hpp:73</a></div></div>
<div class="ttc" id="anamespacefcarouge_xhtml_a6fcefc6a3f548e5225223c8594e62b65"><div class="ttname"><a href="namespacefcarouge.xhtml#a6fcefc6a3f548e5225223c8594e62b65">fcarouge::kalman</a></div><div class="ttdeci">kalman(Arguments... arguments) -&gt; kalman&lt; internal::filter_t&lt; Arguments... &gt; &gt;</div></div>
</div><!-- fragment --><dl class="test"><dt><b><a class="el" href="test.xhtml#_test000011">Test:</a></b></dt><dd>Verifies default values are initialized for multi-dimension filters. </dd></dl>
</div><!-- fragment --><dl class="test"><dt><b><a class="el" href="test.xhtml#_test000010">Test:</a></b></dt><dd>Verifies default values are initialized for multi-dimension filters. </dd></dl>

<p class="definition">Definition at line <a class="el" href="kalman__constructor__default__5x4x3_8cpp_source.xhtml#l00050">50</a> of file <a class="el" href="kalman__constructor__default__5x4x3_8cpp_source.xhtml">kalman_constructor_default_5x4x3.cpp</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 50</span> {[] {</div>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ Variables</h2></td></tr>
<div class="line">}()}</div>
<div class="ttc" id="anamespacefcarouge_xhtml_a6f496dc857f8b172efc57e3ba9bfdbf8"><div class="ttname"><a href="namespacefcarouge.xhtml#a6f496dc857f8b172efc57e3ba9bfdbf8">fcarouge::column_vector</a></div><div class="ttdeci">Eigen::Vector&lt; Type, Row &gt; column_vector</div><div class="ttdoc">Compile-time sized Eigen3 column vector.</div><div class="ttdef"><b>Definition</b> <a href="eigen_2fcarouge_2linalg_8hpp_source.xhtml#l00073">linalg.hpp:73</a></div></div>
<div class="ttc" id="anamespacefcarouge_xhtml_a6fcefc6a3f548e5225223c8594e62b65"><div class="ttname"><a href="namespacefcarouge.xhtml#a6fcefc6a3f548e5225223c8594e62b65">fcarouge::kalman</a></div><div class="ttdeci">kalman(Arguments... arguments) -&gt; kalman&lt; internal::filter_t&lt; Arguments... &gt; &gt;</div></div>
</div><!-- fragment --><dl class="test"><dt><b><a class="el" href="test.xhtml#_test000009">Test:</a></b></dt><dd>Verifies default values are initialized for single-dimension filters with input control. </dd></dl>
</div><!-- fragment --><dl class="test"><dt><b><a class="el" href="test.xhtml#_test000011">Test:</a></b></dt><dd>Verifies default values are initialized for single-dimension filters with input control. </dd></dl>

<p class="definition">Definition at line <a class="el" href="kalman__constructor__default__float__1x1x1_8cpp_source.xhtml#l00047">47</a> of file <a class="el" href="kalman__constructor__default__float__1x1x1_8cpp_source.xhtml">kalman_constructor_default_float_1x1x1.cpp</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 47</span> {[] {</div>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,7 @@ template&lt;<a class="el" href="namespacefcarouge.xhtml#a6f496dc857f8b172efc57e3
</tr>
</table>
</div><div class="memdoc">
<dl class="test"><dt><b><a class="el" href="test.xhtml#_test000013">Test:</a></b></dt><dd>Verifies the multi-dimension filter is move-constructible. </dd></dl>
<dl class="test"><dt><b><a class="el" href="test.xhtml#_test000012">Test:</a></b></dt><dd>Verifies the multi-dimension filter is move-constructible. </dd></dl>

<p class="definition">Definition at line <a class="el" href="kalman__constructor__move__5x4x3_8cpp_source.xhtml#l00051">51</a> of file <a class="el" href="kalman__constructor__move__5x4x3_8cpp_source.xhtml">kalman_constructor_move_5x4x3.cpp</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 51</span> {[] {</div>
Expand Down
Loading

0 comments on commit 5896d03

Please sign in to comment.