org.nd4j.linalg.api.complex

Interface IComplexNumber

All Known Subinterfaces:

IComplexDouble, IComplexFloat

All Known Implementing Classes:

BaseComplexDouble, BaseComplexFloat

public interface IComplexNumber

Baseline interface for a complex number with realComponent and imaginary components. Based off of the jblas api by mikio braun

Author:

Adam Gibson

Method Summary

Modifier and Type	Method and Description
java.lang.Number	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.Number	complexArgument() Returns the argument of a complex number.
IComplexNumber	conj()
IComplexNumber	conji()
IComplexNumber	copy(IComplexNumber other)
IComplexNumber	div(IComplexNumber c) Divide two complex numbers
IComplexNumber	div(java.lang.Number 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)
IComplexNumber	dup()
boolean	eq(IComplexNumber c)
java.lang.Number	imaginaryComponent()
IComplexNumber	inv()
IComplexNumber	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()
IComplexNumber	negi()
java.lang.Number	realComponent()
IComplexNumber	set(java.lang.Number real, java.lang.Number imag)
IComplexNumber	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)

Method Detail

set

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

realComponent

java.lang.Number realComponent()

imaginaryComponent

java.lang.Number imaginaryComponent()

dup

IComplexNumber dup()

copy

IComplexNumber copy(IComplexNumber other)

addi

IComplexNumber addi(IComplexNumber c,
                    IComplexNumber result)

Add two complex numbers in-place

addi

IComplexNumber addi(IComplexNumber c)

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

add

IComplexNumber add(IComplexNumber c)

Add two complex numbers.

addi

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

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

addi

IComplexNumber addi(java.lang.Number c)

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

add

IComplexNumber add(java.lang.Number c)

Add a realComponent number to a complex number.

subi

IComplexNumber subi(IComplexNumber c,
                    IComplexNumber result)

Subtract two complex numbers, in-place

subi

IComplexNumber subi(IComplexNumber c)

sub

IComplexNumber sub(IComplexNumber c)

Subtract two complex numbers

subi

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

subi

IComplexNumber subi(java.lang.Number a)

sub

IComplexNumber sub(java.lang.Number r)

muli

IComplexNumber muli(IComplexNumber c,
                    IComplexNumber result)

Multiply two complex numbers, inplace

muli

IComplexNumber muli(IComplexNumber c)

mul

IComplexNumber mul(IComplexNumber c)

Multiply two complex numbers

mul

IComplexNumber mul(java.lang.Number v)

muli

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

muli

IComplexNumber muli(java.lang.Number v)

div

IComplexNumber div(IComplexNumber c)

Divide two complex numbers

divi

IComplexNumber divi(IComplexNumber c,
                    IComplexNumber result)

Divide two complex numbers, in-place

divi

IComplexNumber divi(IComplexNumber c)

divi

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

divi

IComplexNumber divi(java.lang.Number v)

div

IComplexNumber div(java.lang.Number v)

absoluteValue

java.lang.Number absoluteValue()

Return the absolute value

complexArgument

java.lang.Number complexArgument()

Returns the argument of a complex number.

invi

IComplexNumber invi()

inv

IComplexNumber inv()

neg

IComplexNumber neg()

negi

IComplexNumber negi()

conji

IComplexNumber conji()

conj

IComplexNumber conj()

sqrt

IComplexNumber sqrt()

eq

boolean eq(IComplexNumber c)

ne

boolean ne(IComplexNumber c)

isZero

boolean isZero()

isReal

boolean isReal()

isImag

boolean isImag()

asFloat

IComplexFloat asFloat()

Convert to a float

Returns:

this complex number as a float

asDouble

IComplexDouble asDouble()

Convert to a double

Returns:

this complex number as a double