Complex (josef 3.2.5 API)

java.lang.Object
- org.josef.science.math.Complex

All Implemented Interfaces:

Serializable
```
@ThreadSafety(level=IMMUTABLE)
public final class Complex
extends Object
implements Serializable
```
Abstraction of a Complex number.
Both the real and the imaginary part of a Complex number are represented by a double.
For a technical background read the article on WikiPedia by clicking here. Note: This class solves some of the problems Joshua Bloch mentions so this Class is a first Class citizen. However, if you are seriously going to use Complex numbers, you are probably better of using: apache commons math .
The rules that apply to double arithmetic, also apply to arithmetic on Complex numbers. Using a Complex NaN in any operation, results in NaN for example.

Version:

1.0 $Revision: 6488 $

Author:

Joshua Bloch Effective Java 2nd edition Item 15, Kees Schotanus

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static Complex`	`I` Complex imaginary number I (Square root of -1).
`static Complex`	`NOT_A_NUMBER` Complex number representing NaN (Not a Number).
`static Complex`	`ONE` Complex number with a value of one.
`static Complex`	`TWO` Complex number with a value of two.
`static Complex`	`ZERO` Complex number with a value of zero.

Constructor Summary

Constructors
Constructor and Description

Complex(double real, double imaginary)
Constructs this Complex number from the supplied real and imaginary parts.

Constructors
Constructor and Description
`Complex(double real, double imaginary)` Constructs this Complex number from the supplied real and imaginary parts.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Complex`	`add(Complex complex)` Adds the supplied Complex number to this Complex number.
`static Complex`	`add(Complex left, Complex right)` Computes left + right.
`Complex`	`divide(Complex complex)` Multiplies this Complex number by the supplied Complex number.
`static Complex`	`divide(Complex left, Complex right)` Computes left * right.
`boolean`	`equals(Object object)` Determines whether this object and the supplied object are the same.
`double`	`getImaginary()` Gets the imaginary part of this Complex number.
`double`	`getReal()` Gets the real part of this Complex number.
`int`	`hashCode()` Creates a hash code for this Complex number.
`boolean`	`isInfinite()` Determines whether this Complex number is Infinite..
`boolean`	`isNaN()` Determines whether this Complex number is NaN (Not a Number).
`Complex`	`multiply(Complex complex)` Multiplies this Complex number by the supplied Complex number.
`static Complex`	`multiply(Complex left, Complex right)` Computes left * right.
`Complex`	`negate()` Negates this Complex number.
`Complex`	`subtract(Complex complex)` Subtracts the supplied Complex number from this Complex number.
`static Complex`	`subtract(Complex left, Complex right)` Computes left - right.
`String`	`toString()` Creates a String representation of this Complex number.
`static Complex`	`valueOf(double real, double imaginary)` Creates a Complex number from the supplied real and imaginary parts.

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

- Field Detail
  - ZERO
```
public static final Complex ZERO
```
    Complex number with a value of zero.
  - ONE
```
public static final Complex ONE
```
    Complex number with a value of one.
  - TWO
```
public static final Complex TWO
```
    Complex number with a value of two.
  - I
```
public static final Complex I
```
    Complex imaginary number I (Square root of -1).
  - NOT_A_NUMBER
```
public static final Complex NOT_A_NUMBER
```
    Complex number representing NaN (Not a Number).
- Constructor Detail
  - Complex
```
public Complex(double real,
               double imaginary)
```
    Constructs this Complex number from the supplied real and imaginary parts.
    
    Parameters:
    
    real - The real part for this Complex number.
    
    imaginary - The imaginary part for this Complex number.
- Method Detail
  - valueOf
```
public static Complex valueOf(double real,
                              double imaginary)
```
    Creates a Complex number from the supplied real and imaginary parts.
    This method will return predefined Complex numbers whenever possible.
    
    Parameters:
    
    real - The real part for this Complex number.
    
    imaginary - The imaginary part for this Complex number.
    
    Returns:
    
    The Complex number.
  - getReal
```
public double getReal()
```
    Gets the real part of this Complex number.
    
    Returns:
    
    The real part of this Complex number.
  - getImaginary
```
public double getImaginary()
```
    Gets the imaginary part of this Complex number.
    
    Returns:
    
    The imaginary part of this Complex number.
  - negate
```
public Complex negate()
```
    Negates this Complex number.
    
    Returns:
    
    The negate of this Complex number.
  - add
```
public Complex add(Complex complex)
```
    Adds the supplied Complex number to this Complex number.
    
    Parameters:
    
    complex - The Complex number to add to this Complex number.
    
    Returns:
    
    The result of adding the supplied Complex number to this Complex number.
    
    Throws:
    
    NullPointerException - When the supplied Complex number is null.
  - add
```
public static Complex add(Complex left,
                          Complex right)
```
    Computes left + right.
    
    Parameters:
    
    left - The Complex number at the left of the plus operator.
    
    right - The Complex number at the right of the plus operator.
    
    Returns:
    
    The result of adding the supplied Complex numbers.
    
    Throws:
    
    NullPointerException - When either the supplied left or right Complex number is null.
  - subtract
```
public Complex subtract(Complex complex)
```
    Subtracts the supplied Complex number from this Complex number.
    
    Parameters:
    
    complex - The Complex number to subtract from this Complex number.
    
    Returns:
    
    The result of subtracting the supplied Complex number from this Complex number.
    
    Throws:
    
    NullPointerException - When the supplied Complex number is null.
  - subtract
```
public static Complex subtract(Complex left,
                               Complex right)
```
    Computes left - right.
    
    Parameters:
    
    left - The Complex number at the left of the minus operator
    
    right - The Complex number at the right of the minus operator.
    
    Returns:
    
    The result of subtracting the right Complex number from the left Complex number.
    
    Throws:
    
    NullPointerException - When either the supplied left or right Complex number is null.
  - multiply
```
public Complex multiply(Complex complex)
```
    Multiplies this Complex number by the supplied Complex number.
    
    Parameters:
    
    complex - The Complex number to multiply with.
    
    Returns:
    
    The result of multiplying this Complex number by the supplied Complex number.
    
    Throws:
    
    NullPointerException - When the supplied Complex number is null.
  - multiply
```
public static Complex multiply(Complex left,
                               Complex right)
```
    Computes left * right.
    
    Parameters:
    
    left - The Complex number at the left of the multiply operator.
    
    right - The Complex number at the right of the multiply operator.
    
    Returns:
    
    The result of multiplying the supplied Complex numbers.
    
    Throws:
    
    NullPointerException - When either the supplied left or right Complex number is null.
  - divide
```
public Complex divide(Complex complex)
```
    Multiplies this Complex number by the supplied Complex number.
    
    Parameters:
    
    complex - The Complex number to multiply with.
    
    Returns:
    
    The result of multiplying this Complex number by the supplied Complex number.
    
    Throws:
    
    NullPointerException - When the supplied Complex number is null.
  - divide
```
public static Complex divide(Complex left,
                             Complex right)
```
    Computes left * right.
    
    Parameters:
    
    left - The Complex number at the left of the multiply operator.
    
    right - The Complex number at the right of the multiply operator.
    
    Returns:
    
    The result of multiplying the supplied Complex numbers.
    
    Throws:
    
    NullPointerException - When either the supplied left or right Complex number is null.
  - isNaN
```
public boolean isNaN()
```
    Determines whether this Complex number is NaN (Not a Number).
    A Complex number is NaN when either its real or imaginary part is NaN.
    
    Returns:
    
    True, when this Complex number is NaN, false otherwise.
  - isInfinite
```
public boolean isInfinite()
```
    Determines whether this Complex number is Infinite..
    A Complex number is Infinite when either its real or imaginary part is either Double.POSITIVE_INFINITY or Double.NEGATIVE_INFINITY.
    
    Returns:
    
    True, when this Complex number is Infinite, false otherwise.
  - equals
```
public boolean equals(Object object)
```
    Determines whether this object and the supplied object are the same.
    The two objects are the same if the supplied object is not null and the supplied object is a Complex and the real and imaginary parts of both Complex numbers are the same.
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    object - The Complex number to compare with.
    
    Returns:
    
    True if both objects are the same, false otherwise.
  - hashCode
```
public int hashCode()
```
    Creates a hash code for this Complex number.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    The hash code for this Complex number.
  - toString
```
public String toString()
```
    Creates a String representation of this Complex number.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A String representation of this Complex number.

Class Complex

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ZERO

ONE

TWO

I

NOT_A_NUMBER

Constructor Detail

Complex

Method Detail

valueOf

getReal

getImaginary

negate

add

add

subtract

subtract

multiply

multiply

divide

divide

isNaN

isInfinite

equals

hashCode

toString