1 unstable release
0.0.1 | Dec 23, 2022 |
---|
#10 in #reconstruction
16KB
polyrec
polyrec is a polynomial reconstruction library, blazing fast ⚡and written in Rust 🦀
Report a Bug - Request a Feature - Ask a QuestionTable of Contents
Report a bug
If you find a bug, please open a GitHub issue!
Request a feature
To request a new feature, please open an issue following this template.
About
polyrec: a polynomial reconstruction library, blazing fast ⚡and written in Rust 🦀
Built With
Getting Started
Prerequisites
Rust
The project requires nightly rustup:
rustup toolchain install nightly
rustup default nightly
Installation
polyrecup
To install with polyrecup
run (polyrecup requires nightly rustup):
curl -sL https://raw.githubusercontent.com/abdelhamidbakhta/polyrec-rs/main/polyrecup | sh
Build from source
cargo build --all --release
The binaries will be located in target/release/
.
Usage
Command line interface
// TODO: add cli usage
Performance
Benchmarks
Run the benchmarks with:
cargo bench
Roadmap
See the open issues for a list of proposed features (and known issues).
- Top Feature Requests (Add your votes using the 👍 reaction)
- Top Bugs (Add your votes using the 👍 reaction)
- Newest Bugs
Support
Reach out to the maintainer at one of the following places:
- GitHub Discussions
- Contact options listed on this GitHub profile
Project assistance
If you want to say thank you or/and support active development of polyrec:
- Add a GitHub Star to the project.
- Tweet about the polyrec.
- Write interesting articles about the project on Dev.to, Medium or your personal blog.
Together, we can make polyrec better!
Contributing
First off, thanks for taking the time to contribute! Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make will benefit everybody else and are greatly appreciated.
Please read our contribution guidelines, and thank you for being involved!
Authors & contributors
For a full list of all authors and contributors, see the contributors page.
Security
polyrec follows good practices of security, but 100% security cannot be assured. polyrec is provided "as is" without any warranty. Use at your own risk.
For more information and to report security issues, please refer to our security documentation.
License
This project is licensed under the MIT license.
See LICENSE for more information.