diff options
| author | MridulS <mail@mriduls.com> | 2022-12-20 11:41:34 +0000 |
|---|---|---|
| committer | MridulS <mail@mriduls.com> | 2022-12-20 11:41:34 +0000 |
| commit | 0f58b11d05d40689b53b018224e0b6a545b8bfec (patch) | |
| tree | 68bc8f92a3a5451588f7896d6f848bca0ee4b71f /_modules/networkx/algorithms/smallworld.html | |
| parent | 2a8e7829bc111282c4e0a5ca091d8a27b6f81bed (diff) | |
| download | networkx-0f58b11d05d40689b53b018224e0b6a545b8bfec.tar.gz | |
Deploying to gh-pages from @ networkx/networkx@9d5e11f27033049282e2d244132b0e946df6557d 🚀
Diffstat (limited to '_modules/networkx/algorithms/smallworld.html')
| -rw-r--r-- | _modules/networkx/algorithms/smallworld.html | 20 |
1 files changed, 17 insertions, 3 deletions
diff --git a/_modules/networkx/algorithms/smallworld.html b/_modules/networkx/algorithms/smallworld.html index 34ab4845..a7215f9d 100644 --- a/_modules/networkx/algorithms/smallworld.html +++ b/_modules/networkx/algorithms/smallworld.html @@ -509,6 +509,11 @@ <span class="sd"> G : graph</span> <span class="sd"> The randomized graph.</span> +<span class="sd"> Raises</span> +<span class="sd"> ------</span> +<span class="sd"> NetworkXError</span> +<span class="sd"> If there are fewer than 4 nodes or 2 edges in `G`</span> + <span class="sd"> Notes</span> <span class="sd"> -----</span> <span class="sd"> The implementation is adapted from the algorithm by Maslov and Sneppen</span> @@ -521,7 +526,9 @@ <span class="sd"> Science 296.5569 (2002): 910-913.</span> <span class="sd"> """</span> <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">G</span><span class="p">)</span> <span class="o"><</span> <span class="mi">4</span><span class="p">:</span> - <span class="k">raise</span> <span class="n">nx</span><span class="o">.</span><span class="n">NetworkXError</span><span class="p">(</span><span class="s2">"Graph has less than four nodes."</span><span class="p">)</span> + <span class="k">raise</span> <span class="n">nx</span><span class="o">.</span><span class="n">NetworkXError</span><span class="p">(</span><span class="s2">"Graph has fewer than four nodes."</span><span class="p">)</span> + <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">G</span><span class="o">.</span><span class="n">edges</span><span class="p">)</span> <span class="o"><</span> <span class="mi">2</span><span class="p">:</span> + <span class="k">raise</span> <span class="n">nx</span><span class="o">.</span><span class="n">NetworkXError</span><span class="p">(</span><span class="s2">"Graph has fewer that 2 edges"</span><span class="p">)</span> <span class="kn">from</span> <span class="nn">networkx.utils</span> <span class="kn">import</span> <span class="n">cumulative_distribution</span><span class="p">,</span> <span class="n">discrete_sequence</span> @@ -582,7 +589,7 @@ <span class="sd"> Parameters</span> <span class="sd"> ----------</span> <span class="sd"> G : graph</span> -<span class="sd"> An undirected graph with 4 or more nodes.</span> +<span class="sd"> An undirected graph.</span> <span class="sd"> niter : integer (optional, default=1)</span> <span class="sd"> An edge is rewired approximatively niter times.</span> @@ -602,6 +609,11 @@ <span class="sd"> G : graph</span> <span class="sd"> The latticized graph.</span> +<span class="sd"> Raises</span> +<span class="sd"> ------</span> +<span class="sd"> NetworkXError</span> +<span class="sd"> If there are fewer than 4 nodes or 2 edges in `G`</span> + <span class="sd"> Notes</span> <span class="sd"> -----</span> <span class="sd"> The implementation is adapted from the algorithm by Sporns et al. [1]_.</span> @@ -623,7 +635,9 @@ <span class="n">local_conn</span> <span class="o">=</span> <span class="n">nx</span><span class="o">.</span><span class="n">connectivity</span><span class="o">.</span><span class="n">local_edge_connectivity</span> <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">G</span><span class="p">)</span> <span class="o"><</span> <span class="mi">4</span><span class="p">:</span> - <span class="k">raise</span> <span class="n">nx</span><span class="o">.</span><span class="n">NetworkXError</span><span class="p">(</span><span class="s2">"Graph has less than four nodes."</span><span class="p">)</span> + <span class="k">raise</span> <span class="n">nx</span><span class="o">.</span><span class="n">NetworkXError</span><span class="p">(</span><span class="s2">"Graph has fewer than four nodes."</span><span class="p">)</span> + <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">G</span><span class="o">.</span><span class="n">edges</span><span class="p">)</span> <span class="o"><</span> <span class="mi">2</span><span class="p">:</span> + <span class="k">raise</span> <span class="n">nx</span><span class="o">.</span><span class="n">NetworkXError</span><span class="p">(</span><span class="s2">"Graph has fewer that 2 edges"</span><span class="p">)</span> <span class="c1"># Instead of choosing uniformly at random from a generated edge list,</span> <span class="c1"># this algorithm chooses nonuniformly from the set of nodes with</span> <span class="c1"># probability weighted by degree.</span> |