Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@actions-user
actions-user committed Jul 23, 2024
1 parent 1240cb0 commit 749d15e
Show file tree
Hide file tree
Showing 110 changed files with 485 additions and 633 deletions.
Binary file modified 2d_ellipse-1.pdf
View file
Binary file not shown.
Binary file modified 2d_ellipse-2.pdf
View file
Binary file not shown.
2 changes: 1 addition & 1 deletion 2d_ellipse.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -555,7 +555,7 @@ <h1>2D ellipse<a class="headerlink" href="#d-ellipse" title="Permalink to this h

<div role="contentinfo">
<p>&#169; Copyright 2020-, Peter Corke..
<span class="lastupdated">Last updated on 26-Jun-2024.
<span class="lastupdated">Last updated on 23-Jul-2024.
</span></p>
</div>

Expand Down
2 changes: 1 addition & 1 deletion 2d_line.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -302,7 +302,7 @@ <h1>2D line<a class="headerlink" href="#d-line" title="Permalink to this headlin

<div role="contentinfo">
<p>&#169; Copyright 2020-, Peter Corke..
<span class="lastupdated">Last updated on 26-Jun-2024.
<span class="lastupdated">Last updated on 23-Jul-2024.
</span></p>
</div>

Expand Down
2 changes: 1 addition & 1 deletion 2d_linesegment.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ <h1>2D line segment<a class="headerlink" href="#d-line-segment" title="Permalink

<div role="contentinfo">
<p>&#169; Copyright 2020-, Peter Corke..
<span class="lastupdated">Last updated on 26-Jun-2024.
<span class="lastupdated">Last updated on 23-Jul-2024.
</span></p>
</div>

Expand Down
Binary file modified 2d_orient_SO2-1.pdf
View file
Binary file not shown.
14 changes: 7 additions & 7 deletions 2d_orient_SO2.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ <h1>SO(2) matrix<a class="headerlink" href="#so-2-matrix" title="Permalink to th
<dd class="field-odd"><p><strong>n</strong> (<em>int</em><em>, </em><em>optional</em>) – Number of values, defaults to 1</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Self</p>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>pose instance with <code class="docutils literal notranslate"><span class="pre">n</span></code> default values</p>
Expand Down Expand Up @@ -997,8 +997,8 @@ <h1>SO(2) matrix<a class="headerlink" href="#so-2-matrix" title="Permalink to th
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>arg</strong> (<em>Any</em>) – initial value</p></li>
<li><p><strong>convertfrom</strong> (<em>Tuple</em>) – list of classes to accept and convert from</p></li>
<li><p><strong>arg</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Any</span></code>) – initial value</p></li>
<li><p><strong>convertfrom</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Tuple</span></code>) – list of classes to accept and convert from</p></li>
<li><p><strong>check</strong> (<em>bool</em>) – check value is valid, defaults to True</p></li>
</ul>
</dd>
Expand Down Expand Up @@ -1038,7 +1038,7 @@ <h1>SO(2) matrix<a class="headerlink" href="#so-2-matrix" title="Permalink to th
</div>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>bool</p>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></p>
</dd>
</dl>
</dd></dl>
Expand Down Expand Up @@ -1809,7 +1809,7 @@ <h1>SO(2) matrix<a class="headerlink" href="#so-2-matrix" title="Permalink to th
<dd class="field-odd"><p><a class="reference internal" href="#spatialmath.pose2d.SO2.printline" title="spatialmath.pose2d.SO2.printline"><code class="xref py py-meth docutils literal notranslate"><span class="pre">printline()</span></code></a> <a class="reference internal" href="#spatialmath.pose2d.SO2.strline" title="spatialmath.pose2d.SO2.strline"><code class="xref py py-meth docutils literal notranslate"><span class="pre">strline()</span></code></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>None</p>
<dd class="field-even"><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></p>
</dd>
</dl>
</dd></dl>
Expand Down Expand Up @@ -2167,7 +2167,7 @@ <h1>SO(2) matrix<a class="headerlink" href="#so-2-matrix" title="Permalink to th

<dl class="py property">
<dt class="sig sig-object py" id="spatialmath.pose2d.SO2.A">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">A</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">NDArray</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">NDArray</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#spatialmath.pose2d.SO2.A" title="Permalink to this definition"></a></dt>
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">A</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v2.0)"><span class="pre">numpy.ndarray</span></a><span class="p"><span class="pre">[</span></span><span class="pre">Any</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype" title="(in NumPy v2.0)"><span class="pre">numpy.dtype</span></a><span class="p"><span class="pre">[</span></span><span class="pre">numpy.typing._generic_alias.ScalarType</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v2.0)"><span class="pre">numpy.ndarray</span></a><span class="p"><span class="pre">[</span></span><span class="pre">Any</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype" title="(in NumPy v2.0)"><span class="pre">numpy.dtype</span></a><span class="p"><span class="pre">[</span></span><span class="pre">numpy.typing._generic_alias.ScalarType</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#spatialmath.pose2d.SO2.A" title="Permalink to this definition"></a></dt>
<dd><p>Array value of an instance (BasePoseList superclass method)</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
Expand Down Expand Up @@ -2318,7 +2318,7 @@ <h1>SO(2) matrix<a class="headerlink" href="#so-2-matrix" title="Permalink to th

<div role="contentinfo">
<p>&#169; Copyright 2020-, Peter Corke..
<span class="lastupdated">Last updated on 26-Jun-2024.
<span class="lastupdated">Last updated on 23-Jul-2024.
</span></p>
</div>

Expand Down
Binary file modified 2d_polygon-1.pdf
View file
Binary file not shown.
Binary file modified 2d_polygon-2.pdf
View file
Binary file not shown.
2 changes: 1 addition & 1 deletion 2d_polygon.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -537,7 +537,7 @@ <h1>2D polgon<a class="headerlink" href="#d-polgon" title="Permalink to this hea

<div role="contentinfo">
<p>&#169; Copyright 2020-, Peter Corke..
<span class="lastupdated">Last updated on 26-Jun-2024.
<span class="lastupdated">Last updated on 23-Jul-2024.
</span></p>
</div>

Expand Down
Binary file modified 2d_pose_SE2-1.pdf
View file
Binary file not shown.
14 changes: 7 additions & 7 deletions 2d_pose_SE2.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ <h1>SE(2) matrix<a class="headerlink" href="#se-2-matrix" title="Permalink to th
<dd class="field-odd"><p><strong>n</strong> (<em>int</em><em>, </em><em>optional</em>) – Number of values, defaults to 1</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Self</p>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>pose instance with <code class="docutils literal notranslate"><span class="pre">n</span></code> default values</p>
Expand Down Expand Up @@ -1152,8 +1152,8 @@ <h1>SE(2) matrix<a class="headerlink" href="#se-2-matrix" title="Permalink to th
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>arg</strong> (<em>Any</em>) – initial value</p></li>
<li><p><strong>convertfrom</strong> (<em>Tuple</em>) – list of classes to accept and convert from</p></li>
<li><p><strong>arg</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Any</span></code>) – initial value</p></li>
<li><p><strong>convertfrom</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Tuple</span></code>) – list of classes to accept and convert from</p></li>
<li><p><strong>check</strong> (<em>bool</em>) – check value is valid, defaults to True</p></li>
</ul>
</dd>
Expand Down Expand Up @@ -1193,7 +1193,7 @@ <h1>SE(2) matrix<a class="headerlink" href="#se-2-matrix" title="Permalink to th
</div>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>bool</p>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></p>
</dd>
</dl>
</dd></dl>
Expand Down Expand Up @@ -1964,7 +1964,7 @@ <h1>SE(2) matrix<a class="headerlink" href="#se-2-matrix" title="Permalink to th
<dd class="field-odd"><p><a class="reference internal" href="#spatialmath.pose2d.SE2.printline" title="spatialmath.pose2d.SE2.printline"><code class="xref py py-meth docutils literal notranslate"><span class="pre">printline()</span></code></a> <a class="reference internal" href="#spatialmath.pose2d.SE2.strline" title="spatialmath.pose2d.SE2.strline"><code class="xref py py-meth docutils literal notranslate"><span class="pre">strline()</span></code></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>None</p>
<dd class="field-even"><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></p>
</dd>
</dl>
</dd></dl>
Expand Down Expand Up @@ -2340,7 +2340,7 @@ <h1>SE(2) matrix<a class="headerlink" href="#se-2-matrix" title="Permalink to th

<dl class="py property">
<dt class="sig sig-object py" id="spatialmath.pose2d.SE2.A">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">A</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">NDArray</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">NDArray</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#spatialmath.pose2d.SE2.A" title="Permalink to this definition"></a></dt>
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">A</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v2.0)"><span class="pre">numpy.ndarray</span></a><span class="p"><span class="pre">[</span></span><span class="pre">Any</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype" title="(in NumPy v2.0)"><span class="pre">numpy.dtype</span></a><span class="p"><span class="pre">[</span></span><span class="pre">numpy.typing._generic_alias.ScalarType</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v2.0)"><span class="pre">numpy.ndarray</span></a><span class="p"><span class="pre">[</span></span><span class="pre">Any</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype" title="(in NumPy v2.0)"><span class="pre">numpy.dtype</span></a><span class="p"><span class="pre">[</span></span><span class="pre">numpy.typing._generic_alias.ScalarType</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#spatialmath.pose2d.SE2.A" title="Permalink to this definition"></a></dt>
<dd><p>Array value of an instance (BasePoseList superclass method)</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
Expand Down Expand Up @@ -2557,7 +2557,7 @@ <h1>SE(2) matrix<a class="headerlink" href="#se-2-matrix" title="Permalink to th

<div role="contentinfo">
<p>&#169; Copyright 2020-, Peter Corke..
<span class="lastupdated">Last updated on 26-Jun-2024.
<span class="lastupdated">Last updated on 23-Jul-2024.
</span></p>
</div>

Expand Down
12 changes: 6 additions & 6 deletions 2d_pose_twist.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ <h1>se(2) twist<a class="headerlink" href="#se-2-twist" title="Permalink to this
<dd class="field-odd"><p><strong>n</strong> (<em>int</em><em>, </em><em>optional</em>) – Number of values, defaults to 1</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Self</p>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>pose instance with <code class="docutils literal notranslate"><span class="pre">n</span></code> default values</p>
Expand Down Expand Up @@ -701,11 +701,11 @@ <h1>se(2) twist<a class="headerlink" href="#se-2-twist" title="Permalink to this
<div class="highlight-pycon notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">spatialmath</span> <span class="kn">import</span> <span class="n">Twist3</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">S</span> <span class="o">=</span> <span class="n">Twist3</span><span class="p">(</span><span class="n">SE3</span><span class="o">.</span><span class="n">Rand</span><span class="p">())</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">S</span>
<span class="go">Twist3([-0.085167, 0.084531, -0.18368, 0.007879, 2.716, -0.97149])</span>
<span class="go">Twist3([0.53291, -0.8185, -0.32723, -2.2705, 0.2433, -0.10986])</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">S</span><span class="o">.</span><span class="n">inv</span><span class="p">()</span>
<span class="go">Twist3([0.085167, -0.084531, 0.18368, -0.007879, -2.716, 0.97149])</span>
<span class="go">Twist3([-0.53291, 0.8185, 0.32723, 2.2705, -0.2433, 0.10986])</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">S</span> <span class="o">*</span> <span class="n">S</span><span class="o">.</span><span class="n">inv</span><span class="p">()</span>
<span class="go">Twist3([0, -2.7756e-17, -3.9899e-17, 0, 0, 0])</span>
<span class="go">Twist3([1.1102e-16, -2.2204e-16, 0, 0, 0, 0])</span>
</pre></div>
</div>
</dd></dl>
Expand Down Expand Up @@ -850,7 +850,7 @@ <h1>se(2) twist<a class="headerlink" href="#se-2-twist" title="Permalink to this

<dl class="py property">
<dt class="sig sig-object py" id="spatialmath.twist.Twist2.A">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">A</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">NDArray</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">NDArray</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#spatialmath.twist.Twist2.A" title="Permalink to this definition"></a></dt>
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">A</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v2.0)"><span class="pre">numpy.ndarray</span></a><span class="p"><span class="pre">[</span></span><span class="pre">Any</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype" title="(in NumPy v2.0)"><span class="pre">numpy.dtype</span></a><span class="p"><span class="pre">[</span></span><span class="pre">numpy.typing._generic_alias.ScalarType</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v2.0)"><span class="pre">numpy.ndarray</span></a><span class="p"><span class="pre">[</span></span><span class="pre">Any</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype" title="(in NumPy v2.0)"><span class="pre">numpy.dtype</span></a><span class="p"><span class="pre">[</span></span><span class="pre">numpy.typing._generic_alias.ScalarType</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#spatialmath.twist.Twist2.A" title="Permalink to this definition"></a></dt>
<dd><p>Array value of an instance (BasePoseList superclass method)</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
Expand Down Expand Up @@ -1126,7 +1126,7 @@ <h1>se(2) twist<a class="headerlink" href="#se-2-twist" title="Permalink to this

<div role="contentinfo">
<p>&#169; Copyright 2020-, Peter Corke..
<span class="lastupdated">Last updated on 26-Jun-2024.
<span class="lastupdated">Last updated on 23-Jul-2024.
</span></p>
</div>

Expand Down
Loading

0 comments on commit 749d15e

Please sign in to comment.