Skip to content

docs: update README for the DspSample genericization - #17

Merged
leftger merged 1 commit into
masterfrom
docs/readme-generic-dsp-sample-update
Sep 14, 2026
Merged

leftger merged 1 commit into
masterfrom
docs/readme-generic-dsp-sample-update

Conversation

@leftger

@leftger leftger commented Sep 14, 2026

Copy link
Copy Markdown
Owner

Summary

  • Updates the coverage-floor claim in Highlights from 97% to 96%, matching the COVERAGE_MIN change made in ci.yml/codecov.yml in refactor: complete the sample-generic stages plan (Stages 3-6) #15.
  • Notes that filters, PID, Hilbert transform, CFFT/BFP, and complex-math are now implemented once as generic DspSample code (bit-exact verified against the per-width kernels they replace), with the old F32/Q15/Q31 names kept as type aliases.
  • Updates the Hilbert Transform module-overview entry to reference the new generic HilbertTransform<T>.
  • Tightens the idsp comparison section's prose notes (CORDIC modes, Major) for length, without dropping any of the technical claims.

Test plan

  • Docs-only change; no code paths affected.

Reflect the sample-generic refactor (filters, PID, Hilbert transform,
CFFT/BFP, complex-math now implemented once over DspSample, with old
per-width names kept as aliases), correct the coverage floor claim
from 97% to the current 96%, and tighten the idsp comparison section's
prose notes.
@codecov

codecov Bot commented Sep 14, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@leftger
leftger merged commit 175f5a9 into master Sep 14, 2026
20 of 21 checks passed
@leftger
leftger deleted the docs/readme-generic-dsp-sample-update branch September 14, 2026 04:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant