Table of Contents
About
Quaireaux is a community maintained standard library for Cairo 1.0. It is a collection of useful algorithms and data structures implemented in Cairo.
Features
Data Structures
Math
- Fibonacci
- Zeller's congruence
- Extended Euclidean Algorithm
- Karatsuba Multiplication Algorithm
- Perfect Number Algorithm
- Armstrong Number Algorithm
- GCD of N numbers
- Aliquot Sum
- Collatz Sequence
Sorting
Getting Started
Prerequisites
Installation
Quaireaux is a Scarb package, which can be installed by adding following line to your Scarb.toml
:
[dependencies]
quaireaux = { git = "https://github.com/keep-starknet-strange/quaireaux.git" }
Usage
Build
make build
Run
make run
Test
make test
Format
make format
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 Quaireaux:
- Add a GitHub Star to the project.
- Tweet about the Quaireaux.
- Write interesting articles about the project on Dev.to, Medium or your personal blog.
Together, we can make Quaireaux 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
Quaireaux follows good practices of security, but 100% security cannot be assured. Quaireaux 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
- TheAlgorithms/Rust for inspiration regarding the implementation of algorithms.
Contributors ✨
Thanks goes to these wonderful people (emoji key):
Abdel @ StarkWare 💻 |
Santiago Galván (Dub) 💻 |
Damián Piñones 💻 |
greged93 💻 |
Marek Kaput 💻 |
amanusk 💻 |
Mathieu 💻 |
0xevolve 💻 |
Jordy Romuald 💻 |
gaetbout 💻 |
||||
Add your contributions |
This project follows the all-contributors specification. Contributions of any kind welcome!