ComplexFloat (jblas 1.2.4 API)

java.lang.Object
- org.jblas.ComplexFloat

```
public class ComplexFloat
extends Object
```
A complex value with float precision.

Author:

Mikio L. Braun

Field Summary

Fields
Modifier and Type Field and Description

static ComplexFloat I

static ComplexFloat NEG_I

static ComplexFloat NEG_UNIT

static ComplexFloat UNIT

static ComplexFloat ZERO

Fields
Modifier and Type	Field and Description
`static ComplexFloat`	`I`
`static ComplexFloat`	`NEG_I`
`static ComplexFloat`	`NEG_UNIT`
`static ComplexFloat`	`UNIT`
`static ComplexFloat`	`ZERO`

Constructor Summary

Constructors
Constructor and Description

ComplexFloat(float real)

ComplexFloat(float real, float imag)

Constructors
Constructor and Description
`ComplexFloat(float real)`
`ComplexFloat(float real, float imag)`

Method Summary

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

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

Field Detail

UNIT
```
public static final ComplexFloat UNIT
```

I
```
public static final ComplexFloat I
```

NEG_UNIT

public static final ComplexFloat NEG_UNIT

NEG_I
```
public static final ComplexFloat NEG_I
```

ZERO
```
public static final ComplexFloat ZERO
```

Constructor Detail

ComplexFloat

public ComplexFloat(float real,
                    float imag)

ComplexFloat
```
public ComplexFloat(float real)
```

Method Detail

toString
```
public String toString()
```
Overrides:

toString in class Object

set

public ComplexFloat set(float real,
                        float imag)

real
```
public float real()
```

imag
```
public float imag()
```

dup
```
public ComplexFloat dup()
```

copy

public ComplexFloat copy(ComplexFloat other)

addi
```
public ComplexFloat addi(ComplexFloat c,
                         ComplexFloat 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 ComplexFloat addi(ComplexFloat c)
```
Add two complex numbers in-place storing the result in this.

Parameters:

c - other complex number

Returns:

resulting complex number

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

Parameters:

c - other complex number

Returns:

new complex number with result

addi
```
public ComplexFloat addi(float a,
                         ComplexFloat 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 ComplexFloat addi(float 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 ComplexFloat add(float c)
```
Add a real number to a complex number.

Parameters:

c - real number to add

Returns:

new complex number with result

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

Parameters:

c - complex number to subtract

result - resulting complex number

Returns:

same as result

subi

public ComplexFloat subi(ComplexFloat c)

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

Parameters:

c - complex number to subtract

Returns:

new complex number with result

subi

public ComplexFloat subi(float a,
                         ComplexFloat result)

subi
```
public ComplexFloat subi(float a)
```

sub
```
public ComplexFloat sub(float r)
```

muli
```
public ComplexFloat muli(ComplexFloat c,
                         ComplexFloat 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 ComplexFloat muli(ComplexFloat c)

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

Parameters:

c - other complex number

Returns:

new complex number with product of this and c

mul
```
public ComplexFloat mul(float v)
```

muli

public ComplexFloat muli(float v,
                         ComplexFloat result)

muli
```
public ComplexFloat muli(float v)
```

div
```
public ComplexFloat div(ComplexFloat 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 ComplexFloat divi(ComplexFloat c,
                         ComplexFloat 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 ComplexFloat divi(ComplexFloat c)

divi

public ComplexFloat divi(float v,
                         ComplexFloat result)

divi
```
public ComplexFloat divi(float v)
```

div
```
public ComplexFloat div(float v)
```

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

Returns:

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

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

Returns:

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

invi
```
public ComplexFloat invi()
```

inv
```
public ComplexFloat inv()
```

neg
```
public ComplexFloat neg()
```

negi
```
public ComplexFloat negi()
```

conji
```
public ComplexFloat conji()
```

conj
```
public ComplexFloat conj()
```

sqrt
```
public ComplexFloat sqrt()
```

equals
```
public boolean equals(Object o)
```
Comparing two ComplexFloat values.

Overrides:

equals in class 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 Object

eq
```
public boolean eq(ComplexFloat c)
```

ne
```
public boolean ne(ComplexFloat c)
```

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

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

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

Class ComplexFloat

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

UNIT

I

NEG_UNIT

NEG_I

ZERO

Constructor Detail

ComplexFloat

ComplexFloat

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