JuliaGraphs / JuliaGraphs/Graphs.jl
Vertex mapping for all functions that return a subgraph
Nobody has claimed this yet.
- Dominant language
- Julia
- Stars
- 538
- Forks
- 128
- Avg merge
- 10h 25m
- Merged PRs (30d)
- 2
Description
[!WARNING]
This is still a draft, the bounty has no legal value yet.
As recently pointed out on Discourse, some functions such as steiner_stree return a subgraph without remembering which vertices from the original graph were selected. The original graph might have had vertices 1:N and the subgraph 1:n, but no mapping 1:n -> 1:N is provided.
This contrasts with functions like induced_subgraph which do return this mapping.
It would be nice to write down an exhaustive list of every subgraph-returning function in Graphs.jl, and make sure that each of them has a method/alternative that allows mapping back into the original graph.
The bounty completion requires API implementation, documentation (potentially also including good See also entries and a dedicated page), and testing.
Required skills: Some familiarity with the average julia package-dev process.
Reviewer: @gdalle or members of the JuliaGraphs community
Duration: 1 month (except potential review overhead)
Payout procedure (for this particular bounty program):
The Funding for these bounties comes from the National Science Foundation and from the NSF Center for Quantum Networks. The payouts are managed by the NumFOCUS foundation and processed in bulk once every two months. If you live in a country in which NumFOCUS can make payments, you can participate in this bounty program.
Click here for more details about the bug bounty program.
Bug bounty logistic details (click to expand)
To claim exclusive time to work on this bounty either post a comment here or message skrastanov@umass.edu with:
- your name
- github username
- (optional) a brief list of previous pertinent projects you have engaged in
Currently the project is claimed by no one until ....
If you want to, you can work on this project without making a claim, however claims are encouraged to give you and other contributors peace of mind. Whoever has made a claim takes precedence when solutions are considered.
You can always propose your own funded project, if you would like to contribute something of value that is not yet covered by an official bounty.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing steiner_tree and induced_subgraph, then inventory the other Graphs.jl functions that return subgraphs and determine how each can preserve a mapping to the original graph. Done means the relevant APIs, documentation and tests cover the complete list of subgraph-returning functions and their vertex mappings.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- julia
- Domain
- backend-api-design, data, documentation, testing
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 30/100