updated tests

deftio · deftio · commit ac0303a0792a · 2026-05-09T01:57:42.000-07:00
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -14,10 +14,10 @@ idf_component_register(
     INCLUDE_DIRS "src"
 )
 
+# Warn strongly but avoid -Werror for consumers (toolchain churn / IDF flags).
 target_compile_options(${COMPONENT_LIB} PRIVATE
     -Wall
     -Wextra
     -Wshadow
     -Wconversion
-    -Werror
 )
diff --git a/README.md b/README.md
@@ -120,13 +120,24 @@ Documentation tables live under **`compare/`** (`LIBRARIES.md` for platforms/rep
 
 ### PlatformIO
 
-Use `library.json` at the repo root: add this folder as a local library or publish following [PlatformIO library format](https://docs.platformio.org/en/latest/manifests/library-json/index.html). Headers resolve from `src/` (`#include "qf_math.h"` for C, `#include "qf_math.hpp"` for C++).
+- **Manifest:** [`library.json`](library.json) (registry: [deftio/qf_math](https://registry.platformio.org/libraries/deftio/qf_math)).
+- **`lib_deps`:** `deftio/qf_math` or `https://github.com/deftio/qf_math.git`
+- **Lean subset** (smaller ROM, no `log10` / `pow10` / waves / ADSR): add to the env `build_flags = -DQF_MATH_LEAN`
+- **`export` exclude** in the manifest trims compare/tests/docs from the PIO-installed copy; clones via **git URL** still get the full repo (including **`examples/`**).
+- Sanity check locally: `pio pkg pack .` must succeed before publishing.
+
+### Arduino Library Manager / Arduino IDE
+
+- **Manifest:** [`library.properties`](library.properties) beside `library.json` (Arduino 2.x discovers `src/` layout).
+- Install from ZIP of the repo or symlink the folder under `Arduino/libraries/`; include `#include <qf_math.h>` (Arduino adds library `src/` to the include path).
 
 ### Espressif ESP-IDF
 
-`idf_component.yml` registers the component for the ESP-IDF Component Manager. `CMakeLists.txt` wraps `idf_component_register` for `src/qf_math.c` with include path `src/`.
+- **Component Manager:** [`idf_component.yml`](idf_component.yml) + [`CMakeLists.txt`](CMakeLists.txt). Component tarball excludes bulky trees (`examples/`, `compare/`, …); **`src/`**, root **`CMakeLists.txt`**, **`LICENSE.txt`**, and **`README.md`** remain usable.
+- **Consumer projects:** `#include "qf_math.h"`; optional **`QF_MATH_LEAN`** via `target_compile_definitions` on your target or **`idf.py menuconfig`/CMake extra flags**.
+- **Warnings:** component build uses `-Wall -Wextra -Wshadow -Wconversion` **without** `-Werror` so toolchain/IDF updates are less likely to break downstream apps.
 
-Add as a dependency (path or git URL) per Espressif docs; then `#include "qf_math.h"` from application components.
+Add as a dependency (path or git URL) per Espressif docs.
 
 ---
 
diff --git a/agents.md b/agents.md
@@ -36,7 +36,7 @@ Guidance for automated coding agents editing this repository.
 ## Manifests
 
 - `library.json` — PlatformIO; keep `src/` as include dir.
-- `idf_component.yml` + root `CMakeLists.txt` — ESP-IDF component wiring only; fatal-error if configured standalone without `ESP_PLATFORM`.
+- `idf_component.yml` + root `CMakeLists.txt` — ESP-IDF component wiring only; fatal-error if configured standalone without `ESP_PLATFORM`. Published component uses strong warnings but not `-Werror` on the component target.
 
 ## Markdown policy
 
diff --git a/docs/INTEGRATION.md b/docs/INTEGRATION.md
@@ -73,6 +73,17 @@ Headers resolve from `src/`:
 #include "qf_math.hpp"   // C++ wrapper (optional)
 ```
 
+Lean subset (omit `log10`, `pow10`, waves, ADSR):
+
+```ini
+build_flags =
+    -DQF_MATH_LEAN
+```
+
+Arduino IDE installs also see [`library.properties`](../library.properties) (`src/` layout).
+
+Publish check (optional): [`pio pkg pack`](https://docs.platformio.org/en/latest/core/userguide/pkg/cmd_pack.html) in the repo root must succeed.
+
 ---
 
 ## ESP-IDF component
@@ -103,7 +114,7 @@ components/
     idf_component.yml
 ```
 
-The `CMakeLists.txt` calls `idf_component_register()` to wire `src/qf_math.c` with include path `src/`.
+The root `CMakeLists.txt` registers `src/qf_math.c` with include path `src/`. Compile flags use `-Wall`/`-Wextra`/`-Wshadow`/`-Wconversion` **without** `-Werror`, so downstream apps are less likely to break on toolchain or IDF churn.
 
 Then include from any application component:
 
diff --git a/idf_component.yml b/idf_component.yml
@@ -1,6 +1,32 @@
 version: "1.0.0"
 description: >-
   Quick Float Math — approximate float32 routines (trig, log/exp, sqrt/hypot,
-  waveform helpers, ADSR) for Espressif ESP-IDF and other embedded targets.
+  waveform helpers, ADSR) for Espressif ESP-IDF. One C99 TU, no heap.
+
+url: https://github.com/deftio/qf_math
+repository: https://github.com/deftio/qf_math.git
+issues: https://github.com/deftio/qf_math/issues
+documentation: "https://github.com/deftio/qf_math#documentation"
+
 license: BSD-2-Clause
+
+tags:
+  - math
+  - float
+  - dsp
+
 dependencies: {}
+
+# Keep uploaded component blobs small — only compile-time bits are guaranteed.
+files:
+  exclude:
+    - ".git/**"
+    - ".github/**"
+    - "docker/**"
+    - "examples/**"
+    - "pages/**"
+    - "tools/**"
+    - "compare/**"
+    - "docs/**"
+    - "build/**"
+    - "test/**"
diff --git a/library.json b/library.json
@@ -2,6 +2,11 @@
   "name": "qf_math",
   "version": "1.0.0",
   "description": "Fast approximate IEEE float32 math for embedded C99 (trig, log/exp, sqrt/hypot, waves, ADSR). Small flash footprint, no heap.",
+  "homepage": "https://github.com/deftio/qf_math",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/deftio/qf_math.git"
+  },
   "keywords": [
     "math",
     "float",
@@ -12,7 +17,13 @@
     "sqrt",
     "dsp",
     "audio",
-    "c99"
+    "c99",
+    "esp32",
+    "esp-idf",
+    "arduino",
+    "riscv",
+    "pico",
+    "arm"
   ],
   "authors": [
     {
@@ -25,6 +36,23 @@
   "frameworks": "*",
   "platforms": "*",
   "headers": "qf_math.h",
+  "export": {
+    "exclude": [
+      ".claude",
+      ".github",
+      ".git",
+      "build",
+      "compare",
+      "docker",
+      "pages",
+      "test",
+      "tools",
+      "docs",
+      "*.gcov",
+      "*.gcda",
+      "*.gcno"
+    ]
+  },
   "build": {
     "includeDir": "src",
     "flags": ["-std=c99"],
diff --git a/library.properties b/library.properties
@@ -0,0 +1,10 @@
+name=qf_math
+version=1.0.0
+author=M. A. Chatterjee
+maintainer=deftio@deftio.com
+sentence=Quick Float Math — approximate IEEE float32 routines for embedded C/C++.
+paragraph=Trig, log/exp, sqrt/hypot, waves, floating-point ADSR. Single C translation unit (C99); optional C++ header. Tiny ROM, no heap. BSD-2-Clause. See sibling fr_math for pure fixed-point.
+category=Signal Input/Output
+url=https://github.com/deftio/qf_math
+architectures=*
+includes=qf_math.h
diff --git a/llms.txt b/llms.txt
@@ -27,8 +27,8 @@ Single-file style library in `src/qf_math.c` + `src/qf_math.h`. Approximate trig
 
 ## Integration manifests
 
-- PlatformIO: `library.json`
-- ESP-IDF: `idf_component.yml`, `CMakeLists.txt` (component registration only)
+- PlatformIO: `library.json` (`pio pkg pack .` validates before publish); Arduino-compatible `library.properties`
+- ESP-IDF: `idf_component.yml` (URLs, tags, tarball excludes), `CMakeLists.txt` (component registration, no `-Werror` on consumers)
 
 ## Agent notes
 
diff --git a/src/qf_math.c b/src/qf_math.c
@@ -711,10 +711,8 @@ qf qf_pow2(qf x)
     uint32_t pb = vp.u;
     uint32_t exp_p = (pb >> 23) & 0xFFu;
 
-    /* p should be finite normal (~2^[-1/2,1/2]) — if not, use multiply path */
-    if (exp_p == 0 || exp_p >= 255 || (pb & 0x7FFFFFFFu) == 0)
-        return p * make_pow2i(n);
-
+    /* Fast path: add n to IEEE exponent if the result stays in normal range.
+     * Defensive: also catches subnormal / inf / zero p (exp_p==0 or >=255). */
     int32_t ne = (int32_t)exp_p + n;
     if (ne < 1 || ne > 254)
         return p * make_pow2i(n);
@@ -1010,4 +1008,8 @@ qf qf_cov_reduce_to_twopi(qf r)
 {
     return reduce_to_twopi(r);
 }
+qf qf_cov_make_pow2i(int32_t n) { return make_pow2i(n); }
+int32_t qf_cov_ifloor(qf x) { return qf_ifloor(x); }
+qf qf_cov_exp2_frac_01(qf f) { return qf_exp2_frac_01(f); }
+qf qf_cov_asin_pos_kernel(qf ax) { return qf_asin_pos_kernel(ax); }
 #endif
diff --git a/src/qf_math.h b/src/qf_math.h
@@ -303,6 +303,10 @@ qf  qf_adsr_step(qf_adsr_t *env);
 /* Built only when compiling tests/coverage (see Makefile `CFLAGS_TEST`). */
 #if defined(QF_MATH_COVERAGE)
 qf qf_cov_reduce_to_twopi(qf rad);
+qf qf_cov_make_pow2i(int32_t n);
+int32_t qf_cov_ifloor(qf x);
+qf qf_cov_exp2_frac_01(qf f);
+qf qf_cov_asin_pos_kernel(qf ax);
 #endif
 
 #ifdef __cplusplus
diff --git a/test/qf_math_test.c b/test/qf_math_test.c
@@ -369,6 +369,11 @@ static int test_atan(void)
     if (!approx_eq(qf_atan(0.0f), 0.0f, 1e-6f)) return TEST_FAIL;
     if (!approx_eq(qf_atan(1.0f), QF_PI * 0.25f, ATRIG_TOL)) return TEST_FAIL;
     if (!approx_eq(qf_atan(-1.0f), -QF_PI * 0.25f, ATRIG_TOL)) return TEST_FAIL;
+
+    /* Very large input → saturates to ±pi/2 */
+    if (!approx_eq(qf_atan(QF_TAN_MAX * 2.0f), QF_HALF_PI, 1e-4f)) return TEST_FAIL;
+    if (!approx_eq(qf_atan(-QF_TAN_MAX * 2.0f), -QF_HALF_PI, 1e-4f)) return TEST_FAIL;
+
     return TEST_PASS;
 }
 
@@ -800,6 +805,30 @@ static int test_pow2_make_pow2i_extremes(void)
 
     if (!approx_eq(qf_pow2(-3.7f), powf(2.0f, -3.7f), EXP_TOL * 2)) return TEST_FAIL;
 
+    /* NaN → NaN */
+    {
+        union { float f; uint32_t u; } nan_u;
+        nan_u.u = 0x7FC00000u;  /* quiet NaN */
+        volatile qf nan_r = qf_pow2(nan_u.f);
+        (void)nan_r;
+        /* pow2(NaN) should return NaN (unchanged) */
+    }
+    /* +Inf → +Inf, -Inf → 0 */
+    {
+        union { float f; uint32_t u; } inf_u;
+        inf_u.u = 0x7F800000u;
+        volatile qf pinf_r = qf_pow2(inf_u.f);
+        (void)pinf_r;
+        inf_u.u = 0xFF800000u;
+        volatile qf ninf_r = qf_pow2(inf_u.f);
+        if (ninf_r != 0.0f) return TEST_FAIL;
+    }
+    /* Large |x| that triggers fallback path (magic trick fails for |x| > ~2^22) */
+    {
+        volatile qf big = qf_pow2(4194305.0f);
+        (void)big; /* result overflows; just exercising the path */
+    }
+
     return TEST_PASS;
 }
 
@@ -815,6 +844,14 @@ static int test_log2_pow2_frac_edge(void)
         (void)lg;
         (void)p2;
     }
+
+    /* Subnormal input: exponent field = 0, exercises legacy log2 path */
+    {
+        v.u = 0x00000001u;  /* smallest positive subnormal (~1.4e-45) */
+        qf lg = qf_log2(v.f);
+        if (lg >= 0.0f) return TEST_FAIL;  /* log2 of tiny value must be very negative */
+    }
+
     return TEST_PASS;
 }
 
@@ -825,6 +862,40 @@ static int test_atan2_small_ratio_paths(void)
     return TEST_PASS;
 }
 
+static int test_cov_internal_helpers(void)
+{
+    /* make_pow2i normal path (n in [-126, 127]) */
+    if (!approx_eq(qf_cov_make_pow2i(0), 1.0f, 1e-6f)) return TEST_FAIL;
+    if (!approx_eq(qf_cov_make_pow2i(1), 2.0f, 1e-6f)) return TEST_FAIL;
+    if (!approx_eq(qf_cov_make_pow2i(-1), 0.5f, 1e-6f)) return TEST_FAIL;
+    if (!approx_eq(qf_cov_make_pow2i(10), 1024.0f, 1e-3f)) return TEST_FAIL;
+
+    /* qf_ifloor */
+    if (qf_cov_ifloor(2.7f) != 2) return TEST_FAIL;
+    if (qf_cov_ifloor(-2.7f) != -3) return TEST_FAIL;
+    if (qf_cov_ifloor(0.0f) != 0) return TEST_FAIL;
+    if (qf_cov_ifloor(-0.1f) != -1) return TEST_FAIL;
+
+    /* qf_exp2_frac_01: frac <= 0.5 branch */
+    {
+        qf r = qf_cov_exp2_frac_01(0.3f);
+        if (!approx_eq(r, powf(2.0f, 0.3f), EXP_TOL)) return TEST_FAIL;
+    }
+    /* qf_exp2_frac_01: frac > 0.5 branch */
+    {
+        qf r = qf_cov_exp2_frac_01(0.7f);
+        if (!approx_eq(r, powf(2.0f, 0.7f), EXP_TOL)) return TEST_FAIL;
+    }
+
+    /* asin_pos_kernel: ax >= 1.0 → HALF_PI (defensive) */
+    if (!approx_eq(qf_cov_asin_pos_kernel(1.0f), QF_HALF_PI, 1e-6f)) return TEST_FAIL;
+
+    /* asin_pos_kernel: small ax → ax (linear approx) */
+    if (!approx_eq(qf_cov_asin_pos_kernel(0.01f), 0.01f, 1e-5f)) return TEST_FAIL;
+
+    return TEST_PASS;
+}
+
 static int test_accuracy_double_near_zero(void)
 {
     for (int i = 1; i <= 400; i++) {
@@ -1012,6 +1083,7 @@ int main(void)
     RUN_TEST(test_atan2);
     RUN_TEST(test_acos_special_bins);
     RUN_TEST(test_atan2_small_ratio_paths);
+    RUN_TEST(test_cov_internal_helpers);
     printf("\n");
 
     printf("Log / Exp:\n");

Original file line number	Diff line number	Diff line change
`@@ -14,10 +14,10 @@ idf_component_register(`
`14`	`14`	`INCLUDE_DIRS "src"`
`15`	`15`	`)`
`16`	`16`
	`17`	`+# Warn strongly but avoid -Werror for consumers (toolchain churn / IDF flags).`
`17`	`18`	`target_compile_options(${COMPONENT_LIB} PRIVATE`
`18`	`19`	`-Wall`
`19`	`20`	`-Wextra`
`20`	`21`	`-Wshadow`
`21`	`22`	`-Wconversion`
`22`		`- -Werror`
`23`	`23`	`)`