# sleef

**Repository Path**: eydelu/sleef

## Basic Information

- **Project Name**: sleef
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: BSL-1.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-07-05
- **Last Updated**: 2025-07-05

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

== SLEEF - SIMD Library for Evaluating Elementary Functions

image:http://img.shields.io/badge/DOI-10.1109/TPDS.2019.2960333-blue.svg[TPDS, link=https://ieeexplore.ieee.org/document/8936472]

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.

[cols="1,1,1,1,1,1,1,1,1"]
|===
|        2+|Linux            4+|Windows                              2+|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


=== Support status of each vector extension

[cols="1, 1, 1"]
|===
| x86_64 | SSE2 | Experimental support, seeking sponsorship
| x86_64 | AVX2 | Mainline support
| x86_64 | AVX512F | Mainline support
| RISC-V | RVVM1 | Experimental, seeking sponsorship
| RISC-V | RVVM2 | Experimental, seeking sponsorship
| AArch64 | AdvSIMD | Mainline support
| AArch64 | SVE | Unmaintained
| PowerPC | VSX | Experimental, seeking sponsorship
| PowerPC | VSX3 | Experimental, seeking sponsorship
| S390 | VXE | Experimental, seeking sponsorship
| S390 | VXE2 | Experimental, seeking sponsorship
|===

Unmaintained and experimental features may be removed without notice.

Unmaintained features are not tested and may not build correctly.


== 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

https://github.com/shibatch/tlfloat[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.

[arabic]
. Check out the source code from our GitHub repository

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

[arabic, start=2]
. Make a separate directory to create an out-of-source build

....
cd sleef && mkdir build && cd build
....

[arabic, start=3]
. Run cmake to configure the project

....
cmake .. -DCMAKE_INSTALL_PREFIX=../../install
....

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`.

[arabic, start=4]
. Run make to build the project

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

[arabic, start=5]
. Run tests using ctests

....
ctest -j `nproc`
....

For more detailed build instructions please refer to
https://sleef.org/compile.xhtml#preliminaries[our web page].

== How to cross-compile SLEEF

For more detailed please refer to
https://sleef.org/compile.xhtml#cross[cross-compile SLEEF]

== Install SLEEF

=== From source

Assuming following instructions were followed.

[arabic, start=6]
. Install to specified directory `<prefix>`

....
cmake --install .
....

=== 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 link:./LICENSE.txt[LICENSE.txt] or copy at
http://www.boost.org/LICENSE_1_0.txt. Contributions to this project are
accepted under the same license.

SLEEF project aims to serve society as a whole, not just specific
companies or organizations. We charge a fee for maintaining patches
that are convenient only for your company.

The fact that our software is released under an open source license
only means that you can use the current and older versions of the
software for free. If you want us to continue maintaining our
software, you need to financially support our project. Please see
https://github.com/shibatch/nofreelunch?tab=coc-ov-file[CODE_OF_CONDUCT.md].


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