Skip to content

Commit 4a4832d

Browse files
committed
Deploying to main from @ pyt-team/TopoNetX@f652c82 🚀
1 parent e78f02f commit 4a4832d

19 files changed

+380
-378
lines changed
22 Bytes
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

-794 Bytes
Binary file not shown.

toponetx/_modules/toponetx/classes/colored_hypergraph.html

+3-1
Original file line numberDiff line numberDiff line change
@@ -495,7 +495,9 @@ <h1>Source code for toponetx.classes.colored_hypergraph</h1><div class="highligh
495495
<span class="sd"> NodeView of all nodes.</span>
496496
<span class="sd"> &quot;&quot;&quot;</span>
497497
<span class="k">return</span> <span class="n">NodeView</span><span class="p">(</span>
498-
<span class="bp">self</span><span class="o">.</span><span class="n">_complex_set</span><span class="o">.</span><span class="n">hyperedge_dict</span><span class="p">,</span> <span class="n">cell_type</span><span class="o">=</span><span class="n">HyperEdge</span><span class="p">,</span> <span class="n">colored_nodes</span><span class="o">=</span><span class="kc">True</span>
498+
<span class="bp">self</span><span class="o">.</span><span class="n">_complex_set</span><span class="o">.</span><span class="n">hyperedge_dict</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="p">{}),</span>
499+
<span class="n">cell_type</span><span class="o">=</span><span class="n">HyperEdge</span><span class="p">,</span>
500+
<span class="n">colored_nodes</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
499501
<span class="p">)</span>
500502

501503
<span class="nd">@property</span>

toponetx/_modules/toponetx/classes/combinatorial_complex.html

+3-1
Original file line numberDiff line numberDiff line change
@@ -594,7 +594,9 @@ <h1>Source code for toponetx.classes.combinatorial_complex</h1><div class="highl
594594
<span class="sd"> Returns all the nodes of the combinatorial complex.</span>
595595
<span class="sd"> &quot;&quot;&quot;</span>
596596
<span class="k">return</span> <span class="n">NodeView</span><span class="p">(</span>
597-
<span class="bp">self</span><span class="o">.</span><span class="n">_complex_set</span><span class="o">.</span><span class="n">hyperedge_dict</span><span class="p">,</span> <span class="n">cell_type</span><span class="o">=</span><span class="n">HyperEdge</span><span class="p">,</span> <span class="n">colored_nodes</span><span class="o">=</span><span class="kc">False</span>
597+
<span class="bp">self</span><span class="o">.</span><span class="n">_complex_set</span><span class="o">.</span><span class="n">hyperedge_dict</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="p">{}),</span>
598+
<span class="n">cell_type</span><span class="o">=</span><span class="n">HyperEdge</span><span class="p">,</span>
599+
<span class="n">colored_nodes</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span>
598600
<span class="p">)</span>
599601

600602
<span class="nd">@property</span>

toponetx/_modules/toponetx/classes/reportviews.html

+70-52
Large diffs are not rendered by default.

toponetx/_modules/toponetx/classes/simplex.html

+42-20
Large diffs are not rendered by default.

toponetx/_modules/toponetx/classes/simplicial_complex.html

+183-236
Large diffs are not rendered by default.

toponetx/api/classes.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -448,13 +448,13 @@ <h2>Complexes<a class="headerlink" href="#complexes" title="Link to this heading
448448
<h2>Report Views<a class="headerlink" href="#report-views" title="Link to this heading">#</a></h2>
449449
<div class="pst-scrollable-table-container"><table class="autosummary longtable table autosummary">
450450
<tbody>
451-
<tr class="row-odd"><td><p><a class="reference internal" href="generated/toponetx.NodeView.html#toponetx.NodeView" title="toponetx.NodeView"><code class="xref py py-obj docutils literal notranslate"><span class="pre">toponetx.NodeView</span></code></a>(objectdict, cell_type[, ...])</p></td>
451+
<tr class="row-odd"><td><p><a class="reference internal" href="generated/toponetx.NodeView.html#toponetx.NodeView" title="toponetx.NodeView"><code class="xref py py-obj docutils literal notranslate"><span class="pre">toponetx.NodeView</span></code></a>(nodes, cell_type[, ...])</p></td>
452452
<td><p>Node view class.</p></td>
453453
</tr>
454454
<tr class="row-even"><td><p><a class="reference internal" href="generated/toponetx.AtomView.html#toponetx.AtomView" title="toponetx.AtomView"><code class="xref py py-obj docutils literal notranslate"><span class="pre">toponetx.AtomView</span></code></a>()</p></td>
455455
<td><p>Abstract class representing a read-only view on a collection of atoms.</p></td>
456456
</tr>
457-
<tr class="row-odd"><td><p><a class="reference internal" href="generated/toponetx.SimplexView.html#toponetx.SimplexView" title="toponetx.SimplexView"><code class="xref py py-obj docutils literal notranslate"><span class="pre">toponetx.SimplexView</span></code></a>()</p></td>
457+
<tr class="row-odd"><td><p><a class="reference internal" href="generated/toponetx.SimplexView.html#toponetx.SimplexView" title="toponetx.SimplexView"><code class="xref py py-obj docutils literal notranslate"><span class="pre">toponetx.SimplexView</span></code></a>(simplex_trie)</p></td>
458458
<td><p>Simplex View class.</p></td>
459459
</tr>
460460
<tr class="row-even"><td><p><a class="reference internal" href="generated/toponetx.PathView.html#toponetx.PathView" title="toponetx.PathView"><code class="xref py py-obj docutils literal notranslate"><span class="pre">toponetx.PathView</span></code></a>()</p></td>

toponetx/api/generated/toponetx.NodeView.html

+4-4
Original file line numberDiff line numberDiff line change
@@ -398,13 +398,13 @@
398398
<h1>toponetx.NodeView<a class="headerlink" href="#toponetx-nodeview" title="Link to this heading">#</a></h1>
399399
<dl class="py class">
400400
<dt class="sig sig-object py" id="toponetx.NodeView">
401-
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">toponetx.</span></span><span class="sig-name descname"><span class="pre">NodeView</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">objectdict</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cell_type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">colored_nodes</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><a class="reference internal" href="../../_modules/toponetx/classes/reportviews.html#NodeView"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#toponetx.NodeView" title="Link to this definition">#</a></dt>
401+
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">toponetx.</span></span><span class="sig-name descname"><span class="pre">NodeView</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">nodes</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/stdtypes.html#dict" title="(in Python v3.13)"><span class="pre">dict</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Hashable" title="(in Python v3.13)"><span class="pre">Hashable</span></a><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.Any" title="(in Python v3.13)"><span class="pre">Any</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cell_type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">colored_nodes</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><a class="reference internal" href="../../_modules/toponetx/classes/reportviews.html#NodeView"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#toponetx.NodeView" title="Link to this definition">#</a></dt>
402402
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
403403
<p>Node view class.</p>
404404
<dl class="field-list simple">
405405
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
406406
<dd class="field-odd"><dl class="simple">
407-
<dt><strong>objectdict</strong><span class="classifier">dict</span></dt><dd><p>A dictionary of nodes with their attributes.</p>
407+
<dt><strong>nodes</strong><span class="classifier">dict[Hashable, Any]</span></dt><dd><p>A dictionary of nodes with their attributes.</p>
408408
</dd>
409409
<dt><strong>cell_type</strong><span class="classifier">type</span></dt><dd><p>The type of the cell.</p>
410410
</dd>
@@ -415,13 +415,13 @@ <h1>toponetx.NodeView<a class="headerlink" href="#toponetx-nodeview" title="Link
415415
</dl>
416416
<dl class="py method">
417417
<dt class="sig sig-object py" id="toponetx.NodeView.__init__">
418-
<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">objectdict</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cell_type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">colored_nodes</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/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span></span><a class="reference internal" href="../../_modules/toponetx/classes/reportviews.html#NodeView.__init__"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#toponetx.NodeView.__init__" title="Link to this definition">#</a></dt>
418+
<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">nodes</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/stdtypes.html#dict" title="(in Python v3.13)"><span class="pre">dict</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Hashable" title="(in Python v3.13)"><span class="pre">Hashable</span></a><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.Any" title="(in Python v3.13)"><span class="pre">Any</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cell_type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">colored_nodes</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/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span></span><a class="reference internal" href="../../_modules/toponetx/classes/reportviews.html#NodeView.__init__"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#toponetx.NodeView.__init__" title="Link to this definition">#</a></dt>
419419
<dd></dd></dl>
420420

421421
<p class="rubric">Methods</p>
422422
<div class="pst-scrollable-table-container"><table class="autosummary longtable table autosummary">
423423
<tbody>
424-
<tr class="row-odd"><td><p><a class="reference internal" href="#toponetx.NodeView.__init__" title="toponetx.NodeView.__init__"><code class="xref py py-obj docutils literal notranslate"><span class="pre">__init__</span></code></a>(objectdict, cell_type[, colored_nodes])</p></td>
424+
<tr class="row-odd"><td><p><a class="reference internal" href="#toponetx.NodeView.__init__" title="toponetx.NodeView.__init__"><code class="xref py py-obj docutils literal notranslate"><span class="pre">__init__</span></code></a>(nodes, cell_type[, colored_nodes])</p></td>
425425
<td><p></p></td>
426426
</tr>
427427
</tbody>

toponetx/api/generated/toponetx.PathView.html

+6-6
Original file line numberDiff line numberDiff line change
@@ -399,19 +399,19 @@ <h1>toponetx.PathView<a class="headerlink" href="#toponetx-pathview" title="Link
399399
<dl class="py class">
400400
<dt class="sig sig-object py" id="toponetx.PathView">
401401
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">toponetx.</span></span><span class="sig-name descname"><span class="pre">PathView</span></span><a class="reference internal" href="../../_modules/toponetx/classes/reportviews.html#PathView"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#toponetx.PathView" title="Link to this definition">#</a></dt>
402-
<dd><p>Bases: <a class="reference internal" href="toponetx.SimplexView.html#toponetx.SimplexView" title="toponetx.classes.reportviews.SimplexView"><code class="xref py py-class docutils literal notranslate"><span class="pre">SimplexView</span></code></a></p>
402+
<dd><p>Bases: <a class="reference internal" href="toponetx.AtomView.html#toponetx.AtomView" title="toponetx.classes.reportviews.AtomView"><code class="xref py py-class docutils literal notranslate"><span class="pre">AtomView</span></code></a>[<a class="reference internal" href="toponetx.Path.html#toponetx.Path" title="toponetx.classes.path.Path"><code class="xref py py-class docutils literal notranslate"><span class="pre">Path</span></code></a>]</p>
403403
<p>Path view class.</p>
404404
<dl class="field-list simple">
405405
<dt class="field-odd">Attributes<span class="colon">:</span></dt>
406406
<dd class="field-odd"><dl class="simple">
407-
<dt><a class="reference internal" href="#toponetx.PathView.shape" title="toponetx.PathView.shape"><code class="xref py py-obj docutils literal notranslate"><span class="pre">shape</span></code></a></dt><dd><p>Return the number of simplices in each dimension.</p>
407+
<dt><a class="reference internal" href="#toponetx.PathView.shape" title="toponetx.PathView.shape"><code class="xref py py-obj docutils literal notranslate"><span class="pre">shape</span></code></a></dt><dd><p>Return the number of paths in each dimension.</p>
408408
</dd>
409409
</dl>
410410
</dd>
411411
</dl>
412412
<dl class="py method">
413413
<dt class="sig sig-object py" id="toponetx.PathView.__init__">
414-
<span class="sig-name descname"><span class="pre">__init__</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/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span></span><a class="headerlink" href="#toponetx.PathView.__init__" title="Link to this definition">#</a></dt>
414+
<span class="sig-name descname"><span class="pre">__init__</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/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span></span><a class="reference internal" href="../../_modules/toponetx/classes/reportviews.html#PathView.__init__"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#toponetx.PathView.__init__" title="Link to this definition">#</a></dt>
415415
<dd></dd></dl>
416416

417417
<p class="rubric">Methods</p>
@@ -427,19 +427,19 @@ <h1>toponetx.PathView<a class="headerlink" href="#toponetx-pathview" title="Link
427427
<div class="pst-scrollable-table-container"><table class="autosummary longtable table autosummary">
428428
<tbody>
429429
<tr class="row-odd"><td><p><a class="reference internal" href="#toponetx.PathView.shape" title="toponetx.PathView.shape"><code class="xref py py-obj docutils literal notranslate"><span class="pre">shape</span></code></a></p></td>
430-
<td><p>Return the number of simplices in each dimension.</p></td>
430+
<td><p>Return the number of paths in each dimension.</p></td>
431431
</tr>
432432
</tbody>
433433
</table>
434434
</div>
435435
<dl class="py property">
436436
<dt class="sig sig-object py" id="toponetx.PathView.shape">
437437
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">shape</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/stdtypes.html#tuple" title="(in Python v3.13)"><span class="pre">tuple</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)"><span class="pre">int</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="p"><span class="pre">...</span></span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#toponetx.PathView.shape" title="Link to this definition">#</a></dt>
438-
<dd><p>Return the number of simplices in each dimension.</p>
438+
<dd><p>Return the number of paths in each dimension.</p>
439439
<dl class="field-list simple">
440440
<dt class="field-odd">Returns<span class="colon">:</span></dt>
441441
<dd class="field-odd"><dl class="simple">
442-
<dt>tuple of ints</dt><dd><p>A tuple of integers representing the number of simplices in each dimension.</p>
442+
<dt>tuple of ints</dt><dd><p>A tuple of integers representing the number of paths in each dimension.</p>
443443
</dd>
444444
</dl>
445445
</dd>

0 commit comments

Comments
 (0)