Deploying to main from @ pyt-team/TopoNetX@4089bd0 🚀

Author: ffl096

toponetx/.doctrees/api/generated/toponetx.CellComplex.doctree

@@ -384,10 +384,8 @@ <h1>Source code for toponetx.classes.cell_complex</h1><div class="highlight"><pr
 
 <span class="k">try</span><span class="p">:</span>
     <span class="kn">from</span><span class="w"> </span><span class="nn">hypernetx</span><span class="w"> </span><span class="kn">import</span> <span class="n">Hypergraph</span>
-    <span class="kn">from</span><span class="w"> </span><span class="nn">hypernetx.classes.entity</span><span class="w"> </span><span class="kn">import</span> <span class="n">Entity</span>
 <span class="k">except</span> <span class="ne">ImportError</span><span class="p">:</span>
     <span class="n">Hypergraph</span> <span class="o">=</span> <span class="kc">None</span>
-    <span class="n">Entity</span> <span class="o">=</span> <span class="kc">None</span>
 
 
 <div class="viewcode-block" id="CellComplex">
@@ -2684,12 +2682,17 @@ <h1>Source code for toponetx.classes.cell_complex</h1><div class="highlight"><pr
 <div class="viewcode-block" id="CellComplex.to_hypergraph">
 <a class="viewcode-back" href="../../../api/generated/toponetx.CellComplex.html#toponetx.CellComplex.to_hypergraph">[docs]</a>
     <span class="k">def</span><span class="w"> </span><span class="nf">to_hypergraph</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
-<span class="w">        </span><span class="sd">&quot;&quot;&quot;Convert this cell complex to a hypergraph.</span>
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;Convert this cell complex to a `hypernetx` hypergraph.</span>
 
 <span class="sd">        Returns</span>
 <span class="sd">        -------</span>
 <span class="sd">        Hypergraph</span>
-<span class="sd">            The hyergraph corresponding to this cell complex.</span>
+<span class="sd">            The hypergraph corresponding to this cell complex.</span>
+
+<span class="sd">        Raises</span>
+<span class="sd">        ------</span>
+<span class="sd">        RuntimeError</span>
+<span class="sd">            If `hypernetx` is not installed.</span>
 
 <span class="sd">        Examples</span>
 <span class="sd">        --------</span>
@@ -2699,28 +2702,24 @@ <h1>Source code for toponetx.classes.cell_complex</h1><div class="highlight"><pr
 <span class="sd">        &gt;&gt;&gt; CC.add_cell([5, 6, 7, 8], rank=2)</span>
 <span class="sd">        &gt;&gt;&gt; CC.to_hypergraph()</span>
 <span class="sd">        &quot;&quot;&quot;</span>
-        <span class="kn">from</span><span class="w"> </span><span class="nn">hypernetx.classes.entity</span><span class="w"> </span><span class="kn">import</span> <span class="n">EntitySet</span>
-
-        <span class="n">cells</span> <span class="o">=</span> <span class="p">[]</span>
-        <span class="n">cells</span><span class="o">.</span><span class="n">extend</span><span class="p">(</span>
-            <span class="n">Entity</span><span class="p">(</span>
-                <span class="nb">str</span><span class="p">(</span><span class="nb">list</span><span class="p">(</span><span class="n">cell</span><span class="o">.</span><span class="n">elements</span><span class="p">)),</span>
-                <span class="n">elements</span><span class="o">=</span><span class="n">cell</span><span class="o">.</span><span class="n">elements</span><span class="p">,</span>
-                <span class="o">**</span><span class="bp">self</span><span class="o">.</span><span class="n">get_cell_data</span><span class="p">(</span><span class="n">cell</span><span class="p">,</span> <span class="mi">2</span><span class="p">),</span>
+        <span class="k">if</span> <span class="n">Hypergraph</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
+            <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">(</span>
+                <span class="s2">&quot;Cannot transform cell complex to hypergraph, `hypernetx` is not installed.&quot;</span>
             <span class="p">)</span>
-            <span class="k">for</span> <span class="n">cell</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">cells</span>
-        <span class="p">)</span>
-        <span class="n">cells</span><span class="o">.</span><span class="n">extend</span><span class="p">(</span>
-            <span class="n">Entity</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="nb">list</span><span class="p">(</span><span class="n">cell</span><span class="p">)),</span> <span class="n">elements</span><span class="o">=</span><span class="n">cell</span><span class="p">,</span> <span class="o">**</span><span class="bp">self</span><span class="o">.</span><span class="n">get_cell_data</span><span class="p">(</span><span class="n">cell</span><span class="p">,</span> <span class="mi">1</span><span class="p">))</span>
-            <span class="k">for</span> <span class="n">cell</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">edges</span>
-        <span class="p">)</span>
-        <span class="n">E</span> <span class="o">=</span> <span class="n">EntitySet</span><span class="p">(</span><span class="s2">&quot;CX_to_HG&quot;</span><span class="p">,</span> <span class="n">elements</span><span class="o">=</span><span class="n">cells</span><span class="p">)</span>
-        <span class="n">HG</span> <span class="o">=</span> <span class="n">Hypergraph</span><span class="p">(</span><span class="n">E</span><span class="p">)</span>
-        <span class="n">nodes</span> <span class="o">=</span> <span class="p">[</span>
-            <span class="n">Entity</span><span class="p">(</span><span class="n">cell</span><span class="p">,</span> <span class="n">elements</span><span class="o">=</span><span class="p">[],</span> <span class="o">**</span><span class="bp">self</span><span class="o">.</span><span class="n">get_cell_data</span><span class="p">(</span><span class="n">cell</span><span class="p">,</span> <span class="mi">0</span><span class="p">))</span>
-            <span class="k">for</span> <span class="n">cell</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">nodes</span>
-        <span class="p">]</span>
-        <span class="n">HG</span><span class="o">.</span><span class="n">_add_nodes_from</span><span class="p">(</span><span class="n">nodes</span><span class="p">)</span>
+
+        <span class="n">edges</span> <span class="o">=</span> <span class="p">{}</span>
+        <span class="n">edge_properties</span> <span class="o">=</span> <span class="p">{}</span>
+
+        <span class="k">for</span> <span class="n">edge</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">edges</span><span class="p">:</span>
+            <span class="n">edges</span><span class="p">[</span><span class="nb">str</span><span class="p">(</span><span class="nb">list</span><span class="p">(</span><span class="n">edge</span><span class="p">))]</span> <span class="o">=</span> <span class="n">edge</span>
+            <span class="n">edge_properties</span><span class="p">[</span><span class="nb">str</span><span class="p">(</span><span class="nb">list</span><span class="p">(</span><span class="n">edge</span><span class="p">))]</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_cell_data</span><span class="p">(</span><span class="n">edge</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span>
+        <span class="k">for</span> <span class="n">cell</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">cells</span><span class="p">:</span>
+            <span class="n">edges</span><span class="p">[</span><span class="nb">str</span><span class="p">(</span><span class="nb">list</span><span class="p">(</span><span class="n">cell</span><span class="p">))]</span> <span class="o">=</span> <span class="n">cell</span><span class="o">.</span><span class="n">elements</span>
+            <span class="n">edge_properties</span><span class="p">[</span><span class="nb">str</span><span class="p">(</span><span class="nb">list</span><span class="p">(</span><span class="n">cell</span><span class="p">))]</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_cell_data</span><span class="p">(</span><span class="n">cell</span><span class="p">,</span> <span class="mi">2</span><span class="p">)</span>
+
+        <span class="n">HG</span> <span class="o">=</span> <span class="n">Hypergraph</span><span class="p">(</span><span class="n">edges</span><span class="p">,</span> <span class="n">edge_properties</span><span class="o">=</span><span class="n">edge_properties</span><span class="p">)</span>
+        <span class="n">HG</span><span class="o">.</span><span class="n">add_nodes_from</span><span class="p">([(</span><span class="n">node</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_cell_data</span><span class="p">(</span><span class="n">node</span><span class="p">,</span> <span class="mi">0</span><span class="p">))</span> <span class="k">for</span> <span class="n">node</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">nodes</span><span class="p">])</span>
+
         <span class="k">return</span> <span class="n">HG</span></div>
 
 

toponetx/.doctrees/api/generated/toponetx.SimplicialComplex.doctree

@@ -2225,14 +2225,19 @@ <h1>Source code for toponetx.classes.simplicial_complex</h1><div class="highligh
 
 <div class="viewcode-block" id="SimplicialComplex.to_hypergraph">
 <a class="viewcode-back" href="../../../api/generated/toponetx.SimplicialComplex.html#toponetx.SimplicialComplex.to_hypergraph">[docs]</a>
-    <span class="k">def</span><span class="w"> </span><span class="nf">to_hypergraph</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Hypergraph</span><span class="p">:</span>
-<span class="w">        </span><span class="sd">&quot;&quot;&quot;Convert a simplicial complex to a hypergraph.</span>
+    <span class="k">def</span><span class="w"> </span><span class="nf">to_hypergraph</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;Convert a simplicial complex to a `hypernetx` hypergraph.</span>
 
 <span class="sd">        Returns</span>
 <span class="sd">        -------</span>
 <span class="sd">        Hypergraph</span>
 <span class="sd">            The hypergraph corresponding to this simplicial complex.</span>
 
+<span class="sd">        Raises</span>
+<span class="sd">        ------</span>
+<span class="sd">        RuntimeError</span>
+<span class="sd">            If `hypernetx` is not installed</span>
+
 <span class="sd">        Examples</span>
 <span class="sd">        --------</span>
 <span class="sd">        &gt;&gt;&gt; c1 = tnx.Simplex((1, 2, 3))</span>
@@ -2242,12 +2247,22 @@ <h1>Source code for toponetx.classes.simplicial_complex</h1><div class="highligh
 <span class="sd">        &gt;&gt;&gt; SC.to_hypergraph()</span>
 <span class="sd">        Hypergraph({&#39;e0&#39;: [1, 2], &#39;e1&#39;: [1, 3], &#39;e2&#39;: [1, 4], &#39;e3&#39;: [2, 3], &#39;e4&#39;: [2, 4], &#39;e5&#39;: [2, 5], &#39;e6&#39;: [1, 2, 3], &#39;e7&#39;: [1, 2, 4]},name=)</span>
 <span class="sd">        &quot;&quot;&quot;</span>
-        <span class="n">hyperedges</span> <span class="o">=</span> <span class="p">[</span>
-            <span class="nb">list</span><span class="p">(</span><span class="n">cell</span><span class="p">)</span>
-            <span class="k">for</span> <span class="n">rank</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">dim</span> <span class="o">+</span> <span class="mi">1</span><span class="p">)</span>
-            <span class="k">for</span> <span class="n">cell</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">skeleton</span><span class="p">(</span><span class="n">rank</span><span class="p">)</span>
-        <span class="p">]</span>
-        <span class="k">return</span> <span class="n">Hypergraph</span><span class="p">(</span><span class="n">hyperedges</span><span class="p">,</span> <span class="n">static</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span></div>
+        <span class="k">if</span> <span class="n">Hypergraph</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
+            <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">(</span>
+                <span class="s2">&quot;Cannot transform simplicial complex to hypergraph, `hypernetx` is not installed.&quot;</span>
+            <span class="p">)</span>
+
+        <span class="n">edges</span> <span class="o">=</span> <span class="p">{}</span>
+        <span class="n">edge_properties</span> <span class="o">=</span> <span class="p">{}</span>
+
+        <span class="k">for</span> <span class="n">simplex</span> <span class="ow">in</span> <span class="nb">filter</span><span class="p">(</span><span class="k">lambda</span> <span class="n">s</span><span class="p">:</span> <span class="nb">len</span><span class="p">(</span><span class="n">s</span><span class="p">)</span> <span class="o">&gt;</span> <span class="mi">1</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">simplices</span><span class="p">):</span>
+            <span class="n">edges</span><span class="p">[</span><span class="nb">str</span><span class="p">(</span><span class="nb">list</span><span class="p">(</span><span class="n">simplex</span><span class="p">))]</span> <span class="o">=</span> <span class="n">simplex</span>
+            <span class="n">edge_properties</span><span class="p">[</span><span class="nb">str</span><span class="p">(</span><span class="nb">list</span><span class="p">(</span><span class="n">simplex</span><span class="p">))]</span> <span class="o">=</span> <span class="bp">self</span><span class="p">[</span><span class="n">simplex</span><span class="p">]</span>
+
+        <span class="n">HG</span> <span class="o">=</span> <span class="n">Hypergraph</span><span class="p">(</span><span class="n">edges</span><span class="p">,</span> <span class="n">edge_properties</span><span class="o">=</span><span class="n">edge_properties</span><span class="p">)</span>
+        <span class="n">HG</span><span class="o">.</span><span class="n">add_nodes_from</span><span class="p">([(</span><span class="nb">next</span><span class="p">(</span><span class="nb">iter</span><span class="p">(</span><span class="n">node</span><span class="p">)),</span> <span class="bp">self</span><span class="p">[</span><span class="n">node</span><span class="p">])</span> <span class="k">for</span> <span class="n">node</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">nodes</span><span class="p">])</span>
+
+        <span class="k">return</span> <span class="n">HG</span></div>
 
 
 <div class="viewcode-block" id="SimplicialComplex.to_combinatorial_complex">

toponetx/.doctrees/environment.pickle

@@ -628,7 +628,7 @@ <h1>toponetx.CellComplex<a class="headerlink" href="#toponetx-cellcomplex" title
 <td><p>Create Hasse graph of self.</p></td>
 </tr>
 <tr class="row-odd"><td><p><a class="reference internal" href="#toponetx.CellComplex.to_hypergraph" title="toponetx.CellComplex.to_hypergraph"><code class="xref py py-obj docutils literal notranslate"><span class="pre">to_hypergraph</span></code></a>()</p></td>
-<td><p>Convert this cell complex to a hypergraph.</p></td>
+<td><p>Convert this cell complex to a <cite>hypernetx</cite> hypergraph.</p></td>
 </tr>
 <tr class="row-even"><td><p><a class="reference internal" href="#toponetx.CellComplex.up_laplacian_matrix" title="toponetx.CellComplex.up_laplacian_matrix"><code class="xref py py-obj docutils literal notranslate"><span class="pre">up_laplacian_matrix</span></code></a>(rank[, signed, weight, ...])</p></td>
 <td><p>Compute up laplacian.</p></td>
@@ -858,7 +858,7 @@ <h1>toponetx.CellComplex<a class="headerlink" href="#toponetx-cellcomplex" title
 <td><p>Create Hasse graph of self.</p></td>
 </tr>
 <tr class="row-even"><td><p><a class="reference internal" href="#toponetx.CellComplex.to_hypergraph" title="toponetx.CellComplex.to_hypergraph"><code class="xref py py-obj docutils literal notranslate"><span class="pre">to_hypergraph</span></code></a>()</p></td>
-<td><p>Convert this cell complex to a hypergraph.</p></td>
+<td><p>Convert this cell complex to a <cite>hypernetx</cite> hypergraph.</p></td>
 </tr>
 <tr class="row-odd"><td><p><a class="reference internal" href="#toponetx.CellComplex.up_laplacian_matrix" title="toponetx.CellComplex.up_laplacian_matrix"><code class="xref py py-obj docutils literal notranslate"><span class="pre">up_laplacian_matrix</span></code></a>(rank[, signed, weight, ...])</p></td>
 <td><p>Compute up laplacian.</p></td>
@@ -2480,11 +2480,17 @@ <h1>toponetx.CellComplex<a class="headerlink" href="#toponetx-cellcomplex" title
 <dl class="py method">
 <dt class="sig sig-object py" id="toponetx.CellComplex.to_hypergraph">
 <span class="sig-name descname"><span class="pre">to_hypergraph</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/toponetx/classes/cell_complex.html#CellComplex.to_hypergraph"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#toponetx.CellComplex.to_hypergraph" title="Link to this definition">#</a></dt>
-<dd><p>Convert this cell complex to a hypergraph.</p>
+<dd><p>Convert this cell complex to a <cite>hypernetx</cite> hypergraph.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Returns<span class="colon">:</span></dt>
 <dd class="field-odd"><dl class="simple">
-<dt>Hypergraph</dt><dd><p>The hyergraph corresponding to this cell complex.</p>
+<dt>Hypergraph</dt><dd><p>The hypergraph corresponding to this cell complex.</p>
+</dd>
+</dl>
+</dd>
+<dt class="field-even">Raises<span class="colon">:</span></dt>
+<dd class="field-even"><dl class="simple">
+<dt>RuntimeError</dt><dd><p>If <cite>hypernetx</cite> is not installed.</p>
 </dd>
 </dl>
 </dd>