Repository navigation
Clarify ComplexNumber |z| vs |z|² naming (abs / absSquared) - #27
Merged
Merged
Conversation
Rename getMagnitude to abs and magnitude to absSquared so callers can tell the Euclidean modulus from its square. Keep the old names as deprecated 2.1 aliases for published and downstream callers, and point reciprocal at absSquared. Co-authored-by: Barry G Becker <barrybecker4@yahoo.com>
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.
Fixes #18
ComplexNumberhad two easy-to-confuse operations:magnitudereturned|z|², whilegetMagnitudereturned|z|. Callers could not tell which was which from the names.API change
abs— Euclidean modulus|z| = sqrt(real² + imaginary²)(overflow-safe viahypot)absSquared— squared modulus|z|² = real² + imaginary²(used byreciprocal)Deprecated aliases keep published and downstream callers compiling:
getMagnitude→absmagnitude→absSquaredIn-repo tests and call sites now use the clearer names. Names were chosen after checking this repo and bb4 consumers: the only external use found was
getMagnitudeinbb4-simulations(EscapeIteration), which continues to work via the deprecated alias.