java.lang.Object
- org.jblas.ComplexDouble

public class ComplexDouble
extends java.lang.Object

A complex value with double precision.

Field Summary

Fields
Modifier and Type	Field	Description
`private double`	`i`
`static ComplexDouble`	`I`
`static ComplexDouble`	`NEG_I`
`static ComplexDouble`	`NEG_UNIT`
`private double`	`r`
`static ComplexDouble`	`UNIT`
`static ComplexDouble`	`ZERO`

Constructor Summary

Constructors
Constructor Description

ComplexDouble(double real)

ComplexDouble(double real, double imag)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`double`	`abs()`	Return the absolute value
`ComplexDouble`	`add(double c)`	Add a real number to a complex number.
`ComplexDouble`	`add(ComplexDouble c)`	Add two complex numbers.
`ComplexDouble`	`addi(double c)`	Add a real number to complex number in-place, storing the result in this.
`ComplexDouble`	`addi(double a, ComplexDouble result)`	Add a real number to a complex number in-place.
`ComplexDouble`	`addi(ComplexDouble c)`	Add two complex numbers in-place storing the result in this.
`ComplexDouble`	`addi(ComplexDouble c, ComplexDouble result)`	Add two complex numbers in-place
`double`	`arg()`	Returns the argument of a complex number.
`ComplexDouble`	`conj()`
`ComplexDouble`	`conji()`
`ComplexDouble`	`copy(ComplexDouble other)`
`ComplexDouble`	`div(double v)`
`ComplexDouble`	`div(ComplexDouble c)`	Divide two complex numbers
`ComplexDouble`	`divi(double v)`
`ComplexDouble`	`divi(double v, ComplexDouble result)`
`ComplexDouble`	`divi(ComplexDouble c)`
`ComplexDouble`	`divi(ComplexDouble c, ComplexDouble result)`	Divide two complex numbers, in-place
`ComplexDouble`	`dup()`
`boolean`	`eq(ComplexDouble c)`
`boolean`	`equals(java.lang.Object o)`	Comparing two ComplexDouble values.
`int`	`hashCode()`
`double`	`imag()`
`ComplexDouble`	`inv()`
`ComplexDouble`	`invi()`
`boolean`	`isImag()`
`boolean`	`isReal()`
`boolean`	`isZero()`
`ComplexDouble`	`mul(double v)`
`ComplexDouble`	`mul(ComplexDouble c)`	Multiply two complex numbers
`ComplexDouble`	`muli(double v)`
`ComplexDouble`	`muli(double v, ComplexDouble result)`
`ComplexDouble`	`muli(ComplexDouble c)`
`ComplexDouble`	`muli(ComplexDouble c, ComplexDouble result)`	Multiply two complex numbers, in-place
`boolean`	`ne(ComplexDouble c)`
`ComplexDouble`	`neg()`
`ComplexDouble`	`negi()`
`double`	`real()`
`ComplexDouble`	`set(double real, double imag)`
`ComplexDouble`	`sqrt()`
`ComplexDouble`	`sub(double r)`
`ComplexDouble`	`sub(ComplexDouble c)`	Subtract two complex numbers
`ComplexDouble`	`subi(double a)`
`ComplexDouble`	`subi(double a, ComplexDouble result)`
`ComplexDouble`	`subi(ComplexDouble c)`
`ComplexDouble`	`subi(ComplexDouble c, ComplexDouble result)`	Subtract two complex numbers, in-place
`java.lang.String`	`toString()`

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

Field Detail

r
```
private double r
```

i
```
private double i
```

UNIT
```
public static final ComplexDouble UNIT
```

I
```
public static final ComplexDouble I
```

NEG_UNIT

public static final ComplexDouble NEG_UNIT

NEG_I

public static final ComplexDouble NEG_I

ZERO
```
public static final ComplexDouble ZERO
```

Constructor Detail

ComplexDouble

public ComplexDouble(double real,
                     double imag)

ComplexDouble
```
public ComplexDouble(double real)
```

Method Detail

toString
```
public java.lang.String toString()
```
Overrides:

toString in class java.lang.Object

set

public ComplexDouble set(double real,
                         double imag)

real
```
public double real()
```

imag
```
public double imag()
```

dup
```
public ComplexDouble dup()
```

copy

public ComplexDouble copy(ComplexDouble other)

addi
```
public ComplexDouble addi(ComplexDouble c,
                          ComplexDouble result)
```
Add two complex numbers in-place

Parameters:

c - other complex number

result - complex number where result is stored

Returns:

same as result

addi
```
public ComplexDouble addi(ComplexDouble c)
```
Add two complex numbers in-place storing the result in this.

Parameters:

c - other complex number

Returns:

resulting complex number

add
```
public ComplexDouble add(ComplexDouble c)
```
Add two complex numbers.

Parameters:

c - other complex number

Returns:

new complex number with result

addi
```
public ComplexDouble addi(double a,
                          ComplexDouble result)
```
Add a real number to a complex number in-place.

Parameters:

a - real number to add

result - complex number to hold result

Returns:

same as result

addi
```
public ComplexDouble addi(double c)
```
Add a real number to complex number in-place, storing the result in this.

Parameters:

c - real number to add

Returns:

resulting complex number

add
```
public ComplexDouble add(double c)
```
Add a real number to a complex number.

Parameters:

c - real number to add

Returns:

new complex number with result

subi
```
public ComplexDouble subi(ComplexDouble c,
                          ComplexDouble result)
```
Subtract two complex numbers, in-place

Parameters:

c - complex number to subtract

result - resulting complex number

Returns:

same as result

subi

public ComplexDouble subi(ComplexDouble c)

sub
```
public ComplexDouble sub(ComplexDouble c)
```
Subtract two complex numbers

Parameters:

c - complex number to subtract

Returns:

new complex number with result

subi

public ComplexDouble subi(double a,
                          ComplexDouble result)

subi

public ComplexDouble subi(double a)

sub

public ComplexDouble sub(double r)

muli
```
public ComplexDouble muli(ComplexDouble c,
                          ComplexDouble result)
```
Multiply two complex numbers, in-place

Parameters:

c - other complex number

result - complex number where product is stored

Returns:

same as result

muli

public ComplexDouble muli(ComplexDouble c)

mul
```
public ComplexDouble mul(ComplexDouble c)
```
Multiply two complex numbers

Parameters:

c - other complex number

Returns:

new complex number with product of this and c

mul

public ComplexDouble mul(double v)

muli

public ComplexDouble muli(double v,
                          ComplexDouble result)

muli

public ComplexDouble muli(double v)

div
```
public ComplexDouble div(ComplexDouble c)
```
Divide two complex numbers

Parameters:

c - complex number to divide this by

Returns:

new complex number with quotient of this and c

divi
```
public ComplexDouble divi(ComplexDouble c,
                          ComplexDouble result)
```
Divide two complex numbers, in-place

Parameters:

c - complex number to divide this by

result - complex number to hold result

Returns:

same as result

divi

public ComplexDouble divi(ComplexDouble c)

divi

public ComplexDouble divi(double v,
                          ComplexDouble result)

divi

public ComplexDouble divi(double v)

div

public ComplexDouble div(double v)

abs
```
public double abs()
```
Return the absolute value

Returns:

the result (length of the vector in 2d plane)

arg
```
public double arg()
```
Returns the argument of a complex number.

Returns:

the result (angle in radians of the vector in 2d plane)

invi
```
public ComplexDouble invi()
```

inv
```
public ComplexDouble inv()
```

neg
```
public ComplexDouble neg()
```

negi
```
public ComplexDouble negi()
```

conji
```
public ComplexDouble conji()
```

conj
```
public ComplexDouble conj()
```

sqrt
```
public ComplexDouble sqrt()
```

equals
```
public boolean equals(java.lang.Object o)
```
Comparing two ComplexDouble values.

Overrides:

equals in class java.lang.Object

Parameters:

o - object to compare this against

Returns:

true if both numbers have the same value

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class java.lang.Object

eq

public boolean eq(ComplexDouble c)

ne

public boolean ne(ComplexDouble c)

isZero
```
public boolean isZero()
```

isReal
```
public boolean isReal()
```

isImag
```
public boolean isImag()
```

Constructor	Description
`ComplexDouble(double real)`
`ComplexDouble(double real, double imag)`

Class ComplexDouble

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

r

i

UNIT

I

NEG_UNIT

NEG_I

ZERO

Constructor Detail

ComplexDouble

ComplexDouble

Method Detail

toString

set

real

imag

dup

copy

addi

addi

add

addi

addi

add

subi

subi

sub

subi

subi

sub

muli

muli

mul

mul

muli

muli

div

divi

divi

divi

divi

div

abs

arg

invi

inv

neg

negi

conji

conj

sqrt

equals

hashCode

eq

ne

isZero

isReal

isImag