Skip to content

Commit 04d83bf

Browse files
committed
revise description
1 parent d1ecc83 commit 04d83bf

370 files changed

Lines changed: 5805 additions & 8513 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

docs/.buildinfo

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Sphinx build info version 1
2-
# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
3-
config: 78d139c1318be20102defeb750f79899
2+
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
3+
config: 2f4b892ea5480f7636d290e778aefd7e
44
tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/_modules/easygraph/classes/base.html

Lines changed: 45 additions & 151 deletions
Large diffs are not rendered by default.

docs/_modules/easygraph/classes/directed_graph.html

Lines changed: 44 additions & 147 deletions
Large diffs are not rendered by default.

docs/_modules/easygraph/classes/directed_multigraph.html

Lines changed: 17 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11

2+
23
<!DOCTYPE html>
34

45

5-
<html lang="en" data-content_root="../../../" >
6+
<html lang="en" data-content_root="" >
67

78
<head>
89
<meta charset="utf-8" />
@@ -29,21 +30,19 @@
2930
<link href="../../../_static/styles/theme.css?digest=8878045cc6db502f8baf" rel="stylesheet" />
3031
<link href="../../../_static/styles/pydata-sphinx-theme.css?digest=8878045cc6db502f8baf" rel="stylesheet" />
3132

32-
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=8f2a1f02" />
33-
<link rel="stylesheet" type="text/css" href="../../../_static/my_theme.css?v=538c3502" />
33+
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css" />
34+
<link rel="stylesheet" type="text/css" href="../../../_static/my_theme.css" />
3435

3536
<!-- So that users can add custom icons -->
3637
<script src="../../../_static/scripts/fontawesome.js?digest=8878045cc6db502f8baf"></script>
3738
<!-- Pre-loaded scripts that we'll load fully later -->
3839
<link rel="preload" as="script" href="../../../_static/scripts/bootstrap.js?digest=8878045cc6db502f8baf" />
3940
<link rel="preload" as="script" href="../../../_static/scripts/pydata-sphinx-theme.js?digest=8878045cc6db502f8baf" />
4041

41-
<script src="../../../_static/jquery.js?v=5d32c60e"></script>
42-
<script src="../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
43-
<script src="../../../_static/documentation_options.js?v=350a9c04"></script>
44-
<script src="../../../_static/doctools.js?v=9bcbadda"></script>
45-
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
46-
<script src="../../../_static/copybutton.js?v=e333d19b"></script>
42+
<script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js"></script>
43+
<script src="../../../_static/doctools.js"></script>
44+
<script src="../../../_static/sphinx_highlight.js"></script>
45+
<script src="../../../_static/copybutton.js"></script>
4746
<script>DOCUMENTATION_OPTIONS.pagename = '_modules/easygraph/classes/directed_multigraph';</script>
4847
<link rel="index" title="Index" href="../../../genindex.html" />
4948
<link rel="search" title="Search" href="../../../search.html" />
@@ -491,9 +490,7 @@ <h1>Source code for easygraph.classes.directed_multigraph</h1><div class="highli
491490
<span class="n">__all__</span> <span class="o">=</span> <span class="p">[</span><span class="s2">&quot;MultiDiGraph&quot;</span><span class="p">]</span>
492491

493492

494-
<div class="viewcode-block" id="MultiDiGraph">
495-
<a class="viewcode-back" href="../../../reference/easygraph.classes.directed_multigraph.html#easygraph.classes.directed_multigraph.MultiDiGraph">[docs]</a>
496-
<span class="k">class</span><span class="w"> </span><span class="nc">MultiDiGraph</span><span class="p">(</span><span class="n">MultiGraph</span><span class="p">,</span> <span class="n">DiGraph</span><span class="p">):</span>
493+
<div class="viewcode-block" id="MultiDiGraph"><a class="viewcode-back" href="../../../reference/easygraph.classes.directed_multigraph.html#easygraph.classes.directed_multigraph.MultiDiGraph">[docs]</a><span class="k">class</span><span class="w"> </span><span class="nc">MultiDiGraph</span><span class="p">(</span><span class="n">MultiGraph</span><span class="p">,</span> <span class="n">DiGraph</span><span class="p">):</span>
497494
<span class="n">edge_key_dict_factory</span> <span class="o">=</span> <span class="nb">dict</span>
498495

499496
<span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">incoming_graph_data</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">multigraph_input</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="o">**</span><span class="n">attr</span><span class="p">):</span>
@@ -560,9 +557,7 @@ <h1>Source code for easygraph.classes.directed_multigraph</h1><div class="highli
560557
<span class="k">else</span><span class="p">:</span>
561558
<span class="n">DiGraph</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">incoming_graph_data</span><span class="p">,</span> <span class="o">**</span><span class="n">attr</span><span class="p">)</span>
562559

563-
<div class="viewcode-block" id="MultiDiGraph.add_edge">
564-
<a class="viewcode-back" href="../../../reference/easygraph.classes.directed_multigraph.html#easygraph.classes.directed_multigraph.MultiDiGraph.add_edge">[docs]</a>
565-
<span class="k">def</span><span class="w"> </span><span class="nf">add_edge</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">u_for_edge</span><span class="p">,</span> <span class="n">v_for_edge</span><span class="p">,</span> <span class="n">key</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="o">**</span><span class="n">attr</span><span class="p">):</span>
560+
<div class="viewcode-block" id="MultiDiGraph.add_edge"><a class="viewcode-back" href="../../../reference/easygraph.classes.directed_multigraph.html#easygraph.classes.directed_multigraph.MultiDiGraph.add_edge">[docs]</a> <span class="k">def</span><span class="w"> </span><span class="nf">add_edge</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">u_for_edge</span><span class="p">,</span> <span class="n">v_for_edge</span><span class="p">,</span> <span class="n">key</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="o">**</span><span class="n">attr</span><span class="p">):</span>
566561
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Add an edge between u and v.</span>
567562

568563
<span class="sd"> The nodes u and v will be automatically added if they are</span>
@@ -665,10 +660,7 @@ <h1>Source code for easygraph.classes.directed_multigraph</h1><div class="highli
665660
<span class="bp">self</span><span class="o">.</span><span class="n">_pred</span><span class="p">[</span><span class="n">v</span><span class="p">][</span><span class="n">u</span><span class="p">]</span> <span class="o">=</span> <span class="n">keydict</span>
666661
<span class="k">return</span> <span class="n">key</span></div>
667662

668-
669-
<div class="viewcode-block" id="MultiDiGraph.remove_edge">
670-
<a class="viewcode-back" href="../../../reference/easygraph.classes.directed_multigraph.html#easygraph.classes.directed_multigraph.MultiDiGraph.remove_edge">[docs]</a>
671-
<span class="k">def</span><span class="w"> </span><span class="nf">remove_edge</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">u</span><span class="p">,</span> <span class="n">v</span><span class="p">,</span> <span class="n">key</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
663+
<div class="viewcode-block" id="MultiDiGraph.remove_edge"><a class="viewcode-back" href="../../../reference/easygraph.classes.directed_multigraph.html#easygraph.classes.directed_multigraph.MultiDiGraph.remove_edge">[docs]</a> <span class="k">def</span><span class="w"> </span><span class="nf">remove_edge</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">u</span><span class="p">,</span> <span class="n">v</span><span class="p">,</span> <span class="n">key</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
672664
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Remove an edge between u and v.</span>
673665

674666
<span class="sd"> Parameters</span>
@@ -724,7 +716,6 @@ <h1>Source code for easygraph.classes.directed_multigraph</h1><div class="highli
724716
<span class="k">del</span> <span class="bp">self</span><span class="o">.</span><span class="n">_adj</span><span class="p">[</span><span class="n">u</span><span class="p">][</span><span class="n">v</span><span class="p">]</span>
725717
<span class="k">del</span> <span class="bp">self</span><span class="o">.</span><span class="n">_pred</span><span class="p">[</span><span class="n">v</span><span class="p">][</span><span class="n">u</span><span class="p">]</span></div>
726718

727-
728719
<span class="nd">@property</span>
729720
<span class="k">def</span><span class="w"> </span><span class="nf">edges</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
730721
<span class="n">edges</span> <span class="o">=</span> <span class="nb">list</span><span class="p">()</span>
@@ -807,23 +798,15 @@ <h1>Source code for easygraph.classes.directed_multigraph</h1><div class="highli
807798
<span class="p">)</span>
808799
<span class="n">degree</span><span class="p">[</span><span class="n">n</span><span class="p">]</span> <span class="o">=</span> <span class="n">deg</span>
809800

810-
<div class="viewcode-block" id="MultiDiGraph.is_multigraph">
811-
<a class="viewcode-back" href="../../../reference/easygraph.classes.directed_multigraph.html#easygraph.classes.directed_multigraph.MultiDiGraph.is_multigraph">[docs]</a>
812-
<span class="k">def</span><span class="w"> </span><span class="nf">is_multigraph</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
801+
<div class="viewcode-block" id="MultiDiGraph.is_multigraph"><a class="viewcode-back" href="../../../reference/easygraph.classes.directed_multigraph.html#easygraph.classes.directed_multigraph.MultiDiGraph.is_multigraph">[docs]</a> <span class="k">def</span><span class="w"> </span><span class="nf">is_multigraph</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
813802
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Returns True if graph is a multigraph, False otherwise.&quot;&quot;&quot;</span>
814803
<span class="k">return</span> <span class="kc">True</span></div>
815804

816-
817-
<div class="viewcode-block" id="MultiDiGraph.is_directed">
818-
<a class="viewcode-back" href="../../../reference/easygraph.classes.directed_multigraph.html#easygraph.classes.directed_multigraph.MultiDiGraph.is_directed">[docs]</a>
819-
<span class="k">def</span><span class="w"> </span><span class="nf">is_directed</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
805+
<div class="viewcode-block" id="MultiDiGraph.is_directed"><a class="viewcode-back" href="../../../reference/easygraph.classes.directed_multigraph.html#easygraph.classes.directed_multigraph.MultiDiGraph.is_directed">[docs]</a> <span class="k">def</span><span class="w"> </span><span class="nf">is_directed</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
820806
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Returns True if graph is directed, False otherwise.&quot;&quot;&quot;</span>
821807
<span class="k">return</span> <span class="kc">True</span></div>
822808

823-
824-
<div class="viewcode-block" id="MultiDiGraph.to_undirected">
825-
<a class="viewcode-back" href="../../../reference/easygraph.classes.directed_multigraph.html#easygraph.classes.directed_multigraph.MultiDiGraph.to_undirected">[docs]</a>
826-
<span class="k">def</span><span class="w"> </span><span class="nf">to_undirected</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">reciprocal</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
809+
<div class="viewcode-block" id="MultiDiGraph.to_undirected"><a class="viewcode-back" href="../../../reference/easygraph.classes.directed_multigraph.html#easygraph.classes.directed_multigraph.MultiDiGraph.to_undirected">[docs]</a> <span class="k">def</span><span class="w"> </span><span class="nf">to_undirected</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">reciprocal</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
827810
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Returns an undirected representation of the multidigraph.</span>
828811

829812
<span class="sd"> Parameters</span>
@@ -892,10 +875,7 @@ <h1>Source code for easygraph.classes.directed_multigraph</h1><div class="highli
892875
<span class="p">)</span>
893876
<span class="k">return</span> <span class="n">G</span></div>
894877

895-
896-
<div class="viewcode-block" id="MultiDiGraph.reverse">
897-
<a class="viewcode-back" href="../../../reference/easygraph.classes.directed_multigraph.html#easygraph.classes.directed_multigraph.MultiDiGraph.reverse">[docs]</a>
898-
<span class="k">def</span><span class="w"> </span><span class="nf">reverse</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">copy</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
878+
<div class="viewcode-block" id="MultiDiGraph.reverse"><a class="viewcode-back" href="../../../reference/easygraph.classes.directed_multigraph.html#easygraph.classes.directed_multigraph.MultiDiGraph.reverse">[docs]</a> <span class="k">def</span><span class="w"> </span><span class="nf">reverse</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">copy</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
899879
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Returns the reverse of the graph.</span>
900880

901881
<span class="sd"> The reverse is a graph with the same nodes and edges</span>
@@ -914,9 +894,7 @@ <h1>Source code for easygraph.classes.directed_multigraph</h1><div class="highli
914894
<span class="n">H</span><span class="o">.</span><span class="n">add_nodes_from</span><span class="p">((</span><span class="n">n</span><span class="p">,</span> <span class="n">deepcopy</span><span class="p">(</span><span class="n">d</span><span class="p">))</span> <span class="k">for</span> <span class="n">n</span><span class="p">,</span> <span class="n">d</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_node</span><span class="o">.</span><span class="n">items</span><span class="p">())</span>
915895
<span class="n">H</span><span class="o">.</span><span class="n">add_edges_from</span><span class="p">((</span><span class="n">v</span><span class="p">,</span> <span class="n">u</span><span class="p">,</span> <span class="n">k</span><span class="p">,</span> <span class="n">deepcopy</span><span class="p">(</span><span class="n">d</span><span class="p">))</span> <span class="k">for</span> <span class="n">u</span><span class="p">,</span> <span class="n">v</span><span class="p">,</span> <span class="n">k</span><span class="p">,</span> <span class="n">d</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">edges</span><span class="p">)</span>
916896
<span class="k">return</span> <span class="n">H</span>
917-
<span class="k">return</span> <span class="n">eg</span><span class="o">.</span><span class="n">graphviews</span><span class="o">.</span><span class="n">reverse_view</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span></div>
918-
</div>
919-
897+
<span class="k">return</span> <span class="n">eg</span><span class="o">.</span><span class="n">graphviews</span><span class="o">.</span><span class="n">reverse_view</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span></div></div>
920898
</pre></div>
921899

922900
</article>
@@ -967,7 +945,7 @@ <h1>Source code for easygraph.classes.directed_multigraph</h1><div class="highli
967945
<div class="footer-item">
968946

969947
<p class="sphinx-version">
970-
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.1.3.
948+
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 6.2.1.
971949
<br/>
972950
</p>
973951
</div>

0 commit comments

Comments
 (0)