@@ -105,7 +105,10 @@ def __init__(
105105 # we use a list and a dict, the list respects the order of adding
106106 self ._vertexlist : list [BaseVertex ] = []
107107 self ._vertexdict : dict [str , BaseVertex ] = {}
108- self ._edgelist : set [Edge ] = set ()
108+ # an insertion-ordered set: the keys are the edges, hashed by identity
109+ # (Edge defines no __eq__), the values are unused. This gives O(1)
110+ # removal and a defined order.
111+ self ._edges : dict [Edge , None ] = {}
109112 self ._verbose = verbose
110113 self ._dim = dim
111114 self ._ncomponents = 0
@@ -377,11 +380,11 @@ def validate(self) -> list[str]:
377380 else :
378381 problems .append (f"the vertex list holds { entry !r} , which is not a vertex" )
379382 graph_edges : list [Edge ] = []
380- for member in self ._edgelist :
383+ for member in self ._edges :
381384 if isinstance (member , Edge ):
382385 graph_edges .append (member )
383386 else :
384- problems .append (f"the edge set holds { member !r} , which is not an edge" )
387+ problems .append (f"the graph's edges hold { member !r} , which is not an edge" )
385388
386389 # ---- vertices
387390 members = {id (v ) for v in vertices }
@@ -844,7 +847,7 @@ def remove_edge(self, edge: Edge) -> None:
844847
845848 :seealso: :meth:`remove_vertex` :meth:`Edge.remove`
846849 """
847- if edge not in self ._edgelist :
850+ if edge not in self ._edges :
848851 raise ValueError ("edge does not belong to this graph" )
849852 v1 , v2 = edge .v1 , edge .v2
850853 if v1 is None or v2 is None :
@@ -860,7 +863,7 @@ def remove_edge(self, edge: Edge) -> None:
860863
861864 edge ._set_endpoints (None , None )
862865
863- self ._edgelist . remove ( edge )
866+ del self ._edges [ edge ]
864867
865868 def remove_vertex (self , vertex : BaseVertex ) -> None :
866869 """
@@ -951,7 +954,7 @@ def show(self) -> None:
951954 for v in self ._vertexlist :
952955 print (" " + str (v ))
953956 print ("edges:" )
954- for e in self ._edgelist :
957+ for e in self ._edges :
955958 print (" " + str (e ))
956959
957960 @property
@@ -989,7 +992,7 @@ def ne(self) -> int:
989992 >>> g.add_edge(v1, v2)
990993 >>> print(g.ne)
991994 """
992- return len (self ._edgelist )
995+ return len (self ._edges )
993996
994997 @abstractmethod
995998 def _graphcolor (self ) -> int | None :
@@ -1327,21 +1330,35 @@ def closest(self, coord: ArrayLike) -> tuple[BaseVertex | None, float]:
13271330
13281331 return min_which , min_dist
13291332
1330- def edges (self ) -> set [Edge ]:
1333+ def edges (self ) -> list [Edge ]:
13311334 """
13321335 Get all edges in graph (base class method)
13331336
13341337 :return: All edges in the graph
1335- :rtype: set of Edge references
1338+ :rtype: list of Edge references
1339+
1340+ The edges are in the order they were added to the graph. This is a
1341+ new list, so it can be modified or sorted without affecting the graph,
1342+ and edges can be removed from the graph while iterating over it.
13361343
13371344 We can iterate over all edges in the graph by::
13381345
13391346 for e in g.edges():
13401347 print(e)
13411348
1342- .. note:: Unlike :meth:`BaseVertex.edges`, which returns a ``list`` in
1343- connection order, this returns a ``set`` with no defined
1344- iteration order.
1349+ and select one by index, for example the second edge added is
1350+ ``g.edges()[1]``.
1351+
1352+ .. note:: Like :meth:`BaseVertex.edges` this is a ``list``, but where
1353+ that lists the edges attached to one vertex, this lists every edge
1354+ in the graph once. A self-loop is one edge here, but appears
1355+ twice in the :meth:`BaseVertex.edges` of an undirected vertex
1356+ because it has two ends there.
1357+
1358+ .. versionchanged:: 1.0
1359+ Returns a ``list`` in order of addition. In 0.6.5 this was the
1360+ graph's own ``set``, with no defined order, although the
1361+ documentation said ``list``.
13451362
13461363 .. runblock:: pycon
13471364
@@ -1352,9 +1369,9 @@ def edges(self) -> set[Edge]:
13521369 >>> g.add_edge(v1, v2)
13531370 >>> print(g.edges())
13541371
1355- :seealso: :meth:`BaseVertex.edges`
1372+ :seealso: :meth:`BaseVertex.edges` :attr:`ne`
13561373 """
1357- return self ._edgelist
1374+ return list ( self ._edges )
13581375
13591376 def plot (
13601377 self ,
@@ -2224,14 +2241,14 @@ def incidence(self) -> NDArray:
22242241 .. note::
22252242 - vertices are numbered in their order of creation. A vertex index
22262243 can be resolved to a vertex reference by ``graph[i]``.
2227- - edges are numbered in the order they appear in ``graph.edges()``.
2244+ - edges are numbered in the order they appear in :meth:`edges`, which
2245+ is the order they were added.
22282246 - Both endpoints of every edge are marked, regardless of
22292247 direction -- for a ``DGraph`` this means a vertex that is only
2230- ever a target (never a source) still appears here, unlike
2231- :meth:`degree`/:attr:`BaseVertex.degree`, which count outgoing
2232- edges only. Iterating each vertex's own
2233- :meth:`BaseVertex.edges` instead would silently drop such
2234- vertices for a directed graph.
2248+ ever a target (never a source) still appears here. Iterating
2249+ each vertex's own :meth:`BaseVertex.edges`, which are its
2250+ outgoing edges, would silently drop such vertices for a
2251+ directed graph.
22352252
22362253 .. rubric:: For graphs with parallel edges or loops
22372254
@@ -3541,7 +3558,7 @@ def connect(
35413558 else :
35423559 e = self ._graph ._edge_class (self , dest , cost = cost , data = data )
35433560
3544- self ._graph ._edgelist . add ( e )
3561+ self ._graph ._edges [ e ] = None
35453562 self ._graph ._connectivitychange = True
35463563 self ._connectivitychange = True
35473564
@@ -3661,11 +3678,16 @@ def edges(self) -> list[Edge]:
36613678 :return: List of all edges leaving this vertex
36623679 :rtype: list of Edge
36633680
3681+ The edges are in the order they were connected. This is a new list,
3682+ so it can be modified, and edges can be removed from the graph while
3683+ iterating over it.
3684+
36643685 .. note::
36653686
36663687 - For a directed graph the edges are those leaving this vertex
36673688 - For a non-directed graph the edges are those leaving or entering
3668- this vertex
3689+ this vertex, and a self-loop is listed twice, once for each of
3690+ its ends
36693691
36703692 .. runblock:: pycon
36713693
@@ -3679,7 +3701,7 @@ def edges(self) -> list[Edge]:
36793701 :seealso: :meth:`out_edges` :meth:`in_edges` :meth:`adjacent`
36803702 :meth:`incidences` :attr:`degree` :meth:`BaseGraph.edges`
36813703 """
3682- return self ._edgelist
3704+ return list ( self ._edgelist )
36833705
36843706 def heuristic_distance (self , v2 : BaseVertex ) -> float :
36853707 """
0 commit comments