Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

add support for immutable=True/False parameter in .canonical_label() and other functions that create a new graph #39177

Open
1 task done
maxale opened this issue Dec 20, 2024 · 0 comments
Open
1 task done

add support for immutable=True/False parameter in .canonical_label() and other functions that create a new graph #39177

maxale opened this issue Dec 20, 2024 · 0 comments
Labels
c: graph theory t: enhancement

Comments

@maxale
Copy link
Contributor

maxale commented Dec 20, 2024

Problem Description

Since Graph().canonical_label(immutable=True) gives

TypeError: GenericGraph.canonical_label() got an unexpected keyword argument 'immutable'

one is forced to use an additional .copy() call like Graph().canonical_label().copy(immutable=True) to get an immutable canonical label of a given graph.

Proposed Solution

It will be more straightforward to have immutable= keyword argument supported by any function that creates and returns a new graph (like .canonical_copy()) to save on an extra call to .copy(immutable=True) when the returned graph is needed to be immutable.

Alternatives Considered

N/A

Additional Information

No response

Is there an existing issue for this?

  • I have searched the existing issues for a bug report that matches the one I want to file, without success.
@kaneki003 kaneki003 mentioned this issue Dec 23, 2024
Closed
5 tasks
This was referenced Jan 3, 2025
Merged
Merged
Open
Open
Open
vbraun pushed a commit to vbraun/sage that referenced this issue Jan 5, 2025
sagemathgh-39264: add parameter immutable to generators in `sage/grap…
6f7726f 
…hs/digraph_generators.py` (part 1)

    
We add parameter `immutable` to some generators in
`age/graphs/digraph_generators.py`.

This is straightforward for most of them, except for `RandomTournament`
where we use `getrandbits` rather than repeated calls to `random()`.
This is similar to what is done in method
`Graph(...).random_orientation()`.

This PR is motivated by discussions in sagemath#39177.

### 📝 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.
- [ ] 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#39264
Reported by: David Coudert
Reviewer(s): Frédéric Chapoton
This was referenced Jan 5, 2025
Open
Open
vbraun pushed a commit to vbraun/sage that referenced this issue Jan 7, 2025
sagemathgh-39264: add parameter immutable to generators in `sage/grap…
42942ac 
…hs/digraph_generators.py` (part 1)

    
We add parameter `immutable` to some generators in
`age/graphs/digraph_generators.py`.

This is straightforward for most of them, except for `RandomTournament`
where we use `getrandbits` rather than repeated calls to `random()`.
This is similar to what is done in method
`Graph(...).random_orientation()`.

This PR is motivated by discussions in sagemath#39177.

### 📝 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.
- [ ] 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#39264
Reported by: David Coudert
Reviewer(s): Frédéric Chapoton
This was referenced Jan 7, 2025
Open
Open
vbraun pushed a commit to vbraun/sage that referenced this issue Jan 9, 2025
sagemathgh-39264: add parameter immutable to generators in `sage/grap…
287316c 
…hs/digraph_generators.py` (part 1)

    
We add parameter `immutable` to some generators in
`age/graphs/digraph_generators.py`.

This is straightforward for most of them, except for `RandomTournament`
where we use `getrandbits` rather than repeated calls to `random()`.
This is similar to what is done in method
`Graph(...).random_orientation()`.

This PR is motivated by discussions in sagemath#39177.

### 📝 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.
- [ ] 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#39264
Reported by: David Coudert
Reviewer(s): Frédéric Chapoton
vbraun pushed a commit to vbraun/sage that referenced this issue Jan 10, 2025
sagemathgh-39264: add parameter immutable to generators in `sage/grap…
7e1cd68 
…hs/digraph_generators.py` (part 1)

    
We add parameter `immutable` to some generators in
`age/graphs/digraph_generators.py`.

This is straightforward for most of them, except for `RandomTournament`
where we use `getrandbits` rather than repeated calls to `random()`.
This is similar to what is done in method
`Graph(...).random_orientation()`.

This PR is motivated by discussions in sagemath#39177.

### 📝 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.
- [ ] 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#39264
Reported by: David Coudert
Reviewer(s): Frédéric Chapoton
@dcoudert dcoudert mentioned this issue Jan 11, 2025
Merged
5 tasks
vbraun pushed a commit to vbraun/sage that referenced this issue Jan 12, 2025
sagemathgh-39264: add parameter immutable to generators in `sage/grap…
484252b 
…hs/digraph_generators.py` (part 1)

    
We add parameter `immutable` to some generators in
`age/graphs/digraph_generators.py`.

This is straightforward for most of them, except for `RandomTournament`
where we use `getrandbits` rather than repeated calls to `random()`.
This is similar to what is done in method
`Graph(...).random_orientation()`.

This PR is motivated by discussions in sagemath#39177.

### 📝 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.
- [ ] 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#39264
Reported by: David Coudert
Reviewer(s): Frédéric Chapoton
vbraun pushed a commit to vbraun/sage that referenced this issue Jan 16, 2025
sagemathgh-39264: add parameter immutable to generators in `sage/grap…
89ddeb0 
…hs/digraph_generators.py` (part 1)

    
We add parameter `immutable` to some generators in
`age/graphs/digraph_generators.py`.

This is straightforward for most of them, except for `RandomTournament`
where we use `getrandbits` rather than repeated calls to `random()`.
This is similar to what is done in method
`Graph(...).random_orientation()`.

This PR is motivated by discussions in sagemath#39177.

### 📝 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.
- [ ] 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#39264
Reported by: David Coudert
Reviewer(s): Frédéric Chapoton
vbraun pushed a commit to vbraun/sage that referenced this issue Jan 17, 2025
sagemathgh-39264: add parameter immutable to generators in `sage/grap…
dea7824 
…hs/digraph_generators.py` (part 1)

    
We add parameter `immutable` to some generators in
`age/graphs/digraph_generators.py`.

This is straightforward for most of them, except for `RandomTournament`
where we use `getrandbits` rather than repeated calls to `random()`.
This is similar to what is done in method
`Graph(...).random_orientation()`.

This PR is motivated by discussions in sagemath#39177.

### 📝 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.
- [ ] 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#39264
Reported by: David Coudert
Reviewer(s): Frédéric Chapoton
vbraun pushed a commit to vbraun/sage that referenced this issue Jan 20, 2025
sagemathgh-39247: add parameter immutable to generators in `src/sage/…
a031748 
…graphs/graph_generators.py`

    
We add parameter `immutable` to all generators in
`src/sage/graphs/graph_generators.py`.

As suggested in sagemath#39177, all methods creating and returning a graph
should offer the option to get an immutable 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#39247
Reported by: David Coudert
Reviewer(s): Frédéric Chapoton
vbraun pushed a commit to vbraun/sage that referenced this issue Jan 20, 2025
sagemathgh-39317: add parameter immutable to all methods in `sage/gra…
e9b4ec7 
…phs/generators/basic.py`

    
Following discussions in sagemath#39177, we add parameter `immutable` to all
methods in `sage/graphs/generators/basic.py`.
We also add parameter `name` to some methods to ease constructions.

### 📝 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#39317
Reported by: David Coudert
Reviewer(s): Dima Pasechnik
vbraun pushed a commit to vbraun/sage that referenced this issue Jan 23, 2025
sagemathgh-39247: add parameter immutable to generators in `src/sage/…
15d6073 
…graphs/graph_generators.py`

    
We add parameter `immutable` to all generators in
`src/sage/graphs/graph_generators.py`.

As suggested in sagemath#39177, all methods creating and returning a graph
should offer the option to get an immutable 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#39247
Reported by: David Coudert
Reviewer(s): Frédéric Chapoton
vbraun pushed a commit to vbraun/sage that referenced this issue Jan 23, 2025
sagemathgh-39317: add parameter immutable to all methods in `sage/gra…
1413622 
…phs/generators/basic.py`

    
Following discussions in sagemath#39177, we add parameter `immutable` to all
methods in `sage/graphs/generators/basic.py`.
We also add parameter `name` to some methods to ease constructions.

### 📝 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#39317
Reported by: David Coudert
Reviewer(s): Dima Pasechnik
vbraun pushed a commit to vbraun/sage that referenced this issue Jan 25, 2025
sagemathgh-39247: add parameter immutable to generators in `src/sage/…
b7bbbc7 
…graphs/graph_generators.py`

    
We add parameter `immutable` to all generators in
`src/sage/graphs/graph_generators.py`.

As suggested in sagemath#39177, all methods creating and returning a graph
should offer the option to get an immutable 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#39247
Reported by: David Coudert
Reviewer(s): Frédéric Chapoton
vbraun pushed a commit to vbraun/sage that referenced this issue Jan 25, 2025
sagemathgh-39317: add parameter immutable to all methods in `sage/gra…
6a5d2ec 
…phs/generators/basic.py`

    
Following discussions in sagemath#39177, we add parameter `immutable` to all
methods in `sage/graphs/generators/basic.py`.
We also add parameter `name` to some methods to ease constructions.

### 📝 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#39317
Reported by: David Coudert
Reviewer(s): Dima Pasechnik
vbraun pushed a commit to vbraun/sage that referenced this issue Jan 26, 2025
sagemathgh-39247: add parameter immutable to generators in `src/sage/…
88bc18e 
…graphs/graph_generators.py`

    
We add parameter `immutable` to all generators in
`src/sage/graphs/graph_generators.py`.

As suggested in sagemath#39177, all methods creating and returning a graph
should offer the option to get an immutable 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#39247
Reported by: David Coudert
Reviewer(s): Frédéric Chapoton
vbraun pushed a commit to vbraun/sage that referenced this issue Jan 26, 2025
sagemathgh-39317: add parameter immutable to all methods in `sage/gra…
0a483f1 
…phs/generators/basic.py`

    
Following discussions in sagemath#39177, we add parameter `immutable` to all
methods in `sage/graphs/generators/basic.py`.
We also add parameter `name` to some methods to ease constructions.

### 📝 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#39317
Reported by: David Coudert
Reviewer(s): Dima Pasechnik
vbraun pushed a commit to vbraun/sage that referenced this issue Jan 28, 2025
sagemathgh-39285: add parameter immutable to some graph products in…
e61f9b8 
… `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 issue Jan 29, 2025
sagemathgh-39285: add parameter immutable to some graph products in…
bdf44ff 
… `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 issue Jan 30, 2025
sagemathgh-39285: add parameter immutable to some graph products in…
d261bfe 
… `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 issue Jan 31, 2025
sagemathgh-39285: add parameter immutable to some graph products in…
af6adb9 
… `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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
c: graph theory t: enhancement
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Added immutable keyword argument to canonical_form function kaneki003/sage
2 participants
@maxale @dcoudert