std.complex
This module contains the Complex type, which is used to represent complex numbers, along with related mathematical operations and functions. Complex will eventually replace the built-in types cfloat, cdouble, creal, ifloat, idouble, and ireal. Authors:Lars Tandle Kyllingstad, Don Clugston License:
Boost License 1.0 Source:
std/complex.d
- Helper function that returns a complex number with the specified
real and imaginary parts.
If neither re nor im are floating-point numbers, this
function returns a Complex!double. Otherwise, the return type
is deduced using std.traits.CommonType!(R, I).
Examples:
auto c = complex(2.0); static assert (is(typeof(c) == Complex!double)); assert (c.re == 2.0); assert (c.im == 0.0); auto w = complex(2); static assert (is(typeof(w) == Complex!double)); assert (w == c); auto z = complex(1, 3.14L); static assert (is(typeof(z) == Complex!real)); assert (z.re == 1.0L); assert (z.im == 3.14L);
- A complex number parametrised by a type T, which must be either
float, double or real.
- The real part of the number.
- The imaginary part of the number.
- Converts the complex number to a string representation. If a sink delegate is specified, the string is passed to it and this function returns null. Otherwise, this function returns the string representation directly. The output format is controlled via formatSpec, which should consist of a single POSIX format specifier, including the percent (%) character. Note that complex numbers are floating point numbers, so the only valid format characters are 'e', 'f', 'g', 'a', and 's', where 's' gives the default behaviour. Positional parameters are not valid in this context. See the std.format documentation for more information.
- Calculates the absolute value (or modulus) of a complex number.
- Calculates the argument (or phase) of a complex number.
- Returns the complex conjugate of a complex number.
- Constructs a complex number given its absolute value and argument.
- Trigonometric functions.
- Calculates cos(y) + i sin(y).
Note:
expi is included here for convenience and for easy migration of code that uses std.math.expi. Unlike std.math.expi, which uses the x87 fsincos instruction when possible, this function is no faster than calculating cos(y) and sin(y) separately. - Square root.