This is a single-header C++ Library from Ailurus Studio that brings you extra time to admire life instead of coding the same functions again and again.

But try not to forget that with great power comes great responsibility.

Integration

ai.hh is the single header. Install it with simple make install from a release or using one of the package managers below. You need to add

#include <ai>

to the files you want to upgrade with ai.hh functions and set the necessary switches to enable C++11 (e.g., -std=c++11 for GCC and Clang).

Package Managers

If you are using OS X and Homebrew, just type brew tap starobinskii/AiLibrary and brew install AiLibrary and you're set. If you want the bleeding edge rather than the latest release, use brew install AiLibrary --HEAD.

On Linux you can get Homebrew too! See Linuxbrew and use the very same commands to install AiLibrary.

If you are using the Snapcraft, install with ease by typing snap install ailibrary.

Also we are looking forward to add our package to Spack and some other managers.

Documentation

The docs can be found here (created using Doxygen). Do not hesitate to contact us by email dev@ailurus.ru if you have questions.

For changes between versions see the CHANGELOG.md.

Tests

We have found Catch2 pretty useful to test this library. To run the existing tests type ./Scripts/test.sh.

Do not forget to install the library before testing.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

Egor Starobinskii - Initial work - starobinskii
Nikita Mushchak - Fast Fourier transform (FFT) - NikitaMushchak

See also the list of contributors who participated in this project.

License

This project is licensed under the BSD 3-Clause License - see the LICENSE.md file for details