Package fi.iki.jmtilli.javafastcomplex

Class ComplexBuffer

java.lang.Object
fi.iki.jmtilli.javafastcomplex.ComplexBuffer
All Implemented Interfaces:
ComplexNumber, java.io.Serializable
public class ComplexBuffer
extends java.lang.Object
implements ComplexNumber, java.io.Serializable
A mutable complex number. An instance of this class refers to a complex number the value of which can be changed. This allows higher performance, as if the value of the number can be changed, not that many small objects need to be created.
See Also:
Serialized Form

  • Constructor Details

    • ComplexBuffer

      public ComplexBuffer​(ComplexNumber num)
      Create a complex buffer that initially stores the specified complex number.
      Parameters:
      num - The specified complex number

    • ComplexBuffer

      public ComplexBuffer​(ComplexNumberArray num, int j)
      Create a complex buffer that initially stores the specified complex number.
      Parameters:
      num - The specified complex numberarray
      j - The array inex

    • ComplexBuffer

      public ComplexBuffer()
      Create a complex buffer that initially has zero real and imaginary parts.

    • ComplexBuffer

      public ComplexBuffer​(double re)
      Create a complex buffer that initially the specified real part and zero as the imaginary part.
      Parameters:
      re - The initial real part

    • ComplexBuffer

      public ComplexBuffer​(double re, double im)
      Create a complex buffer that initially has the specified real and imaginary parts
      Parameters:
      re - The initial real part
      im - The initial imaginary part

  • Method Details

    • set

      public ComplexBuffer set​(double re)
      Modify the real part of this complex buffer and set imaginary part to zero.
      Parameters:
      re - The new real part
      Returns:
      this

    • set

      public ComplexBuffer set​(double re, double im)
      Modify the real and imaginary parts of this complex buffer
      Parameters:
      re - The new real part
      im - The new imaginary part
      Returns:
      this

    • set

      public ComplexBuffer set​(ComplexNumber num)
      Modify the value of this complex buffer
      Parameters:
      num - The new value
      Returns:
      this

    • set

      public ComplexBuffer set​(ComplexNumberArray num, int j)
      Modify the value of this complex buffer
      Parameters:
      num - The new value array
      j - The array index
      Returns:
      this

    • get

      public Complex get()
      Get the value of this complex buffer as an immutable object
      Returns:
      A new immutable complex number that has the same value as this buffer

    • addInPlace

      public ComplexBuffer addInPlace​(ComplexNumber c)
      Add another complex number to this buffer and store the result in this buffer
      Parameters:
      c - The other complex number
      Returns:
      this

    • addInPlace

      public ComplexBuffer addInPlace​(ComplexNumberArray c, int j)
      Add another complex number to this buffer and store the result in this buffer
      Parameters:
      c - The other complex number array
      j - The array index
      Returns:
      this

    • addInPlace

      public ComplexBuffer addInPlace​(double d)
      Add a real number to this buffer and store the result in this buffer
      Parameters:
      d - The real number
      Returns:
      this

    • subtractInPlace

      public ComplexBuffer subtractInPlace​(ComplexNumber c)
      Subtract another complex number from this buffer and store the result in this buffer
      Parameters:
      c - The other complex number
      Returns:
      this

    • subtractInPlace

      public ComplexBuffer subtractInPlace​(ComplexNumberArray c, int j)
      Subtract another complex number from this buffer and store the result in this buffer
      Parameters:
      c - The other complex number array
      j - The array index
      Returns:
      this

    • subtractInPlace

      public ComplexBuffer subtractInPlace​(double d)
      Subtract a real number from this buffer and store the result in this buffer
      Parameters:
      d - The real number
      Returns:
      this

    • subtractReversedInPlace

      public ComplexBuffer subtractReversedInPlace​(ComplexNumber c)
      Subtract the value of this buffer from another complex number and store the result in this buffer
      Parameters:
      c - The other complex number
      Returns:
      this

    • subtractReversedInPlace

      public ComplexBuffer subtractReversedInPlace​(ComplexNumberArray c, int j)
      Subtract the value of this buffer from another complex number and store the result in this buffer
      Parameters:
      c - The other complex number array
      j - The array index
      Returns:
      this

    • subtractReversedInPlace

      public ComplexBuffer subtractReversedInPlace​(double d)
      Subtract the value of this buffer from a real number and store the result in this buffer
      Parameters:
      d - The real number
      Returns:
      this

    • negateInPlace

      public ComplexBuffer negateInPlace()
      Negate the value of this buffer and store the result in this buffer
      Returns:
      this

    • conjugateInPlace

      public ComplexBuffer conjugateInPlace()
      Calculate the conjugate of the value of this buffer and store the result in this buffer
      Returns:
      this

    • invertInPlace

      public ComplexBuffer invertInPlace()
      Calculate the inverse of the value of this buffer and store the result in this buffer
      Returns:
      this

    • sqrtInPlace

      public ComplexBuffer sqrtInPlace()
      Calculate the square root of the value of this buffer and store the result in this buffer
      Returns:
      this

    • expInPlace

      public ComplexBuffer expInPlace()
      Calculate the exponential of the value of this buffer and store the result in this buffer
      Returns:
      this

    • logInPlace

      public ComplexBuffer logInPlace()
      Calculate the logarithm of the value of this buffer and store the result in this buffer
      Returns:
      this

    • log1pInPlace

      public ComplexBuffer log1pInPlace()
      Calculate the logarithm of 1 added to the value of this buffer and store the result in this buffer
      Returns:
      this

    • expm1InPlace

      public ComplexBuffer expm1InPlace()
      Calculate exp(this)-1 and store the result in this buffer
      Returns:
      this

    • acoshInPlace

      public ComplexBuffer acoshInPlace()
      Calculate the inverse hyperbolic cosine of the value of the buffer and store the result in this buffer
      Returns:
      this

    • asinhInPlace

      public ComplexBuffer asinhInPlace()
      Calculate the inverse hyperbolic sine of the value of the buffer and store the result in this buffer
      Returns:
      this

    • atanhInPlace

      public ComplexBuffer atanhInPlace()
      Calculate the inverse hyperbolic tangent of the value of the buffer and store the result in this buffer
      Returns:
      this

    • acosInPlace

      public ComplexBuffer acosInPlace()
      Calculate the inverse cosine of the value of the buffer and store the result in this buffer
      Returns:
      this

    • asinInPlace

      public ComplexBuffer asinInPlace()
      Calculate the inverse sine of the value of the buffer and store the result in this buffer
      Returns:
      this

    • atanInPlace

      public ComplexBuffer atanInPlace()
      Calculate the inverse tangent of the value of the buffer and store the result in this buffer
      Returns:
      this

    • cosInPlace

      public ComplexBuffer cosInPlace()
      Calculate the cosine of the value of the buffer and store the result in this buffer
      Returns:
      this

    • sinInPlace

      public ComplexBuffer sinInPlace()
      Calculate the sine of the value of the buffer and store the result in this buffer
      Returns:
      this

    • tanInPlace

      public ComplexBuffer tanInPlace()
      Calculate the tangent of the value of the buffer and store the result in this buffer
      Returns:
      this

    • coshInPlace

      public ComplexBuffer coshInPlace()
      Calculate the hyperbolic cosine of the value of the buffer and store the result in this buffer
      Returns:
      this

    • sinhInPlace

      public ComplexBuffer sinhInPlace()
      Calculate the hyperbolic sine of the value of the buffer and store the result in this buffer
      Returns:
      this

    • tanhInPlace

      public ComplexBuffer tanhInPlace()
      Calculate the hyperbolic tangent of the value of the buffer and store the result in this buffer
      Returns:
      this

    • powInPlace

      public ComplexBuffer powInPlace​(double b)
      Raise this complex number to a real power and store the result in this buffer
      Parameters:
      b - The real power
      Returns:
      this

    • powInPlace

      public ComplexBuffer powInPlace​(ComplexNumber b)
      Raise this complex number to a complex power and store the result in this buffer
      Parameters:
      b - The complex power
      Returns:
      this

    • powInPlace

      public ComplexBuffer powInPlace​(ComplexNumberArray b, int j)
      Raise this complex number to a complex power and store the result in this buffer
      Parameters:
      b - The complex power array
      j - The array index
      Returns:
      this

    • multiplyInPlace

      public ComplexBuffer multiplyInPlace​(ComplexNumber c)
      Multiply the value of this complex buffer by another complex number and store the result in this buffer
      Parameters:
      c - The other complex number
      Returns:
      this

    • multiplyInPlace

      public ComplexBuffer multiplyInPlace​(ComplexNumberArray c, int j)
      Multiply the value of this complex buffer by another complex number and store the result in this buffer
      Parameters:
      c - The other complex number array
      j - The array index
      Returns:
      this

    • multiplyInPlace

      public ComplexBuffer multiplyInPlace​(double d)
      Multiply the value of this complex buffer by a real number and store the result in this buffer
      Parameters:
      d - The real number
      Returns:
      this

    • multiplyInPlace

      public ComplexBuffer multiplyInPlace​(int i)
      Multiply the value of this complex buffer by an integer and store the result in this buffer
      Parameters:
      i - The integer
      Returns:
      this

    • divideInPlace

      public ComplexBuffer divideInPlace​(ComplexNumber c)
      Divide the value of this complex buffer by another complex number and store the result in this buffer
      Parameters:
      c - The other complex number
      Returns:
      this

    • divideInPlace

      public ComplexBuffer divideInPlace​(ComplexNumberArray c, int j)
      Divide the value of this complex buffer by another complex number and store the result in this buffer
      Parameters:
      c - The other complex number array
      j - The array index
      Returns:
      this

    • divideInPlace

      public ComplexBuffer divideInPlace​(double d)
      Divide the value of this complex buffer by a real number and store the result in this buffer
      Parameters:
      d - The real number
      Returns:
      this

    • divideReversedInPlace

      public ComplexBuffer divideReversedInPlace​(ComplexNumber c)
      Divide another complex number by the value of this complex buffer and store the result in this buffer
      Parameters:
      c - The other complex number
      Returns:
      this

    • divideReversedInPlace

      public ComplexBuffer divideReversedInPlace​(ComplexNumberArray c, int j)
      Divide another complex number by the value of this complex buffer and store the result in this buffer
      Parameters:
      c - The other complex number array
      j - The array index
      Returns:
      this

    • divideReversedInPlace

      public ComplexBuffer divideReversedInPlace​(double d)
      Divide a real number by the value of this complex buffer and store the result in this buffer
      Parameters:
      d - The real number
      Returns:
      this

    • 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

    • abs

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

    • arg

      public double arg()
      Calculate the argument of the complex number in this complex buffer. 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 in this buffer 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 in this buffer is NaN

    • isInfinite

      public boolean isInfinite()
      Check whether the complex number in this buffer 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 in this buffer is infinite

    • toString

      public java.lang.String toString()
      Returns a String representation of the complex number in this complex buffer.
      Specified by:
      toString in interface ComplexNumber
      Overrides:
      toString in class java.lang.Object
      Returns:
      "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