From 210c1f8cd15b07e5f7860695d7decaff3baf6108 Mon Sep 17 00:00:00 2001 From: Geolm Date: Fri, 19 Jan 2024 09:59:20 -0500 Subject: [PATCH] Update README.md --- README.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 66c0a39..2bbe2da 100644 --- a/README.md +++ b/README.md @@ -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