orx-math/org.openrndr.extra.math.complex/Complex

Complex

@Serializable

data class Complex(val real: Double, val imaginary: Double)(source)

Represents a complex number with a real and imaginary part.

Provides functionality to perform common mathematical operations with complex numbers, such as addition, subtraction, multiplication, division, and more. Includes utility functions for magnitude, argument, and conversions between polar and rectangular forms.

Constructors

Complex

constructor(real: Double, imaginary: Double)

Types

Companion

object Companion

Properties

imaginary

val imaginary: Double

The imaginary part of the complex number.

real

val real: Double

The real part of the complex number.

Functions

argument

fun argument(): Double

Computes the argument (or angle) of the complex number in polar coordinates. The argument is the angle formed by the positive real axis and the line representing the complex number in the complex plane, measured in radians.

conjugate

fun conjugate(): Complex

Computes the conjugate of the complex number. The conjugate of a complex number is formed by changing the sign of its imaginary part.

div

operator fun div(other: Double): Complex

operator fun div(other: Complex): Complex

magnitude

fun magnitude(): Double

Calculates the magnitude (or absolute value) of the complex number. The magnitude is computed as the square root of the sum of the squares of the real and imaginary parts.

minus

operator fun minus(other: Complex): Complex

normalize

fun normalize(): Complex

Normalizes the complex number to a unit magnitude. The normalized complex number retains the same direction in the complex plane but has a magnitude of 1.

plus

operator fun plus(other: Complex): Complex

pow

fun pow(exponent: Double): Complex

Raises the current complex number to the power of the given exponent. The operation is performed in polar form, where the magnitude is raised to the exponent and the argument is multiplied by the exponent.

sqrMagnitude

fun sqrMagnitude(): Double

Computes the squared magnitude (or squared absolute value) of the complex number. The squared magnitude is determined as the sum of the squares of the real and imaginary parts.

sqrt

fun sqrt(): Complex

Computes the principal square root of the complex number. The square root is calculated based on the polar representation of the complex number.

times

operator fun times(other: Double): Complex

operator fun times(other: Complex): Complex

unaryMinus

operator fun unaryMinus(): Complex