Skip to content

Document in-place complex magnitude support - #335

Open
sylvesterkaczmarek wants to merge 1 commit into
ARM-software:mainfrom
sylvesterkaczmarek:docs/complex-magnitude-in-place-110
Open

Document in-place complex magnitude support#335
sylvesterkaczmarek wants to merge 1 commit into
ARM-software:mainfrom
sylvesterkaczmarek:docs/complex-magnitude-in-place-110

Conversation

@sylvesterkaczmarek

Copy link
Copy Markdown

Summary

  • document that complex magnitude functions support identical source and destination buffers
  • state that in-place operation writes the magnitude results over the first numSamples input elements
  • place the guarantee in the shared complex magnitude group documentation so it covers every supported data type

Context

The maintainer confirmed in #110 that complex magnitude can be processed in place, but the public documentation does not state this. The missing guarantee can cause callers to allocate an unnecessary output buffer.

This addresses the confirmed complex-magnitude portion of #110. It does not make any claim about the filtering functions discussed in that issue.

Validation

  • git diff --check
  • compiled the f16, f32, f64, q15, fast q15, and q31 scalar implementations with GCC 13.3.0 and -Wall -Wextra -Werror
  • ran each implementation with separate buffers and with pSrc == pDst in plain scalar and loop-unrolled builds; all five-sample outputs matched byte for byte
  • inspected the current NEON and MVE branches to confirm that input blocks are loaded before overlapping output elements are written

Documentation-only change. The full repository test suite was not run.

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