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

Created functions to generate random k-tree and partial k-tree graphs #36587

Merged

vbraun merged 17 commits into sagemath:develop from damianbasso:kTreeGenerators

Feb 25, 2024

Contributor

damianbasso commented Oct 30, 2023 •

edited

Loading

Implemented graph generators which produce a random k-tree and a random partial k-tree. The k-tree algorithm first generates a complete graph, before adding vertices one by one, creating a clique utilising random existing vertices and the new vertex. Partial k-trees are generated by producing a k-tree and then randomly removing edges from it.

Previously SageMath lacked a way to generat randomised graphs which have a fixed treewidth value. This provides a methodology to do so .

Addresses #36586

📝 Checklist

The title is concise, informative, and self-explanatory.
The description explains in detail what this PR is about.
I have linked a relevant issue or discussion.
I have created tests covering the changes.
I have updated the documentation accordingly.

dcoudert added the c: graph theory label

Contributor

dcoudert commented Oct 31, 2023

For your information, there is an (old) open issue about generating k-trees #11369.

dcoudert suggested changes

View reviewed changes

Contributor

dcoudert left a comment

Thank you for this contribution. Random k-trees are useful.

I have a few suggestions for improving the code.

src/sage/graphs/generators/random.py Outdated Show resolved Hide resolved

src/sage/graphs/generators/random.py Outdated Show resolved Hide resolved

src/sage/graphs/generators/random.py Outdated Show resolved Hide resolved

src/sage/graphs/generators/random.py Show resolved Hide resolved

src/sage/graphs/generators/random.py Outdated Show resolved Hide resolved

src/sage/graphs/generators/random.py Outdated Show resolved Hide resolved

src/sage/graphs/generators/random.py Outdated Show resolved Hide resolved

src/sage/graphs/generators/random.py Outdated Show resolved Hide resolved

src/sage/graphs/generators/random.py Outdated Show resolved Hide resolved

src/sage/graphs/generators/random.py Outdated Show resolved Hide resolved

Contributor Author

damianbasso commented Nov 1, 2023

Thank you for this contribution. Random k-trees are useful.

I have a few suggestions for improving the code.

Thanks for reviewing @dcoudert. Just added another commit implementing your suggestions.

dcoudert suggested changes

View reviewed changes

Contributor

dcoudert left a comment

a few more suggestions.

src/sage/graphs/generators/random.py Outdated Show resolved Hide resolved

src/sage/graphs/generators/random.py Outdated Show resolved Hide resolved

src/sage/graphs/generators/random.py Outdated Show resolved Hide resolved

src/sage/graphs/generators/random.py Outdated Show resolved Hide resolved

src/sage/graphs/generators/random.py Outdated Show resolved Hide resolved

src/sage/graphs/generators/random.py Outdated Show resolved Hide resolved

Contributor Author

damianbasso commented Nov 2, 2023

a few more suggestions.

Thanks, some good ideas. I've added to the Pull Request

dcoudert reviewed

View reviewed changes

src/sage/graphs/generators/random.py Outdated Show resolved Hide resolved

src/sage/graphs/generators/random.py Outdated Show resolved Hide resolved

damianbasso requested a review from dcoudert

November 9, 2023 03:19

dcoudert suggested changes

View reviewed changes

Contributor

dcoudert left a comment

some details.

src/sage/graphs/generators/random.py Outdated Show resolved Hide resolved

src/sage/graphs/generators/random.py Outdated Show resolved Hide resolved

src/sage/graphs/generators/random.py Outdated Show resolved Hide resolved

damianbasso requested a review from dcoudert

November 11, 2023 09:39

dcoudert approved these changes

View reviewed changes

Contributor

dcoudert left a comment

LGTM.

dcoudert added the s: positive review label

vbraun force-pushed the develop branch from 883e05f to e349b00 Compare

November 12, 2023 16:25

vbraun added the s: needs work label

Member

vbraun commented Dec 3, 2023

[sagemath_doc_html-none] OSError: /home/release/Sage/src/sage/graphs/generators/random.py:docstring of sage.graphs.generators.random.RandomPartialKTree:11: WARNING: Bullet list ends without a blank line; unexpected unindent.

dcoudert suggested changes

View reviewed changes

src/sage/graphs/generators/random.py Outdated Show resolved Hide resolved

dcoudert removed the s: positive review label

dcoudert mentioned this pull request

add interface to nauty's genktreeg #36924

Merged

5 tasks

vbraun pushed a commit to vbraun/sage that referenced this pull request


          sagemathgh-36924: add interface to nauty's genktreeg

1172a7a

    
Nauty has a generator of k-trees. We add an interface to this generator.
This is a complement of sagemath#36587.

### 📝 Checklist

<!-- Put an `x` in all the boxes that apply. -->
<!-- If your change requires a documentation PR, please link it
appropriately -->
<!-- If you're unsure about any of these, don't hesitate to ask. We're
here to help! -->
<!-- Feel free to remove irrelevant items. -->

- [x] The title is concise, informative, and self-explanatory.
- [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 accordingly.

### ⌛ Dependencies

<!-- List all open PRs that this PR logically depends on
- sagemath#12345: short description why this is a dependency
- sagemath#34567: ...
-->

<!-- If you're unsure about any of these, don't hesitate to ask. We're
here to help! -->
    
URL: sagemath#36924
Reported by: David Coudert
Reviewer(s): Matthias Köppe

vbraun pushed a commit to vbraun/sage that referenced this pull request


          sagemathgh-36924: add interface to nauty's genktreeg

980aa72

    
Nauty has a generator of k-trees. We add an interface to this generator.
This is a complement of sagemath#36587.

### 📝 Checklist

<!-- Put an `x` in all the boxes that apply. -->
<!-- If your change requires a documentation PR, please link it
appropriately -->
<!-- If you're unsure about any of these, don't hesitate to ask. We're
here to help! -->
<!-- Feel free to remove irrelevant items. -->

- [x] The title is concise, informative, and self-explanatory.
- [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 accordingly.

### ⌛ Dependencies

<!-- List all open PRs that this PR logically depends on
- sagemath#12345: short description why this is a dependency
- sagemath#34567: ...
-->

<!-- If you're unsure about any of these, don't hesitate to ask. We're
here to help! -->
    
URL: sagemath#36924
Reported by: David Coudert
Reviewer(s): Matthias Köppe

Contributor

dcoudert commented Feb 5, 2024

You should certainly rebase the branch on the last beta to launch all the tests.

damianbasso force-pushed the kTreeGenerators branch 2 times, most recently from e745c71 to 92d5967 Compare

February 6, 2024 05:25

dcoudert suggested changes

View reviewed changes

Contributor

dcoudert left a comment

Some improvements to ensure that the method cannot be called with wrong parameters.

src/sage/graphs/generators/random.py Show resolved Hide resolved

src/sage/graphs/generators/random.py Outdated Show resolved Hide resolved

src/sage/graphs/generators/random.py Show resolved Hide resolved

dcoudert reviewed

View reviewed changes

src/sage/graphs/generators/random.py Outdated Show resolved Hide resolved

dcoudert added s: needs review and removed s: needs work labels

dcoudert suggested changes

View reviewed changes

src/sage/graphs/generators/random.py Outdated Show resolved Hide resolved

dcoudert approved these changes

View reviewed changes

Contributor

dcoudert left a comment

LGTM.

dcoudert removed the s: needs review label

Contributor

dcoudert commented Feb 14, 2024

I don't understand the last 2 commits. Is it due to the last beta release ?

You should certainly rebase the branch on the last beta.

damianbasso force-pushed the kTreeGenerators branch from e4ddcb0 to aabfa65 Compare

February 15, 2024 04:55

damianbasso added 14 commits

February 15, 2024 04:57


          Created functions to generate random k-tree and partial k-trees

1a8561d


          addressed comments on commit #1e8bca1b9f1b14591f9d48a0420da18be739a790

8bec896


          address comments on commit #578a6abb8b121e7543654319d53f685e565268bc

fd16329


          fixed k-tree edge count formula

d1c76e8


          Update code style

ff9d037


          fixed to make style compliant

ae86ffd


          fix linting

858381f


          Updating examples

c390cc1


          fix test

074a178


          Added error checking cases

0cfb682


          fix incorrect disconnected graphs

30e5bb6


          Changed k-tree graph names

911e1c7


          Increase test coverage

7769f1c


          remove unnecessary paramters from tests

f1342ec

damianbasso force-pushed the kTreeGenerators branch from aabfa65 to f1342ec Compare

February 15, 2024 05:02

dcoudert suggested changes

View reviewed changes

src/sage/graphs/generators/random.py Outdated Show resolved Hide resolved


          fixed typo

b4dff90

dcoudert suggested changes

View reviewed changes

src/sage/graphs/generators/random.py Outdated Show resolved Hide resolved

damianbasso added 2 commits

February 15, 2024 09:03


          fix typo

79d0bdd


          fix test

faa737b

dcoudert approved these changes

View reviewed changes

Contributor

dcoudert left a comment

I have no more comments. Thanks.

LGTM.

dcoudert added s: positive review and removed s: needs review labels

vbraun pushed a commit to vbraun/sage that referenced this pull request


          sagemathgh-36587: Created functions to generate random k-tree and par…

5990b75

…tial k-tree graphs

    
<!-- ^^^^^
Please provide a concise, informative and self-explanatory title.
Don't put issue numbers in there, do this in the PR body below.
For example, instead of "Fixes sagemath#1234" use "Introduce new method to
calculate 1+1"
-->
<!-- Describe your changes here in detail -->
Implemented graph generators which produce a random k-tree and a random
partial k-tree. The k-tree algorithm first generates a complete graph,
before adding vertices one by one, creating a clique utilising random
existing vertices and the new vertex. Partial k-trees are generated by
producing a k-tree and then randomly removing edges from it.

<!-- Why is this change required? What problem does it solve? -->
Previously SageMath lacked a way to generat randomised graphs which have
a fixed treewidth value. This provides a methodology to do so .
<!-- If this PR resolves an open issue, please link to it here. For
example "Fixes sagemath#12345". -->
Addresses sagemath#36586
<!-- If your change requires a documentation PR, please link it
appropriately. -->

### 📝 Checklist

<!-- Put an `x` in all the boxes that apply. -->
<!-- If your change requires a documentation PR, please link it
appropriately -->
<!-- If you're unsure about any of these, don't hesitate to ask. We're
here to help! -->
<!-- Feel free to remove irrelevant items. -->

- [x] The title is concise, informative, and self-explanatory.
- [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 accordingly.


<!-- If you're unsure about any of these, don't hesitate to ask. We're
here to help! -->
    
URL: sagemath#36587
Reported by: Damian Basso
Reviewer(s): Damian Basso, David Coudert

vbraun pushed a commit to vbraun/sage that referenced this pull request


          sagemathgh-36587: Created functions to generate random k-tree and par…

…tial k-tree graphs

    
<!-- ^^^^^
Please provide a concise, informative and self-explanatory title.
Don't put issue numbers in there, do this in the PR body below.
For example, instead of "Fixes sagemath#1234" use "Introduce new method to
calculate 1+1"
-->
<!-- Describe your changes here in detail -->
Implemented graph generators which produce a random k-tree and a random
partial k-tree. The k-tree algorithm first generates a complete graph,
before adding vertices one by one, creating a clique utilising random
existing vertices and the new vertex. Partial k-trees are generated by
producing a k-tree and then randomly removing edges from it.

<!-- Why is this change required? What problem does it solve? -->
Previously SageMath lacked a way to generat randomised graphs which have
a fixed treewidth value. This provides a methodology to do so .
<!-- If this PR resolves an open issue, please link to it here. For
example "Fixes sagemath#12345". -->
Addresses sagemath#36586
<!-- If your change requires a documentation PR, please link it
appropriately. -->

### 📝 Checklist

<!-- Put an `x` in all the boxes that apply. -->
<!-- If your change requires a documentation PR, please link it
appropriately -->
<!-- If you're unsure about any of these, don't hesitate to ask. We're
here to help! -->
<!-- Feel free to remove irrelevant items. -->

- [x] The title is concise, informative, and self-explanatory.
- [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 accordingly.


<!-- If you're unsure about any of these, don't hesitate to ask. We're
here to help! -->
    
URL: sagemath#36587
Reported by: Damian Basso
Reviewer(s): Damian Basso, David Coudert

vbraun merged commit 34e5618 into sagemath:develop

4 checks passed

github-actions bot removed the s: positive review label

mkoeppe added this to the sage-10.3 milestone

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

c: graph theory