Skip to content

Commit 66d51ed

Browse files
committed
Deploying to main from @ pyt-team/TopoNetX@c22b372 🚀
1 parent 8323d9e commit 66d51ed

20 files changed

+24
-24
lines changed

toponetx/.buildinfo

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Sphinx build info version 1
22
# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
3-
config: edf5d969167734d5e876de0a479534cd
3+
config: b7506eea0f88499dec85a7a5a9927a72
44
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.

toponetx/.doctrees/environment.pickle

6 Bytes
Binary file not shown.

toponetx/api/generated/toponetx.Cell.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -549,7 +549,7 @@ <h1>toponetx.Cell<a class="headerlink" href="#toponetx-cell" title="Link to this
549549

550550
<dl class="py method">
551551
<dt class="sig sig-object py" id="toponetx.Cell.clone">
552-
<span class="sig-name descname"><span class="pre">clone</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">Self</span></span></span><a class="reference internal" href="../../_modules/toponetx/classes/cell.html#Cell.clone"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#toponetx.Cell.clone" title="Link to this definition">#</a></dt>
552+
<span class="sig-name descname"><span class="pre">clone</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Self" title="(in Python v3.13)"><span class="pre">Self</span></a></span></span><a class="reference internal" href="../../_modules/toponetx/classes/cell.html#Cell.clone"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#toponetx.Cell.clone" title="Link to this definition">#</a></dt>
553553
<dd><p>Clone the Cell with all attributes.</p>
554554
<p>The clone method by default returns an independent shallow copy of the cell and
555555
attributes. That is, if an attribute is a container, that container is shared

toponetx/api/generated/toponetx.CellComplex.html

+3-3
Original file line numberDiff line numberDiff line change
@@ -1112,7 +1112,7 @@ <h1>toponetx.CellComplex<a class="headerlink" href="#toponetx-cellcomplex" title
11121112

11131113
<dl class="py method">
11141114
<dt class="sig sig-object py" id="toponetx.CellComplex.clone">
1115-
<span class="sig-name descname"><span class="pre">clone</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">Self</span></span></span><a class="reference internal" href="../../_modules/toponetx/classes/cell_complex.html#CellComplex.clone"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#toponetx.CellComplex.clone" title="Link to this definition">#</a></dt>
1115+
<span class="sig-name descname"><span class="pre">clone</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Self" title="(in Python v3.13)"><span class="pre">Self</span></a></span></span><a class="reference internal" href="../../_modules/toponetx/classes/cell_complex.html#CellComplex.clone"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#toponetx.CellComplex.clone" title="Link to this definition">#</a></dt>
11161116
<dd><p>Create a clone of the CellComplex.</p>
11171117
<dl class="field-list simple">
11181118
<dt class="field-odd">Returns<span class="colon">:</span></dt>
@@ -1329,7 +1329,7 @@ <h1>toponetx.CellComplex<a class="headerlink" href="#toponetx-cellcomplex" title
13291329

13301330
<dl class="py method">
13311331
<dt class="sig sig-object py" id="toponetx.CellComplex.from_trimesh">
1332-
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_trimesh</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">mesh</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">Self</span></span></span><a class="reference internal" href="../../_modules/toponetx/classes/cell_complex.html#CellComplex.from_trimesh"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#toponetx.CellComplex.from_trimesh" title="Link to this definition">#</a></dt>
1332+
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_trimesh</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">mesh</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Self" title="(in Python v3.13)"><span class="pre">Self</span></a></span></span><a class="reference internal" href="../../_modules/toponetx/classes/cell_complex.html#CellComplex.from_trimesh"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#toponetx.CellComplex.from_trimesh" title="Link to this definition">#</a></dt>
13331333
<dd><p>Convert from trimesh object.</p>
13341334
<dl class="field-list simple">
13351335
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
@@ -1742,7 +1742,7 @@ <h1>toponetx.CellComplex<a class="headerlink" href="#toponetx-cellcomplex" title
17421742

17431743
<dl class="py method">
17441744
<dt class="sig sig-object py" id="toponetx.CellComplex.load_mesh">
1745-
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">load_mesh</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">file_path</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">process</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.13)"><span class="pre">bool</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">Self</span></span></span><a class="reference internal" href="../../_modules/toponetx/classes/cell_complex.html#CellComplex.load_mesh"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#toponetx.CellComplex.load_mesh" title="Link to this definition">#</a></dt>
1745+
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">load_mesh</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">file_path</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">process</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.13)"><span class="pre">bool</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Self" title="(in Python v3.13)"><span class="pre">Self</span></a></span></span><a class="reference internal" href="../../_modules/toponetx/classes/cell_complex.html#CellComplex.load_mesh"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#toponetx.CellComplex.load_mesh" title="Link to this definition">#</a></dt>
17461746
<dd><p>Load a mesh.</p>
17471747
<dl class="field-list simple">
17481748
<dt class="field-odd">Parameters<span class="colon">:</span></dt>

toponetx/api/generated/toponetx.ColoredHyperGraph.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -911,7 +911,7 @@ <h1>toponetx.ColoredHyperGraph<a class="headerlink" href="#toponetx-coloredhyper
911911

912912
<dl class="py method">
913913
<dt class="sig sig-object py" id="toponetx.ColoredHyperGraph.clone">
914-
<span class="sig-name descname"><span class="pre">clone</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">Self</span></span></span><a class="reference internal" href="../../_modules/toponetx/classes/colored_hypergraph.html#ColoredHyperGraph.clone"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#toponetx.ColoredHyperGraph.clone" title="Link to this definition">#</a></dt>
914+
<span class="sig-name descname"><span class="pre">clone</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Self" title="(in Python v3.13)"><span class="pre">Self</span></a></span></span><a class="reference internal" href="../../_modules/toponetx/classes/colored_hypergraph.html#ColoredHyperGraph.clone"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#toponetx.ColoredHyperGraph.clone" title="Link to this definition">#</a></dt>
915915
<dd><p>Return a copy of the simplex.</p>
916916
<p>The clone method by default returns an independent shallow copy of the simplex
917917
and attributes. That is, if an attribute is a container, that container is
@@ -1491,7 +1491,7 @@ <h1>toponetx.ColoredHyperGraph<a class="headerlink" href="#toponetx-coloredhyper
14911491

14921492
<dl class="py method">
14931493
<dt class="sig sig-object py" id="toponetx.ColoredHyperGraph.remove_node">
1494-
<span class="sig-name descname"><span class="pre">remove_node</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">node</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">Self</span></span></span><a class="reference internal" href="../../_modules/toponetx/classes/colored_hypergraph.html#ColoredHyperGraph.remove_node"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#toponetx.ColoredHyperGraph.remove_node" title="Link to this definition">#</a></dt>
1494+
<span class="sig-name descname"><span class="pre">remove_node</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">node</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Self" title="(in Python v3.13)"><span class="pre">Self</span></a></span></span><a class="reference internal" href="../../_modules/toponetx/classes/colored_hypergraph.html#ColoredHyperGraph.remove_node"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#toponetx.ColoredHyperGraph.remove_node" title="Link to this definition">#</a></dt>
14951495
<dd><p>Remove a node from the ColoredHyperGraph.</p>
14961496
<p>This method removes a node from the cells and deletes any reference in the nodes of the CHG.</p>
14971497
<dl class="field-list simple">

toponetx/api/generated/toponetx.CombinatorialComplex.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -903,7 +903,7 @@ <h1>toponetx.CombinatorialComplex<a class="headerlink" href="#toponetx-combinato
903903

904904
<dl class="py method">
905905
<dt class="sig sig-object py" id="toponetx.CombinatorialComplex.clone">
906-
<span class="sig-name descname"><span class="pre">clone</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">Self</span></span></span><a class="reference internal" href="../../_modules/toponetx/classes/combinatorial_complex.html#CombinatorialComplex.clone"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#toponetx.CombinatorialComplex.clone" title="Link to this definition">#</a></dt>
906+
<span class="sig-name descname"><span class="pre">clone</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Self" title="(in Python v3.13)"><span class="pre">Self</span></a></span></span><a class="reference internal" href="../../_modules/toponetx/classes/combinatorial_complex.html#CombinatorialComplex.clone"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#toponetx.CombinatorialComplex.clone" title="Link to this definition">#</a></dt>
907907
<dd><p>Return a copy of the simplex.</p>
908908
<p>The clone method by default returns an independent shallow copy of the simplex
909909
and attributes. That is, if an attribute is a container, that container is

toponetx/api/generated/toponetx.Complex.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -560,7 +560,7 @@ <h1>toponetx.Complex<a class="headerlink" href="#toponetx-complex" title="Link t
560560

561561
<dl class="py method">
562562
<dt class="sig sig-object py" id="toponetx.Complex.clone">
563-
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">clone</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">Self</span></span></span><a class="reference internal" href="../../_modules/toponetx/classes/complex.html#Complex.clone"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#toponetx.Complex.clone" title="Link to this definition">#</a></dt>
563+
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">clone</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Self" title="(in Python v3.13)"><span class="pre">Self</span></a></span></span><a class="reference internal" href="../../_modules/toponetx/classes/complex.html#Complex.clone"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#toponetx.Complex.clone" title="Link to this definition">#</a></dt>
564564
<dd><p>Clone complex.</p>
565565
</dd></dl>
566566

toponetx/api/generated/toponetx.Path.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -561,7 +561,7 @@ <h1>toponetx.Path<a class="headerlink" href="#toponetx-path" title="Link to this
561561

562562
<dl class="py method">
563563
<dt class="sig sig-object py" id="toponetx.Path.clone">
564-
<span class="sig-name descname"><span class="pre">clone</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">Self</span></span></span><a class="reference internal" href="../../_modules/toponetx/classes/path.html#Path.clone"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#toponetx.Path.clone" title="Link to this definition">#</a></dt>
564+
<span class="sig-name descname"><span class="pre">clone</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Self" title="(in Python v3.13)"><span class="pre">Self</span></a></span></span><a class="reference internal" href="../../_modules/toponetx/classes/path.html#Path.clone"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#toponetx.Path.clone" title="Link to this definition">#</a></dt>
565565
<dd><p>Return a shallow copy of the elementary p-path.</p>
566566
<dl class="field-list simple">
567567
<dt class="field-odd">Returns<span class="colon">:</span></dt>

toponetx/api/generated/toponetx.PathComplex.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -777,7 +777,7 @@ <h1>toponetx.PathComplex<a class="headerlink" href="#toponetx-pathcomplex" title
777777

778778
<dl class="py method">
779779
<dt class="sig sig-object py" id="toponetx.PathComplex.clone">
780-
<span class="sig-name descname"><span class="pre">clone</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">Self</span></span></span><a class="reference internal" href="../../_modules/toponetx/classes/path_complex.html#PathComplex.clone"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#toponetx.PathComplex.clone" title="Link to this definition">#</a></dt>
780+
<span class="sig-name descname"><span class="pre">clone</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Self" title="(in Python v3.13)"><span class="pre">Self</span></a></span></span><a class="reference internal" href="../../_modules/toponetx/classes/path_complex.html#PathComplex.clone"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#toponetx.PathComplex.clone" title="Link to this definition">#</a></dt>
781781
<dd><p>Return a copy of the path complex.</p>
782782
<p>The clone method by default returns an independent shallow copy of the path
783783
complex. Use Python’s <cite>copy.deepcopy</cite> for new containers.</p>

0 commit comments

Comments
 (0)