Package fi.iki.jmtilli.javafastcomplex

Class Complex

java.lang.Object
fi.iki.jmtilli.javafastcomplex.Complex
All Implemented Interfaces:
ComplexNumber, java.io.Serializable
public class Complex
extends java.lang.Object
implements ComplexNumber, java.io.Serializable
An immutable complex number. An instance of this class refers to a complex number the value of which cannot be changed.
See Also:
Serialized Form

  • Field Summary

    Fields 
    Modifier and Type Field Description
    static Complex I
    A complex number representing the imaginary unit
    static Complex NaN
    A complex number representing NaN (not a number)
    static Complex ONE
    A complex number representing one
    static Complex ZERO
    A complex number representing zero

  • Constructor Summary

    Constructors 
    Constructor Description
    Complex​(double re)
    Create a complex number with zero imaginary part.
    Complex​(double re, double im)
    Create a complex number.
    Complex​(ComplexNumber num)
    Create a complex number that has the same value as the specified other complex number.
    Complex​(ComplexNumberArray num, int i)
    Create a complex number that has the same value as the specified other complex number.

  • Method Summary

    Modifier and Type Method Description
    double abs()
    Calculates the absolute value of this complex number.
    Complex acos()
    Calculate the inverse cosine of this complex number.
    Complex acosh()
    Calculate the inverse hyperbolic cosine of this complex number.
    Complex add​(double d)
    Add a real number to this complex number
    Complex add​(ComplexNumber c)
    Add another complex number to this complex number
    Complex add​(ComplexNumberArray c, int i)
    Add another complex number to this complex number
    double arg()
    Calculates the argument of this complex number.
    Complex asin()
    Calculate the inverse sine of this complex number.
    Complex asinh()
    Calculate the inverse hyperbolic sine of this complex number.
    Complex atan()
    Calculate the inverse tangent of this complex number.
    Complex atanh()
    Calculate the inverse hyperbolic tangent of this complex number.
    Complex conjugate()
    Calculates the conjugate of this complex number
    Complex cos()
    Calculate the cosine of this complex number.
    Complex cosh()
    Calculate the hyperbolic cosine of this complex number.
    Complex divide​(double d)
    Divide this complex number by a real number
    Complex divide​(ComplexNumber c)
    Divide this complex number by another complex number
    Complex divide​(ComplexNumberArray c, int i)
    Divide this complex number by another complex number
    Complex divideReversed​(double d)
    Divide a real number by this complex number
    Complex divideReversed​(ComplexNumber c)
    Divide another complex number by this complex number
    Complex divideReversed​(ComplexNumberArray c, int i)
    Divide another complex number by this complex number
    boolean equals​(java.lang.Object o)
    Compare this complex number to another object.
    Complex exp()
    Calculates the exponential of this complex number
    Complex expm1()
    Returns exp(this)-1.
    double getImag()
    Returns the imaginary part of the complex number.
    double getReal()
    Returns the real part of the complex number.
    int hashCode()
    Returns a hash code of the complex number.
    Complex invert()
    Calculates the inverse of this complex number
    boolean isInfinite()
    Check whether the complex number is infinite.
    boolean isNaN()
    Check whether the complex number is NaN (not-a-numer).
    Complex log()
    Calculates the natural logarithm of this complex number
    Complex log1p()
    Returns log(this+1).
    Complex multiply​(double d)
    Multiply this complex number by a real number
    Complex multiply​(int i)
    Multiply this complex number by an integer
    Complex multiply​(ComplexNumber c)
    Multiply this complex number by another complex number
    Complex multiply​(ComplexNumberArray c, int i)
    Multiply this complex number by another complex number
    Complex negate()
    Calculates the negation of this complex number
    static Complex newPolar​(double abs, double argument)
    Create a complex number from polar coordinates.
    Complex pow​(double d)
    Raise this complex number to a real power
    Complex pow​(ComplexNumber c)
    Raise this complex number to a complex power
    Complex pow​(ComplexNumberArray c, int i)
    Raise this complex number to a complex power
    Complex sin()
    Calculate the sine of this complex number.
    Complex sinh()
    Calculate the hyperbolic sine of this complex number.
    Complex sqrt()
    Calculates the square root of this complex number
    Complex subtract​(double d)
    Subtract a real number from this complex number
    Complex subtract​(ComplexNumber c)
    Subtract another complex number from this complex number
    Complex subtract​(ComplexNumberArray c, int i)
    Subtract another complex number from this complex number
    Complex subtractReversed​(double d)
    Subtract this complex number from a real number
    Complex subtractReversed​(ComplexNumber c)
    Subtract this complex number from another complex number
    Complex subtractReversed​(ComplexNumberArray c, int i)
    Subtract this complex number from another complex number
    Complex tan()
    Calculate the tangent of this complex number.
    Complex tanh()
    Calculate the hyperbolic tangent of this complex number.
    java.lang.String toString()
    Returns a text representation of the complex number.
    static Complex valueOf​(double re)
    Create a complex number with zero imaginary part.
    static Complex valueOf​(double re, double im)
    Create a complex number.
    static Complex valueOf​(ComplexNumber num)
    Create a complex number that has the same value as the specified other complex number.
    static Complex valueOf​(ComplexNumberArray num, int i)
    Create a complex number that has the same value as the specified other complex number.

    Methods inherited from class java.lang.Object

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

  • Field Details

    • I

      public static final Complex I
      A complex number representing the imaginary unit

    • ONE

      public static final Complex ONE
      A complex number representing one

    • ZERO

      public static final Complex ZERO
      A complex number representing zero

    • NaN

      public static final Complex NaN
      A complex number representing NaN (not a number)

  • Constructor Details

    • Complex

      public Complex​(ComplexNumber num)
      Create a complex number that has the same value as the specified other complex number.
      Parameters:
      num - The other complex number

    • Complex

      public Complex​(ComplexNumberArray num, int i)
      Create a complex number that has the same value as the specified other complex number.
      Parameters:
      num - The other complex number array
      i - Array index

    • Complex

      public Complex​(double re)
      Create a complex number with zero imaginary part.
      Parameters:
      re - The real part

    • Complex

      public Complex​(double re, double im)
      Create a complex number.
      Parameters:
      re - The real part
      im - The imaginary part

  • Method Details

    • valueOf

      public static Complex valueOf​(ComplexNumber num)
      Create a complex number that has the same value as the specified other complex number. If a new Complex instance is not required, this method should be used instead of the constructor Complex(ComplexNumber), as this method results in better performance by caching frequently used values.
      Parameters:
      num - The other complex number
      Returns:
      The new complex number

    • valueOf

      public static Complex valueOf​(ComplexNumberArray num, int i)
      Create a complex number that has the same value as the specified other complex number. If a new Complex instance is not required, this method should be used instead of the constructor Complex(ComplexNumber), as this method results in better performance by caching frequently used values.
      Parameters:
      num - The other complex number array
      i - Array index
      Returns:
      The new complex number

    • valueOf

      public static Complex valueOf​(double re)
      Create a complex number with zero imaginary part. If a new Complex instance is not required, this method should be used instead of the constructor Complex(double), as this method results in better performance by caching frequently used values.
      Parameters:
      re - The real part
      Returns:
      The new complex number

    • valueOf

      public static Complex valueOf​(double re, double im)
      Create a complex number. If a new Complex instance is not required, this method should be used instead of the constructor Complex(double, double), as this method results in better performance by caching frequently used values.
      Parameters:
      re - The real part
      im - The imaginary part
      Returns:
      The new complex number

    • newPolar

      public static Complex newPolar​(double abs, double argument)
      Create a complex number from polar coordinates.
      Parameters:
      abs - The absolute value
      argument - The argument
      Returns:
      The new complex number

    • getReal

      public double getReal()
      Returns the real part of the complex number.
      Specified by:
      getReal in interface ComplexNumber
      Returns:
      The real part

    • getImag

      public double getImag()
      Returns the imaginary part of the complex number.
      Specified by:
      getImag in interface ComplexNumber
      Returns:
      The imaginary part

    • add

      public Complex add​(ComplexNumber c)
      Add another complex number to this complex number
      Parameters:
      c - The other complex number
      Returns:
      the sum

    • add

      public Complex add​(ComplexNumberArray c, int i)
      Add another complex number to this complex number
      Parameters:
      c - The other complex number array
      i - The array index
      Returns:
      the sum

    • add

      public Complex add​(double d)
      Add a real number to this complex number
      Parameters:
      d - The real number
      Returns:
      the sum

    • subtract

      public Complex subtract​(ComplexNumber c)
      Subtract another complex number from this complex number
      Parameters:
      c - The other complex number
      Returns:
      the difference

    • subtract

      public Complex subtract​(ComplexNumberArray c, int i)
      Subtract another complex number from this complex number
      Parameters:
      c - The other complex number array
      i - The array index
      Returns:
      the difference

    • subtractReversed

      public Complex subtractReversed​(ComplexNumber c)
      Subtract this complex number from another complex number
      Parameters:
      c - The other complex number
      Returns:
      the difference

    • subtractReversed

      public Complex subtractReversed​(ComplexNumberArray c, int i)
      Subtract this complex number from another complex number
      Parameters:
      c - The other complex number array
      i - The array index
      Returns:
      the difference

    • subtract

      public Complex subtract​(double d)
      Subtract a real number from this complex number
      Parameters:
      d - The real number
      Returns:
      the difference

    • subtractReversed

      public Complex subtractReversed​(double d)
      Subtract this complex number from a real number
      Parameters:
      d - The real number
      Returns:
      the difference

    • multiply

      public Complex multiply​(ComplexNumber c)
      Multiply this complex number by another complex number
      Parameters:
      c - The complex number multiplier
      Returns:
      the product

    • multiply

      public Complex multiply​(ComplexNumberArray c, int i)
      Multiply this complex number by another complex number
      Parameters:
      c - The complex number array multiplier
      i - The array index
      Returns:
      the product

    • multiply

      public Complex multiply​(double d)
      Multiply this complex number by a real number
      Parameters:
      d - The real number multiplier
      Returns:
      the product

    • multiply

      public Complex multiply​(int i)
      Multiply this complex number by an integer
      Parameters:
      i - The integer multiplier
      Returns:
      the product

    • divide

      public Complex divide​(ComplexNumber c)
      Divide this complex number by another complex number
      Parameters:
      c - The complex number divisor
      Returns:
      the result of this division

    • divide

      public Complex divide​(ComplexNumberArray c, int i)
      Divide this complex number by another complex number
      Parameters:
      c - The complex number array divisor
      i - The array index
      Returns:
      the result of this division

    • divide

      public Complex divide​(double d)
      Divide this complex number by a real number
      Parameters:
      d - The real number divisor
      Returns:
      the result of this division

    • divideReversed

      public Complex divideReversed​(ComplexNumber c)
      Divide another complex number by this complex number
      Parameters:
      c - The complex number dividend
      Returns:
      the result of this division

    • divideReversed

      public Complex divideReversed​(ComplexNumberArray c, int i)
      Divide another complex number by this complex number
      Parameters:
      c - The complex number array dividend
      i - The array index
      Returns:
      the result of this division

    • divideReversed

      public Complex divideReversed​(double d)
      Divide a real number by this complex number
      Parameters:
      d - The real number dividend
      Returns:
      the result of this division

    • negate

      public Complex negate()
      Calculates the negation of this complex number
      Returns:
      -this

    • conjugate

      public Complex conjugate()
      Calculates the conjugate of this complex number
      Returns:
      The square root

    • sqrt

      public Complex sqrt()
      Calculates the square root of this complex number
      Returns:
      The square root

    • exp

      public Complex exp()
      Calculates the exponential of this complex number
      Returns:
      e raised to the power this

    • expm1

      public Complex expm1()
      Returns exp(this)-1. For values of this near 0, calculating expm1(this) is much more accurate than calculating exp(this)-1.
      Returns:
      The value exp(this)-1

    • log

      public Complex log()
      Calculates the natural logarithm of this complex number
      Returns:
      The natural logarithm

    • log1p

      public Complex log1p()
      Returns log(this+1). For values of this near 0, calculating log1p(this) is much more accurate than calculating log(1+this).
      Returns:
      The value log(1+this)

    • acosh

      public Complex acosh()
      Calculate the inverse hyperbolic cosine of this complex number.
      Returns:
      The inverse hyperbolic cosine of this complex number

    • asinh

      public Complex asinh()
      Calculate the inverse hyperbolic sine of this complex number.
      Returns:
      The inverse hyperbolic sine of this complex number

    • atanh

      public Complex atanh()
      Calculate the inverse hyperbolic tangent of this complex number.
      Returns:
      The inverse hyperbolic tangent of this complex number

    • acos

      public Complex acos()
      Calculate the inverse cosine of this complex number.
      Returns:
      The inverse cosine of this complex number

    • asin

      public Complex asin()
      Calculate the inverse sine of this complex number.
      Returns:
      The inverse sine of this complex number

    • atan

      public Complex atan()
      Calculate the inverse tangent of this complex number.
      Returns:
      The inverse tangent of this complex number

    • cos

      public Complex cos()
      Calculate the cosine of this complex number.
      Returns:
      The cosine of this complex number

    • sin

      public Complex sin()
      Calculate the sine of this complex number.
      Returns:
      The sine of this complex number

    • tan

      public Complex tan()
      Calculate the tangent of this complex number.
      Returns:
      The tangent of this complex number

    • cosh

      public Complex cosh()
      Calculate the hyperbolic cosine of this complex number.
      Returns:
      The hyperbolic cosine of this complex number

    • sinh

      public Complex sinh()
      Calculate the hyperbolic sine of this complex number.
      Returns:
      The hyperbolic sine of this complex number

    • tanh

      public Complex tanh()
      Calculate the hyperbolic tangent of this complex number.
      Returns:
      The hyperbolic tangent of this complex number

    • pow

      public Complex pow​(ComplexNumber c)
      Raise this complex number to a complex power
      Parameters:
      c - The complex power
      Returns:
      The result

    • pow

      public Complex pow​(ComplexNumberArray c, int i)
      Raise this complex number to a complex power
      Parameters:
      c - The complex array power
      i - The array index
      Returns:
      The result

    • pow

      public Complex pow​(double d)
      Raise this complex number to a real power
      Parameters:
      d - The real power
      Returns:
      The result

    • invert

      public Complex invert()
      Calculates the inverse of this complex number
      Returns:
      1 divided by this complex number

    • abs

      public double abs()
      Calculates the absolute value of this complex number.
      Specified by:
      abs in interface ComplexNumber
      Returns:
      x≥0 the absolute value

    • arg

      public double arg()
      Calculates the argument of this complex number. The argument is the angle between the positive real axis and the point that represents this number in the complex plane.
      Specified by:
      arg in interface ComplexNumber
      Returns:
      -pi≤x≤pi the argument

    • isNaN

      public boolean isNaN()
      Check whether the complex number is NaN (not-a-numer). A complex number is considered NaN if either the real or the imaginary part is NaN.
      Specified by:
      isNaN in interface ComplexNumber
      Returns:
      Whether the complex number is NaN

    • isInfinite

      public boolean isInfinite()
      Check whether the complex number is infinite. A complex number is considered infinite if either the real or the imaginary part is infinite. If either the real of imaginary part is NaN, the number is not considered infinite, so isNaN() and isInfinite() cannot be true at the same time.
      Specified by:
      isInfinite in interface ComplexNumber
      Returns:
      Whether the complex number is infinite

    • toString

      public java.lang.String toString()
      Returns a text representation of the complex number.
      Specified by:
      toString in interface ComplexNumber
      Overrides:
      toString in class java.lang.Object
      Returns:
      A text representation of the complex number.
      "NaN" if NaN
      re if purely real
      im + "i" if purely imaginary
      re " + " + im + "i" if imaginary part positive
      re " - " + (-im) + "i" if imaginary part negative

    • hashCode

      public int hashCode()
      Returns a hash code of the complex number. The hash code is based on the bit representations of the real and imaginary parts. If two complex numbers are considered equal by the equals method, they have the same hash code. The hash code calculation is the same as ComplexUtils.hashCode.
      Overrides:
      hashCode in class java.lang.Object
      Returns:
      The hash code

    • equals

      public boolean equals​(java.lang.Object o)
      Compare this complex number to another object. Note that this compares the bit representations of the real and imaginary parts. Thus for example NaN is equal to itself and +0.0+0.0i is not equal to -0.0-0.0i. All instances of NaN are considered equal. This definition allows hash tables to work properly. The equality comparison is the same as ComplexUtils.equal.
      Overrides:
      equals in class java.lang.Object
      Returns:
      true if both complex numbers are NaN
      true if the bit representations of the real and imaginary parts are equal
      false if o is not an instance of the Complex class
      false otherwise