polyrec

polyrec is a polynomial reconstruction library, blazing fast ⚡and written in Rust 🦀

Report a Bug - Request a Feature - Ask a Question

[![GitHub Workflow Status](https://github.com/abdelhamidbakhta/polyrec-rs/actions/workflows/test.yml/badge.svg)](https://github.com/abdelhamidbakhta/polyrec-rs/actions/workflows/test.yml) [![Project license](https://img.shields.io/github/license/abdelhamidbakhta/polyrec-rs.svg?style=flat-square)](LICENSE) [![Pull Requests welcome](https://img.shields.io/badge/PRs-welcome-ff69b4.svg?style=flat-square)](https://github.com/abdelhamidbakhta/polyrec-rs/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22)

Table 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:

bash rustup toolchain install nightly rustup default nightly

Installation

polyrecup

To install with polyrecup run (polyrecup requires nightly rustup):

bash curl -sL https://raw.githubusercontent.com/abdelhamidbakhta/polyrec-rs/main/polyrecup | sh

Build from source

bash cargo build --all --release

The binaries will be located in target/release/.

Usage

Command line interface

bash // TODO: add cli usage

Performance

Benchmarks

Run the benchmarks with:

bash cargo bench

Roadmap

See the open issues for a list of proposed features (and known issues).

Support

Reach out to the maintainer at one of the following places:

Project assistance

If you want to say thank you or/and support active development of polyrec:

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.

Acknowledgements