Document in-place matrix addition, subtraction, and scaling - #337
Open
sylvesterkaczmarek wants to merge 1 commit into
Open
Document in-place matrix addition, subtraction, and scaling#337sylvesterkaczmarek 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.
Summary
Context
Issue #44 asks which matrix operations support in-place use and notes that the behavior is absent from the documentation. A maintainer confirmed that operations such as scaling and addition support it and that the documentation should be improved.
The current addition, subtraction, and scaling implementations read each input element or vector block before writing the corresponding output. This permits exact destination aliasing for the available f16, f32, f64, q15, and q31 variants without changing their APIs or implementations.
This addresses #44.
Validation
git diff --check-Wall -Wextra -Werror,ARM_MATH_MATRIX_CHECK, and configurations both with and withoutARM_MATH_LOOPUNROLLDocumentation-only change. The full repository test suite was not run.