std.math.complex: add imaginary unit, other breaking changes, etc. #25115
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.
New imaginary unit
Previously, users had to manually define the imaginary unit when working with complex numbers, like this:
const i: Complex(T) = .init(0, 1);
.For instance, what used to look like:
Can now be written more cleanly as:
or:
(don't forget that you can actually use
mulByI
).This PR includes addition of a built-in imaginary unit constant to
Complex(T)
, which simplifies things a bit.Others
Changes
Complex(T).mulByMinusI
is added -- this will multiplies -i to a complex number.Breaking Changes
These renames are for consistency with other naming conventions:
Complex(T).conjugate
has been renamed toComplex(T).conj
.Complex(T).mulbyi
has been renamed toComplex(T).mulByI
.Complex(T).reciprocal
has been renamed toComplex(T).recip
.Other breaking changes:
std.math.complex.conj
has been removed. UseComplex(T).conj
instead.