ComplexFloat

java.lang.Object
- ej.numeric.ComplexFloat

All Implemented Interfaces:

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

Constructor Summary

Constructors
Constructor and Description

ComplexFloat(float real, float imag)
Create a complex with real and imaginary parts

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

Method Summary

Methods
Modifier and Type	Method and Description
`ComplexFloat`	`add(ComplexFloat complex)` Add a complex
`ComplexFloat`	`add(float scalar)` Add a scalar
`ComplexFloat`	`addi(ComplexFloat complex)` In place add a complex
`ComplexFloat`	`addi(float scalar)` In place add a scalar
`java.lang.Object`	`clone()` Returns a copy of this `ComplexFloat`
`ComplexFloat`	`conjugate()` Conjugate
`ComplexFloat`	`conjugatei()` In-place conjugate
`ComplexFloat`	`div(ComplexFloat complex)` Divide by a complex
`ComplexFloat`	`div(float scalar)` Divide by a scalar
`ComplexFloat`	`divi(ComplexFloat complex)` In place divide by a complex
`ComplexFloat`	`divi(float scalar)` In place divide by a scalar
`boolean`	`eq(ComplexFloat complex)` Equals between complex numbers
`boolean`	`equals(java.lang.Object object)` Compares this object against the specified object.
`boolean`	`ge(ComplexFloat complex)` Greater or equals between complex numbers' real parts
`boolean`	`ge(float scalar)` Greater or equals between complex number's real part and a scalar
`float`	`getImaginary()` Get the imaginary part of the complex
`float`	`getReal()` Get the real part of the complex
`boolean`	`gt(ComplexFloat complex)` Greater than between complex numbers' real parts
`boolean`	`gt(float scalar)` Greater than between complex number's real part and a scalar
`int`	`hashCode()` Returns a hash code for this object.
`ComplexFloat`	`inv()` Inversion
`ComplexFloat`	`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(ComplexFloat complex)` Lower or equals between complex numbers' real parts
`boolean`	`le(float scalar)` Lower or equals between complex number's real part and a scalar
`boolean`	`lt(ComplexFloat complex)` Lower than between complex numbers' real parts
`boolean`	`lt(float scalar)` Lower than between complex number's real part and a scalar
`static ComplexFloat`	`minusOne()` Returns a new instance with (-1,0)
`float`	`modulus()` Absolute value/modulus/magnitude
`ComplexFloat`	`mul(ComplexFloat complex)` Multiply by a complex
`ComplexFloat`	`mul(float scalar)` Multiply by a scalar
`ComplexFloat`	`muli(ComplexFloat complex)` In place multiply by a complex
`ComplexFloat`	`muli(float scalar)` In place multiply by a scalar
`static ComplexFloat`	`NaN()` Returns a new instance with value (NaN,NaN)
`boolean`	`ne(ComplexFloat complex)` Not-equals between complex numbers
`ComplexFloat`	`neg()` Negate
`ComplexFloat`	`negi()` In-place negate
`static ComplexFloat`	`one()` Returns a new instance with (1,0)
`void`	`setImaginary(float imag)` Set the imaginary part of the complex
`void`	`setReal(float real)` Set the real part of the complex
`ComplexFloat`	`sqrt()` Positive square root.
`ComplexFloat`	`sqrti()` In-place positive square root.
`ComplexFloat`	`square()` Square
`ComplexFloat`	`squarei()` Square
`ComplexFloat`	`sub(ComplexFloat complex)` Subtract a complex
`ComplexFloat`	`sub(float scalar)` Subtract a scalar
`ComplexFloat`	`subi(ComplexFloat complex)` In place subtract a complex
`ComplexFloat`	`subi(float 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 ComplexFloat`	`zero()` Returns a new instance with (0,0)

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

- Constructor Detail
  - ComplexFloat
```
public ComplexFloat(float real,
            float 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 ComplexFloat
    
    Overrides:
    
    clone in class java.lang.Object
    
    Returns:
    a copy of this ComplexFloat
  - getReal
```
public float getReal()
```
    Get the real part of the complex
    
    Returns:
    Real part of the complex
  - setReal
```
public void setReal(float 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 float getImaginary()
```
    Get the imaginary part of the complex
    
    Returns:
    Imaginary part of the complex
  - setImaginary
```
public void setImaginary(float 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 ComplexFloat minusOne()
```
    Returns a new instance with (-1,0)
    
    Returns:
    a new instance with (-1,0)
  - zero
```
public static ComplexFloat zero()
```
    Returns a new instance with (0,0)
    
    Returns:
    a new instance with (0,0)
  - one
```
public static ComplexFloat one()
```
    Returns a new instance with (1,0)
    
    Returns:
    a new instance with (1,0)
  - NaN
```
public static ComplexFloat NaN()
```
    Returns a new instance with value (NaN,NaN)
    
    Returns:
    a new instance with value (NaN,NaN)
  - add
```
public ComplexFloat add(ComplexFloat 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 ComplexFloat addi(ComplexFloat complex)
```
    In place add a complex
    
    Parameters:
    complex - The complex to add to the current complex
    
    Returns:
    The current complex
  - add
```
public ComplexFloat add(float 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 ComplexFloat addi(float scalar)
```
    In place add a scalar
    
    Parameters:
    scalar - The scalar to add to the current complex
    
    Returns:
    The current complex
  - sub
```
public ComplexFloat sub(ComplexFloat 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 ComplexFloat subi(ComplexFloat complex)
```
    In place subtract a complex
    
    Parameters:
    complex - The complex to subtract to the current complex
    
    Returns:
    The current complex
  - sub
```
public ComplexFloat sub(float 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 ComplexFloat subi(float scalar)
```
    In place subtract a scalar
    
    Parameters:
    scalar - The scalar to subtract to the current complex
    
    Returns:
    The current complex
  - mul
```
public ComplexFloat mul(ComplexFloat 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 ComplexFloat muli(ComplexFloat complex)
```
    In place multiply by a complex
    
    Parameters:
    complex - The complex to multiply the current complex by
    
    Returns:
    The current complex
  - mul
```
public ComplexFloat mul(float 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 ComplexFloat muli(float scalar)
```
    In place multiply by a scalar
    
    Parameters:
    scalar - The scalar to multiply the current complex by
    
    Returns:
    The current complex
  - div
```
public ComplexFloat div(ComplexFloat 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 ComplexFloat divi(ComplexFloat complex)
```
    In place divide by a complex
    
    Parameters:
    complex - The complex to divide the current complex by
    
    Returns:
    The current complex
  - div
```
public ComplexFloat div(float 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 ComplexFloat divi(float 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 ComplexFloat and equals this object
  - eq
```
public boolean eq(ComplexFloat 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(ComplexFloat 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(ComplexFloat 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(float 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(ComplexFloat 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(float 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(ComplexFloat 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(float 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(ComplexFloat 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(float 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 ComplexFloat conjugate()
```
    Conjugate
    
    Returns:
    a new instance of this ComplexFloat but the value is conjugated (imaginary part is negated)
  - conjugatei
```
public ComplexFloat conjugatei()
```
    In-place conjugate
    
    Returns:
    the current conjugated complex (imaginary part is negated)
  - neg
```
public ComplexFloat neg()
```
    Negate
    
    Returns:
    a new instance of this ComplexFloat but the value is negated (both real and imaginary parts are negated)
  - negi
```
public ComplexFloat negi()
```
    In-place negate
    
    Returns:
    the current negated complex (both real and imaginary parts are negated)
  - inv
```
public ComplexFloat inv()
```
    Inversion
    
    Returns:
    a new instance of this ComplexFloat with the inverse value
    
    Throws:
    
    java.lang.ArithmeticException - if the ComplexFloat cannot be inverted (real^2+imaginary^2==0)
  - invi
```
public ComplexFloat invi()
```
    In-place inversion
    
    Returns:
    the inverse of this instance
    
    Throws:
    
    java.lang.ArithmeticException - if the ComplexFloat cannot be inverted (real^2+imaginary^2==0)
  - modulus
```
public float modulus()
```
    Absolute value/modulus/magnitude
    result = Math.sqrt( real * real + imag * imag )
    
    Returns:
    a new instance of this ComplexFloat with the absolute value
  - sqrt
```
public ComplexFloat sqrt()
```
    Positive square root. The other square root can be obtained by multiplying the returned value with -1.
    
    Returns:
    a new instance of this ComplexFloat with the positive square root
  - sqrti
```
public ComplexFloat 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 ComplexFloat square()
```
    Square
    
    Returns:
    a new instance of this ComplexFloat with the square
  - squarei
```
public ComplexFloat 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 ComplexFloat

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ComplexFloat

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