add parameter immutable to some graph operations in sage/graphs/generic_graph.py
#39280
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Documentation preview for this PR (built with commit 4aeb7dd; changes) is ready! 🎉 |
|
I must say that I would like it much better if graphs were immutable by default :-( |
|
Before debating such drastic change, we must make sure that the entire graph library, including generators, is consistent. |
This was referenced Jan 5, 2025
|
maybe you could create a function "scream_if_immutable" to avoid repeating ? |
fchapoton
reviewed
Jan 8, 2025
I'm adding this idea to my todo list. It should certainly be done also in backends... |
vbraun
pushed a commit
to vbraun/sage
that referenced
this pull request
Jan 28, 2025
sagemathgh-39285: add parameter `immutable` to some graph products in `sage/graphs/generic_graph.py` Following sagemath#39280 and discussions in sagemath#39177, we add parameter `immutable` to some graph product operations defined in `sage/graphs/generic_graph.py`: - `cartesian_product` - `tensor_product` - `lexicographic_product` - `strong_product` - `disjunctive_product` ### 📝 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#39285 Reported by: David Coudert Reviewer(s): David Coudert, Frédéric Chapoton
vbraun
pushed a commit
to vbraun/sage
that referenced
this pull request
Jan 29, 2025
sagemathgh-39285: add parameter `immutable` to some graph products in `sage/graphs/generic_graph.py` Following sagemath#39280 and discussions in sagemath#39177, we add parameter `immutable` to some graph product operations defined in `sage/graphs/generic_graph.py`: - `cartesian_product` - `tensor_product` - `lexicographic_product` - `strong_product` - `disjunctive_product` ### 📝 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#39285 Reported by: David Coudert Reviewer(s): David Coudert, Frédéric Chapoton
vbraun
pushed a commit
to vbraun/sage
that referenced
this pull request
Jan 30, 2025
sagemathgh-39285: add parameter `immutable` to some graph products in `sage/graphs/generic_graph.py` Following sagemath#39280 and discussions in sagemath#39177, we add parameter `immutable` to some graph product operations defined in `sage/graphs/generic_graph.py`: - `cartesian_product` - `tensor_product` - `lexicographic_product` - `strong_product` - `disjunctive_product` ### 📝 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#39285 Reported by: David Coudert Reviewer(s): David Coudert, Frédéric Chapoton
vbraun
pushed a commit
to vbraun/sage
that referenced
this pull request
Jan 31, 2025
sagemathgh-39285: add parameter `immutable` to some graph products in `sage/graphs/generic_graph.py` Following sagemath#39280 and discussions in sagemath#39177, we add parameter `immutable` to some graph product operations defined in `sage/graphs/generic_graph.py`: - `cartesian_product` - `tensor_product` - `lexicographic_product` - `strong_product` - `disjunctive_product` ### 📝 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#39285 Reported by: David Coudert Reviewer(s): David Coudert, Frédéric Chapoton
vbraun
pushed a commit
to vbraun/sage
that referenced
this pull request
Feb 3, 2025
sagemathgh-39285: add parameter `immutable` to some graph products in `sage/graphs/generic_graph.py` Following sagemath#39280 and discussions in sagemath#39177, we add parameter `immutable` to some graph product operations defined in `sage/graphs/generic_graph.py`: - `cartesian_product` - `tensor_product` - `lexicographic_product` - `strong_product` - `disjunctive_product` ### 📝 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#39285 Reported by: David Coudert Reviewer(s): David Coudert, Frédéric Chapoton
vbraun
pushed a commit
to vbraun/sage
that referenced
this pull request
Feb 4, 2025
sagemathgh-39285: add parameter `immutable` to some graph products in `sage/graphs/generic_graph.py` Following sagemath#39280 and discussions in sagemath#39177, we add parameter `immutable` to some graph product operations defined in `sage/graphs/generic_graph.py`: - `cartesian_product` - `tensor_product` - `lexicographic_product` - `strong_product` - `disjunctive_product` ### 📝 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#39285 Reported by: David Coudert Reviewer(s): David Coudert, Frédéric Chapoton
vbraun
pushed a commit
to vbraun/sage
that referenced
this pull request
Feb 9, 2025
sagemathgh-39280: add parameter `immutable` to some graph operations in `sage/graphs/generic_graph.py` As proposed in sagemath#39177, we add parameter `immutable` to (some) graph operations. - add tests to `add_clique`, `add_path`, and `add_cycle` to prevent modifying an immutable graph - add the parameter to method `complement` - ensure that method `to_undirected` behaves as expected - propose a more direct version of `disjoint_union` to ensure a correct behavior - ensure that method `union` behaves as expected This is only a beginning. More to come in future PRs. ### 📝 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#39280 Reported by: David Coudert Reviewer(s): David Coudert, Frédéric Chapoton
vbraun
pushed a commit
to vbraun/sage
that referenced
this pull request
Feb 9, 2025
sagemathgh-39285: add parameter `immutable` to some graph products in `sage/graphs/generic_graph.py` Following sagemath#39280 and discussions in sagemath#39177, we add parameter `immutable` to some graph product operations defined in `sage/graphs/generic_graph.py`: - `cartesian_product` - `tensor_product` - `lexicographic_product` - `strong_product` - `disjunctive_product` ### 📝 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#39285 Reported by: David Coudert Reviewer(s): David Coudert, Frédéric Chapoton
vbraun
pushed a commit
to vbraun/sage
that referenced
this pull request
Feb 9, 2025
sagemathgh-39280: add parameter `immutable` to some graph operations in `sage/graphs/generic_graph.py` As proposed in sagemath#39177, we add parameter `immutable` to (some) graph operations. - add tests to `add_clique`, `add_path`, and `add_cycle` to prevent modifying an immutable graph - add the parameter to method `complement` - ensure that method `to_undirected` behaves as expected - propose a more direct version of `disjoint_union` to ensure a correct behavior - ensure that method `union` behaves as expected This is only a beginning. More to come in future PRs. ### 📝 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#39280 Reported by: David Coudert Reviewer(s): David Coudert, Frédéric Chapoton
vbraun
pushed a commit
to vbraun/sage
that referenced
this pull request
Feb 9, 2025
sagemathgh-39285: add parameter `immutable` to some graph products in `sage/graphs/generic_graph.py` Following sagemath#39280 and discussions in sagemath#39177, we add parameter `immutable` to some graph product operations defined in `sage/graphs/generic_graph.py`: - `cartesian_product` - `tensor_product` - `lexicographic_product` - `strong_product` - `disjunctive_product` ### 📝 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#39285 Reported by: David Coudert Reviewer(s): David Coudert, Frédéric Chapoton
vbraun
pushed a commit
to vbraun/sage
that referenced
this pull request
Feb 10, 2025
sagemathgh-39285: add parameter `immutable` to some graph products in `sage/graphs/generic_graph.py` Following sagemath#39280 and discussions in sagemath#39177, we add parameter `immutable` to some graph product operations defined in `sage/graphs/generic_graph.py`: - `cartesian_product` - `tensor_product` - `lexicographic_product` - `strong_product` - `disjunctive_product` ### 📝 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#39285 Reported by: David Coudert Reviewer(s): David Coudert, Frédéric Chapoton
vbraun
pushed a commit
to vbraun/sage
that referenced
this pull request
Feb 10, 2025
sagemathgh-39297: more care about parameter `immutable` in `sage/graphs/generic_graph.py` Following sagemath#39280, sagemath#39285, sagemath#39287, sagemath#39296 and discussions in sagemath#39177, we add parameter immutable to methods in `sage/graphs/generic_graph.py`: - `longest_cycle` - `longest_path` - `hamiltonian_path` - and add tests in `cycle_basis` ### 📝 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#39297 Reported by: David Coudert Reviewer(s): Kwankyu Lee
This was referenced Feb 12, 2025
vbraun
pushed a commit
to vbraun/sage
that referenced
this pull request
Mar 9, 2025
sagemathgh-39287: add parameter `immutable` to transitive closure methods in `sage/graphs/generic_graph.py` Following sagemath#39280 and discussions in sagemath#39177, we add parameter `immutable` to methods related to transitive closure in `sage/graphs/generic_graph.py` and `sage/graphs/generic_graph_pyx.pyx`: - `transitive_closure`. We also fix the use of parameter `loops` that was previously ignored - `transitive_reduction` - `transitive_reduction_acyclic` - `is_transitively_reduced`. Here we ensure that the method accepts immutable digraphs. ### 📝 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#39287 Reported by: David Coudert Reviewer(s): Frédéric Chapoton
vbraun
pushed a commit
to vbraun/sage
that referenced
this pull request
Mar 9, 2025
sagemathgh-39287: add parameter `immutable` to transitive closure methods in `sage/graphs/generic_graph.py` Following sagemath#39280 and discussions in sagemath#39177, we add parameter `immutable` to methods related to transitive closure in `sage/graphs/generic_graph.py` and `sage/graphs/generic_graph_pyx.pyx`: - `transitive_closure`. We also fix the use of parameter `loops` that was previously ignored - `transitive_reduction` - `transitive_reduction_acyclic` - `is_transitively_reduced`. Here we ensure that the method accepts immutable digraphs. ### 📝 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#39287 Reported by: David Coudert Reviewer(s): Frédéric Chapoton
vbraun
pushed a commit
to vbraun/sage
that referenced
this pull request
Mar 19, 2025
sagemathgh-39296: fix the behavior for immutable graphs in methods related to isomorphisms in `sage/graphs/generic_graph.py` Following sagemath#39280 and discussions in sagemath#39177, we add parameter `immutable` to methods related to graph isomorphisms in `sage/graphs/generic_graph.py` and `bliss.pyx`: - `canonical_form` - `automorphism_group` - `is_isomorphic` - `graph_isom_equivalent_non_edge_labeled_graph` - and also `cayley_graph` We also fix the behavior of method `canonical_label` in `BipartiteGraph`. ### 📝 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#39296 Reported by: David Coudert Reviewer(s): Frédéric Chapoton
vbraun
pushed a commit
to vbraun/sage
that referenced
this pull request
Mar 22, 2025
sagemathgh-39296: fix the behavior for immutable graphs in methods related to isomorphisms in `sage/graphs/generic_graph.py` Following sagemath#39280 and discussions in sagemath#39177, we add parameter `immutable` to methods related to graph isomorphisms in `sage/graphs/generic_graph.py` and `bliss.pyx`: - `canonical_form` - `automorphism_group` - `is_isomorphic` - `graph_isom_equivalent_non_edge_labeled_graph` - and also `cayley_graph` We also fix the behavior of method `canonical_label` in `BipartiteGraph`. ### 📝 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#39296 Reported by: David Coudert Reviewer(s): Frédéric Chapoton
5 tasks
vbraun
pushed a commit
to vbraun/sage
that referenced
this pull request
Jun 15, 2025
sagemathgh-39755: add helper method `_scream_if_immutable` to graphs As proposed in sagemath#39280 (comment), we add a helper method `_scream_if_immutable` to (di)graphs. We then use it in several methods trying to modify the graph. ### 📝 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#39755 Reported by: David Coudert Reviewer(s): Frédéric Chapoton
vbraun
pushed a commit
to vbraun/sage
that referenced
this pull request
Jun 17, 2025
sagemathgh-39755: add helper method `_scream_if_immutable` to graphs As proposed in sagemath#39280 (comment), we add a helper method `_scream_if_immutable` to (di)graphs. We then use it in several methods trying to modify the graph. ### 📝 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#39755 Reported by: David Coudert Reviewer(s): Frédéric Chapoton
vbraun
pushed a commit
to vbraun/sage
that referenced
this pull request
Jun 18, 2025
sagemathgh-39755: add helper method `_scream_if_immutable` to graphs As proposed in sagemath#39280 (comment), we add a helper method `_scream_if_immutable` to (di)graphs. We then use it in several methods trying to modify the graph. ### 📝 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#39755 Reported by: David Coudert Reviewer(s): Frédéric Chapoton
vbraun
pushed a commit
to vbraun/sage
that referenced
this pull request
Jun 21, 2025
sagemathgh-39755: add helper method `_scream_if_immutable` to graphs As proposed in sagemath#39280 (comment), we add a helper method `_scream_if_immutable` to (di)graphs. We then use it in several methods trying to modify the graph. ### 📝 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#39755 Reported by: David Coudert Reviewer(s): Frédéric Chapoton
vbraun
pushed a commit
to vbraun/sage
that referenced
this pull request
Jun 25, 2025
sagemathgh-39755: add helper method `_scream_if_immutable` to graphs As proposed in sagemath#39280 (comment), we add a helper method `_scream_if_immutable` to (di)graphs. We then use it in several methods trying to modify the graph. ### 📝 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#39755 Reported by: David Coudert Reviewer(s): Frédéric Chapoton
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
As proposed in #39177, we add parameter
immutableto (some) graph operations.add_clique,add_path, andadd_cycleto prevent modifying an immutable graphcomplementto_undirectedbehaves as expecteddisjoint_unionto ensure a correct behaviorunionbehaves as expectedThis is only a beginning. More to come in future PRs.
📝 Checklist
⌛ Dependencies