diff options
Diffstat (limited to '_modules/networkx/drawing/layout.html')
| -rw-r--r-- | _modules/networkx/drawing/layout.html | 28 |
1 files changed, 14 insertions, 14 deletions
diff --git a/_modules/networkx/drawing/layout.html b/_modules/networkx/drawing/layout.html index 5e2a18b8..0afdd047 100644 --- a/_modules/networkx/drawing/layout.html +++ b/_modules/networkx/drawing/layout.html @@ -522,7 +522,7 @@ <div class="viewcode-block" id="random_layout"><a class="viewcode-back" href="../../../reference/generated/networkx.drawing.layout.random_layout.html#networkx.drawing.layout.random_layout">[docs]</a><span class="nd">@np_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_layout</span><span class="p">(</span><span class="n">G</span><span class="p">,</span> <span class="n">center</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">dim</span><span class="o">=</span><span class="mi">2</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">"""Position nodes uniformly at random in the unit square.</span> +<span class="w"> </span><span class="sd">"""Position nodes uniformly at random in the unit square.</span> <span class="sd"> For every node, a position is generated by choosing each of dim</span> <span class="sd"> coordinates uniformly at random on the interval [0.0, 1.0).</span> @@ -571,7 +571,7 @@ <div class="viewcode-block" id="circular_layout"><a class="viewcode-back" href="../../../reference/generated/networkx.drawing.layout.circular_layout.html#networkx.drawing.layout.circular_layout">[docs]</a><span class="k">def</span> <span class="nf">circular_layout</span><span class="p">(</span><span class="n">G</span><span class="p">,</span> <span class="n">scale</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span> <span class="n">center</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">dim</span><span class="o">=</span><span class="mi">2</span><span class="p">):</span> <span class="c1"># dim=2 only</span> - <span class="sd">"""Position nodes on a circle.</span> +<span class="w"> </span><span class="sd">"""Position nodes on a circle.</span> <span class="sd"> Parameters</span> <span class="sd"> ----------</span> @@ -638,7 +638,7 @@ <div class="viewcode-block" id="shell_layout"><a class="viewcode-back" href="../../../reference/generated/networkx.drawing.layout.shell_layout.html#networkx.drawing.layout.shell_layout">[docs]</a><span class="k">def</span> <span class="nf">shell_layout</span><span class="p">(</span><span class="n">G</span><span class="p">,</span> <span class="n">nlist</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">rotate</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">scale</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span> <span class="n">center</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">dim</span><span class="o">=</span><span class="mi">2</span><span class="p">):</span> - <span class="sd">"""Position nodes in concentric circles.</span> +<span class="w"> </span><span class="sd">"""Position nodes in concentric circles.</span> <span class="sd"> Parameters</span> <span class="sd"> ----------</span> @@ -731,7 +731,7 @@ <div class="viewcode-block" id="bipartite_layout"><a class="viewcode-back" href="../../../reference/generated/networkx.drawing.layout.bipartite_layout.html#networkx.drawing.layout.bipartite_layout">[docs]</a><span class="k">def</span> <span class="nf">bipartite_layout</span><span class="p">(</span> <span class="n">G</span><span class="p">,</span> <span class="n">nodes</span><span class="p">,</span> <span class="n">align</span><span class="o">=</span><span class="s2">"vertical"</span><span class="p">,</span> <span class="n">scale</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span> <span class="n">center</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">aspect_ratio</span><span class="o">=</span><span class="mi">4</span> <span class="o">/</span> <span class="mi">3</span> <span class="p">):</span> - <span class="sd">"""Position nodes in two straight lines.</span> +<span class="w"> </span><span class="sd">"""Position nodes in two straight lines.</span> <span class="sd"> Parameters</span> <span class="sd"> ----------</span> @@ -820,7 +820,7 @@ <span class="n">dim</span><span class="o">=</span><span class="mi">2</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="sd">"""Position nodes using Fruchterman-Reingold force-directed algorithm.</span> +<span class="w"> </span><span class="sd">"""Position nodes using Fruchterman-Reingold force-directed algorithm.</span> <span class="sd"> The algorithm simulates a force-directed representation of the network</span> <span class="sd"> treating edges as springs holding nodes close, while treating nodes</span> @@ -1102,7 +1102,7 @@ <div class="viewcode-block" id="kamada_kawai_layout"><a class="viewcode-back" href="../../../reference/generated/networkx.drawing.layout.kamada_kawai_layout.html#networkx.drawing.layout.kamada_kawai_layout">[docs]</a><span class="k">def</span> <span class="nf">kamada_kawai_layout</span><span class="p">(</span> <span class="n">G</span><span class="p">,</span> <span class="n">dist</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">pos</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">weight</span><span class="o">=</span><span class="s2">"weight"</span><span class="p">,</span> <span class="n">scale</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span> <span class="n">center</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">dim</span><span class="o">=</span><span class="mi">2</span> <span class="p">):</span> - <span class="sd">"""Position nodes using Kamada-Kawai path-length cost-function.</span> +<span class="w"> </span><span class="sd">"""Position nodes using Kamada-Kawai path-length cost-function.</span> <span class="sd"> Parameters</span> <span class="sd"> ----------</span> @@ -1225,7 +1225,7 @@ <div class="viewcode-block" id="spectral_layout"><a class="viewcode-back" href="../../../reference/generated/networkx.drawing.layout.spectral_layout.html#networkx.drawing.layout.spectral_layout">[docs]</a><span class="k">def</span> <span class="nf">spectral_layout</span><span class="p">(</span><span class="n">G</span><span class="p">,</span> <span class="n">weight</span><span class="o">=</span><span class="s2">"weight"</span><span class="p">,</span> <span class="n">scale</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span> <span class="n">center</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">dim</span><span class="o">=</span><span class="mi">2</span><span class="p">):</span> - <span class="sd">"""Position nodes using the eigenvectors of the graph Laplacian.</span> +<span class="w"> </span><span class="sd">"""Position nodes using the eigenvectors of the graph Laplacian.</span> <span class="sd"> Using the unnormalized Laplacian, the layout shows possible clusters of</span> <span class="sd"> nodes which are an approximation of the ratio cut. If dim is the number of</span> @@ -1354,7 +1354,7 @@ <div class="viewcode-block" id="planar_layout"><a class="viewcode-back" href="../../../reference/generated/networkx.drawing.layout.planar_layout.html#networkx.drawing.layout.planar_layout">[docs]</a><span class="k">def</span> <span class="nf">planar_layout</span><span class="p">(</span><span class="n">G</span><span class="p">,</span> <span class="n">scale</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span> <span class="n">center</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">dim</span><span class="o">=</span><span class="mi">2</span><span class="p">):</span> - <span class="sd">"""Position nodes without edge intersections.</span> +<span class="w"> </span><span class="sd">"""Position nodes without edge intersections.</span> <span class="sd"> Parameters</span> <span class="sd"> ----------</span> @@ -1411,7 +1411,7 @@ <div class="viewcode-block" id="spiral_layout"><a class="viewcode-back" href="../../../reference/generated/networkx.drawing.layout.spiral_layout.html#networkx.drawing.layout.spiral_layout">[docs]</a><span class="k">def</span> <span class="nf">spiral_layout</span><span class="p">(</span><span class="n">G</span><span class="p">,</span> <span class="n">scale</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span> <span class="n">center</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">dim</span><span class="o">=</span><span class="mi">2</span><span class="p">,</span> <span class="n">resolution</span><span class="o">=</span><span class="mf">0.35</span><span class="p">,</span> <span class="n">equidistant</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span> - <span class="sd">"""Position nodes in a spiral layout.</span> +<span class="w"> </span><span class="sd">"""Position nodes in a spiral layout.</span> <span class="sd"> Parameters</span> <span class="sd"> ----------</span> @@ -1490,7 +1490,7 @@ <div class="viewcode-block" id="multipartite_layout"><a class="viewcode-back" href="../../../reference/generated/networkx.drawing.layout.multipartite_layout.html#networkx.drawing.layout.multipartite_layout">[docs]</a><span class="k">def</span> <span class="nf">multipartite_layout</span><span class="p">(</span><span class="n">G</span><span class="p">,</span> <span class="n">subset_key</span><span class="o">=</span><span class="s2">"subset"</span><span class="p">,</span> <span class="n">align</span><span class="o">=</span><span class="s2">"vertical"</span><span class="p">,</span> <span class="n">scale</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span> <span class="n">center</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span> - <span class="sd">"""Position nodes in layers of straight lines.</span> +<span class="w"> </span><span class="sd">"""Position nodes in layers of straight lines.</span> <span class="sd"> Parameters</span> <span class="sd"> ----------</span> @@ -1583,7 +1583,7 @@ <span class="n">dt</span><span class="o">=</span><span class="mf">1e-3</span><span class="p">,</span> <span class="n">max_iter</span><span class="o">=</span><span class="mi">1000</span><span class="p">,</span> <span class="p">):</span> - <span class="sd">"""Arf layout for networkx</span> +<span class="w"> </span><span class="sd">"""Arf layout for networkx</span> <span class="sd"> The attractive and repulsive forces (arf) layout [1]</span> <span class="sd"> improves the spring layout in three ways. First, it</span> @@ -1687,7 +1687,7 @@ <div class="viewcode-block" id="rescale_layout"><a class="viewcode-back" href="../../../reference/generated/networkx.drawing.layout.rescale_layout.html#networkx.drawing.layout.rescale_layout">[docs]</a><span class="k">def</span> <span class="nf">rescale_layout</span><span class="p">(</span><span class="n">pos</span><span class="p">,</span> <span class="n">scale</span><span class="o">=</span><span class="mi">1</span><span class="p">):</span> - <span class="sd">"""Returns scaled position array to (-scale, scale) in all axes.</span> +<span class="w"> </span><span class="sd">"""Returns scaled position array to (-scale, scale) in all axes.</span> <span class="sd"> The function acts on NumPy arrays which hold position information.</span> <span class="sd"> Each position is one row of the array. The dimension of the space</span> @@ -1728,7 +1728,7 @@ <div class="viewcode-block" id="rescale_layout_dict"><a class="viewcode-back" href="../../../reference/generated/networkx.drawing.layout.rescale_layout_dict.html#networkx.drawing.layout.rescale_layout_dict">[docs]</a><span class="k">def</span> <span class="nf">rescale_layout_dict</span><span class="p">(</span><span class="n">pos</span><span class="p">,</span> <span class="n">scale</span><span class="o">=</span><span class="mi">1</span><span class="p">):</span> - <span class="sd">"""Return a dictionary of scaled positions keyed by node</span> +<span class="w"> </span><span class="sd">"""Return a dictionary of scaled positions keyed by node</span> <span class="sd"> Parameters</span> <span class="sd"> ----------</span> @@ -1814,7 +1814,7 @@ <p class="copyright"> - © Copyright 2004-2022, NetworkX Developers.<br> + © Copyright 2004-2023, NetworkX Developers.<br> </p> |