Skip to content

Commit

Permalink
Regenerate docs from 2d3f140f82bd226f5316f14af1218661ef440c98
Browse files Browse the repository at this point in the history
  • Loading branch information
bradley-solliday-skydio committed Nov 15, 2023
1 parent c0c1aac commit 84c53bd
Show file tree
Hide file tree
Showing 24 changed files with 710 additions and 710 deletions.
38 changes: 19 additions & 19 deletions _modules/symforce/internal/symbolic.html

Large diffs are not rendered by default.

22 changes: 11 additions & 11 deletions _modules/symforce/logic.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion _modules/symforce/ops/impl/vector_class_lie_group_ops.html
Original file line number Diff line number Diff line change
Expand Up @@ -744,7 +744,7 @@ <h1>Source code for symforce.ops.impl.vector_class_lie_group_ops</h1><div class=
<span class="kn">from</span> <span class="nn">.class_storage_ops</span> <span class="kn">import</span> <span class="n">ClassStorageOps</span>


<div class="viewcode-block" id="VectorClassLieGroupOps"><a class="viewcode-back" href="../../../../api/symforce.ops.impl.vector_class_lie_group_ops.html#symforce.ops.impl.vector_class_lie_group_ops.VectorClassLieGroupOps">[docs]</a><span class="k">class</span> <span class="nc">VectorClassLieGroupOps</span><span class="p">(</span><span class="n">ClassStorageOps</span><span class="p">,</span> <span class="n">AbstractVectorLieGroupOps</span><span class="p">[</span><span class="n">Storage</span><span class="p">]):</span>
<div class="viewcode-block" id="VectorClassLieGroupOps"><a class="viewcode-back" href="../../../../api/symforce.symbolic.html#symforce.symbolic.VectorClassLieGroupOps">[docs]</a><span class="k">class</span> <span class="nc">VectorClassLieGroupOps</span><span class="p">(</span><span class="n">ClassStorageOps</span><span class="p">,</span> <span class="n">AbstractVectorLieGroupOps</span><span class="p">[</span><span class="n">Storage</span><span class="p">]):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> A generic implementation of Lie group ops for subclasses of</span>
<span class="sd"> :class:`symforce.ops.interfaces.storage.Storage`.</span>
Expand Down
22 changes: 11 additions & 11 deletions _modules/symforce/ops/interfaces/storage.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion api/symforce.cam.camera_cal.html
Original file line number Diff line number Diff line change
Expand Up @@ -746,7 +746,7 @@
<dl class="py class">
<dt class="sig sig-object py" id="symforce.cam.camera_cal.CameraCal">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">CameraCal</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">focal_length</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">principal_point</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">distortion_coeffs</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">()</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/symforce/cam/camera_cal.html#CameraCal"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#symforce.cam.camera_cal.CameraCal" title="Permalink to this definition">#</a></dt>
<dd><p>Bases: <a class="reference internal" href="symforce.symbolic.html#symforce.symbolic.Storage" title="symforce.ops.interfaces.storage.Storage"><code class="xref py py-class docutils literal notranslate"><span class="pre">Storage</span></code></a></p>
<dd><p>Bases: <a class="reference internal" href="symforce.ops.interfaces.storage.html#symforce.ops.interfaces.storage.Storage" title="symforce.ops.interfaces.storage.Storage"><code class="xref py py-class docutils literal notranslate"><span class="pre">Storage</span></code></a></p>
<p>Base class for symbolic camera models.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
Expand Down
2 changes: 1 addition & 1 deletion api/symforce.codegen.codegen.html
Original file line number Diff line number Diff line change
Expand Up @@ -853,7 +853,7 @@
</dl>
<dl class="py property">
<dt class="sig sig-object py" id="symforce.codegen.codegen.Codegen.output_symbols">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">output_symbols</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Set" title="(in Python v3.12)"><span class="pre">Set</span></a><span class="p"><span class="pre">[</span></span><a class="reference internal" href="symforce.symbolic.html#symforce.symbolic.Symbol" title="symforce.internal.symbolic.Symbol"><span class="pre">Symbol</span></a><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#symforce.codegen.codegen.Codegen.output_symbols" 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">output_symbols</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Set" title="(in Python v3.12)"><span class="pre">Set</span></a><span class="p"><span class="pre">[</span></span><a class="reference internal" href="symforce.internal.symbolic.html#symforce.internal.symbolic.Symbol" title="symforce.internal.symbolic.Symbol"><span class="pre">Symbol</span></a><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#symforce.codegen.codegen.Codegen.output_symbols" title="Permalink to this definition">#</a></dt>
<dd><p>The set of free symbols in the output</p>
<p>Cached, because this is somewhat expensive to compute for large outputs</p>
</dd></dl>
Expand Down
8 changes: 4 additions & 4 deletions api/symforce.codegen.codegen_util.html
Original file line number Diff line number Diff line change
Expand Up @@ -969,7 +969,7 @@
</ul>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Tuple" title="(in Python v3.12)"><em>Tuple</em></a>[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Sequence" title="(in Python v3.12)"><em>Sequence</em></a>[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Tuple" title="(in Python v3.12)"><em>Tuple</em></a>[<a class="reference internal" href="symforce.symbolic.html#symforce.symbolic.Symbol" title="symforce.internal.symbolic.Symbol"><em>Symbol</em></a>, <a class="reference internal" href="symforce.symbolic.html#symforce.symbolic.Expr" title="symengine.lib.symengine_wrapper.Expr"><em>Expr</em></a>]], <a class="reference internal" href="#symforce.codegen.codegen_util.DenseAndSparseOutputTerms" title="symforce.codegen.codegen_util.DenseAndSparseOutputTerms"><em>DenseAndSparseOutputTerms</em></a>]</p>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Tuple" title="(in Python v3.12)"><em>Tuple</em></a>[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Sequence" title="(in Python v3.12)"><em>Sequence</em></a>[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Tuple" title="(in Python v3.12)"><em>Tuple</em></a>[<a class="reference internal" href="symforce.internal.symbolic.html#symforce.internal.symbolic.Symbol" title="symforce.internal.symbolic.Symbol"><em>Symbol</em></a>, <a class="reference internal" href="symforce.symbolic.html#symforce.symbolic.Expr" title="symengine.lib.symengine_wrapper.Expr"><em>Expr</em></a>]], <a class="reference internal" href="#symforce.codegen.codegen_util.DenseAndSparseOutputTerms" title="symforce.codegen.codegen_util.DenseAndSparseOutputTerms"><em>DenseAndSparseOutputTerms</em></a>]</p>
</dd>
</dl>
</dd></dl>
Expand All @@ -987,13 +987,13 @@
<li><p><strong>inputs</strong> (<a class="reference internal" href="symforce.values.values.html#symforce.values.values.Values" title="symforce.values.values.Values"><em>Values</em></a>) – </p></li>
<li><p><strong>dense_outputs</strong> (<a class="reference internal" href="symforce.values.values.html#symforce.values.values.Values" title="symforce.values.values.Values"><em>Values</em></a>) – </p></li>
<li><p><strong>sparse_outputs</strong> (<a class="reference internal" href="symforce.values.values.html#symforce.values.values.Values" title="symforce.values.values.Values"><em>Values</em></a>) – </p></li>
<li><p><strong>intermediate_terms</strong> (<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Sequence" title="(in Python v3.12)"><em>Sequence</em></a><em>[</em><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Tuple" title="(in Python v3.12)"><em>Tuple</em></a><em>[</em><a class="reference internal" href="symforce.symbolic.html#symforce.symbolic.Symbol" title="symforce.internal.symbolic.Symbol"><em>Symbol</em></a><em>, </em><a class="reference internal" href="symforce.symbolic.html#symforce.symbolic.Expr" title="symengine.lib.symengine_wrapper.Expr"><em>Expr</em></a><em>]</em><em>]</em>) – </p></li>
<li><p><strong>intermediate_terms</strong> (<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Sequence" title="(in Python v3.12)"><em>Sequence</em></a><em>[</em><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Tuple" title="(in Python v3.12)"><em>Tuple</em></a><em>[</em><a class="reference internal" href="symforce.internal.symbolic.html#symforce.internal.symbolic.Symbol" title="symforce.internal.symbolic.Symbol"><em>Symbol</em></a><em>, </em><a class="reference internal" href="symforce.symbolic.html#symforce.symbolic.Expr" title="symengine.lib.symengine_wrapper.Expr"><em>Expr</em></a><em>]</em><em>]</em>) – </p></li>
<li><p><strong>output_terms</strong> (<a class="reference internal" href="#symforce.codegen.codegen_util.DenseAndSparseOutputTerms" title="symforce.codegen.codegen_util.DenseAndSparseOutputTerms"><em>DenseAndSparseOutputTerms</em></a>) – </p></li>
<li><p><strong>config</strong> (<a class="reference internal" href="symforce.codegen.codegen_config.html#symforce.codegen.codegen_config.CodegenConfig" title="symforce.codegen.codegen_config.CodegenConfig"><em>CodegenConfig</em></a>) – </p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Tuple" title="(in Python v3.12)"><em>Tuple</em></a>[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Sequence" title="(in Python v3.12)"><em>Sequence</em></a>[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Tuple" title="(in Python v3.12)"><em>Tuple</em></a>[<a class="reference internal" href="symforce.symbolic.html#symforce.symbolic.Symbol" title="symforce.internal.symbolic.Symbol"><em>Symbol</em></a>, <a class="reference internal" href="symforce.symbolic.html#symforce.symbolic.Expr" title="symengine.lib.symengine_wrapper.Expr"><em>Expr</em></a>]], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Sequence" title="(in Python v3.12)"><em>Sequence</em></a>[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Sequence" title="(in Python v3.12)"><em>Sequence</em></a>[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Tuple" title="(in Python v3.12)"><em>Tuple</em></a>[<a class="reference internal" href="symforce.symbolic.html#symforce.symbolic.Symbol" title="symforce.internal.symbolic.Symbol"><em>Symbol</em></a>, <a class="reference internal" href="symforce.symbolic.html#symforce.symbolic.Expr" title="symengine.lib.symengine_wrapper.Expr"><em>Expr</em></a>]]], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Sequence" title="(in Python v3.12)"><em>Sequence</em></a>[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Sequence" title="(in Python v3.12)"><em>Sequence</em></a>[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Tuple" title="(in Python v3.12)"><em>Tuple</em></a>[<a class="reference internal" href="symforce.symbolic.html#symforce.symbolic.Symbol" title="symforce.internal.symbolic.Symbol"><em>Symbol</em></a>, <a class="reference internal" href="symforce.symbolic.html#symforce.symbolic.Expr" title="symengine.lib.symengine_wrapper.Expr"><em>Expr</em></a>]]]]</p>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Tuple" title="(in Python v3.12)"><em>Tuple</em></a>[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Sequence" title="(in Python v3.12)"><em>Sequence</em></a>[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Tuple" title="(in Python v3.12)"><em>Tuple</em></a>[<a class="reference internal" href="symforce.internal.symbolic.html#symforce.internal.symbolic.Symbol" title="symforce.internal.symbolic.Symbol"><em>Symbol</em></a>, <a class="reference internal" href="symforce.symbolic.html#symforce.symbolic.Expr" title="symengine.lib.symengine_wrapper.Expr"><em>Expr</em></a>]], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Sequence" title="(in Python v3.12)"><em>Sequence</em></a>[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Sequence" title="(in Python v3.12)"><em>Sequence</em></a>[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Tuple" title="(in Python v3.12)"><em>Tuple</em></a>[<a class="reference internal" href="symforce.internal.symbolic.html#symforce.internal.symbolic.Symbol" title="symforce.internal.symbolic.Symbol"><em>Symbol</em></a>, <a class="reference internal" href="symforce.symbolic.html#symforce.symbolic.Expr" title="symengine.lib.symengine_wrapper.Expr"><em>Expr</em></a>]]], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Sequence" title="(in Python v3.12)"><em>Sequence</em></a>[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Sequence" title="(in Python v3.12)"><em>Sequence</em></a>[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Tuple" title="(in Python v3.12)"><em>Tuple</em></a>[<a class="reference internal" href="symforce.internal.symbolic.html#symforce.internal.symbolic.Symbol" title="symforce.internal.symbolic.Symbol"><em>Symbol</em></a>, <a class="reference internal" href="symforce.symbolic.html#symforce.symbolic.Expr" title="symengine.lib.symengine_wrapper.Expr"><em>Expr</em></a>]]]]</p>
</dd>
</dl>
</dd></dl>
Expand Down Expand Up @@ -1021,7 +1021,7 @@
</ul>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Tuple" title="(in Python v3.12)"><em>Tuple</em></a>[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.List" title="(in Python v3.12)"><em>List</em></a>[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.List" title="(in Python v3.12)"><em>List</em></a>[<a class="reference internal" href="symforce.symbolic.html#symforce.symbolic.Symbol" title="symforce.internal.symbolic.Symbol"><em>Symbol</em></a> | <a class="reference internal" href="symforce.symbolic.html#symforce.symbolic.DataBuffer" title="symengine.lib.symengine_wrapper.DataBuffer"><em>DataBuffer</em></a>]], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.List" title="(in Python v3.12)"><em>List</em></a>[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.List" title="(in Python v3.12)"><em>List</em></a>[<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.12)">float</a>]]]</p>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Tuple" title="(in Python v3.12)"><em>Tuple</em></a>[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.List" title="(in Python v3.12)"><em>List</em></a>[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.List" title="(in Python v3.12)"><em>List</em></a>[<a class="reference internal" href="symforce.internal.symbolic.html#symforce.internal.symbolic.Symbol" title="symforce.internal.symbolic.Symbol"><em>Symbol</em></a> | <a class="reference internal" href="symforce.symbolic.html#symforce.symbolic.DataBuffer" title="symengine.lib.symengine_wrapper.DataBuffer"><em>DataBuffer</em></a>]], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.List" title="(in Python v3.12)"><em>List</em></a>[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.List" title="(in Python v3.12)"><em>List</em></a>[<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.12)">float</a>]]]</p>
</dd>
</dl>
</dd></dl>
Expand Down
2 changes: 1 addition & 1 deletion api/symforce.geo.matrix.html
Original file line number Diff line number Diff line change
Expand Up @@ -746,7 +746,7 @@
<dl class="py class">
<dt class="sig sig-object py" id="symforce.geo.matrix.Matrix">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">Matrix</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/symforce/geo/matrix.html#Matrix"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#symforce.geo.matrix.Matrix" title="Permalink to this definition">#</a></dt>
<dd><p>Bases: <a class="reference internal" href="symforce.symbolic.html#symforce.symbolic.Storage" title="symforce.ops.interfaces.storage.Storage"><code class="xref py py-class docutils literal notranslate"><span class="pre">Storage</span></code></a></p>
<dd><p>Bases: <a class="reference internal" href="symforce.ops.interfaces.storage.html#symforce.ops.interfaces.storage.Storage" title="symforce.ops.interfaces.storage.Storage"><code class="xref py py-class docutils literal notranslate"><span class="pre">Storage</span></code></a></p>
<p>Matrix type that wraps the SymPy Matrix class. Care has been taken to allow this class
to create fixed-size child classes like <a class="reference internal" href="#symforce.geo.matrix.Matrix31" title="symforce.geo.matrix.Matrix31"><code class="xref py py-class docutils literal notranslate"><span class="pre">Matrix31</span></code></a>. Anytime <a class="reference internal" href="#symforce.geo.matrix.Matrix.__new__" title="symforce.geo.matrix.Matrix.__new__"><code class="xref py py-meth docutils literal notranslate"><span class="pre">__new__()</span></code></a> is called,
the appropriate fixed size class is returned rather than the type of the arguments. The API is
Expand Down
Loading

0 comments on commit 84c53bd

Please sign in to comment.