Usage as a rust library

[ecstrema]

Hello!

Fantastic implementation you have here!

Are there any plans to make this usable as a library? Instead of using the command line, I would like to use it from another rust project.

Thanks again!

[JeroenGar]

Hi Remi,

Thank you for the kind words!
As I am currently in the final stages of my PhD, I do not have time at the moment to make a "clean" interface to use sparrow as a library.

However, if you look at the code inside main.rs, the high-level flow is not that difficult to comprehend.
This projects builds on jagua-rs, which is a properly documented library.
Basically the following is happening:

1. Parse a problem instance (typically in JSON format) to a ExtSPInstance (jagua-rs)
2. Create a Importer to convert it to an internal SPInstance (jagua-rs)
3. Optimize the problem and retrieve a SPSolution (sparrow)
4. Use jagua-rs to convert the (internal) SPSolution to an ExtSPSSolution (jagua-rs)
5. Now you have a valid solution matching the original input, which you can easily serialize.

If are experienced in Rust and would be interested to contribute, I fully welcome contributions to enable using sparrow as a Rust library!

FYI: there is a project ongoing to create a python library/wrapper called spyrrow, everything is still very early stages though.

Best,
Jeroen

[ecstrema]

Thanks for your answer! I'll try to have a look, though I haven't played much with Rust lately...

Good luck with you phd!