Skip to content

Commit 37b5d7b

Browse files
committed
Update documentation
1 parent 86a0974 commit 37b5d7b

107 files changed

Lines changed: 282 additions & 201 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎2d_ellipse-1.pdf‎

0 Bytes
Binary file not shown.

‎2d_ellipse-2.pdf‎

0 Bytes
Binary file not shown.

‎2d_ellipse.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -555,7 +555,7 @@ <h1>2D ellipse<a class="headerlink" href="#d-ellipse" title="Permalink to this h
555555

556556
<div role="contentinfo">
557557
<p>&#169; Copyright 2020-, Peter Corke..
558-
<span class="lastupdated">Last updated on 28-Nov-2023.
558+
<span class="lastupdated">Last updated on 30-Nov-2023.
559559
</span></p>
560560
</div>
561561

‎2d_line.html‎

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -173,7 +173,10 @@ <h1>2D line<a class="headerlink" href="#d-line" title="Permalink to this headlin
173173
<dd><p>Test if point is in line</p>
174174
<dl class="field-list simple">
175175
<dt class="field-odd">Parameters</dt>
176-
<dd class="field-odd"><p><strong>p1</strong> (<em>array_like</em><em>(</em><em>2</em><em>) or </em><em>array_like</em><em>(</em><em>3</em><em>)</em>) – point to test</p>
176+
<dd class="field-odd"><ul class="simple">
177+
<li><p><strong>p1</strong> (<em>array_like</em><em>(</em><em>2</em><em>) or </em><em>array_like</em><em>(</em><em>3</em><em>)</em>) – point to test</p></li>
178+
<li><p><strong>tol</strong> (<em>float</em>) – tolerance in units of eps, defaults to 10</p></li>
179+
</ul>
177180
</dd>
178181
<dt class="field-even">Returns</dt>
179182
<dd class="field-even"><p>True if point lies in the line</p>
@@ -220,7 +223,10 @@ <h1>2D line<a class="headerlink" href="#d-line" title="Permalink to this headlin
220223
<dd><p>Intersection with line</p>
221224
<dl class="field-list simple">
222225
<dt class="field-odd">Parameters</dt>
223-
<dd class="field-odd"><p><strong>other</strong> (<a class="reference internal" href="classes-2d.html#spatialmath.geom2d.Line2" title="spatialmath.geom2d.Line2"><em>Line2</em></a>) – another 2D line</p>
226+
<dd class="field-odd"><ul class="simple">
227+
<li><p><strong>other</strong> (<a class="reference internal" href="classes-2d.html#spatialmath.geom2d.Line2" title="spatialmath.geom2d.Line2"><em>Line2</em></a>) – another 2D line</p></li>
228+
<li><p><strong>tol</strong> (<em>float</em>) – tolerance in units of eps, defaults to 10</p></li>
229+
</ul>
224230
</dd>
225231
<dt class="field-even">Returns</dt>
226232
<dd class="field-even"><p>intersection point in homogeneous form</p>
@@ -240,13 +246,14 @@ <h1>2D line<a class="headerlink" href="#d-line" title="Permalink to this headlin
240246

241247
<dl class="py method">
242248
<dt class="sig sig-object py" id="spatialmath.geom2d.Line2.intersect_segment">
243-
<span class="sig-name descname"><span class="pre">intersect_segment</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">p1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">p2</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/spatialmath/geom2d.html#Line2.intersect_segment"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#spatialmath.geom2d.Line2.intersect_segment" title="Permalink to this definition"></a></dt>
249+
<span class="sig-name descname"><span class="pre">intersect_segment</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">p1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">p2</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tol</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">10</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/spatialmath/geom2d.html#Line2.intersect_segment"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#spatialmath.geom2d.Line2.intersect_segment" title="Permalink to this definition"></a></dt>
244250
<dd><p>Test for line intersecting line segment</p>
245251
<dl class="field-list simple">
246252
<dt class="field-odd">Parameters</dt>
247253
<dd class="field-odd"><ul class="simple">
248254
<li><p><strong>p1</strong> (<em>array_like</em><em>(</em><em>2</em><em>) or </em><em>array_like</em><em>(</em><em>3</em><em>)</em>) – start of line segment</p></li>
249255
<li><p><strong>p2</strong> (<em>array_like</em><em>(</em><em>2</em><em>) or </em><em>array_like</em><em>(</em><em>3</em><em>)</em>) – end of line segment</p></li>
256+
<li><p><strong>tol</strong> (<em>float</em>) – tolerance in units of eps, defaults to 10</p></li>
250257
</ul>
251258
</dd>
252259
<dt class="field-even">Returns</dt>
@@ -295,7 +302,7 @@ <h1>2D line<a class="headerlink" href="#d-line" title="Permalink to this headlin
295302

296303
<div role="contentinfo">
297304
<p>&#169; Copyright 2020-, Peter Corke..
298-
<span class="lastupdated">Last updated on 28-Nov-2023.
305+
<span class="lastupdated">Last updated on 30-Nov-2023.
299306
</span></p>
300307
</div>
301308

‎2d_linesegment.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@ <h1>2D line segment<a class="headerlink" href="#d-line-segment" title="Permalink
122122

123123
<div role="contentinfo">
124124
<p>&#169; Copyright 2020-, Peter Corke..
125-
<span class="lastupdated">Last updated on 28-Nov-2023.
125+
<span class="lastupdated">Last updated on 30-Nov-2023.
126126
</span></p>
127127
</div>
128128

‎2d_orient_SO2-1.pdf‎

0 Bytes
Binary file not shown.

‎2d_orient_SO2.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2317,7 +2317,7 @@ <h1>SO(2) matrix<a class="headerlink" href="#so-2-matrix" title="Permalink to th
23172317

23182318
<div role="contentinfo">
23192319
<p>&#169; Copyright 2020-, Peter Corke..
2320-
<span class="lastupdated">Last updated on 28-Nov-2023.
2320+
<span class="lastupdated">Last updated on 30-Nov-2023.
23212321
</span></p>
23222322
</div>
23232323

‎2d_polygon-1.pdf‎

0 Bytes
Binary file not shown.

‎2d_polygon-2.pdf‎

0 Bytes
Binary file not shown.

‎2d_polygon.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -537,7 +537,7 @@ <h1>2D polgon<a class="headerlink" href="#d-polgon" title="Permalink to this hea
537537

538538
<div role="contentinfo">
539539
<p>&#169; Copyright 2020-, Peter Corke..
540-
<span class="lastupdated">Last updated on 28-Nov-2023.
540+
<span class="lastupdated">Last updated on 30-Nov-2023.
541541
</span></p>
542542
</div>
543543

0 commit comments

Comments
 (0)