Skip to content

Commit be75864

Browse files
author
Release Manager
committed
gh-40918: switch to n_vertices, n_edges and n_faces for graphs This provides aliases `n_vertices`, `n_edges` and `n_faces`, and uses them throughout the docstring `EXAMPLES`. The old aliases `num_verts`,`num_edges` and `num_faces` are kept. Also, they are kept in the code base, to avoid touching too many files. URL: #40918 Reported by: Martin Rubey Reviewer(s): David Coudert
2 parents d5952cd + 57156ca commit be75864

21 files changed

+108
-88
lines changed

‎src/doc/en/thematic_tutorials/sandpile.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4365,7 +4365,7 @@ EXAMPLES::
43654365
{0: 2, 1: 3, 2: 1, 3: 2}
43664366
sage: n(mean([D.simulate_threshold().deg() for _ in range(10)])) # random
43674367
7.10000000000000
4368-
sage: n(s.stationary_density()*s.num_verts())
4368+
sage: n(s.stationary_density()*s.n_vertices())
43694369
6.93750000000000
43704370

43714371
.. NOTE::

‎src/sage/categories/coxeter_groups.py‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1885,11 +1885,11 @@ def reduced_word_graph(self):
18851885
sage: W = WeylGroup(['A', 3], prefix='s')
18861886
sage: w0 = W.long_element()
18871887
sage: G = w0.reduced_word_graph()
1888-
sage: G.num_verts()
1888+
sage: G.n_vertices()
18891889
16
18901890
sage: len(w0.reduced_words())
18911891
16
1892-
sage: G.num_edges()
1892+
sage: G.n_edges()
18931893
18
18941894
sage: len([e for e in G.edges(sort=False) if e[2] == 2])
18951895
10
@@ -1906,9 +1906,9 @@ def reduced_word_graph(self):
19061906
sage: # needs sage.combinat sage.graphs sage.groups
19071907
sage: w1 = W.one()
19081908
sage: G = w1.reduced_word_graph()
1909-
sage: G.num_verts()
1909+
sage: G.n_vertices()
19101910
1
1911-
sage: G.num_edges()
1911+
sage: G.n_edges()
19121912
0
19131913
19141914
.. SEEALSO::

‎src/sage/categories/semigroups.py‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -208,7 +208,7 @@ def cayley_graph(self, side='right', simple=False, elements=None,
208208
....: vertex_colors={(1,1,1): G.vertices(sort=True)},
209209
....: bgcolor=(0,0,0), color_by_label=True,
210210
....: xres=700, yres=700, iterations=200)
211-
sage: G.num_edges()
211+
sage: G.n_edges()
212212
120
213213
214214
sage: # needs sage.combinat sage.graphs sage.groups
@@ -221,7 +221,7 @@ def cayley_graph(self, side='right', simple=False, elements=None,
221221
222222
sage: # needs sage.graphs sage.groups
223223
sage: G = A5.cayley_graph(generators=[A5.gens()[0]])
224-
sage: G.num_edges()
224+
sage: G.n_edges()
225225
60
226226
sage: g = PermutationGroup([(i + 1, j + 1)
227227
....: for i in range(5)
@@ -242,7 +242,7 @@ def cayley_graph(self, side='right', simple=False, elements=None,
242242
....: for w in sum((list(Words(M.semigroup_generators(), k))
243243
....: for k in range(4)), [])]
244244
sage: G = M.cayley_graph(elements=elements)
245-
sage: G.num_verts(), G.num_edges()
245+
sage: G.n_vertices(), G.n_edges()
246246
(85, 84)
247247
sage: G.show3d(color_by_label=True, edge_size=0.001, vertex_size=0.01) # needs sage.plot
248248

‎src/sage/combinat/constellation.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -885,9 +885,9 @@ def braid_group_orbit(self):
885885
g1 (0)(1,4)(2)(3)
886886
g2 (0,1,3,2,4)
887887
sage: G = c.braid_group_orbit()
888-
sage: G.num_verts()
888+
sage: G.n_vertices()
889889
4
890-
sage: G.num_edges()
890+
sage: G.n_edges()
891891
12
892892
"""
893893
G = DiGraph(multiedges=True, loops=True)

‎src/sage/combinat/posets/hasse_diagram.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -942,7 +942,7 @@ def cardinality(self):
942942
sage: H = L.hasse_diagram()
943943
sage: H.size()
944944
80
945-
sage: H.size() == H.num_edges()
945+
sage: H.size() == H.n_edges()
946946
True
947947
"""
948948
return self.order()

‎src/sage/graphs/base/c_graph.pyx‎

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1418,7 +1418,7 @@ cdef class CGraphBackend(GenericGraphBackend):
14181418
else:
14191419
self._loops = False
14201420

1421-
def num_edges(self, directed):
1421+
def n_edges(self, directed):
14221422
"""
14231423
Return the number of edges in ``self``.
14241424
@@ -1434,13 +1434,13 @@ cdef class CGraphBackend(GenericGraphBackend):
14341434
14351435
.. SEEALSO::
14361436
1437-
- :meth:`num_verts`
1437+
- :meth:`n_vertices`
14381438
-- return the order of this graph.
14391439
14401440
EXAMPLES::
14411441
14421442
sage: G = Graph(graphs.PetersenGraph())
1443-
sage: G._backend.num_edges(False)
1443+
sage: G._backend.n_edges(False)
14441444
15
14451445
14461446
TESTS:
@@ -1485,23 +1485,23 @@ cdef class CGraphBackend(GenericGraphBackend):
14851485
2
14861486
sage: from sage.graphs.base.sparse_graph import SparseGraphBackend
14871487
sage: S = SparseGraphBackend(7)
1488-
sage: S.num_edges(False)
1488+
sage: S.n_edges(False)
14891489
0
14901490
sage: S.loops(True)
14911491
sage: S.add_edge(1, 1, None, directed=False)
1492-
sage: S.num_edges(False)
1492+
sage: S.n_edges(False)
14931493
1
14941494
sage: S.multiple_edges(True)
14951495
sage: S.add_edge(1, 1, None, directed=False)
1496-
sage: S.num_edges(False)
1496+
sage: S.n_edges(False)
14971497
2
14981498
sage: from sage.graphs.base.dense_graph import DenseGraphBackend
14991499
sage: D = DenseGraphBackend(7)
1500-
sage: D.num_edges(False)
1500+
sage: D.n_edges(False)
15011501
0
15021502
sage: D.loops(True)
15031503
sage: D.add_edge(1, 1, None, directed=False)
1504-
sage: D.num_edges(False)
1504+
sage: D.n_edges(False)
15051505
1
15061506
"""
15071507
if directed:
@@ -1521,25 +1521,29 @@ cdef class CGraphBackend(GenericGraphBackend):
15211521
i = (i - k) // 2
15221522
return i + k
15231523

1524-
def num_verts(self):
1524+
num_edges = n_edges
1525+
1526+
def n_vertices(self):
15251527
"""
15261528
Return the number of vertices in ``self``.
15271529
15281530
OUTPUT: the order of this graph
15291531
15301532
.. SEEALSO::
15311533
1532-
- :meth:`num_edges`
1534+
- :meth:`n_edges`
15331535
-- return the number of (directed) edges in this graph.
15341536
15351537
EXAMPLES::
15361538
15371539
sage: G = Graph(graphs.PetersenGraph())
1538-
sage: G._backend.num_verts()
1540+
sage: G._backend.n_vertices()
15391541
10
15401542
"""
15411543
return self.cg().num_verts
15421544

1545+
num_verts = n_vertices
1546+
15431547
cdef bint _delete_edge_before_adding(self) noexcept:
15441548
"""
15451549
Return whether we should delete edges before adding any.

‎src/sage/graphs/base/graph_backends.pyx‎

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,8 @@ Any graph backend must redefine the following methods (for which
3535
:meth:`~GenericGraphBackend.loops` | Get/set whether or not ``self`` allows loops.
3636
:meth:`~GenericGraphBackend.multiple_edges` | Get/set whether or not ``self`` allows multiple edges.
3737
:meth:`~GenericGraphBackend.name` | Get/set name of ``self``.
38-
:meth:`~GenericGraphBackend.num_edges` | The number of edges in ``self``
39-
:meth:`~GenericGraphBackend.num_verts` | The number of vertices in ``self``
38+
:meth:`~GenericGraphBackend.n_edges` | The number of edges in ``self``
39+
:meth:`~GenericGraphBackend.n_vertices` | The number of vertices in ``self``
4040
:meth:`~GenericGraphBackend.relabel` | Relabel the vertices of ``self`` by a permutation.
4141
:meth:`~GenericGraphBackend.set_edge_label` | Label the edge `(u,v)` by `l`.
4242
@@ -583,7 +583,7 @@ cdef class GenericGraphBackend(SageObject):
583583
"""
584584
raise NotImplementedError()
585585

586-
def num_edges(self, directed):
586+
def n_edges(self, directed):
587587
"""
588588
Return the number of edges in ``self``.
589589
@@ -594,31 +594,35 @@ cdef class GenericGraphBackend(SageObject):
594594
TESTS::
595595
596596
sage: G = sage.graphs.base.graph_backends.GenericGraphBackend()
597-
sage: G.num_edges(True)
597+
sage: G.n_edges(True)
598598
Traceback (most recent call last):
599599
...
600600
NotImplementedError
601-
sage: G.num_edges(False)
601+
sage: G.n_edges(False)
602602
Traceback (most recent call last):
603603
...
604604
NotImplementedError
605605
"""
606606
raise NotImplementedError()
607607

608-
def num_verts(self):
608+
num_edges = n_edges
609+
610+
def n_vertices(self):
609611
"""
610612
Return the number of vertices in ``self``.
611613
612614
TESTS::
613615
614616
sage: G = sage.graphs.base.graph_backends.GenericGraphBackend()
615-
sage: G.num_verts()
617+
sage: G.n_vertices()
616618
Traceback (most recent call last):
617619
...
618620
NotImplementedError
619621
"""
620622
raise NotImplementedError()
621623

624+
num_verts = n_vertices
625+
622626
def relabel(self, perm, directed):
623627
"""
624628
Relabel the vertices of ``self`` by a permutation.

‎src/sage/graphs/base/static_sparse_backend.pyx‎

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -980,19 +980,21 @@ cdef class StaticSparseBackend(CGraphBackend):
980980
yield x
981981
return
982982

983-
def num_verts(self):
983+
def n_vertices(self):
984984
r"""
985985
Return the number of vertices.
986986
987987
TESTS::
988988
989989
sage: from sage.graphs.base.static_sparse_backend import StaticSparseBackend
990990
sage: g = StaticSparseBackend(graphs.PetersenGraph())
991-
sage: g.num_verts()
991+
sage: g.n_vertices()
992992
10
993993
"""
994994
return self._order
995995

996+
num_verts = n_vertices
997+
996998
def allows_loops(self, value=None):
997999
r"""
9981000
Return whether the graph allows loops.
@@ -1043,7 +1045,7 @@ cdef class StaticSparseBackend(CGraphBackend):
10431045
else:
10441046
raise ValueError("the graph is immutable and cannot be changed in any way")
10451047

1046-
def num_edges(self, directed):
1048+
def n_edges(self, directed):
10471049
r"""
10481050
Return the number of edges.
10491051
@@ -1056,13 +1058,13 @@ cdef class StaticSparseBackend(CGraphBackend):
10561058
10571059
sage: from sage.graphs.base.static_sparse_backend import StaticSparseBackend
10581060
sage: g = StaticSparseBackend(graphs.PetersenGraph())
1059-
sage: g.num_edges(False)
1061+
sage: g.n_edges(False)
10601062
15
10611063
10621064
Testing the exception::
10631065
10641066
sage: g = StaticSparseBackend(digraphs.Circuit(4))
1065-
sage: g.num_edges(False)
1067+
sage: g.n_edges(False)
10661068
Traceback (most recent call last):
10671069
...
10681070
NotImplementedError: Sorry, I have no idea what is expected in this situation. I don't think that it is well-defined either, especially for multigraphs.
@@ -1095,6 +1097,8 @@ cdef class StaticSparseBackend(CGraphBackend):
10951097
# Returns the number of edges
10961098
return int(cg.g.m)
10971099

1100+
num_edges = n_edges
1101+
10981102
def iterator_edges(self, vertices, bint labels):
10991103
r"""
11001104
Iterate over the graph's edges.

‎src/sage/graphs/bliss.pyx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -476,7 +476,7 @@ cpdef canonical_form(G, partition=None, return_graph=False,
476476
....: for labels in product([0,1], repeat=len(edges)):
477477
....: g = Graph([(u,v,l) for ((u,v),l) in zip(edges, labels)])
478478
....: gcan = canonical_form(g, use_edge_labels=True)
479-
....: for p in permutations(range(g.num_verts())):
479+
....: for p in permutations(range(g.n_vertices())):
480480
....: h = Graph([(p[u], p[v], lab) for u,v,lab in g.edges(sort=True)])
481481
....: hcan = canonical_form(h, use_edge_labels=True)
482482
....: if gcan != hcan: print(edges, labels, p)

‎src/sage/graphs/digraph.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1494,7 +1494,7 @@ def degree_polynomial(self):
14941494
14951495
.. SEEALSO::
14961496
1497-
:meth:`num_verts` for the value at `(x, y) = (1, 1)`
1497+
:meth:`n_vertices` for the value at `(x, y) = (1, 1)`
14981498
14991499
EXAMPLES::
15001500
@@ -1611,7 +1611,7 @@ def feedback_edge_set(self, constraint_generation=True, value_only=False,
16111611
`vu` is in the returned feedback arc set::
16121612
16131613
sage: g = graphs.RandomGNP(5,.3)
1614-
sage: while not g.num_edges():
1614+
sage: while not g.n_edges():
16151615
....: g = graphs.RandomGNP(5,.3)
16161616
sage: dg = DiGraph(g)
16171617
sage: feedback = dg.feedback_edge_set() # needs sage.numerical.mip

0 commit comments

Comments
 (0)