agi.foundation.coordinates

(agi.foundation.core-2024r3.jar)

Class Complex

java.lang.Object

agi.foundation.coordinates.Complex

All Implemented Interfaces:

IEquatable<Complex>, ImmutableValueType, ValueType

public final class Complex
extends Object
implements IEquatable<Complex>, ImmutableValueType

Structure which represents a complex value.

Constructor Summary

Constructors

Constructor and Description
Complex() Initializes a new instance.
Complex(double real) Initializes a new instance with only the real component.
Complex(double real, double imaginary) Initializes a new instance with real and imaginary components.

Method Summary

Modifier and Type	Method and Description
static Complex	abs(Complex value) Compute the absolute value and returns the result.
static Complex	acos(Complex x) Calculates the arc cosine of the input value.
static Complex	acosh(Complex x) Calculates the inverse hyperbolic cosine of a value.
static Complex	add(Complex left, Complex right) Adds two complex numbers and returns the result.
static Complex	conjugate(Complex value) Computes the conjugate for a complex number and returns the result.
static Complex	cos(Complex x) Calculates the cosine of the input complex value.
static Complex	divide(Complex dividend, Complex divisor) Divides one complex number by another and returns the result.
static Complex	divide(Complex dividend, double scalar) Divides one complex number by a scalar and returns the result.
static boolean	equals(Complex left, Complex right) Returns true if the two instances are exactly equal.
boolean	equals(Object obj) Indicates whether another object is exactly equal to this instance.
boolean	equalsType(Complex other) Indicates whether another instance of this type is exactly equal to this instance.
static Complex	exp(Complex c) Returns e raised to the specified power.
double	getImaginary() Gets the imaginary component of the complex number.
static Complex	getImaginaryOne() Gets a Complex value of i.
double	getMagnitude() Gets the magnitude of the complex number.
double	getMagnitudeSquared() Gets the square of the magnitude of the complex number.
static Complex	getOne() Gets a Complex value of 1.
double	getPhase() Gets the phase of the complex number.
double	getReal() Gets the real component of the complex number.
int	hashCode() Returns a hash code for this instance, which is suitable for use in hashing algorithms and data structures like a hash table.
static Complex	log(Complex x) Calculates the complex natural logarithm of the input value.
static Complex	multiply(Complex left, Complex right) Returns the product of two complex numbers.
static Complex	negate(Complex value) Negates the Complex value.
static boolean	notEquals(Complex left, Complex right) Returns true if the two instances are not exactly equal.
static Complex	pow(Complex x, Complex power) Calculates the complex square root of the input value.
static Complex	sign(Complex x) Returns the sign of a complex value as either a -1 or +1.
static Complex	sqrt(Complex x) Calculates the complex square root of the input value.
static Complex	subtract(Complex left, Complex right) Subtracts two complex numbers and returns the result.
static Complex	toComplex(double real) Implicit conversion from double to complex number.
String	toString() Returns a string which represents the complex number.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Complex

public Complex()

Initializes a new instance.

Complex

public Complex(double real)

Initializes a new instance with only the real component. The imaginary component defaults to 0.

Parameters:

real - The real component of the complex value.

Complex

public Complex(double real,
               double imaginary)

Initializes a new instance with real and imaginary components.

Parameters:

real - The real component of the complex value.

imaginary - The imaginary component of the complex value.

Method Detail

getReal

public final double getReal()

Gets the real component of the complex number.

getImaginary

public final double getImaginary()

Gets the imaginary component of the complex number.

getMagnitude

public final double getMagnitude()

Gets the magnitude of the complex number.

getMagnitudeSquared

public final double getMagnitudeSquared()

Gets the square of the magnitude of the complex number.

getPhase

public final double getPhase()

Gets the phase of the complex number.

add

@Nonnull
public static Complex add(@Nonnull
                                    Complex left,
                                    @Nonnull
                                    Complex right)

Adds two complex numbers and returns the result.

Parameters:

left - The first complex number to add.

right - The second complex number to add.

Returns:

The complex number that is the result of the addition.

negate

@Nonnull
public static Complex negate(@Nonnull
                                       Complex value)

Negates the Complex value.

Parameters:

value - The value to negate.

Returns:

The complex number that is the result of the negation.

subtract

@Nonnull
public static Complex subtract(@Nonnull
                                         Complex left,
                                         @Nonnull
                                         Complex right)

Subtracts two complex numbers and returns the result.

Parameters:

left - The complex number to subtract from.

right - The complex number to subtract.

Returns:

The complex number that is the difference.

multiply

@Nonnull
public static Complex multiply(@Nonnull
                                         Complex left,
                                         @Nonnull
                                         Complex right)

Returns the product of two complex numbers.

Parameters:

left - The first complex number to multiply.

right - The second complex number to multiply.

Returns:

The product of the complex numbers.

divide

@Nonnull
public static Complex divide(@Nonnull
                                       Complex dividend,
                                       @Nonnull
                                       Complex divisor)

Divides one complex number by another and returns the result.

Parameters:

dividend - The complex number to be divided.

divisor - The complex number to divide by.

Returns:

The complex number that is the result of the division.

divide

@Nonnull
public static Complex divide(@Nonnull
                                       Complex dividend,
                                       double scalar)

Divides one complex number by a scalar and returns the result.

Parameters:

dividend - The complex number to be divided.

scalar - The scalar to divisor.

Returns:

The complex number that is the result of the division.

conjugate

@Nonnull
public static Complex conjugate(@Nonnull
                                          Complex value)

Computes the conjugate for a complex number and returns the result.

Parameters:

value - A complex number.

Returns:

The computed conjugate.

abs

@Nonnull
public static Complex abs(@Nonnull
                                    Complex value)

Compute the absolute value and returns the result.

Parameters:

value - The complex value from which the absolute value is computed.

Returns:

The computed absolute value.

equals

public static boolean equals(@Nonnull
                             Complex left,
                             @Nonnull
                             Complex right)

Returns true if the two instances are exactly equal.

Parameters:

left - The instance to compare to right.

right - The instance to compare to left.

Returns:

true if left represents the same value as right; otherwise false.

notEquals

public static boolean notEquals(@Nonnull
                                Complex left,
                                @Nonnull
                                Complex right)

Returns true if the two instances are not exactly equal.

Parameters:

left - The instance to compare to right.

right - The instance to compare to left.

Returns:

true if left does not represent the same value as right; otherwise false.

equalsType

public final boolean equalsType(@Nonnull
                                Complex other)

Indicates whether another instance of this type is exactly equal to this instance.

Specified by:

equalsType in interface IEquatable<Complex>

Parameters:

other - The instance to compare to this instance.

Returns:

true if other represents the same value as this instance; otherwise false.

equals

public boolean equals(Object obj)

Indicates whether another object is exactly equal to this instance.

Overrides:

equals in class Object

Parameters:

obj - The object to compare to this instance.

Returns:

true if obj is an instance of this type and represents the same value as this instance; otherwise false.

See Also:

Object.hashCode(), HashMap

exp

@Nonnull
public static Complex exp(@Nonnull
                                    Complex c)

Returns e raised to the specified power.

Parameters:

c - A complex value specifying a power.

Returns:

The number e raised to the power c

hashCode

public int hashCode()

Returns a hash code for this instance, which is suitable for use in hashing algorithms and data structures like a hash table.

Overrides:

hashCode in class Object

Returns:

A hash code for the current object.

See Also:

Object.equals(java.lang.Object), System.identityHashCode(java.lang.Object)

toString

public String toString()

Returns a string which represents the complex number.

Overrides:

toString in class Object

Returns:

A string which represents the complex number.

toComplex

@Nonnull
public static Complex toComplex(double real)

Implicit conversion from double to complex number.

Parameters:

real - The real component of the complex number.

Returns:

A Complex type with the imaginary part defaulted to 0.

getImaginaryOne

@Nonnull
public static Complex getImaginaryOne()

Gets a Complex value of i.

getOne

@Nonnull
public static Complex getOne()

Gets a Complex value of 1.

pow

@Nonnull
public static Complex pow(@Nonnull
                                    Complex x,
                                    @Nonnull
                                    Complex power)

Calculates the complex square root of the input value.

Parameters:

x - The input complex number.

power - The power to raise the complex number to.

Returns:

The square root.

sqrt

@Nonnull
public static Complex sqrt(@Nonnull
                                     Complex x)

Calculates the complex square root of the input value.

Parameters:

x - The input complex number.

Returns:

The square root.

log

@Nonnull
public static Complex log(@Nonnull
                                    Complex x)

Calculates the complex natural logarithm of the input value.

Parameters:

x - The input complex number.

Returns:

The complex natural logarithm of the input.

cos

@Nonnull
public static Complex cos(@Nonnull
                                    Complex x)

Calculates the cosine of the input complex value.

Parameters:

x - The input value.

Returns:

The cosine of the input.

acos

@Nonnull
public static Complex acos(@Nonnull
                                     Complex x)

Calculates the arc cosine of the input value.

Parameters:

x - The input value.

Returns:

The complex angle.

acosh

@Nonnull
public static Complex acosh(@Nonnull
                                      Complex x)

Calculates the inverse hyperbolic cosine of a value.

sign

@Nonnull
public static Complex sign(@Nonnull
                                     Complex x)

Returns the sign of a complex value as either a -1 or +1. In the case of zero this function returns zero.