Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Geolm authored Jan 19, 2024
1 parent 19f137b commit 210c1f8
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,25 @@
# math_intrinsics
One header file library that implement of missing transcendental math functions (cos, sin, acos, and more....) using 100% AVX/Neon instructions (no branching)

### unit tests build status
[![Build Status](https://github.com/geolm/math_intrinsics/actions/workflows/build.yml/badge.svg)](https://github.com/geolm/math_intrinsics/actions)

# why?
AVX and Neon intrinsics don't provide transcendental math functions. Of course there are already some libraries with those functions but there are usually not free, restricted to one tpe of hardware or with low precision. This library is super easy to integrate, with a precision close to the C math library (see below) and with MIT license.

# how to

It's one-header lib, just define the macro once and include the header
It's one-header lib, just define the macro once and include the header.

```C
#define __MATH__INTRINSICS__IMPLEMENTATION__
#include "math_intrinsics.h"
```

On intel/AMD computer, you need to compile with -mavx2. You can add also -mfma

On ARM based computer nothing required as the lib is for AArch64

# functions

```C
Expand Down

0 comments on commit 210c1f8

Please sign in to comment.