README.adoc

SLEEF - SIMD Library for Evaluating Elementary Functions

SLEEF is a library that implements vectorized versions of C standard math functions. This library also includes DFT subroutines.

• Web Page: https://sleef.org/

• Sources: https://github.com/shibatch/sleef

Supported environment

Test matrix

The following table summarizes currently supported OSes and compilers.

	Linux		Windows				Mac
	gcc	llvm	MSVC	Clang	MinGW	Cygwin	Clang	GCC
x86_64	✔	✔	✔	✔	✔	❓	✔	❓
RISC-V 64	✔	❓	N/A	N/A	N/A	N/A	N/A	N/A
AArch64	✔	✔	❌	❌	❌	❌	✔	❓
POWER	✔	❓	N/A	N/A	N/A	N/A	N/A	N/A
S390X	✔	❓	N/A	N/A	N/A	N/A	N/A	N/A

✔ : Tested on CI, ❓ : Not tested, ❌ : Not supported

How to build SLEEF

The library itself does not have any additional dependency.

In order to build SLEEF, you need CMake 3.18+, and C and C++ compilers of the same version. It is also recommended to have the following tools.

• Ninja

• Git

TLFloat is automatically downloaded if no suitable version is found on your system.

Some tests require:

• libssl and libcrypto, that can be provided by installing openssl.

• libm, libgmp and libmpfr

• libfftw.

The build procedure is as follows.

1. Check out the source code from our GitHub repository

git clone https://github.com/shibatch/sleef

2. Make a separate directory to create an out-of-source build

cd sleef && mkdir build

3. Run cmake to configure the project

cmake -S . -B build

By default this will generate shared libraries. In order to generate static libraries, pass option -DBUILD_SHARED_LIBS=OFF.

For more verbose output add option -DSLEEF_SHOW_CONFIG=ON.

4. Run make to build the project

cmake --build build -j --clean-first

5. Run tests using ctests

ctest --test-dir build -j

For more detailed build instructions please refer to our web page.

How to cross-compile SLEEF

For more detailed please refer to cross-compile SLEEF

Install SLEEF

From source

Assuming following instructions were followed.

6. Install to specified directory <prefix>

cmake --install build --prefix=<prefix>

Uninstall

In order to uninstall SLEEF library and headers run

sudo xargs rm -v < build/install_manifest.txt

License

The software is distributed under the Boost Software License, Version 1.0. See accompanying file LICENSE.txt or copy at http://www.boost.org/LICENSE_1_0.txt. Contributions to this project are accepted under the same license.

The fact that this software is released under an open source license only means that you can use the current version of the software for free. If you want this software to be maintained, you need to financially support the project. Please see CODE_OF_CONDUCT.md.

Copyright © 2010-2025 SLEEF Project, Naoki Shibata and contributors.