Skip to content

Commit

Permalink
sagemathgh-38269: Fix lex_BFS (and co.) for directed graphs
Browse files Browse the repository at this point in the history
    
<!-- ^ Please provide a concise and informative title. -->
<!-- ^ Don't put issue numbers in the title, do this in the PR
description below. -->
<!-- ^ For example, instead of "Fixes sagemath#12345" use "Introduce new method
to calculate 1 + 2". -->
<!-- v Describe your changes below in detail. -->
<!-- v Why is this change required? What problem does it solve? -->
<!-- v If this PR resolves an open issue, please link to it here. For
example, "Fixes sagemath#12345". -->

For directed graphs, the semantic of `lex_BFS`, `lex_DFS`, `lex_DOWN`
and `lex_UP` methods are not consistent. In some parts of the code,
directed graphs were converted into undirected graphs before the actual
computation and in some other parts (in particular in the check function
`_is_valid_lex_BFS_order`) directed graphs were explicitly considered as
directed.

In this PR, the following changes are implemented:
- always consider (and convert) directed graphs into undirected graphs
for `lex_*` methods
- do the same conversion in `_is_valid_lex_BFS_order` for consistency
- add the following line in the documentation of the `lex_*` methods:
```py
r"""
   Loops and multiple edges are ignored during the computation of <name
of the method> and
   directed graphs are converted to undirected graphs.
"""
```
- change some doctests: with the previous changes, methods can return a
different (but still valid) order
- set the copy of the graph to immutable

Fixes sagemath#38234

### 📝 Checklist

<!-- Put an `x` in all the boxes that apply. -->

- [x] The title is concise and informative.
- [x] The description explains in detail what this PR is about.
- [x] I have linked a relevant issue or discussion.
- [x] I have created tests covering the changes.
- [x] I have updated the documentation and checked the documentation
preview.

### ⌛ Dependencies

<!-- List all open PRs that this PR logically depends on. For example,
-->
<!-- - sagemath#12345: short description why this is a dependency -->
<!-- - sagemath#34567: ... -->
    
URL: sagemath#38269
Reported by: cyrilbouvier
Reviewer(s): cyrilbouvier, David Coudert
  • Loading branch information
Release Manager committed Jul 30, 2024
2 parents d7bd310 + 03cbae8 commit be6db15
Showing 0 changed files with 0 additions and 0 deletions.

0 comments on commit be6db15

Please sign in to comment.