Skip to content

Commit d322730

Browse files
committed
Update documentation
1 parent 66424d6 commit d322730

103 files changed

Lines changed: 642 additions & 516 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.html‎

Lines changed: 7 additions & 6 deletions
Large diffs are not rendered by default.

‎2d_line.html‎

Lines changed: 8 additions & 7 deletions
Large diffs are not rendered by default.

‎2d_linesegment.html‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=9edc463e" />
1616
<link rel="stylesheet" type="text/css" href="_static/graphviz.css?v=4ae1632d" />
1717
<link rel="stylesheet" type="text/css" href="_static/plot_directive.css" />
18+
<link rel="stylesheet" type="text/css" href="_static/sphinx_autodoc_typehints.css?v=057ac668" />
1819
<link rel="stylesheet" type="text/css" href="_static/copybutton.css?v=76b2166b" />
1920
<link rel="stylesheet" type="text/css" href="_static/sphinx-codeautolink.css?v=b2176991" />
2021

@@ -124,7 +125,7 @@ <h1>2D line segment<a class="headerlink" href="#d-line-segment" title="Link to t
124125

125126
<div role="contentinfo">
126127
<p>&#169; Copyright 2020-, Peter Corke..
127-
<span class="lastupdated">Last updated on 16-Oct-2026.
128+
<span class="lastupdated">Last updated on 26-Oct-2026.
128129
</span></p>
129130
</div>
130131

‎2d_orient_SO2.html‎

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515
<link href="_static/css/theme.css?v=9edc463e" rel="stylesheet" type="text/css"/>
1616
<link href="_static/graphviz.css?v=4ae1632d" rel="stylesheet" type="text/css"/>
1717
<link href="_static/plot_directive.css" rel="stylesheet" type="text/css"/>
18+
<link href="_static/sphinx_autodoc_typehints.css?v=057ac668" rel="stylesheet" type="text/css"/>
1819
<link href="_static/copybutton.css?v=76b2166b" rel="stylesheet" type="text/css"/>
1920
<link href="_static/sphinx-codeautolink.css?v=b2176991" rel="stylesheet" type="text/css"/>
2021
<script src="_static/jquery.js?v=5d32c60e"></script>
@@ -869,7 +870,7 @@ <h1>SO(2) matrix<a class="headerlink" href="#so-2-matrix" title="Link to this he
869870
</ul>
870871
</dd>
871872
<dt class="field-even">Return type<span class="colon">:</span></dt>
872-
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></span></p>
873+
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><span class="highlight sphinx_autodoc_typehints-value"><code class="xref py py-obj docutils literal notranslate"><span class="kc"><span class="pre">None</span></span></code></span></span></p>
873874
</dd>
874875
</dl>
875876
<ul class="simple">
@@ -904,7 +905,7 @@ <h1>SO(2) matrix<a class="headerlink" href="#so-2-matrix" title="Link to this he
904905
<dd class="field-even"><p><strong>ValueError</strong> – incorrect type of appended object</p>
905906
</dd>
906907
<dt class="field-odd">Return type<span class="colon">:</span></dt>
907-
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></span></p>
908+
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><span class="highlight sphinx_autodoc_typehints-value"><code class="xref py py-obj docutils literal notranslate"><span class="kc"><span class="pre">None</span></span></code></span></span></p>
908909
</dd>
909910
</dl>
910911
<p>Appends the argument to the object’s internal list of values.</p>
@@ -1110,7 +1111,7 @@ <h1>SO(2) matrix<a class="headerlink" href="#so-2-matrix" title="Link to this he
11101111
<dd class="field-odd"><p>Determinant of rotational component</p>
11111112
</dd>
11121113
<dt class="field-even">Return type<span class="colon">:</span></dt>
1113-
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-data docutils literal notranslate"><span class="pre">Tuple</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code>, <code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v2.5)"><code class="xref py py-class docutils literal notranslate"><span class="pre">ndarray</span></code></a>[<code class="xref py py-data docutils literal notranslate"><span class="pre">Tuple</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">ResizeEventType</span></code>[2]], <a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype" title="(in NumPy v2.5)"><code class="xref py py-class docutils literal notranslate"><span class="pre">dtype</span></code></a>[<a class="reference external" href="https://numpy.org/doc/stable/reference/arrays.scalars.html#numpy.floating" title="(in NumPy v2.5)"><code class="xref py py-class docutils literal notranslate"><span class="pre">floating</span></code></a>]], <a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v2.5)"><code class="xref py py-class docutils literal notranslate"><span class="pre">ndarray</span></code></a>[<code class="xref py py-data docutils literal notranslate"><span class="pre">Tuple</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">ResizeEventType</span></code>[3]], <a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype" title="(in NumPy v2.5)"><code class="xref py py-class docutils literal notranslate"><span class="pre">dtype</span></code></a>[<a class="reference external" href="https://numpy.org/doc/stable/reference/arrays.scalars.html#numpy.floating" title="(in NumPy v2.5)"><code class="xref py py-class docutils literal notranslate"><span class="pre">floating</span></code></a>]]]]</span></p>
1114+
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-data docutils literal notranslate"><span class="pre">Tuple</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code>, <code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v2.5)"><code class="xref py py-class docutils literal notranslate"><span class="pre">ndarray</span></code></a>[<code class="xref py py-data docutils literal notranslate"><span class="pre">Tuple</span></code>[<code class="xref py py-data docutils literal notranslate"><span class="pre">Literal</span></code>[<span class="highlight sphinx_autodoc_typehints-value"><code class="docutils literal notranslate"><span class="mi"><span class="pre">2</span></span></code></span>]], <a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype" title="(in NumPy v2.5)"><code class="xref py py-class docutils literal notranslate"><span class="pre">dtype</span></code></a>[<a class="reference external" href="https://numpy.org/doc/stable/reference/arrays.scalars.html#numpy.floating" title="(in NumPy v2.5)"><code class="xref py py-class docutils literal notranslate"><span class="pre">floating</span></code></a>]], <a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v2.5)"><code class="xref py py-class docutils literal notranslate"><span class="pre">ndarray</span></code></a>[<code class="xref py py-data docutils literal notranslate"><span class="pre">Tuple</span></code>[<code class="xref py py-data docutils literal notranslate"><span class="pre">Literal</span></code>[<span class="highlight sphinx_autodoc_typehints-value"><code class="docutils literal notranslate"><span class="mi"><span class="pre">3</span></span></code></span>]], <a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype" title="(in NumPy v2.5)"><code class="xref py py-class docutils literal notranslate"><span class="pre">dtype</span></code></a>[<a class="reference external" href="https://numpy.org/doc/stable/reference/arrays.scalars.html#numpy.floating" title="(in NumPy v2.5)"><code class="xref py py-class docutils literal notranslate"><span class="pre">floating</span></code></a>]]]]</span></p>
11141115
</dd>
11151116
</dl>
11161117
<p><code class="docutils literal notranslate"><span class="pre">x.det()</span></code> is the determinant of the rotation component of the values
@@ -1142,7 +1143,7 @@ <h1>SO(2) matrix<a class="headerlink" href="#so-2-matrix" title="Link to this he
11421143
<dd class="field-even"><p><strong>ValueError</strong> – incorrect type of appended object</p>
11431144
</dd>
11441145
<dt class="field-odd">Return type<span class="colon">:</span></dt>
1145-
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></span></p>
1146+
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><span class="highlight sphinx_autodoc_typehints-value"><code class="xref py py-obj docutils literal notranslate"><span class="kc"><span class="pre">None</span></span></code></span></span></p>
11461147
</dd>
11471148
</dl>
11481149
<p>Appends the argument’s values to the object’s internal list of values.</p>
@@ -1172,7 +1173,7 @@ <h1>SO(2) matrix<a class="headerlink" href="#so-2-matrix" title="Link to this he
11721173
<dd class="field-even"><p><strong>ValueError</strong> – incorrect type of inserted value</p>
11731174
</dd>
11741175
<dt class="field-odd">Return type<span class="colon">:</span></dt>
1175-
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></span></p>
1176+
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><span class="highlight sphinx_autodoc_typehints-value"><code class="xref py py-obj docutils literal notranslate"><span class="kc"><span class="pre">None</span></span></code></span></span></p>
11761177
</dd>
11771178
</dl>
11781179
<p>Inserts the argument into the object’s internal list of values.</p>
@@ -1587,7 +1588,7 @@ <h1>SO(2) matrix<a class="headerlink" href="#so-2-matrix" title="Link to this he
15871588
<dd class="field-odd"><p><strong>**kwargs</strong> – plotting options</p>
15881589
</dd>
15891590
<dt class="field-even">Return type<span class="colon">:</span></dt>
1590-
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></span></p>
1591+
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><span class="highlight sphinx_autodoc_typehints-value"><code class="xref py py-obj docutils literal notranslate"><span class="kc"><span class="pre">None</span></span></code></span></span></p>
15911592
</dd>
15921593
</dl>
15931594
<ul class="simple">
@@ -1655,7 +1656,7 @@ <h1>SO(2) matrix<a class="headerlink" href="#so-2-matrix" title="Link to this he
16551656
</ul>
16561657
</dd>
16571658
<dt class="field-even">Return type<span class="colon">:</span></dt>
1658-
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></span></p>
1659+
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><span class="highlight sphinx_autodoc_typehints-value"><code class="xref py py-obj docutils literal notranslate"><span class="kc"><span class="pre">None</span></span></code></span></span></p>
16591660
</dd>
16601661
</dl>
16611662
<p>Print the pose as a matrix, with an optional line beforehand. By default
@@ -1699,7 +1700,7 @@ <h1>SO(2) matrix<a class="headerlink" href="#so-2-matrix" title="Link to this he
16991700
</ul>
17001701
</dd>
17011702
<dt class="field-even">Return type<span class="colon">:</span></dt>
1702-
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></span></p>
1703+
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><span class="highlight sphinx_autodoc_typehints-value"><code class="xref py py-obj docutils literal notranslate"><span class="kc"><span class="pre">None</span></span></code></span></span></p>
17031704
</dd>
17041705
</dl>
17051706
<p>Print pose in a compact single line format. If <code class="docutils literal notranslate"><span class="pre">X</span></code> has multiple
@@ -2013,7 +2014,7 @@ <h1>SO(2) matrix<a class="headerlink" href="#so-2-matrix" title="Link to this he
20132014
</dd></dl>
20142015
<dl class="py property">
20152016
<dt class="sig sig-object py" id="spatialmath.pose2d.SO2.A">
2016-
<span class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">A</span></span><span class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </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="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">NDArray</span></span><a class="headerlink" href="#spatialmath.pose2d.SO2.A" title="Link to this definition"></a></dt>
2017+
<span class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">A</span></span><span 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></span><a class="headerlink" href="#spatialmath.pose2d.SO2.A" title="Link to this definition"></a></dt>
20172018
<dd><p>Array value of an instance (BasePoseList superclass method)</p>
20182019
<dl class="field-list simple">
20192020
<dt class="field-odd">Returns<span class="colon">:</span></dt>
@@ -2152,7 +2153,7 @@ <h1>SO(2) matrix<a class="headerlink" href="#so-2-matrix" title="Link to this he
21522153
<hr/>
21532154
<div role="contentinfo">
21542155
<p>© Copyright 2020-, Peter Corke..
2155-
<span class="lastupdated">Last updated on 16-Oct-2026.
2156+
<span class="lastupdated">Last updated on 26-Oct-2026.
21562157
</span></p>
21572158
</div>
21582159

0 commit comments

Comments
 (0)