Staging 0.5.0

[wizenink]

No description provided.

[gemini-code-assist]

Summary of Changes

Hello @wizenink, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request significantly enhances the stft-rs library by introducing no_std compatibility, making it suitable for a broader range of applications, particularly in embedded systems. It achieves this by implementing an FFT backend abstraction, allowing flexible choice between rustfft for full-featured standard library usage and microfft for resource-constrained no_std environments. The changes also include comprehensive testing and documentation updates to support the new functionality.

Highlights

• no_std Support: The library now supports no_std environments, enabling its use on embedded systems and other contexts without the standard library.
• Dual FFT Backends: An abstraction layer has been introduced for FFT implementations, allowing users to choose between rustfft (default for std environments) and microfft (lightweight for no_std, f32 only, power-of-2 sizes) via feature flags.
• Version Bump: The library version has been updated to 0.5.0 to reflect these significant changes.
• Backend Comparison Example and Script: A new example (backend_comparison.rs) and a shell script (compare_backends.sh) have been added to demonstrate and verify the numerical equivalence of the rustfft and microfft backends for f32 processing.
• Dedicated no_std Test Project: A new no_std_test project has been added to ensure the library functions correctly in a no_std environment, including custom memory allocation and panic handling.

Ignored Files

• Ignored by pattern: .github/workflows/** (1)
  • .github/workflows/rust.yml

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request introduces a major and well-executed refactoring to add no_std support to the library, bumping the version to 0.5.0. The core of this change is a new fft_backend.rs module that abstracts away the FFT implementation, allowing the use of microfft for no_std environments and rustfft for std. This is managed through a clean feature flag system. The changes are extensive, touching most of the library to use core instead of std and the new backend abstraction. The addition of a no_std test crate and a backend comparison example with an accompanying script is excellent for ensuring correctness and quality.

My review includes a few suggestions for improvement, mainly concerning documentation accuracy in the README, using more idiomatic Rust for finding min/max values in the new example, and replacing manual memory function implementations in the no_std test with more efficient core::ptr equivalents. Overall, this is a high-quality contribution that significantly expands the library's usability.