Clarify the correlation output layout - #333
Open
sylvesterkaczmarek wants to merge 1 commit into
Open
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.
Summary
srcALen + srcBLen - 1correlation values from the larger zero-padded destination bufferContext
The correlation implementations intentionally use a destination length of
2 * max(srcALen, srcBLen) - 1. The existing group documentation describes that entire buffer as the correlation result, but does not show where the actual correlation values are located when the input lengths differ.This change documents the existing layout without changing the implementation or API.
Fixes #120.
Validation
git diff --checkarm_correlate_f32.cpath with GCC 13.3.0 and-Wall -Wextra -Werror, using minimal test-only stubs for the external CMSIS Core headersDocumentation-only change. The repository test suite was not run.