Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history 
Triggered by commit da5b462.

Co-authored-by: nahueespinosa <[email protected]>
  • Loading branch information
@github-actions @nahueespinosa
github-actions[bot] and nahueespinosa committed Jan 15, 2024
1 parent dc00b03 commit 71c5a61
Show file tree
Hide file tree
Showing 239 changed files with 1,329 additions and 1,278 deletions.
4 changes: 2 additions & 2 deletions annotated.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -165,8 +165,8 @@
<tr id="row_0_64_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structbeluga_1_1tuple__index_3_01T_00_01TupleLike_3_01Args_8_8_8_01_4_00_01std_1_1enable__if__t_8b6a44f3e1dec7206a1db1c3f8ee23de.html" target="_self">tuple_index&lt; T, TupleLike&lt; Args... &gt;, std::enable_if_t&lt; is_tuple_like_v&lt; std::decay_t&lt; TupleLike&lt; Args... &gt; &gt; &gt; &amp;&amp;detail::tuple_index_found&lt; T, Args... &gt;()&gt; &gt;</a></td><td class="desc"><code><a class="el" href="structbeluga_1_1tuple__index.html" title="Meta-function that returns the tuple index of the element whose type is T.">tuple_index</a></code> specialization for tuples </td></tr>
<tr id="row_0_65_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structbeluga_1_1has__single__element.html" target="_self">has_single_element</a></td><td class="desc">Meta-function that returns true if there is a single element of type T in the tuple-like type </td></tr>
<tr id="row_0_66_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structbeluga_1_1has__single__element_3_01T_00_01TupleLike_3_01Args_8_8_8_01_4_00_01std_1_1enable74bb370853b4969c8155f7c3b3c0dd64.html" target="_self">has_single_element&lt; T, TupleLike&lt; Args... &gt;, std::enable_if_t&lt; is_tuple_like_v&lt; std::decay_t&lt; TupleLike&lt; Args... &gt; &gt; &gt; &amp;&amp;detail::tuple_index_found&lt; T, Args... &gt;()&gt; &gt;</a></td><td class="desc"><code><a class="el" href="structbeluga_1_1has__single__element.html" title="Meta-function that returns true if there is a single element of type T in the tuple-like type.">has_single_element</a></code> specialization for tuples </td></tr>
<tr id="row_0_67_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structbeluga_1_1std__tuple__decay.html" target="_self">std_tuple_decay</a></td><td class="desc">Meta-function that returns a std::tuple with decayed types given a tuple-like type </td></tr>
<tr id="row_0_68_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structbeluga_1_1std__tuple__decay_3_01TupleLike_3_01Args_8_8_8_01_4_00_01std_1_1enable__if__t_3_3328432e4045266018fea12ec70b7228.html" target="_self">std_tuple_decay&lt; TupleLike&lt; Args... &gt;, std::enable_if_t&lt; is_tuple_like_v&lt; std::decay_t&lt; TupleLike&lt; Args... &gt; &gt; &gt; &gt; &gt;</a></td><td class="desc"><code><a class="el" href="structbeluga_1_1std__tuple__decay.html" title="Meta-function that returns a std::tuple with decayed types given a tuple-like type.">std_tuple_decay</a></code> specialization for tuples </td></tr>
<tr id="row_0_67_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structbeluga_1_1decay__tuple__like.html" target="_self">decay_tuple_like</a></td><td class="desc">Meta-function that decays a tuple like type and its members </td></tr>
<tr id="row_0_68_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structbeluga_1_1decay__tuple__like_3_01TupleLike_3_01Args_8_8_8_01_4_00_01std_1_1enable__if__t_3ee802d0cdb58b24411f7d7c175ec0540.html" target="_self">decay_tuple_like&lt; TupleLike&lt; Args... &gt;, std::enable_if_t&lt; is_tuple_like_v&lt; std::decay_t&lt; TupleLike&lt; Args... &gt; &gt; &gt; &gt; &gt;</a></td><td class="desc"><code><a class="el" href="structbeluga_1_1decay__tuple__like.html" title="Meta-function that decays a tuple like type and its members.">decay_tuple_like</a></code> specialization for tuples </td></tr>
<tr id="row_0_69_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structbeluga_1_1LandmarkMapBoundaries.html" target="_self">LandmarkMapBoundaries</a></td><td class="desc">Landmark bearing detection data </td></tr>
<tr id="row_0_70_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structbeluga_1_1LandmarkPositionDetection.html" target="_self">LandmarkPositionDetection</a></td><td class="desc">Landmark bearing detection data </td></tr>
<tr id="row_0_71_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structbeluga_1_1LandmarkBearingDetection.html" target="_self">LandmarkBearingDetection</a></td><td class="desc">Landmark bearing detection data </td></tr>
Expand Down
100 changes: 50 additions & 50 deletions beluga_8hpp.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -89,56 +89,56 @@
<div class="dyncontent">
<div class="center"><img src="beluga_8hpp__incl.png" border="0" usemap="#a_2____w_2beluga_2beluga_2src_2beluga_2beluga_2include_2beluga_2beluga_8hpp" alt=""/></div>
<map name="a_2____w_2beluga_2beluga_2src_2beluga_2beluga_2include_2beluga_2beluga_8hpp" id="a_2____w_2beluga_2beluga_2src_2beluga_2beluga_2include_2beluga_2beluga_8hpp">
<area shape="rect" title="Includes all the Beluga API." alt="" coords="2414,5,2606,61"/>
<area shape="rect" href="actions_8hpp.html" title="Implementation of useful range actions." alt="" coords="440,109,585,136"/>
<area shape="rect" href="algorithm_8hpp.html" title="Includes all beluga algorithms." alt="" coords="1669,191,1831,218"/>
<area shape="rect" href="mixin_8hpp.html" title="Implementation of mixin utilities and extensions." alt="" coords="2913,109,3048,136"/>
<area shape="rect" href="primitives_8hpp.html" title="Implementation of library primitives to abstract member access." alt="" coords="2407,556,2571,583"/>
<area shape="rect" href="type__traits_8hpp.html" title="Includes all Beluga type traits." alt="" coords="2497,385,2665,411"/>
<area shape="rect" href="tuple__vector_8hpp.html" title="Implementation of a tuple of containers." alt="" coords="2715,288,2894,315"/>
<area shape="rect" href="motion_8hpp.html" title="Includes all Beluga motion models." alt="" coords="3803,109,3947,136"/>
<area shape="rect" href="random_8hpp.html" title="Includes all Beluga random distributions." alt="" coords="4227,109,4375,136"/>
<area shape="rect" href="sensor_8hpp.html" title="Includes all Beluga sensor models and their interfaces." alt="" coords="732,109,872,136"/>
<area shape="rect" href="views_8hpp.html" title="Implementation of useful container views." alt="" coords="2054,288,2190,315"/>
<area shape="rect" href="assign_8hpp_source.html" title=" " alt="" coords="355,191,545,218"/>
<area shape="rect" href="distance__map_8hpp.html" title="Implementation of algorithm to calculate distance from obstacles." alt="" coords="1185,281,1377,322"/>
<area shape="rect" href="estimation_8hpp.html" title="Implementation of algorithms that allow calculating the estimated state of a particle filter." alt="" coords="1710,288,1945,315"/>
<area shape="rect" href="exponential__filter_8hpp.html" title="Implementation of an exponential filter." alt="" coords="1565,377,1780,419"/>
<area shape="rect" href="raycasting_8hpp.html" title="Implementation of raycasting algorithms." alt="" coords="1401,288,1635,315"/>
<area shape="rect" href="spatial__hash_8hpp.html" title="Implementation of a spatial hash for N dimensional states." alt="" coords="1915,467,2097,508"/>
<area shape="rect" title=" " alt="" coords="828,385,891,411"/>
<area shape="rect" title=" " alt="" coords="2151,720,2205,747"/>
<area shape="rect" title=" " alt="" coords="2595,720,2687,747"/>
<area shape="rect" title=" " alt="" coords="2699,191,2777,218"/>
<area shape="rect" href="descriptor_8hpp.html" title="Implementation of descriptors and their traits." alt="" coords="3125,474,3327,501"/>
<area shape="rect" href="utility_8hpp.html" title="Implementation of extensions to the standard utility library." alt="" coords="3139,556,3313,583"/>
<area shape="rect" href="particle__filter_8hpp.html" title="Implementation of particle filters." alt="" coords="3357,281,3517,322"/>
<area shape="rect" href="sampling_8hpp.html" title="Implementation of algorithms related to generation, sampling and resampling of particles." alt="" coords="2220,288,2419,315"/>
<area shape="rect" href="storage_8hpp.html" title="Implementation of storage policies." alt="" coords="2985,191,3173,218"/>
<area shape="rect" href="ciabatta_8hpp_source.html" title=" " alt="" coords="2801,191,2961,218"/>
<area shape="rect" href="forward__like_8hpp_source.html" title=" " alt="" coords="2901,631,3063,672"/>
<area shape="rect" href="particle__traits_8hpp.html" title="Implementation of traits for particle types, see the Particle named requirements." alt="" coords="2509,467,2653,508"/>
<area shape="rect" href="strongly__typed__numeric_8hpp.html" title="Implementation of a strongly typed numeric helper." alt="" coords="2666,631,2877,672"/>
<area shape="rect" href="tuple__traits_8hpp.html" title="Implementation of traits for tuple&#45;like types." alt="" coords="2329,631,2469,672"/>
<area shape="rect" href="particles_8hpp.html" title="Implementation of views related to particle ranges." alt="" coords="2225,385,2421,411"/>
<area shape="rect" href="random__intersperse_8hpp.html" title="Implementation of a random_intersperse range adaptor object." alt="" coords="1805,377,1967,419"/>
<area shape="rect" title=" " alt="" coords="2937,377,3083,419"/>
<area shape="rect" title=" " alt="" coords="3107,385,3289,411"/>
<area shape="rect" title=" " alt="" coords="3313,385,3488,411"/>
<area shape="rect" href="zip_8hpp.html" title="Implementation of a zip range adaptor object." alt="" coords="2043,385,2201,411"/>
<area shape="rect" title=" " alt="" coords="2740,377,2912,419"/>
<area shape="rect" href="differential__drive__model_8hpp.html" title="Implementation of a differential drive odometry motion model." alt="" coords="3665,184,3856,225"/>
<area shape="rect" href="omnidirectional__drive__model_8hpp.html" title="Implementation of an omnidirectional drive odometry motion model." alt="" coords="3880,184,4103,225"/>
<area shape="rect" href="stationary__model_8hpp.html" title="Implementation of a stationary motion model." alt="" coords="4127,184,4314,225"/>
<area shape="rect" href="multivariate__normal__distribution_8hpp.html" title="Implementation of a multivariate normal distribution." alt="" coords="4339,184,4543,225"/>
<area shape="rect" href="bearing__sensor__model__interface_8hpp.html" title="Includes the interface for bearing sensor models." alt="" coords="609,281,822,322"/>
<area shape="rect" href="landmark__sensor__model__interface_8hpp.html" title="Includes the interface for generic landmark sensor models." alt="" coords="897,281,1110,322"/>
<area shape="rect" href="laser__sensor__model__interface__2d_8hpp.html" title="Includes the interface for laser sensor models." alt="" coords="5,273,191,329"/>
<area shape="rect" href="beam__model_8hpp.html" title="Implementation of a beam sensor model for range finders." alt="" coords="1070,184,1225,225"/>
<area shape="rect" href="bearing__sensor__model_8hpp.html" title="Implementation of a discrete landmark bearing sensor model." alt="" coords="215,281,381,322"/>
<area shape="rect" href="landmark__sensor__model_8hpp.html" title="Implementation of a discrete landmark sensor model." alt="" coords="406,281,585,322"/>
<area shape="rect" href="likelihood__field__model_8hpp.html" title="Implementation of a likelihood field sensor model for range finders." alt="" coords="773,184,953,225"/>
<area shape="rect" href="elements_8hpp.html" title="Implementation of the C++20&#39;s std::views::elements view." alt="" coords="1548,556,1749,583"/>
<area shape="rect" title="Includes all the Beluga API." alt="" coords="2485,5,2677,61"/>
<area shape="rect" href="actions_8hpp.html" title="Implementation of useful range actions." alt="" coords="619,109,764,136"/>
<area shape="rect" href="algorithm_8hpp.html" title="Includes all beluga algorithms." alt="" coords="1935,191,2096,218"/>
<area shape="rect" href="mixin_8hpp.html" title="Implementation of mixin utilities and extensions." alt="" coords="2839,109,2973,136"/>
<area shape="rect" href="primitives_8hpp.html" title="Implementation of library primitives to abstract member access." alt="" coords="2781,556,2945,583"/>
<area shape="rect" href="type__traits_8hpp.html" title="Includes all Beluga type traits." alt="" coords="2402,385,2570,411"/>
<area shape="rect" href="tuple__vector_8hpp.html" title="Implementation of a tuple of containers." alt="" coords="2738,288,2917,315"/>
<area shape="rect" href="motion_8hpp.html" title="Includes all Beluga motion models." alt="" coords="3759,109,3903,136"/>
<area shape="rect" href="random_8hpp.html" title="Includes all Beluga random distributions." alt="" coords="4183,109,4331,136"/>
<area shape="rect" href="sensor_8hpp.html" title="Includes all Beluga sensor models and their interfaces." alt="" coords="872,109,1012,136"/>
<area shape="rect" href="views_8hpp.html" title="Implementation of useful container views." alt="" coords="1402,288,1538,315"/>
<area shape="rect" href="assign_8hpp_source.html" title=" " alt="" coords="536,191,727,218"/>
<area shape="rect" href="distance__map_8hpp.html" title="Implementation of algorithm to calculate distance from obstacles." alt="" coords="1186,281,1378,322"/>
<area shape="rect" href="estimation_8hpp.html" title="Implementation of algorithms that allow calculating the estimated state of a particle filter." alt="" coords="1821,288,2055,315"/>
<area shape="rect" href="exponential__filter_8hpp.html" title="Implementation of an exponential filter." alt="" coords="1891,377,2105,419"/>
<area shape="rect" href="raycasting_8hpp.html" title="Implementation of raycasting algorithms." alt="" coords="1563,288,1796,315"/>
<area shape="rect" href="spatial__hash_8hpp.html" title="Implementation of a spatial hash for N dimensional states." alt="" coords="2187,467,2369,508"/>
<area shape="rect" title=" " alt="" coords="936,385,999,411"/>
<area shape="rect" title=" " alt="" coords="2439,720,2493,747"/>
<area shape="rect" title=" " alt="" coords="2907,720,2999,747"/>
<area shape="rect" title=" " alt="" coords="2946,191,3023,218"/>
<area shape="rect" href="descriptor_8hpp.html" title="Implementation of descriptors and their traits." alt="" coords="3595,474,3798,501"/>
<area shape="rect" href="utility_8hpp.html" title="Implementation of extensions to the standard utility library." alt="" coords="3385,556,3560,583"/>
<area shape="rect" href="particle__filter_8hpp.html" title="Implementation of particle filters." alt="" coords="2554,281,2714,322"/>
<area shape="rect" href="sampling_8hpp.html" title="Implementation of algorithms related to generation, sampling and resampling of particles." alt="" coords="2180,288,2379,315"/>
<area shape="rect" href="storage_8hpp.html" title="Implementation of storage policies." alt="" coords="2733,191,2921,218"/>
<area shape="rect" href="ciabatta_8hpp_source.html" title=" " alt="" coords="3047,191,3207,218"/>
<area shape="rect" href="forward__like_8hpp_source.html" title=" " alt="" coords="3157,631,3319,672"/>
<area shape="rect" href="particle__traits_8hpp.html" title="Implementation of traits for particle types, see the Particle named requirements." alt="" coords="2653,467,2797,508"/>
<area shape="rect" href="tuple__traits_8hpp.html" title="Implementation of traits for tuple&#45;like types." alt="" coords="2653,631,2793,672"/>
<area shape="rect" href="strongly__typed__numeric_8hpp.html" title="Implementation of a strongly typed numeric helper." alt="" coords="2919,631,3130,672"/>
<area shape="rect" href="particles_8hpp.html" title="Implementation of views related to particle ranges." alt="" coords="2181,385,2377,411"/>
<area shape="rect" href="random__intersperse_8hpp.html" title="Implementation of a random_intersperse range adaptor object." alt="" coords="1469,377,1631,419"/>
<area shape="rect" title=" " alt="" coords="2893,377,3039,419"/>
<area shape="rect" title=" " alt="" coords="3063,385,3245,411"/>
<area shape="rect" title=" " alt="" coords="3269,385,3444,411"/>
<area shape="rect" href="zip_8hpp.html" title="Implementation of a zip range adaptor object." alt="" coords="1656,385,1815,411"/>
<area shape="rect" title=" " alt="" coords="2696,377,2868,419"/>
<area shape="rect" href="differential__drive__model_8hpp.html" title="Implementation of a differential drive odometry motion model." alt="" coords="3621,184,3812,225"/>
<area shape="rect" href="omnidirectional__drive__model_8hpp.html" title="Implementation of an omnidirectional drive odometry motion model." alt="" coords="3836,184,4059,225"/>
<area shape="rect" href="stationary__model_8hpp.html" title="Implementation of a stationary motion model." alt="" coords="4083,184,4270,225"/>
<area shape="rect" href="multivariate__normal__distribution_8hpp.html" title="Implementation of a multivariate normal distribution." alt="" coords="4295,184,4499,225"/>
<area shape="rect" href="bearing__sensor__model__interface_8hpp.html" title="Includes the interface for bearing sensor models." alt="" coords="399,281,613,322"/>
<area shape="rect" href="landmark__sensor__model__interface_8hpp.html" title="Includes the interface for generic landmark sensor models." alt="" coords="637,281,850,322"/>
<area shape="rect" href="laser__sensor__model__interface__2d_8hpp.html" title="Includes the interface for laser sensor models." alt="" coords="875,273,1060,329"/>
<area shape="rect" href="beam__model_8hpp.html" title="Implementation of a beam sensor model for range finders." alt="" coords="1211,184,1366,225"/>
<area shape="rect" href="bearing__sensor__model_8hpp.html" title="Implementation of a discrete landmark bearing sensor model." alt="" coords="5,281,172,322"/>
<area shape="rect" href="landmark__sensor__model_8hpp.html" title="Implementation of a discrete landmark sensor model." alt="" coords="197,281,375,322"/>
<area shape="rect" href="likelihood__field__model_8hpp.html" title="Implementation of a likelihood field sensor model for range finders." alt="" coords="1007,184,1187,225"/>
<area shape="rect" href="elements_8hpp.html" title="Implementation of the C++20&#39;s std::views::elements view." alt="" coords="1660,556,1861,583"/>
</map>
</div>
</div>
Expand Down
Loading

0 comments on commit 71c5a61

Please sign in to comment.