Complex (math 0.4 API)

java.lang.Object
- com.github.signaflo.math.Complex

All Implemented Interfaces:

FieldElement<Complex>, Comparable<Complex>
```
public final class Complex
extends Object
implements FieldElement<Complex>
```
A representation of a complex number. This class is immutable and thread-safe.

Constructor Summary

Constructors
Constructor and Description
`Complex()` Construct a new complex number with real and imaginary parts both equal to 0.
`Complex(double real)` Construct a new complex number with zero imaginary part, i.e, a real number.
`Complex(double real, double im)` Construct a new complex number with the given real and imaginary parts.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`double`	`abs()` Compute and return the absolute value of this element.
`Complex`	`additiveInverse()` Return the element of this field that, when added to this element, produces the additive identity.
`int`	`compareTo(Complex other)`
`Complex`	`complexSqrt()` The square root operation applied to this element, returning a complex number.
`Complex`	`conjugate()` Compute and return the conjugate of this element.
`Complex`	`dividedBy(Complex value)` Divide this element by the given element and return the result.
`Complex`	`dividedBy(double value)` Divide this element by the given double.
`static Complex`	`from(Real real)`
`double`	`im()` The imaginary part of this complex number.
`boolean`	`isReal()` Returns true if this complex number is also a real number and false otherwise.
`Complex`	`minus(Complex other)` Subtract the given element from this element.
`Complex`	`plus(Complex other)` Add this element to the given element.
`Complex`	`plus(double other)` Add this element to the given double.
`double`	`real()` The real part of this complex number.
`Complex`	`sqrt()` Computes and returns the square root of this number as long as the square root is of the same type (i.e., belongs to the same field) as this number.
`Complex`	`times(Complex other)` Multiply this element by the given element.
`String`	`toString()`
`static Complex`	`zero()`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Complex
```
public Complex()
```
    Construct a new complex number with real and imaginary parts both equal to 0.
  - Complex
```
public Complex(double real)
```
    Construct a new complex number with zero imaginary part, i.e, a real number.
    
    Parameters:
    
    real - the real part of the new complex number.
  - Complex
```
public Complex(double real,
               double im)
```
    Construct a new complex number with the given real and imaginary parts.
    
    Parameters:
    
    real - the real part of the new complex number.
    
    im - the imaginary part of the new complex number.
- Method Detail
  - from
```
public static Complex from(Real real)
```
  - zero
```
public static Complex zero()
```
  - plus
```
public final Complex plus(Complex other)
```
    Description copied from interface: FieldElement
    
    Add this element to the given element.
    
    Specified by:
    
    plus in interface FieldElement<Complex>
    
    Parameters:
    
    other - the element to add to this element.
    
    Returns:
    
    this element added to the given element.
  - plus
```
public final Complex plus(double other)
```
    Add this element to the given double.
    
    Parameters:
    
    other - the double to add to this element.
    
    Returns:
    
    this element added to the given double.
  - minus
```
public final Complex minus(Complex other)
```
    Description copied from interface: FieldElement
    
    Subtract the given element from this element.
    
    Specified by:
    
    minus in interface FieldElement<Complex>
    
    Parameters:
    
    other - the element to subtract from this element.
    
    Returns:
    
    this element subtracted by the given element.
  - times
```
public final Complex times(Complex other)
```
    Description copied from interface: FieldElement
    
    Multiply this element by the given element.
    
    Specified by:
    
    times in interface FieldElement<Complex>
    
    Parameters:
    
    other - the element to multiply this element by.
    
    Returns:
    
    this element multiplied by the given element.
  - dividedBy
```
public final Complex dividedBy(double value)
```
    Divide this element by the given double.
    
    Parameters:
    
    value - the double to divide this element by.
    
    Returns:
    
    this element divided by the given double.
  - dividedBy
```
public final Complex dividedBy(Complex value)
```
    Description copied from interface: FieldElement
    
    Divide this element by the given element and return the result.
    
    Specified by:
    
    dividedBy in interface FieldElement<Complex>
    
    Parameters:
    
    value - the divisor.
    
    Returns:
    
    this element divided by the given element.
  - conjugate
```
public final Complex conjugate()
```
    Description copied from interface: FieldElement
    
    Compute and return the conjugate of this element.
    
    Specified by:
    
    conjugate in interface FieldElement<Complex>
    
    Returns:
    
    the conjugate of this element.
  - abs
```
public final double abs()
```
    Description copied from interface: FieldElement
    
    Compute and return the absolute value of this element.
    
    Specified by:
    
    abs in interface FieldElement<Complex>
    
    Returns:
    
    the absolute value of this element.
  - additiveInverse
```
public Complex additiveInverse()
```
    Description copied from interface: FieldElement
    
    Return the element of this field that, when added to this element, produces the additive identity.
    
    Specified by:
    
    additiveInverse in interface FieldElement<Complex>
    
    Returns:
    
    the element of this field that, when added to this element, produces the additive identity.
  - complexSqrt
```
public Complex complexSqrt()
```
    Description copied from interface: FieldElement
    
    The square root operation applied to this element, returning a complex number. If the field this element belongs to is not part of the complex number hierarchy, then implementations may throw an IllegalStateException
    
    Specified by:
    
    complexSqrt in interface FieldElement<Complex>
    
    Returns:
    
    the square root of this element.
  - sqrt
```
public Complex sqrt()
```
    Description copied from interface: FieldElement
    
    Computes and returns the square root of this number as long as the square root is of the same type (i.e., belongs to the same field) as this number. If the return type is not guaranteed to be of the same type as this number, then FieldElement.complexSqrt() should be used instead.
    
    Specified by:
    
    sqrt in interface FieldElement<Complex>
    
    Returns:
    
    the square root of this number if the square root is of the same type.
  - real
```
public final double real()
```
    The real part of this complex number.
    
    Returns:
    
    the real part of this complex number.
  - im
```
public final double im()
```
    The imaginary part of this complex number.
    
    Returns:
    
    the imaginary part of this complex number.
  - isReal
```
public final boolean isReal()
```
    Returns true if this complex number is also a real number and false otherwise.
    
    Returns:
    
    true if this complex number is also a real number and false otherwise.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - compareTo
```
public int compareTo(@NonNull
                     Complex other)
```
    Specified by:
    
    compareTo in interface Comparable<Complex>

Class Complex

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Complex

Complex

Complex

Method Detail

from

zero

plus

plus

minus

times

dividedBy

dividedBy

conjugate

abs

additiveInverse

complexSqrt

sqrt

real

im

isReal

toString

compareTo