jon.recoil.org

Module Stdlib.ComplexSource

Complex numbers.

This module provides arithmetic operations on complex numbers. Complex numbers are represented by their real and imaginary parts (cartesian representation). Each part is represented by a double-precision floating-point number (type float).

Sourcetype t = {
  1. re : float;
  2. im : float;
}

The type of complex numbers. re is the real part and im the imaginary part.

Sourceval zero : Stdlib.Complex.t @@ portable

The complex number 0.

Sourceval one : Stdlib.Complex.t @@ portable

The complex number 1.

Sourceval i : Stdlib.Complex.t @@ portable

The complex number i.

Sourceval neg : Stdlib.Complex.t -> Stdlib.Complex.t @@ portable

Unary negation.

Sourceval conj : Stdlib.Complex.t -> Stdlib.Complex.t @@ portable

Conjugate: given the complex x + i.y, returns x - i.y.

Addition

Subtraction

Multiplication

Sourceval inv : Stdlib.Complex.t -> Stdlib.Complex.t @@ portable

Multiplicative inverse (1/z).

Division

Sourceval sqrt : Stdlib.Complex.t -> Stdlib.Complex.t @@ portable

Square root. The result x + i.y is such that x > 0 or x = 0 and y >= 0. This function has a discontinuity along the negative real axis.

Sourceval norm2 : Stdlib.Complex.t -> float @@ portable

Norm squared: given x + i.y, returns x^2 + y^2.

Sourceval norm : Stdlib.Complex.t -> float @@ portable

Norm: given x + i.y, returns sqrt(x^2 + y^2).

Sourceval arg : Stdlib.Complex.t -> float @@ portable

Argument. The argument of a complex number is the angle in the complex plane between the positive real axis and a line passing through zero and the number. This angle ranges from -pi to pi. This function has a discontinuity along the negative real axis.

Sourceval polar : float -> float -> Stdlib.Complex.t @@ portable

polar norm arg returns the complex having norm norm and argument arg.

Sourceval exp : Stdlib.Complex.t -> Stdlib.Complex.t @@ portable

Exponentiation. exp z returns e to the z power.

Sourceval log : Stdlib.Complex.t -> Stdlib.Complex.t @@ portable

Natural logarithm (in base e).

Power function. pow z1 z2 returns z1 to the z2 power.