diff --git a/doc/Matlab_interface.md b/doc/Matlab_interface.md index eb6c8479..6223747a 100644 --- a/doc/Matlab_interface.md +++ b/doc/Matlab_interface.md @@ -13,8 +13,8 @@ objects in the library: - Biarc - ClothoidCurve - PolyLine -- ClothoisList -- ClothoisSplineG2 +- ClothoidList +- ClothoidSplineG2 - Triangle2D - FresnelCS @@ -504,7 +504,7 @@ XY_DD = CL.eval_DD( s, offs ); XY_DDD = CL.eval_DDD( s, offs ); ``` -## ClothoisList +## ClothoidList Store a list of clothoids to be used as a single spline. @@ -512,7 +512,7 @@ Store a list of clothoids to be used as a single spline. Documentation will be available soon, see examples in `tests` for the moments -## ClothoisSplineG2 +## ClothoidSplineG2 Implements the algorithm described in references [2] and [3]. diff --git a/docs/api/class_g2lib_1_1_clothoid_list.html b/docs/api/class_g2lib_1_1_clothoid_list.html index 96178d64..793814c2 100644 --- a/docs/api/class_g2lib_1_1_clothoid_list.html +++ b/docs/api/class_g2lib_1_1_clothoid_list.html @@ -134,7 +134,7 @@
init
()¶initialize the clothois list
+initialize the clothoid list
reserve
(int_type n)¶reserve memory for n
clothois
reserve memory for n
clothoids
closure_check
(real_type tol_xy = 1e-6, real_type tol_tg = 1e-6) const¶check if clothois list is closed
+check if clothoid list is closed
numSegment
() const¶return the numbber of clothois of the list
+return the numbber of clothoids of the list
wrap_in_range
(real_type &s) const¶The list of clothois has total length \( L \) the parameter \( s \) us recomputed as \( s+kL\) in such a way \( s+kL\in[0,L)\) with \( k\in\mathbb{Z} \).
+The list of clothoids has total length \( L \) the parameter \( s \) us recomputed as \( s+kL\) in such a way \( s+kL\in[0,L)\) with \( k\in\mathbb{Z} \).
getSK
(real_type *s, real_type *kappa) const¶Return the clothois list as a list of nodes and curvatures
+Return the clothoid list as a list of nodes and curvatures
getSK
(std::vector<real_type> &s, std::vector<real_type> &kappa) const¶Return the clothois list as a list of nodes and curvatures
+Return the clothoid list as a list of nodes and curvatures
getSTK
(real_type *s, real_type *theta, real_type *kappa) const¶Return the clothois list as a list of nodes angles and curvatures
+Return the clothoid list as a list of nodes angles and curvatures
getSTK
(std::vector<real_type> &s, std::vector<real_type> &theta, std::vector<real_type> &kappa) const¶Return the clothois list as a list of nodes angles and curvatures
+Return the clothoid list as a list of nodes angles and curvatures
Store a list of clothoids to be used as a single spline.
Documentation will be available soon, see examples in tests
for the moments
Implements the algorithm described in references [2] and [3].
documentation will be available soon, see examples in tests
for the moments
Store a list of clothoids to be used as a single spline.
Documentation will be available soon, see examples in tests
for the moments
Implements the algorithm described in references [2] and [3].