ComplexDouble

java.lang.Object
- ej.numeric.ComplexDouble

All Implemented Interfaces:

Complex, java.lang.Cloneable
```
public class ComplexDouble
extends java.lang.Object
implements Complex
```
Implementation of complex ComplexDouble elements

Constructor Summary

Constructors
Constructor and Description

ComplexDouble(double real, double imag)
Create a complex with real and imaginary parts

Constructors
Constructor and Description
`ComplexDouble(double real, double imag)` Create a complex with real and imaginary parts

Method Summary

Methods
Modifier and Type	Method and Description
`ComplexDouble`	`add(ComplexDouble complex)` Add a complex
`ComplexDouble`	`add(double scalar)` Add a scalar
`ComplexDouble`	`addi(ComplexDouble complex)` In place add a complex
`ComplexDouble`	`addi(double scalar)` In place add a scalar
`java.lang.Object`	`clone()` Returns a copy of this `ComplexDouble`
`ComplexDouble`	`conjugate()` Conjugate
`ComplexDouble`	`conjugatei()` In-place conjugate
`ComplexDouble`	`div(ComplexDouble complex)` Divide by a complex
`ComplexDouble`	`div(double scalar)` Divide by a scalar
`ComplexDouble`	`divi(ComplexDouble complex)` In place divide by a complex
`ComplexDouble`	`divi(double scalar)` In place divide by a scalar
`boolean`	`eq(ComplexDouble complex)` Equals between complex numbers
`boolean`	`equals(java.lang.Object object)` Compares this object against the specified object.
`boolean`	`ge(ComplexDouble complex)` Greater or equals between complex numbers' real parts
`boolean`	`ge(double scalar)` Greater or equals between complex number's real part and a scalar
`double`	`getImaginary()` Get the imaginary part of the complex
`double`	`getReal()` Get the real part of the complex
`boolean`	`gt(ComplexDouble complex)` Greater than between complex numbers' real parts
`boolean`	`gt(double scalar)` Greater than between complex number's real part and a scalar
`int`	`hashCode()` Returns a hash code for this object.
`ComplexDouble`	`inv()` Inversion
`ComplexDouble`	`invi()` In-place inversion
`boolean`	`isImaginary()` Test if complex is imaginary
`boolean`	`isNaN()` Returns true, if the current value is not a number.
`boolean`	`isReal()` Test if complex is real
`boolean`	`le(ComplexDouble complex)` Lower or equals between complex numbers' real parts
`boolean`	`le(double scalar)` Lower or equals between complex number's real part and a scalar
`boolean`	`lt(ComplexDouble complex)` Lower than between complex numbers' real parts
`boolean`	`lt(double scalar)` Lower than between complex number's real part and a scalar
`static ComplexDouble`	`minusOne()` Returns a new instance with (-1,0)
`double`	`modulus()` Absolute value/modulus/magnitude
`ComplexDouble`	`mul(ComplexDouble complex)` Multiply by a complex
`ComplexDouble`	`mul(double scalar)` Multiply by a scalar
`ComplexDouble`	`muli(ComplexDouble complex)` In place multiply by a complex
`ComplexDouble`	`muli(double scalar)` In place multiply by a scalar
`static ComplexDouble`	`NaN()` Returns a new instance with value (NaN,NaN)
`boolean`	`ne(ComplexDouble complex)` Not-equals between complex numbers
`ComplexDouble`	`neg()` Negate
`ComplexDouble`	`negi()` In-place negate
`static ComplexDouble`	`one()` Returns a new instance with (1,0)
`void`	`setImaginary(double imag)` Set the imaginary part of the complex
`void`	`setReal(double real)` Set the real part of the complex
`ComplexDouble`	`sqrt()` Positive square root.
`ComplexDouble`	`sqrti()` In-place positive square root.
`ComplexDouble`	`square()` Square
`ComplexDouble`	`squarei()` Square
`ComplexDouble`	`sub(ComplexDouble complex)` Subtract a complex
`ComplexDouble`	`sub(double scalar)` Subtract a scalar
`ComplexDouble`	`subi(ComplexDouble complex)` In place subtract a complex
`ComplexDouble`	`subi(double scalar)` In place subtract a scalar
`ComplexDouble`	`toComplexDouble()` Convert the current complex to ComplexDouble
`ComplexFloat`	`toComplexFloat()` Convert the current complex to ComplexFloat
`double`	`toDouble()` Convert the current complex to double
`float`	`toFloat()` Convert the current complex to float
`java.lang.String`	`toString()` Get string representation of this complex
`static ComplexDouble`	`zero()` Returns a new instance with (0,0)

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

- Constructor Detail
  - ComplexDouble
```
public ComplexDouble(double real,
             double imag)
```
    Create a complex with real and imaginary parts
    
    Parameters:
    real - Real part of the complex
    imag - Imaginary part of the complex
- Method Detail
  - clone
```
public java.lang.Object clone()
```
    Returns a copy of this ComplexDouble
    
    Overrides:
    
    clone in class java.lang.Object
    
    Returns:
    a copy of this ComplexDouble
  - getReal
```
public double getReal()
```
    Get the real part of the complex
    
    Returns:
    Real part of the complex
  - setReal
```
public void setReal(double real)
```
    Set the real part of the complex
    
    Parameters:
    real - Real part of the complex to set
  - isReal
```
public boolean isReal()
```
    Test if complex is real
    
    Returns:
    true if imaginary part is zero
  - getImaginary
```
public double getImaginary()
```
    Get the imaginary part of the complex
    
    Returns:
    Imaginary part of the complex
  - setImaginary
```
public void setImaginary(double imag)
```
    Set the imaginary part of the complex
    
    Parameters:
    imag - Imaginary part of the complex to set
  - isImaginary
```
public boolean isImaginary()
```
    Test if complex is imaginary
    
    Returns:
    true if real part is zero
  - isNaN
```
public boolean isNaN()
```
    Returns true, if the current value is not a number.
    
    Returns:
    true, if the current value is not a number
  - minusOne
```
public static ComplexDouble minusOne()
```
    Returns a new instance with (-1,0)
    
    Returns:
    a new instance with (-1,0)
  - zero
```
public static ComplexDouble zero()
```
    Returns a new instance with (0,0)
    
    Returns:
    a new instance with (0,0)
  - one
```
public static ComplexDouble one()
```
    Returns a new instance with (1,0)
    
    Returns:
    a new instance with (1,0)
  - NaN
```
public static ComplexDouble NaN()
```
    Returns a new instance with value (NaN,NaN)
    
    Returns:
    a new instance with value (NaN,NaN)
  - add
```
public ComplexDouble add(ComplexDouble complex)
```
    Add a complex
    
    Parameters:
    complex - The complex to add to the current complex
    
    Returns:
    New complex with the result of the operation
  - addi
```
public ComplexDouble addi(ComplexDouble complex)
```
    In place add a complex
    
    Parameters:
    complex - The complex to add to the current complex
    
    Returns:
    The current complex
  - add
```
public ComplexDouble add(double scalar)
```
    Add a scalar
    
    Parameters:
    scalar - The scalar to add to the current complex
    
    Returns:
    New complex with the result of the operation
  - addi
```
public ComplexDouble addi(double scalar)
```
    In place add a scalar
    
    Parameters:
    scalar - The scalar to add to the current complex
    
    Returns:
    The current complex
  - sub
```
public ComplexDouble sub(ComplexDouble complex)
```
    Subtract a complex
    
    Parameters:
    complex - The complex to subtract to the current complex
    
    Returns:
    New complex with the result of the operation
  - subi
```
public ComplexDouble subi(ComplexDouble complex)
```
    In place subtract a complex
    
    Parameters:
    complex - The complex to subtract to the current complex
    
    Returns:
    The current complex
  - sub
```
public ComplexDouble sub(double scalar)
```
    Subtract a scalar
    
    Parameters:
    scalar - The scalar to subtract to the current complex
    
    Returns:
    New complex with the result of the operation
  - subi
```
public ComplexDouble subi(double scalar)
```
    In place subtract a scalar
    
    Parameters:
    scalar - The scalar to subtract to the current complex
    
    Returns:
    The current complex
  - mul
```
public ComplexDouble mul(ComplexDouble complex)
```
    Multiply by a complex
    
    Parameters:
    complex - The complex to multiply the current complex by
    
    Returns:
    New complex with the result of the operation
  - muli
```
public ComplexDouble muli(ComplexDouble complex)
```
    In place multiply by a complex
    
    Parameters:
    complex - The complex to multiply the current complex by
    
    Returns:
    The current complex
  - mul
```
public ComplexDouble mul(double scalar)
```
    Multiply by a scalar
    
    Parameters:
    scalar - The scalar to multiply the current complex by
    
    Returns:
    New complex with the result of the operation
  - muli
```
public ComplexDouble muli(double scalar)
```
    In place multiply by a scalar
    
    Parameters:
    scalar - The scalar to multiply the current complex by
    
    Returns:
    The current complex
  - div
```
public ComplexDouble div(ComplexDouble complex)
```
    Divide by a complex
    
    Parameters:
    complex - The complex to divide the current complex by
    
    Returns:
    New complex with the result of the operation
  - divi
```
public ComplexDouble divi(ComplexDouble complex)
```
    In place divide by a complex
    
    Parameters:
    complex - The complex to divide the current complex by
    
    Returns:
    The current complex
  - div
```
public ComplexDouble div(double scalar)
```
    Divide by a scalar
    
    Parameters:
    scalar - The scalar to divide the current complex by
    
    Returns:
    New complex with the result of the operation
  - divi
```
public ComplexDouble divi(double scalar)
```
    In place divide by a scalar
    
    Parameters:
    scalar - The scalar to divide the current complex by
    
    Returns:
    The current complex
  - hashCode
```
public int hashCode()
```
    Returns a hash code for this object.
    
    Overrides:
    
    hashCode in class java.lang.Object
    
    Returns:
    Hash code of the object
  - equals
```
public boolean equals(java.lang.Object object)
```
    Compares this object against the specified object.
    
    Overrides:
    
    equals in class java.lang.Object
    
    Parameters:
    object - Other object to compare complex with
    
    Returns:
    True other object is of type ComplexDouble and equals this object
  - eq
```
public boolean eq(ComplexDouble complex)
```
    Equals between complex numbers
    
    Parameters:
    complex - The complex to compare the current complex with
    
    Returns:
    True if complex numbers are equal
  - ne
```
public boolean ne(ComplexDouble complex)
```
    Not-equals between complex numbers
    
    Parameters:
    complex - The complex to compare the current complex with
    
    Returns:
    True if complex numbers are not equal
  - gt
```
public boolean gt(ComplexDouble complex)
```
    Greater than between complex numbers' real parts
    
    Parameters:
    complex - The complex to compare the current complex with
    
    Returns:
    True if complex number's real part is greater than other complex number's real part
  - gt
```
public boolean gt(double scalar)
```
    Greater than between complex number's real part and a scalar
    
    Parameters:
    scalar - The scalar to compare the elements of the complex with
    
    Returns:
    True if complex number's real part is greater than scalar
  - lt
```
public boolean lt(ComplexDouble complex)
```
    Lower than between complex numbers' real parts
    
    Parameters:
    complex - The complex to compare the current complex with
    
    Returns:
    True if complex number's real part is lower than other complex number's real part
  - lt
```
public boolean lt(double scalar)
```
    Lower than between complex number's real part and a scalar
    
    Parameters:
    scalar - The scalar to compare the elements of the complex with
    
    Returns:
    True if complex number's real part is lower than scalar
  - ge
```
public boolean ge(ComplexDouble complex)
```
    Greater or equals between complex numbers' real parts
    
    Parameters:
    complex - The complex to compare the current complex with
    
    Returns:
    True if complex number's real part is greater or equal than other complex number's real part
  - ge
```
public boolean ge(double scalar)
```
    Greater or equals between complex number's real part and a scalar
    
    Parameters:
    scalar - The scalar to compare the elements of the complex with
    
    Returns:
    True if complex number's real part is greater or equal than scalar
  - le
```
public boolean le(ComplexDouble complex)
```
    Lower or equals between complex numbers' real parts
    
    Parameters:
    complex - The complex to compare the current complex with
    
    Returns:
    True if complex number's real part is lower or equal than other complex number's real part
  - le
```
public boolean le(double scalar)
```
    Lower or equals between complex number's real part and a scalar
    
    Parameters:
    scalar - The scalar to compare the elements of the complex with
    
    Returns:
    True if complex number's real part is lower or equal than scalar
  - conjugate
```
public ComplexDouble conjugate()
```
    Conjugate
    
    Returns:
    a new instance of this ComplexDouble but the value is conjugated (imaginary part is negated)
  - conjugatei
```
public ComplexDouble conjugatei()
```
    In-place conjugate
    
    Returns:
    the current conjugated complex (imaginary part is negated)
  - neg
```
public ComplexDouble neg()
```
    Negate
    
    Returns:
    a new instance of this ComplexDouble but the value is negated (both real and imaginary parts are negated)
  - negi
```
public ComplexDouble negi()
```
    In-place negate
    
    Returns:
    the current negated complex (both real and imaginary parts are negated)
  - inv
```
public ComplexDouble inv()
```
    Inversion
    
    Returns:
    a new instance of this ComplexDouble with the inverse value
    
    Throws:
    
    java.lang.ArithmeticException - if the ComplexDouble cannot be inverted (real^2+imaginary^2==0)
  - invi
```
public ComplexDouble invi()
```
    In-place inversion
    
    Returns:
    the inverse of this instance
    
    Throws:
    
    java.lang.ArithmeticException - if the ComplexDouble cannot be inverted (real^2+imaginary^2==0)
  - modulus
```
public double modulus()
```
    Absolute value/modulus/magnitude
    result = Math.sqrt( real * real + imag * imag )
    
    Returns:
    a new instance of this ComplexDouble with the absolute value
  - sqrt
```
public ComplexDouble sqrt()
```
    Positive square root. The other square root can be obtained by multiplying the returned value with -1.
    
    Returns:
    a new instance of this ComplexDouble with the positive square root
  - sqrti
```
public ComplexDouble sqrti()
```
    In-place positive square root. The other square root can be obtained by multiplying the returned value with -1.
    
    Returns:
    the positive square root of this instance
  - square
```
public ComplexDouble square()
```
    Square
    
    Returns:
    a new instance of this ComplexDouble with the square
  - squarei
```
public ComplexDouble squarei()
```
    Square
    
    Returns:
    the quare of this instance
  - toString
```
public java.lang.String toString()
```
    Get string representation of this complex
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    String representation of this complex
  - toFloat
```
public float toFloat()
```
    Convert the current complex to float
    
    Returns:
    Converted complex to float type
  - toDouble
```
public double toDouble()
```
    Convert the current complex to double
    
    Returns:
    Converted complex to double type
  - toComplexFloat
```
public ComplexFloat toComplexFloat()
```
    Convert the current complex to ComplexFloat
    
    Specified by:
    
    toComplexFloat in interface Complex
    
    Returns:
    Converted complex to ComplexFloat type
  - toComplexDouble
```
public ComplexDouble toComplexDouble()
```
    Convert the current complex to ComplexDouble
    
    Specified by:
    
    toComplexDouble in interface Complex
    
    Returns:
    Converted complex to ComplexDouble type

Class ComplexDouble

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ComplexDouble

Method Detail

clone

getReal

setReal

isReal

getImaginary

setImaginary

isImaginary

isNaN

minusOne

zero

one

NaN

add

addi

add

addi

sub

subi

sub

subi

mul

muli

mul

muli

div

divi

div

divi

hashCode

equals

eq

ne

gt

gt

lt

lt

ge

ge

le

le

conjugate

conjugatei

neg

negi

inv

invi

modulus

sqrt

sqrti

square

squarei

toString

toFloat

toDouble

toComplexFloat

toComplexDouble