diff options
Diffstat (limited to '_modules/networkx/generators/community.html')
| -rw-r--r-- | _modules/networkx/generators/community.html | 32 |
1 files changed, 16 insertions, 16 deletions
diff --git a/_modules/networkx/generators/community.html b/_modules/networkx/generators/community.html index 275fe412..f85e1e9c 100644 --- a/_modules/networkx/generators/community.html +++ b/_modules/networkx/generators/community.html @@ -483,7 +483,7 @@ <div class="viewcode-block" id="caveman_graph"><a class="viewcode-back" href="../../../reference/generated/networkx.generators.community.caveman_graph.html#networkx.generators.community.caveman_graph">[docs]</a><span class="k">def</span> <span class="nf">caveman_graph</span><span class="p">(</span><span class="n">l</span><span class="p">,</span> <span class="n">k</span><span class="p">):</span> - <span class="sd">"""Returns a caveman graph of `l` cliques of size `k`.</span> +<span class="w"> </span><span class="sd">"""Returns a caveman graph of `l` cliques of size `k`.</span> <span class="sd"> Parameters</span> <span class="sd"> ----------</span> @@ -529,7 +529,7 @@ <div class="viewcode-block" id="connected_caveman_graph"><a class="viewcode-back" href="../../../reference/generated/networkx.generators.community.connected_caveman_graph.html#networkx.generators.community.connected_caveman_graph">[docs]</a><span class="k">def</span> <span class="nf">connected_caveman_graph</span><span class="p">(</span><span class="n">l</span><span class="p">,</span> <span class="n">k</span><span class="p">):</span> - <span class="sd">"""Returns a connected caveman graph of `l` cliques of size `k`.</span> +<span class="w"> </span><span class="sd">"""Returns a connected caveman graph of `l` cliques of size `k`.</span> <span class="sd"> The connected caveman graph is formed by creating `n` cliques of size</span> <span class="sd"> `k`, then a single edge in each clique is rewired to a node in an</span> @@ -583,7 +583,7 @@ <div class="viewcode-block" id="relaxed_caveman_graph"><a class="viewcode-back" href="../../../reference/generated/networkx.generators.community.relaxed_caveman_graph.html#networkx.generators.community.relaxed_caveman_graph">[docs]</a><span class="nd">@py_random_state</span><span class="p">(</span><span class="mi">3</span><span class="p">)</span> <span class="k">def</span> <span class="nf">relaxed_caveman_graph</span><span class="p">(</span><span class="n">l</span><span class="p">,</span> <span class="n">k</span><span class="p">,</span> <span class="n">p</span><span class="p">,</span> <span class="n">seed</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span> - <span class="sd">"""Returns a relaxed caveman graph.</span> +<span class="w"> </span><span class="sd">"""Returns a relaxed caveman graph.</span> <span class="sd"> A relaxed caveman graph starts with `l` cliques of size `k`. Edges are</span> <span class="sd"> then randomly rewired with probability `p` to link different cliques.</span> @@ -634,7 +634,7 @@ <div class="viewcode-block" id="random_partition_graph"><a class="viewcode-back" href="../../../reference/generated/networkx.generators.community.random_partition_graph.html#networkx.generators.community.random_partition_graph">[docs]</a><span class="nd">@py_random_state</span><span class="p">(</span><span class="mi">3</span><span class="p">)</span> <span class="k">def</span> <span class="nf">random_partition_graph</span><span class="p">(</span><span class="n">sizes</span><span class="p">,</span> <span class="n">p_in</span><span class="p">,</span> <span class="n">p_out</span><span class="p">,</span> <span class="n">seed</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">directed</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span> - <span class="sd">"""Returns the random partition graph with a partition of sizes.</span> +<span class="w"> </span><span class="sd">"""Returns the random partition graph with a partition of sizes.</span> <span class="sd"> A partition graph is a graph of communities with sizes defined by</span> <span class="sd"> s in sizes. Nodes in the same group are connected with probability</span> @@ -712,7 +712,7 @@ <div class="viewcode-block" id="planted_partition_graph"><a class="viewcode-back" href="../../../reference/generated/networkx.generators.community.planted_partition_graph.html#networkx.generators.community.planted_partition_graph">[docs]</a><span class="nd">@py_random_state</span><span class="p">(</span><span class="mi">4</span><span class="p">)</span> <span class="k">def</span> <span class="nf">planted_partition_graph</span><span class="p">(</span><span class="n">l</span><span class="p">,</span> <span class="n">k</span><span class="p">,</span> <span class="n">p_in</span><span class="p">,</span> <span class="n">p_out</span><span class="p">,</span> <span class="n">seed</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">directed</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span> - <span class="sd">"""Returns the planted l-partition graph.</span> +<span class="w"> </span><span class="sd">"""Returns the planted l-partition graph.</span> <span class="sd"> This model partitions a graph with n=l*k vertices in</span> <span class="sd"> l groups with k vertices each. Vertices of the same</span> @@ -767,7 +767,7 @@ <div class="viewcode-block" id="gaussian_random_partition_graph"><a class="viewcode-back" href="../../../reference/generated/networkx.generators.community.gaussian_random_partition_graph.html#networkx.generators.community.gaussian_random_partition_graph">[docs]</a><span class="nd">@py_random_state</span><span class="p">(</span><span class="mi">6</span><span class="p">)</span> <span class="k">def</span> <span class="nf">gaussian_random_partition_graph</span><span class="p">(</span><span class="n">n</span><span class="p">,</span> <span class="n">s</span><span class="p">,</span> <span class="n">v</span><span class="p">,</span> <span class="n">p_in</span><span class="p">,</span> <span class="n">p_out</span><span class="p">,</span> <span class="n">directed</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">seed</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span> - <span class="sd">"""Generate a Gaussian random partition graph.</span> +<span class="w"> </span><span class="sd">"""Generate a Gaussian random partition graph.</span> <span class="sd"> A Gaussian random partition graph is created by creating k partitions</span> <span class="sd"> each with a size drawn from a normal distribution with mean s and variance</span> @@ -842,7 +842,7 @@ <div class="viewcode-block" id="ring_of_cliques"><a class="viewcode-back" href="../../../reference/generated/networkx.generators.community.ring_of_cliques.html#networkx.generators.community.ring_of_cliques">[docs]</a><span class="k">def</span> <span class="nf">ring_of_cliques</span><span class="p">(</span><span class="n">num_cliques</span><span class="p">,</span> <span class="n">clique_size</span><span class="p">):</span> - <span class="sd">"""Defines a "ring of cliques" graph.</span> +<span class="w"> </span><span class="sd">"""Defines a "ring of cliques" graph.</span> <span class="sd"> A ring of cliques graph is consisting of cliques, connected through single</span> <span class="sd"> links. Each clique is a complete graph.</span> @@ -897,7 +897,7 @@ <div class="viewcode-block" id="windmill_graph"><a class="viewcode-back" href="../../../reference/generated/networkx.generators.community.windmill_graph.html#networkx.generators.community.windmill_graph">[docs]</a><span class="k">def</span> <span class="nf">windmill_graph</span><span class="p">(</span><span class="n">n</span><span class="p">,</span> <span class="n">k</span><span class="p">):</span> - <span class="sd">"""Generate a windmill graph.</span> +<span class="w"> </span><span class="sd">"""Generate a windmill graph.</span> <span class="sd"> A windmill graph is a graph of `n` cliques each of size `k` that are all</span> <span class="sd"> joined at one node.</span> <span class="sd"> It can be thought of as taking a disjoint union of `n` cliques of size `k`,</span> @@ -952,7 +952,7 @@ <span class="k">def</span> <span class="nf">stochastic_block_model</span><span class="p">(</span> <span class="n">sizes</span><span class="p">,</span> <span class="n">p</span><span class="p">,</span> <span class="n">nodelist</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">seed</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">directed</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">selfloops</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">sparse</span><span class="o">=</span><span class="kc">True</span> <span class="p">):</span> - <span class="sd">"""Returns a stochastic block model graph.</span> +<span class="w"> </span><span class="sd">"""Returns a stochastic block model graph.</span> <span class="sd"> This model partitions the nodes in blocks of arbitrary sizes, and places</span> <span class="sd"> edges between pairs of nodes independently, with a probability that depends</span> @@ -1118,7 +1118,7 @@ <span class="k">def</span> <span class="nf">_zipf_rv_below</span><span class="p">(</span><span class="n">gamma</span><span class="p">,</span> <span class="n">xmin</span><span class="p">,</span> <span class="n">threshold</span><span class="p">,</span> <span class="n">seed</span><span class="p">):</span> - <span class="sd">"""Returns a random value chosen from the bounded Zipf distribution.</span> +<span class="w"> </span><span class="sd">"""Returns a random value chosen from the bounded Zipf distribution.</span> <span class="sd"> Repeatedly draws values from the Zipf distribution until the</span> <span class="sd"> threshold is met, then returns that value.</span> @@ -1130,7 +1130,7 @@ <span class="k">def</span> <span class="nf">_powerlaw_sequence</span><span class="p">(</span><span class="n">gamma</span><span class="p">,</span> <span class="n">low</span><span class="p">,</span> <span class="n">high</span><span class="p">,</span> <span class="n">condition</span><span class="p">,</span> <span class="n">length</span><span class="p">,</span> <span class="n">max_iters</span><span class="p">,</span> <span class="n">seed</span><span class="p">):</span> - <span class="sd">"""Returns a list of numbers obeying a constrained power law distribution.</span> +<span class="w"> </span><span class="sd">"""Returns a list of numbers obeying a constrained power law distribution.</span> <span class="sd"> ``gamma`` and ``low`` are the parameters for the Zipf distribution.</span> @@ -1161,7 +1161,7 @@ <span class="k">def</span> <span class="nf">_hurwitz_zeta</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">q</span><span class="p">,</span> <span class="n">tolerance</span><span class="p">):</span> - <span class="sd">"""The Hurwitz zeta function, or the Riemann zeta function of two arguments.</span> +<span class="w"> </span><span class="sd">"""The Hurwitz zeta function, or the Riemann zeta function of two arguments.</span> <span class="sd"> ``x`` must be greater than one and ``q`` must be positive.</span> @@ -1179,7 +1179,7 @@ <span class="k">def</span> <span class="nf">_generate_min_degree</span><span class="p">(</span><span class="n">gamma</span><span class="p">,</span> <span class="n">average_degree</span><span class="p">,</span> <span class="n">max_degree</span><span class="p">,</span> <span class="n">tolerance</span><span class="p">,</span> <span class="n">max_iters</span><span class="p">):</span> - <span class="sd">"""Returns a minimum degree from the given average degree."""</span> +<span class="w"> </span><span class="sd">"""Returns a minimum degree from the given average degree."""</span> <span class="c1"># Defines zeta function whether or not Scipy is available</span> <span class="k">try</span><span class="p">:</span> <span class="kn">from</span> <span class="nn">scipy.special</span> <span class="kn">import</span> <span class="n">zeta</span> @@ -1211,7 +1211,7 @@ <span class="k">def</span> <span class="nf">_generate_communities</span><span class="p">(</span><span class="n">degree_seq</span><span class="p">,</span> <span class="n">community_sizes</span><span class="p">,</span> <span class="n">mu</span><span class="p">,</span> <span class="n">max_iters</span><span class="p">,</span> <span class="n">seed</span><span class="p">):</span> - <span class="sd">"""Returns a list of sets, each of which represents a community.</span> +<span class="w"> </span><span class="sd">"""Returns a list of sets, each of which represents a community.</span> <span class="sd"> ``degree_seq`` is the degree sequence that must be met by the</span> <span class="sd"> graph.</span> @@ -1276,7 +1276,7 @@ <span class="n">max_iters</span><span class="o">=</span><span class="mi">500</span><span class="p">,</span> <span class="n">seed</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="p">):</span> - <span class="sa">r</span><span class="sd">"""Returns the LFR benchmark graph.</span> +<span class="w"> </span><span class="sa">r</span><span class="sd">"""Returns the LFR benchmark graph.</span> <span class="sd"> This algorithm proceeds as follows:</span> @@ -1573,7 +1573,7 @@ <p class="copyright"> - © Copyright 2004-2022, NetworkX Developers.<br> + © Copyright 2004-2023, NetworkX Developers.<br> </p> |