Fix EngineDelay and EngineFilterDelay modulo calculation documentation #4848
Conversation
This file contains 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
This commit adds documentation for the modulo calculation in the EngineDelay::process. The mentioned documentation explains the usage of the addition. The added value is the size of the delay buffer, which is used for the modulo operator as well (as a divisor for division). From a mathematical point of view, this addition can be removed. Anyway, from the cpp point of view, the delay buffer size addition is necessary based on an otherwise negative result using the cpp modulo operator.
This commit adds documentation for the modulo calculation in the EngineFilterDelay::process. The mentioned documentation explains the usage of the addition. The added value is the size of the delay buffer, which is used for the modulo operator as well (as a divisor for division). From a mathematical point of view, this addition can be removed. Anyway, from the cpp point of view, the delay buffer size addition is necessary based on an otherwise negative result using the cpp modulo operator.
Swiftb0y
approved these changes
Jul 9, 2022
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.
Adds documentation for the modulo calculation in the EngineDelay::process and EngineFilterDelay::process.
The mentioned documentation explains the usage of the addition. The added value is the size of the delay buffer, which is used for the modulo operator as well (as a divisor for division). From a mathematical point of view, this addition can be removed.
Anyway, from the cpp point of view, the delay buffer size addition is necessary based on an otherwise negative result using the cpp modulo operator.