ComplexNumber

data class ComplexNumber(real: Number, imaginary: Number)(source)

Main Complex Number class.

Since

Version 1.0

Parameters

real

Real value of this complex number as a Number.

imaginary

Imaginary value of this complex number as a Number.

Constructors

Link copied to clipboard
constructor(real: Number, imaginary: Number)

Creates a complex number.

Properties

Link copied to clipboard
val arg: Double

Argument of the complex number

Link copied to clipboard
val im: Double

Actual imaginary value of the number. Converts Number to Double

Link copied to clipboard
val mag: Double

Modulus or Magnitude of the complex number

Link copied to clipboard
val mod: Double

Modulus or Magnitude of the complex number

Link copied to clipboard
val re: Double

Actual real value of the number. Converts Number to Double

Functions

Link copied to clipboard
Link copied to clipboard
fun copy(real: Number, imaginary: Number): ComplexNumber
Link copied to clipboard
operator fun dec(parameter: Parameter = Parameter.BOTH): ComplexNumber

Decreases by 1 the values of re and im It's an operator overload of ComplexNumber

Link copied to clipboard
operator fun div(b: ComplexNumber): ComplexNumber

Divides one complex number with another complex number. It's an operator overload of ComplexNumber

operator fun div(b: Number): ComplexNumber

Division between a Number and a ComplexNumber. Overloads div() to include ComplexNumber

Link copied to clipboard
fun divides(parameter: ComplexNumber): Boolean

Will perform a modular operation between the current complex number and a parameter parameter and will return true or false depending on the result of said operation

Link copied to clipboard
open operator override fun equals(other: Any?): Boolean

Compares the values of two Complex Numbers by using the checkEquals member function of ComplexNumber. It's an operator overload of ComplexNumber

Link copied to clipboard
open override fun hashCode(): Int

Converts the ComplexNumber class to a hashCode

Link copied to clipboard
operator fun inc(parameter: Parameter = Parameter.BOTH): ComplexNumber

Increments by 1 the values of re and im It's an operator overload of ComplexNumber

Link copied to clipboard

Subtracts one complex number from another. It's an operator overload of ComplexNumber

operator fun minus(b: Number): ComplexNumber

Subtraction between a Number and a ComplexNumber. Overloads minus() to include ComplexNumber

Link copied to clipboard
operator fun plus(b: ComplexNumber): ComplexNumber

Adds two complex numbers together. It's an operator overload of ComplexNumber

operator fun plus(b: Number): ComplexNumber

Addition between a Number and a ComplexNumber. Overloads plus() to include ComplexNumber

Link copied to clipboard
infix fun pow(other: ComplexNumber): ComplexNumber
infix fun pow(other: Number): ComplexNumber

Performs the operation Z ^ W

Link copied to clipboard
operator fun rem(b: ComplexNumber): ComplexNumber

Remainder of the division between two ComplexNumber. It's an operator overload of ComplexNumber

Link copied to clipboard
fun round(places: Int): ComplexNumber

rounds a ComplexNumber to places decimal places by rounding both the re and im members

Link copied to clipboard

Rounds both re and im members of a ComplexNumber to an Int

Link copied to clipboard

Multiplies one complex number with another It's an operator overload of ComplexNumber

operator fun times(b: Number): ComplexNumber

Multiplication between a Number and a ComplexNumber. Overloads times() to include ComplexNumber

Link copied to clipboard
fun toReal(): Double?

Converts a ComplexNumber to a real Double

Link copied to clipboard
open override fun toString(): String

Converts the ComplexNumber class to a string

Link copied to clipboard
operator fun unaryMinus(): ComplexNumber

Multiplies both re and im components of this ComplexNumber by -1. It's an operator overload of ComplexNumber