org.nd4j.linalg.api.complex

Class BaseComplexFloat

java.lang.Object

org.nd4j.linalg.api.complex.BaseComplexFloat

All Implemented Interfaces:

IComplexFloat, IComplexNumber

public abstract class BaseComplexFloat
extends java.lang.Object
implements IComplexFloat

Base complex float class

Author:

Adam Gibson

Field Summary

Fields

Modifier and Type	Field and Description
protected float	imag
protected float	real

Constructor Summary

Constructors

Constructor and Description
BaseComplexFloat(float real)
BaseComplexFloat(float real, float imag)

Method Summary

Modifier and Type	Method and Description
java.lang.Float	absoluteValue() Return the absolute value
IComplexNumber	add(IComplexNumber c) Add two complex numbers.
IComplexNumber	add(java.lang.Number c) Add a realComponent number to a complex number.
IComplexNumber	addi(IComplexNumber c) Add two complex numbers in-place storing the result in this.
IComplexNumber	addi(IComplexNumber c, IComplexNumber result) Add two complex numbers in-place
IComplexNumber	addi(java.lang.Number c) Add a realComponent number to complex number in-place, storing the result in this.
IComplexNumber	addi(java.lang.Number a, IComplexNumber result) Add a realComponent number to a complex number in-place.
IComplexDouble	asDouble() Convert to a double
IComplexFloat	asFloat() Convert to a float
java.lang.Float	complexArgument() Returns the argument of a complex number.
IComplexNumber	conj()
IComplexFloat	conji()
IComplexNumber	copy(IComplexNumber other)
IComplexNumber	div(float v)
IComplexNumber	div(IComplexNumber c) Divide two complex numbers
IComplexNumber	div(java.lang.Number v)
IComplexFloat	divi(float v)
IComplexNumber	divi(IComplexNumber c)
IComplexNumber	divi(IComplexNumber c, IComplexNumber result) Divide two complex numbers, in-place
IComplexNumber	divi(java.lang.Number v)
IComplexNumber	divi(java.lang.Number v, IComplexNumber result)
boolean	eq(IComplexNumber c)
boolean	equals(java.lang.Object o) Comparing two floatComplex values.
int	hashCode()
java.lang.Float	imaginaryComponent()
IComplexNumber	inv()
IComplexFloat	invi()
boolean	isImag()
boolean	isReal()
boolean	isZero()
IComplexNumber	mul(IComplexNumber c) Multiply two complex numbers
IComplexNumber	mul(java.lang.Number v)
IComplexNumber	muli(IComplexNumber c)
IComplexNumber	muli(IComplexNumber c, IComplexNumber result) Multiply two complex numbers, inplace
IComplexNumber	muli(java.lang.Number v)
IComplexNumber	muli(java.lang.Number v, IComplexNumber result)
boolean	ne(IComplexNumber c)
IComplexNumber	neg()
IComplexFloat	negi()
java.lang.Float	realComponent()
IComplexNumber	set(java.lang.Number real, java.lang.Number imag)
IComplexFloat	sqrt()
IComplexNumber	sub(IComplexNumber c) Subtract two complex numbers
IComplexNumber	sub(java.lang.Number r)
IComplexNumber	subi(IComplexNumber c)
IComplexNumber	subi(IComplexNumber c, IComplexNumber result) Subtract two complex numbers, in-place
IComplexNumber	subi(java.lang.Number a)
IComplexNumber	subi(java.lang.Number a, IComplexNumber result)
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.nd4j.linalg.api.complex.IComplexNumber

dup

Field Detail

real

protected float real

imag

protected float imag

Constructor Detail

BaseComplexFloat

public BaseComplexFloat(float real,
                        float imag)

BaseComplexFloat

public BaseComplexFloat(float real)

Method Detail

asDouble

public IComplexDouble asDouble()

Convert to a double

Specified by:

asDouble in interface IComplexNumber

Returns:

this complex number as a double

asFloat

public IComplexFloat asFloat()

Convert to a float

Specified by:

asFloat in interface IComplexNumber

Returns:

this complex number as a float

conji

public IComplexFloat conji()

Specified by:

conji in interface IComplexNumber

conj

public IComplexNumber conj()

Specified by:

conj in interface IComplexNumber

set

public IComplexNumber set(java.lang.Number real,
                          java.lang.Number imag)

Specified by:

set in interface IComplexNumber

copy

public IComplexNumber copy(IComplexNumber other)

Specified by:

copy in interface IComplexNumber

addi

public IComplexNumber addi(IComplexNumber c,
                           IComplexNumber result)

Add two complex numbers in-place

Specified by:

addi in interface IComplexNumber

Parameters:

c -

result -

addi

public IComplexNumber addi(IComplexNumber c)

Add two complex numbers in-place storing the result in this.

Specified by:

addi in interface IComplexNumber

Parameters:

c -

add

public IComplexNumber add(IComplexNumber c)

Add two complex numbers.

Specified by:

add in interface IComplexNumber

Parameters:

c -

addi

public IComplexNumber addi(java.lang.Number a,
                           IComplexNumber result)

Add a realComponent number to a complex number in-place.

Specified by:

addi in interface IComplexNumber

Parameters:

a -

result -

addi

public IComplexNumber addi(java.lang.Number c)

Add a realComponent number to complex number in-place, storing the result in this.

Specified by:

addi in interface IComplexNumber

Parameters:

c -

add

public IComplexNumber add(java.lang.Number c)

Add a realComponent number to a complex number.

Specified by:

add in interface IComplexNumber

Parameters:

c -

subi

public IComplexNumber subi(IComplexNumber c,
                           IComplexNumber result)

Subtract two complex numbers, in-place

Specified by:

subi in interface IComplexNumber

Parameters:

c -

result -

subi

public IComplexNumber subi(IComplexNumber c)

Specified by:

subi in interface IComplexNumber

sub

public IComplexNumber sub(IComplexNumber c)

Subtract two complex numbers

Specified by:

sub in interface IComplexNumber

Parameters:

c -

subi

public IComplexNumber subi(java.lang.Number a,
                           IComplexNumber result)

Specified by:

subi in interface IComplexNumber

subi

public IComplexNumber subi(java.lang.Number a)

Specified by:

subi in interface IComplexNumber

sub

public IComplexNumber sub(java.lang.Number r)

Specified by:

sub in interface IComplexNumber

muli

public IComplexNumber muli(IComplexNumber c,
                           IComplexNumber result)

Multiply two complex numbers, inplace

Specified by:

muli in interface IComplexNumber

Parameters:

c -

result -

muli

public IComplexNumber muli(IComplexNumber c)

Specified by:

muli in interface IComplexNumber

mul

public IComplexNumber mul(IComplexNumber c)

Multiply two complex numbers

Specified by:

mul in interface IComplexNumber

Parameters:

c -

mul

public IComplexNumber mul(java.lang.Number v)

Specified by:

mul in interface IComplexNumber

muli

public IComplexNumber muli(java.lang.Number v,
                           IComplexNumber result)

Specified by:

muli in interface IComplexNumber

muli

public IComplexNumber muli(java.lang.Number v)

Specified by:

muli in interface IComplexNumber

div

public IComplexNumber div(IComplexNumber c)

Divide two complex numbers

Specified by:

div in interface IComplexNumber

Parameters:

c -

divi

public IComplexNumber divi(IComplexNumber c,
                           IComplexNumber result)

Divide two complex numbers, in-place

Specified by:

divi in interface IComplexNumber

Parameters:

c -

result -

divi

public IComplexNumber divi(IComplexNumber c)

Specified by:

divi in interface IComplexNumber

divi

public IComplexNumber divi(java.lang.Number v,
                           IComplexNumber result)

Specified by:

divi in interface IComplexNumber

divi

public IComplexNumber divi(java.lang.Number v)

Specified by:

divi in interface IComplexNumber

div

public IComplexNumber div(java.lang.Number v)

Specified by:

div in interface IComplexNumber

eq

public boolean eq(IComplexNumber c)

Specified by:

eq in interface IComplexNumber

ne

public boolean ne(IComplexNumber c)

Specified by:

ne in interface IComplexNumber

realComponent

public java.lang.Float realComponent()

Specified by:

realComponent in interface IComplexFloat

Specified by:

realComponent in interface IComplexNumber

imaginaryComponent

public java.lang.Float imaginaryComponent()

Specified by:

imaginaryComponent in interface IComplexFloat

Specified by:

imaginaryComponent in interface IComplexNumber

divi

public IComplexFloat divi(float v)

Specified by:

divi in interface IComplexFloat

div

public IComplexNumber div(float v)

Specified by:

div in interface IComplexFloat

absoluteValue

public java.lang.Float absoluteValue()

Return the absolute value

Specified by:

absoluteValue in interface IComplexNumber

complexArgument

public java.lang.Float complexArgument()

Returns the argument of a complex number.

Specified by:

complexArgument in interface IComplexFloat

Specified by:

complexArgument in interface IComplexNumber

invi

public IComplexFloat invi()

Specified by:

invi in interface IComplexNumber

inv

public IComplexNumber inv()

Specified by:

inv in interface IComplexNumber

neg

public IComplexNumber neg()

Specified by:

neg in interface IComplexNumber

negi

public IComplexFloat negi()

Specified by:

negi in interface IComplexNumber

sqrt

public IComplexFloat sqrt()

Specified by:

sqrt in interface IComplexNumber

equals

public boolean equals(java.lang.Object o)

Comparing two floatComplex values.

Overrides:

equals in class java.lang.Object

Parameters:

o -

isZero

public boolean isZero()

Specified by:

isZero in interface IComplexNumber

isReal

public boolean isReal()

Specified by:

isReal in interface IComplexNumber

isImag

public boolean isImag()

Specified by:

isImag in interface IComplexNumber

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object