Complex

java.lang.Object
- smile.math.Complex

All Implemented Interfaces:

java.io.Serializable
```
public class Complex
extends java.lang.Object
implements java.io.Serializable
```
Complex number. The object is immutable so once you create and initialize a Complex object, you cannot modify it.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Complex.Array
Packed array of complex numbers for better memory efficiency.

Nested Classes
Modifier and Type	Class and Description
`static class`	`Complex.Array` Packed array of complex numbers for better memory efficiency.

Field Summary

Fields
Modifier and Type Field and Description

double im
The imaginary part.

double re
The real part.

Fields
Modifier and Type	Field and Description
`double`	`im` The imaginary part.
`double`	`re` The real part.

Constructor Summary

Constructors
Constructor and Description

Complex(double real, double imag)
Constructor.

Constructors
Constructor and Description
`Complex(double real, double imag)` Constructor.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`double`	`abs()` Returns abs/modulus/magnitude.
`Complex`	`add(Complex b)` Returns this + b.
`Complex`	`conjugate()` Returns the conjugate.
`Complex`	`cos()` Returns the complex cosine.
`Complex`	`div(Complex b)` Returns a / b.
`boolean`	`equals(java.lang.Object o)`
`Complex`	`exp()` Returns the complex exponential.
`int`	`hashCode()`
`Complex`	`mul(Complex b)` Returns this * b.
`static Complex`	`of(double real)` Returns a Complex instance representing the specified value.
`static Complex`	`of(double real, double imag)` Returns a Complex instance representing the specified value.
`double`	`phase()` Returns angle/phase/argument between -pi and pi.
`Complex`	`reciprocal()` Returns the reciprocal.
`Complex`	`scale(double b)` Scalar multiplication.
`Complex`	`sin()` Returns the complex sine.
`Complex`	`sub(Complex b)` Returns this - b.
`Complex`	`tan()` Returns the complex tangent.
`java.lang.String`	`toString()`

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

- Field Detail
  - re
```
public final double re
```
    The real part.
  - im
```
public final double im
```
    The imaginary part.
- Constructor Detail
  - Complex
```
public Complex(double real,
               double imag)
```
    Constructor.
    
    Parameters:
    
    real - real part
    
    imag - imaginary part
- Method Detail
  - of
```
public static Complex of(double real)
```
    Returns a Complex instance representing the specified value.
  - of
```
public static Complex of(double real,
                         double imag)
```
    Returns a Complex instance representing the specified value.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object o)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - add
```
public Complex add(Complex b)
```
    Returns this + b.
  - sub
```
public Complex sub(Complex b)
```
    Returns this - b.
  - mul
```
public Complex mul(Complex b)
```
    Returns this * b.
  - scale
```
public Complex scale(double b)
```
    Scalar multiplication.
    
    Returns:
    
    this * b.
  - div
```
public Complex div(Complex b)
```
    Returns a / b.
  - abs
```
public double abs()
```
    Returns abs/modulus/magnitude.
  - phase
```
public double phase()
```
    Returns angle/phase/argument between -pi and pi.
  - conjugate
```
public Complex conjugate()
```
    Returns the conjugate.
  - reciprocal
```
public Complex reciprocal()
```
    Returns the reciprocal.
  - exp
```
public Complex exp()
```
    Returns the complex exponential.
  - sin
```
public Complex sin()
```
    Returns the complex sine.
  - cos
```
public Complex cos()
```
    Returns the complex cosine.
  - tan
```
public Complex tan()
```
    Returns the complex tangent.

Class Complex

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

re

im

Constructor Detail

Complex

Method Detail

of

of

toString

equals

hashCode

add

sub

mul

scale

div

abs

phase

conjugate

reciprocal

exp

sin

cos

tan