Correct Q31 scalar output saturation documentation - #342
Open
sylvesterkaczmarek wants to merge 1 commit into
Open
Correct Q31 scalar output saturation documentation#342sylvesterkaczmarek wants to merge 1 commit into
sylvesterkaczmarek wants to merge 1 commit into
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Addresses #328
Summary
postShiftarm_mat_cmplx_mult_q31unchanged because its scalar path callsclip_q63_to_q31Context
The affected comments currently promise saturation while the scalar implementations store a shifted accumulator through a plain
q31_tconversion. Issue #175 confirms that non-saturating Q31 behavior is intentional for scalar kernels and also notes that Helium can saturate. The revised wording is therefore explicitly scoped to the scalar implementations.Validation
arm_mat_cmplx_mult_q31exception remains unchangedgit diff --checkThe full CMSIS-DSP test suite was not run because this change only updates Doxygen comments and does not alter compiled code.