Opened 11 years ago
Closed 11 years ago
#6401 closed Library Submissions (fixed)
BGL: new algorithm
| Reported by: | Owned by: | Jeremiah Willcock | |
|---|---|---|---|
| Milestone: | To Be Determined | Component: | graph |
| Version: | Boost Development Trunk | Severity: | Not Applicable |
| Keywords: | bgl, mrt | Cc: |
Description
I would like to submit a new algorithm for inclusion in the Boost Graph Library. It can be used to search the common spanning trees of two graphs, assuming that the graphs are represented as lists of edges. More details if you are interested. It is currently used within the software QSapecNG (https://sourceforge.net/projects/qsapecng/).
I request to know what is required for submission in support of the algorithm.
Thanks, Michele
Attachments (2)
Change History (12)
comment:1 by , 11 years ago
| Component: | None → graph |
|---|---|
| Owner: | set to |
comment:2 by , 11 years ago
comment:3 by , 11 years ago
Sorry for the late, I was busy.
The implementation is ready, it has been developed (maybe) as boost compliant and it works fine. I'm working on doc and test cases. I would like to submit the proposal during next week.
Can I use doxygen to embed doc into the code? Tell me what's the preferred way.
The algorithm has been released under the GPLv3, with the software QSapecNG. However, there is no problem to release a copy of the algorithm under the Boost License 1.0.
I'm the author of the implementation that I'd like to submit.
Best Regards, Michele
comment:4 by , 11 years ago
Hello, as an attachment (mrt.tar.gz) a first draft of what you asked. Certainly something will be incorrect, please let me know and I will correct as soon as possible. I look forward to hearing from you.
Thanks, Michele Caini
comment:5 by , 11 years ago
This is mostly ready to put in; here are the major things to change:
- Please change the directory structure to match Boost conventions (you do not need to put in Jamfiles).
- BGL algorithms' file names typically spell out the full algorithm names, and have header guards that match the file name (see the other BGL headers).
- There should be an HTML documentation file similar to the ones in
libs/graph/doc. - The test code should use Boost.Test.
comment:7 by , 11 years ago
Hello, as an attachment (boost.tar.gz) a new draft. Please let me know if there is something wrong and I will fix the package as soon as possible. I look forward to hearing from you. Michele
comment:10 by , 11 years ago
| Resolution: | → fixed |
|---|---|
| Status: | new → closed |
To submit a new algorithm, you just need to write the implementation, test case(s), and documentation, and be willing to release those under the Boost license. I can help with code reviews and doing the actual merge into the Boost source tree. You can also start a discussion on one of the Boost mailing lists (
boostorboost-users) about your implementation.