Merge pull request #23 from ben-z/fix-spelling

Fix the spelling of Clothoids, ClothoidList, ClothoidSplineG2, etc. in the docs
ebertolazzi · May 5, 2021 · f250a99 · f250a99
2 parents 41d36b8 + 5f17249
commit f250a99
Show file tree

Hide file tree

Showing 10 changed files with 42 additions and 42 deletions.
diff --git 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,15 +504,15 @@ 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.
 
 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
@@ -134,7 +134,7 @@ <h2>Class Documentation<a class="headerlink" href="#class-documentation" title="
 <span id="_CPPv3N5G2lib12ClothoidList4initEv"></span><span id="_CPPv2N5G2lib12ClothoidList4initEv"></span><span id="G2lib::ClothoidList::init"></span><span class="target" id="class_g2lib_1_1_clothoid_list_1a02fd73d861ef2e4aabb38c0c9ff82947"></span><span class="pre">void</span> <code class="sig-name descname"><span class="pre">init</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5G2lib12ClothoidList4initEv" title="Permalink to this definition">¶</a><br>
 </dt>
 <dd>
-<p>initialize the clothois list </p>
+<p>initialize the clothoid list </p>
 </dd>
 </dl>
 
@@ -143,7 +143,7 @@ <h2>Class Documentation<a class="headerlink" href="#class-documentation" title="
 <span id="_CPPv3N5G2lib12ClothoidList7reserveE8int_type"></span><span id="_CPPv2N5G2lib12ClothoidList7reserveE8int_type"></span><span id="G2lib::ClothoidList::reserve__int_type"></span><span class="target" id="class_g2lib_1_1_clothoid_list_1ad3913b018bd1f832c239780ef464cf61"></span><span class="pre">void</span> <code class="sig-name descname"><span class="pre">reserve</span></code><span class="sig-paren">(</span><a class="reference internal" href="typedef_namespace_g2lib_1ac4de9d9335536ac22821171deec8d39e.html#_CPPv4N5G2lib8int_typeE" title="G2lib::int_type"><span class="pre">int_type</span></a> <em><span class="pre">n</span></em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5G2lib12ClothoidList7reserveE8int_type" title="Permalink to this definition">¶</a><br>
 </dt>
 <dd>
-<p>reserve memory for <code class="docutils literal notranslate"><span class="pre">n</span></code> clothois </p>
+<p>reserve memory for <code class="docutils literal notranslate"><span class="pre">n</span></code> clothoids </p>
 </dd>
 </dl>
 
@@ -440,7 +440,7 @@ <h2>Class Documentation<a class="headerlink" href="#class-documentation" title="
 <span id="_CPPv3NK5G2lib12ClothoidList13closure_checkE9real_type9real_type"></span><span id="_CPPv2NK5G2lib12ClothoidList13closure_checkE9real_type9real_type"></span><span id="G2lib::ClothoidList::closure_check__real_type.real_typeC"></span><span class="target" id="class_g2lib_1_1_clothoid_list_1a25db7b758c8ec4e1181309f4c6fc039b"></span><em class="property"><span class="pre">inline</span></em> <span class="pre">bool</span> <code class="sig-name descname"><span class="pre">closure_check</span></code><span class="sig-paren">(</span><a class="reference internal" href="typedef_namespace_g2lib_1ac0b09ba58a37f5f3ca415be4a02ec7aa.html#_CPPv4N5G2lib9real_typeE" title="G2lib::real_type"><span class="pre">real_type</span></a> <em><span class="pre">tol_xy</span></em> <span class="pre">=</span> <span class="pre">1e-6</span>, <a class="reference internal" href="typedef_namespace_g2lib_1ac0b09ba58a37f5f3ca415be4a02ec7aa.html#_CPPv4N5G2lib9real_typeE" title="G2lib::real_type"><span class="pre">real_type</span></a> <em><span class="pre">tol_tg</span></em> <span class="pre">=</span> <span class="pre">1e-6</span><span class="sig-paren">)</span> <em class="property"><span class="pre">const</span></em><a class="headerlink" href="#_CPPv4NK5G2lib12ClothoidList13closure_checkE9real_type9real_type" title="Permalink to this definition">¶</a><br>
 </dt>
 <dd>
-<p>check if clothois list is closed</p>
+<p>check if clothoid list is closed</p>
 <p></p>
 <dl class="simple">
 <dt><strong>Return</strong></dt>
@@ -643,7 +643,7 @@ <h2>Class Documentation<a class="headerlink" href="#class-documentation" title="
 <span id="_CPPv3NK5G2lib12ClothoidList10numSegmentEv"></span><span id="_CPPv2NK5G2lib12ClothoidList10numSegmentEv"></span><span id="G2lib::ClothoidList::numSegmentC"></span><span class="target" id="class_g2lib_1_1_clothoid_list_1a22b8ca7f9d077ffb6d6801f48fcf819b"></span><em class="property"><span class="pre">inline</span></em> <a class="reference internal" href="typedef_namespace_g2lib_1ac4de9d9335536ac22821171deec8d39e.html#_CPPv4N5G2lib8int_typeE" title="G2lib::int_type"><span class="pre">int_type</span></a> <code class="sig-name descname"><span class="pre">numSegment</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property"><span class="pre">const</span></em><a class="headerlink" href="#_CPPv4NK5G2lib12ClothoidList10numSegmentEv" title="Permalink to this definition">¶</a><br>
 </dt>
 <dd>
-<p>return the numbber of clothois of the list </p>
+<p>return the numbber of clothoids of the list </p>
 </dd>
 </dl>
 
@@ -652,7 +652,7 @@ <h2>Class Documentation<a class="headerlink" href="#class-documentation" title="
 <span id="_CPPv3NK5G2lib12ClothoidList13wrap_in_rangeER9real_type"></span><span id="_CPPv2NK5G2lib12ClothoidList13wrap_in_rangeER9real_type"></span><span id="G2lib::ClothoidList::wrap_in_range__real_typeRC"></span><span class="target" id="class_g2lib_1_1_clothoid_list_1a937114d20264f3e3e280d6674449c1c0"></span><span class="pre">void</span> <code class="sig-name descname"><span class="pre">wrap_in_range</span></code><span class="sig-paren">(</span><a class="reference internal" href="typedef_namespace_g2lib_1ac0b09ba58a37f5f3ca415be4a02ec7aa.html#_CPPv4N5G2lib9real_typeE" title="G2lib::real_type"><span class="pre">real_type</span></a> <span class="pre">&amp;</span><em><span class="pre">s</span></em><span class="sig-paren">)</span> <em class="property"><span class="pre">const</span></em><a class="headerlink" href="#_CPPv4NK5G2lib12ClothoidList13wrap_in_rangeER9real_type" title="Permalink to this definition">¶</a><br>
 </dt>
 <dd>
-<p>The list of clothois has total length <span class="math notranslate nohighlight">\( L \)</span> the parameter <span class="math notranslate nohighlight">\( s \)</span> us recomputed as <span class="math notranslate nohighlight">\( s+kL\)</span> in such a way <span class="math notranslate nohighlight">\( s+kL\in[0,L)\)</span> with <span class="math notranslate nohighlight">\( k\in\mathbb{Z} \)</span>. </p>
+<p>The list of clothoids has total length <span class="math notranslate nohighlight">\( L \)</span> the parameter <span class="math notranslate nohighlight">\( s \)</span> us recomputed as <span class="math notranslate nohighlight">\( s+kL\)</span> in such a way <span class="math notranslate nohighlight">\( s+kL\in[0,L)\)</span> with <span class="math notranslate nohighlight">\( k\in\mathbb{Z} \)</span>. </p>
 </dd>
 </dl>
 
@@ -1735,7 +1735,7 @@ <h2>Class Documentation<a class="headerlink" href="#class-documentation" title="
 <span id="_CPPv3NK5G2lib12ClothoidList5getSKEP9real_typeP9real_type"></span><span id="_CPPv2NK5G2lib12ClothoidList5getSKEP9real_typeP9real_type"></span><span id="G2lib::ClothoidList::getSK__real_typeP.real_typePC"></span><span class="target" id="class_g2lib_1_1_clothoid_list_1af19891786035374bd154c5d02207fe19"></span><span class="pre">void</span> <code class="sig-name descname"><span class="pre">getSK</span></code><span class="sig-paren">(</span><a class="reference internal" href="typedef_namespace_g2lib_1ac0b09ba58a37f5f3ca415be4a02ec7aa.html#_CPPv4N5G2lib9real_typeE" title="G2lib::real_type"><span class="pre">real_type</span></a> <span class="pre">*</span><em><span class="pre">s</span></em>, <a class="reference internal" href="typedef_namespace_g2lib_1ac0b09ba58a37f5f3ca415be4a02ec7aa.html#_CPPv4N5G2lib9real_typeE" title="G2lib::real_type"><span class="pre">real_type</span></a> <span class="pre">*</span><em><span class="pre">kappa</span></em><span class="sig-paren">)</span> <em class="property"><span class="pre">const</span></em><a class="headerlink" href="#_CPPv4NK5G2lib12ClothoidList5getSKEP9real_typeP9real_type" title="Permalink to this definition">¶</a><br>
 </dt>
 <dd>
-<p>Return the clothois list as a list of nodes and curvatures</p>
+<p>Return the clothoid list as a list of nodes and curvatures</p>
 <p></p>
 <dl class="simple">
 <dt><strong>Parameters</strong></dt>
@@ -1755,7 +1755,7 @@ <h2>Class Documentation<a class="headerlink" href="#class-documentation" title="
 <span id="_CPPv3NK5G2lib12ClothoidList5getSKERNSt6vectorI9real_typeEERNSt6vectorI9real_typeEE"></span><span id="_CPPv2NK5G2lib12ClothoidList5getSKERNSt6vectorI9real_typeEERNSt6vectorI9real_typeEE"></span><span id="G2lib::ClothoidList::getSK__std::vector:real_type:R.std::vector:real_type:RC"></span><span class="target" id="class_g2lib_1_1_clothoid_list_1adaff2b797f3b4ef2d97d3d5dc2890ad2"></span><em class="property"><span class="pre">inline</span></em> <span class="pre">void</span> <code class="sig-name descname"><span class="pre">getSK</span></code><span class="sig-paren">(</span><span class="pre">std</span><span class="pre">::</span><span class="pre">vector</span><span class="pre">&lt;</span><a class="reference internal" href="typedef_namespace_g2lib_1ac0b09ba58a37f5f3ca415be4a02ec7aa.html#_CPPv4N5G2lib9real_typeE" title="G2lib::real_type"><span class="pre">real_type</span></a><span class="pre">&gt;</span> <span class="pre">&amp;</span><em><span class="pre">s</span></em>, <span class="pre">std</span><span class="pre">::</span><span class="pre">vector</span><span class="pre">&lt;</span><a class="reference internal" href="typedef_namespace_g2lib_1ac0b09ba58a37f5f3ca415be4a02ec7aa.html#_CPPv4N5G2lib9real_typeE" title="G2lib::real_type"><span class="pre">real_type</span></a><span class="pre">&gt;</span> <span class="pre">&amp;</span><em><span class="pre">kappa</span></em><span class="sig-paren">)</span> <em class="property"><span class="pre">const</span></em><a class="headerlink" href="#_CPPv4NK5G2lib12ClothoidList5getSKERNSt6vectorI9real_typeEERNSt6vectorI9real_typeEE" title="Permalink to this definition">¶</a><br>
 </dt>
 <dd>
-<p>Return the clothois list as a list of nodes and curvatures</p>
+<p>Return the clothoid list as a list of nodes and curvatures</p>
 <p></p>
 <dl class="simple">
 <dt><strong>Parameters</strong></dt>
@@ -1775,7 +1775,7 @@ <h2>Class Documentation<a class="headerlink" href="#class-documentation" title="
 <span id="_CPPv3NK5G2lib12ClothoidList6getSTKEP9real_typeP9real_typeP9real_type"></span><span id="_CPPv2NK5G2lib12ClothoidList6getSTKEP9real_typeP9real_typeP9real_type"></span><span id="G2lib::ClothoidList::getSTK__real_typeP.real_typeP.real_typePC"></span><span class="target" id="class_g2lib_1_1_clothoid_list_1a1ce2da05e68f0b3cccc2be8d692986f9"></span><span class="pre">void</span> <code class="sig-name descname"><span class="pre">getSTK</span></code><span class="sig-paren">(</span><a class="reference internal" href="typedef_namespace_g2lib_1ac0b09ba58a37f5f3ca415be4a02ec7aa.html#_CPPv4N5G2lib9real_typeE" title="G2lib::real_type"><span class="pre">real_type</span></a> <span class="pre">*</span><em><span class="pre">s</span></em>, <a class="reference internal" href="typedef_namespace_g2lib_1ac0b09ba58a37f5f3ca415be4a02ec7aa.html#_CPPv4N5G2lib9real_typeE" title="G2lib::real_type"><span class="pre">real_type</span></a> <span class="pre">*</span><em><span class="pre">theta</span></em>, <a class="reference internal" href="typedef_namespace_g2lib_1ac0b09ba58a37f5f3ca415be4a02ec7aa.html#_CPPv4N5G2lib9real_typeE" title="G2lib::real_type"><span class="pre">real_type</span></a> <span class="pre">*</span><em><span class="pre">kappa</span></em><span class="sig-paren">)</span> <em class="property"><span class="pre">const</span></em><a class="headerlink" href="#_CPPv4NK5G2lib12ClothoidList6getSTKEP9real_typeP9real_typeP9real_type" title="Permalink to this definition">¶</a><br>
 </dt>
 <dd>
-<p>Return the clothois list as a list of nodes angles and curvatures</p>
+<p>Return the clothoid list as a list of nodes angles and curvatures</p>
 <p></p>
 <dl class="simple">
 <dt><strong>Parameters</strong></dt>
@@ -1796,7 +1796,7 @@ <h2>Class Documentation<a class="headerlink" href="#class-documentation" title="
 <span id="_CPPv3NK5G2lib12ClothoidList6getSTKERNSt6vectorI9real_typeEERNSt6vectorI9real_typeEERNSt6vectorI9real_typeEE"></span><span id="_CPPv2NK5G2lib12ClothoidList6getSTKERNSt6vectorI9real_typeEERNSt6vectorI9real_typeEERNSt6vectorI9real_typeEE"></span><span id="G2lib::ClothoidList::getSTK__std::vector:real_type:R.std::vector:real_type:R.std::vector:real_type:RC"></span><span class="target" id="class_g2lib_1_1_clothoid_list_1a4333689acce930b882b6848e58652d19"></span><em class="property"><span class="pre">inline</span></em> <span class="pre">void</span> <code class="sig-name descname"><span class="pre">getSTK</span></code><span class="sig-paren">(</span><span class="pre">std</span><span class="pre">::</span><span class="pre">vector</span><span class="pre">&lt;</span><a class="reference internal" href="typedef_namespace_g2lib_1ac0b09ba58a37f5f3ca415be4a02ec7aa.html#_CPPv4N5G2lib9real_typeE" title="G2lib::real_type"><span class="pre">real_type</span></a><span class="pre">&gt;</span> <span class="pre">&amp;</span><em><span class="pre">s</span></em>, <span class="pre">std</span><span class="pre">::</span><span class="pre">vector</span><span class="pre">&lt;</span><a class="reference internal" href="typedef_namespace_g2lib_1ac0b09ba58a37f5f3ca415be4a02ec7aa.html#_CPPv4N5G2lib9real_typeE" title="G2lib::real_type"><span class="pre">real_type</span></a><span class="pre">&gt;</span> <span class="pre">&amp;</span><em><span class="pre">theta</span></em>, <span class="pre">std</span><span class="pre">::</span><span class="pre">vector</span><span class="pre">&lt;</span><a class="reference internal" href="typedef_namespace_g2lib_1ac0b09ba58a37f5f3ca415be4a02ec7aa.html#_CPPv4N5G2lib9real_typeE" title="G2lib::real_type"><span class="pre">real_type</span></a><span class="pre">&gt;</span> <span class="pre">&amp;</span><em><span class="pre">kappa</span></em><span class="sig-paren">)</span> <em class="property"><span class="pre">const</span></em><a class="headerlink" href="#_CPPv4NK5G2lib12ClothoidList6getSTKERNSt6vectorI9real_typeEERNSt6vectorI9real_typeEERNSt6vectorI9real_typeEE" title="Permalink to this definition">¶</a><br>
 </dt>
 <dd>
-<p>Return the clothois list as a list of nodes angles and curvatures</p>
+<p>Return the clothoid list as a list of nodes angles and curvatures</p>
 <p></p>
 <dl class="simple">
 <dt><strong>Parameters</strong></dt>

diff --git a/docs/index.html b/docs/index.html
@@ -92,8 +92,8 @@ <h2>G1 and G2 fitting with clothoids, spline of clothods, circle arc and biarc<a
 <li class="toctree-l2"><a class="reference internal" href="manual.html#circlearc">CircleArc</a></li>
 <li class="toctree-l2"><a class="reference internal" href="manual.html#biarc">Biarc</a></li>
 <li class="toctree-l2"><a class="reference internal" href="manual.html#clothoidcurve">ClothoidCurve</a></li>
-<li class="toctree-l2"><a class="reference internal" href="manual.html#clothoislist">ClothoisList</a></li>
-<li class="toctree-l2"><a class="reference internal" href="manual.html#clothoissplineg2">ClothoisSplineG2</a></li>
+<li class="toctree-l2"><a class="reference internal" href="manual.html#clothoidlist">ClothoidList</a></li>
+<li class="toctree-l2"><a class="reference internal" href="manual.html#clothoidsplineg2">ClothoidSplineG2</a></li>
 <li class="toctree-l2"><a class="reference internal" href="manual.html#triangle2d">Triangle2D</a></li>
 <li class="toctree-l2"><a class="reference internal" href="manual.html#fresnelcs">FresnelCS</a></li>
 <li class="toctree-l2"><a class="reference internal" href="manual.html#authors">Authors</a></li>

diff --git a/docs/manual.html b/docs/manual.html
@@ -86,8 +86,8 @@ <h1>Matlab Interface<a class="headerlink" href="#matlab-interface" title="Permal
 <li><p>Biarc</p></li>
 <li><p>ClothoidCurve</p></li>
 <li><p>PolyLine</p></li>
-<li><p>ClothoisList</p></li>
-<li><p>ClothoisSplineG2</p></li>
+<li><p>ClothoidList</p></li>
+<li><p>ClothoidSplineG2</p></li>
 <li><p>Triangle2D</p></li>
 <li><p>FresnelCS</p></li>
 </ul>
@@ -596,14 +596,14 @@ <h3>Evaluation Methods<a class="headerlink" href="#id10" title="Permalink to thi
 </div>
 </div>
 </div>
-<div class="section" id="clothoislist">
-<h2>ClothoisList<a class="headerlink" href="#clothoislist" title="Permalink to this headline">¶</a>
+<div class="section" id="clothoidlist">
+<h2>ClothoidList<a class="headerlink" href="#clothoidlist" title="Permalink to this headline">¶</a>
 </h2>
 <p>Store a list of clothoids to be used as a single spline.</p>
 <p>Documentation will be available soon, see examples in <code class="docutils literal notranslate"><span class="pre">tests</span></code> for the moments</p>
 </div>
-<div class="section" id="clothoissplineg2">
-<h2>ClothoisSplineG2<a class="headerlink" href="#clothoissplineg2" title="Permalink to this headline">¶</a>
+<div class="section" id="clothoidsplineg2">
+<h2>ClothoidSplineG2<a class="headerlink" href="#clothoidsplineg2" title="Permalink to this headline">¶</a>
 </h2>
 <p>Implements the algorithm described in references [2] and [3].</p>
 <p>documentation will be available soon, see examples in <code class="docutils literal notranslate"><span class="pre">tests</span></code> for the moments</p>
@@ -711,8 +711,8 @@ <h3><a href="index.html">Page contents</a></h3>
 <li><a class="reference internal" href="#id10">Evaluation Methods</a></li>
 </ul>
 </li>
-<li><a class="reference internal" href="#clothoislist">ClothoisList</a></li>
-<li><a class="reference internal" href="#clothoissplineg2">ClothoisSplineG2</a></li>
+<li><a class="reference internal" href="#clothoidlist">ClothoidList</a></li>
+<li><a class="reference internal" href="#clothoidsplineg2">ClothoidSplineG2</a></li>
 <li><a class="reference internal" href="#triangle2d">Triangle2D</a></li>
 <li><a class="reference internal" href="#fresnelcs">FresnelCS</a></li>
 <li><a class="reference internal" href="#authors">Authors</a></li>

diff --git a/docs/searchindex.js b/docs/searchindex.js