Module org.scijava.ops.image

Package org.scijava.ops.image.util

Class BigComplex

java.lang.Object

org.scijava.ops.image.util.BigComplex

All Implemented Interfaces:

ComplexType<BigComplex>, NumericType<BigComplex>, Add<BigComplex>, Div<BigComplex>, Mul<BigComplex>, MulFloatingPoint, Pow<BigComplex>, PowFloatingPoint, SetOne, SetZero, Sub<BigComplex>, ValueEquals<BigComplex>, Type<BigComplex>

public class BigComplex
extends Object
implements ComplexType<BigComplex>

A complex number that stores values in BigDecimal (arbitrary) precision. Besides providing precise numeric operations this class is useful for supporting DataType translations with minimal data loss. Some methods may round values to 50 decimal places of precision.

Author:

Barry DeZonia

Constructor Summary

Constructors

Constructor	Description
BigComplex()	Default constructor: value = (0,0).
BigComplex(double r, double i)	Constructor from doubles.
BigComplex(long r, long i)	Constructor from longs.
BigComplex(String r, String i)	Constructor from Strings.
BigComplex(BigDecimal r, BigDecimal i)	Constructor from BigDecimals.
BigComplex(BigInteger r, BigInteger i)	Constructor from BigIntegers.

Method Summary

Modifier and Type	Method	Description
void	add(BigComplex other)	Adds another BigComplex value to self.
void	add(BigComplex a, BigComplex b)	Set self to the result of addition between two BigComplex values.
void	complexConjugate()	Does complex conjugation on self.
BigComplex	copy()	Creates a new BigComplex whose values are taken from this BigComplex.
BigComplex	createVariable()	Creates a new BigComplex initialized to (0,0).
void	div(BigComplex other)	Divides self by another BigComplex value.
void	div(BigComplex a, BigComplex b)	Set self to the result of division between two BigComplex values.
void	E()	Fills self with the representation of e for the given type.
BigDecimal	getImag()	Gets imaginary component of this complex number as a BigDecimal.
double	getImaginaryDouble()	Gets imaginary component as a double (narrowing possible).
float	getImaginaryFloat()	Gets imaginary component as a float (narrowing possible).
BigDecimal	getPhase()	Gets phase as a BigDecimal.
double	getPhaseDouble()	Gets phase as a double (narrowing possible).
float	getPhaseFloat()	Gets phase as a float (narrowing possible).
BigDecimal	getPower()	Gets magnitude as a BigDecimal.
double	getPowerDouble()	Gets magnitude as a double (narrowing possible).
float	getPowerFloat()	Gets magnitude as a float (narrowing possible).
BigDecimal	getReal()	Gets real component of this complex number as a BigDecimal.
double	getRealDouble()	Gets real component as a double (narrowing possible).
float	getRealFloat()	Gets real component as a float (narrowing possible).
void	mul(double c)	Multiplies self by a scalar (double) constant.
void	mul(float c)	Multiplies self by a scalar (float) constant.
void	mul(BigComplex other)	Multiplies another BigComplex value with self.
void	mul(BigComplex a, BigComplex b)	Set self to the result of multiplication between two BigComplex values.
void	PI()	Fills self with the representation of pi for the given type.
void	pow(double power)
void	pow(BigComplex c)
void	set(double r, double i)	Sets the real and imaginary components of this BigComplex to given double values.
void	set(long r, long i)	Sets the real and imaginary components of this BigComplex to given long values.
void	set(String r, String i)	Sets the real and imaginary components of this BigComplex to given String values.
void	set(BigDecimal r, BigDecimal i)	Sets the real and imaginary components of this BigComplex to given BigDecimal values.
void	set(BigInteger r, BigInteger i)	Sets the real and imaginary components of this BigComplex to given BigInteger values.
void	set(BigComplex other)	Sets the real and imaginary components of this BigComplex to match those of another.
void	setComplexNumber(double r, double i)	Sets the real and imaginary components of this BigComplex to given double values.
void	setComplexNumber(float r, float i)	Sets the real and imaginary components of this BigComplex to given float values.
void	setComplexNumber(String r, String i)	Sets the real and imaginary components of this BigComplex to given String values.
void	setComplexNumber(BigDecimal r, BigDecimal i)	Sets the real and imaginary components of this BigComplex to given BigDecimal values.
void	setImag(double i)	Sets the imaginary component of this BigComplex to given double value.
void	setImag(long i)	Sets the imaginary component of this BigComplex to given long value.
void	setImag(String i)	Sets the imaginary component of this BigComplex to given String value.
void	setImag(BigDecimal i)	Sets the imaginary component of this BigComplex to given BigDecimal value.
void	setImag(BigInteger i)	Sets the imaginary component of this BigComplex to given BigInteger value.
void	setImaginary(double f)	Sets the imaginary component of this BigComplex to given double value.
void	setImaginary(float f)	Sets the imaginary component of this BigComplex to given float value.
void	setOne()	Sets this BigComplex to the unity value.
void	setReal(double r)	Sets the real component of this BigComplex to given double value.
void	setReal(float f)	Sets the real component of this BigComplex to given float value.
void	setReal(long r)	Sets the real component of this BigComplex to given long value.
void	setReal(String r)	Sets the real component of this BigComplex to given String value.
void	setReal(BigDecimal r)	Sets the real component of this BigComplex to given BigDecimal value.
void	setReal(BigInteger r)	Sets the real component of this BigComplex to given BigInteger value.
void	setZero()	Sets this BigComplex to the zero value.
void	sub(BigComplex other)	Subtracts another BigComplex value from self.
void	sub(BigComplex a, BigComplex b)	Set self to the result of subtraction between two BigComplex values.
boolean	valueEquals(BigComplex t)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BigComplex

public BigComplex()

Default constructor: value = (0,0).

BigComplex

public BigComplex(long r,
                  long i)

Constructor from longs.

BigComplex

public BigComplex(double r,
                  double i)

Constructor from doubles.

BigComplex

public BigComplex(BigInteger r,
                  BigInteger i)

Constructor from BigIntegers.

BigComplex

public BigComplex(BigDecimal r,
                  BigDecimal i)

Constructor from BigDecimals.

BigComplex

public BigComplex(String r,
                  String i)

Constructor from Strings. The strings must represent numbers that BigDecimal can parse.

Method Detail

getReal

public BigDecimal getReal()

Gets real component of this complex number as a BigDecimal.

getImag

public BigDecimal getImag()

Gets imaginary component of this complex number as a BigDecimal.

set

public void set(BigComplex other)

Sets the real and imaginary components of this BigComplex to match those of another.

Specified by:

set in interface Type<BigComplex>

set

public void set(long r,
                long i)

Sets the real and imaginary components of this BigComplex to given long values.

set

public void set(double r,
                double i)

Sets the real and imaginary components of this BigComplex to given double values.

set

public void set(BigInteger r,
                BigInteger i)

Sets the real and imaginary components of this BigComplex to given BigInteger values.

set

public void set(BigDecimal r,
                BigDecimal i)

Sets the real and imaginary components of this BigComplex to given BigDecimal values.

set

public void set(String r,
                String i)

Sets the real and imaginary components of this BigComplex to given String values. The strings must represent numbers that BigDecimal can parse.

setReal

public void setReal(long r)

Sets the real component of this BigComplex to given long value.

setReal

public void setReal(float f)

Sets the real component of this BigComplex to given float value.

Specified by:

setReal in interface ComplexType<BigComplex>

setReal

public void setReal(double r)

Sets the real component of this BigComplex to given double value.

Specified by:

setReal in interface ComplexType<BigComplex>

setReal

public void setReal(BigInteger r)

Sets the real component of this BigComplex to given BigInteger value.

setReal

public void setReal(BigDecimal r)

Sets the real component of this BigComplex to given BigDecimal value.

setReal

public void setReal(String r)

Sets the real component of this BigComplex to given String value. The string must represent a number that BigDecimal can parse.

setImag

public void setImag(long i)

Sets the imaginary component of this BigComplex to given long value.

setImag

public void setImag(double i)

Sets the imaginary component of this BigComplex to given double value.

setImag

public void setImag(BigInteger i)

Sets the imaginary component of this BigComplex to given BigInteger value.

setImag

public void setImag(BigDecimal i)

Sets the imaginary component of this BigComplex to given BigDecimal value.

setImag

public void setImag(String i)

Sets the imaginary component of this BigComplex to given String value. The string must represent a number that BigDecimal can parse.

setImaginary

public void setImaginary(float f)

Sets the imaginary component of this BigComplex to given float value.

Specified by:

setImaginary in interface ComplexType<BigComplex>

setImaginary

public void setImaginary(double f)

Sets the imaginary component of this BigComplex to given double value.

Specified by:

setImaginary in interface ComplexType<BigComplex>

setComplexNumber

public void setComplexNumber(float r,
                             float i)

Sets the real and imaginary components of this BigComplex to given float values.

Specified by:

setComplexNumber in interface ComplexType<BigComplex>

setComplexNumber

public void setComplexNumber(double r,
                             double i)

Sets the real and imaginary components of this BigComplex to given double values.

Specified by:

setComplexNumber in interface ComplexType<BigComplex>

setComplexNumber

public void setComplexNumber(BigDecimal r,
                             BigDecimal i)

Sets the real and imaginary components of this BigComplex to given BigDecimal values.

setComplexNumber

public void setComplexNumber(String r,
                             String i)

Sets the real and imaginary components of this BigComplex to given String values. The strings must represent numbers that BigDecimal can parse.

setZero

public void setZero()

Sets this BigComplex to the zero value.

Specified by:

setZero in interface SetZero

setOne

public void setOne()

Sets this BigComplex to the unity value.

Specified by:

setOne in interface SetOne

createVariable

public BigComplex createVariable()

Creates a new BigComplex initialized to (0,0).

Specified by:

createVariable in interface Type<BigComplex>

copy

public BigComplex copy()

Creates a new BigComplex whose values are taken from this BigComplex.

Specified by:

copy in interface Type<BigComplex>

add

public void add(BigComplex a,
                BigComplex b)

Set self to the result of addition between two BigComplex values.

add

public void add(BigComplex other)

Adds another BigComplex value to self.

Specified by:

add in interface Add<BigComplex>

sub

public void sub(BigComplex a,
                BigComplex b)

Set self to the result of subtraction between two BigComplex values.

sub

public void sub(BigComplex other)

Subtracts another BigComplex value from self.

Specified by:

sub in interface Sub<BigComplex>

mul

public void mul(BigComplex a,
                BigComplex b)

Set self to the result of multiplication between two BigComplex values.

mul

public void mul(BigComplex other)

Multiplies another BigComplex value with self.

Specified by:

mul in interface Mul<BigComplex>

div

public void div(BigComplex a,
                BigComplex b)

Set self to the result of division between two BigComplex values. Precision loss is possible.

div

public void div(BigComplex other)

Divides self by another BigComplex value. Precision loss is possible.

Specified by:

div in interface Div<BigComplex>

mul

public void mul(float c)

Multiplies self by a scalar (float) constant.

Specified by:

mul in interface MulFloatingPoint

mul

public void mul(double c)

Multiplies self by a scalar (double) constant.

Specified by:

mul in interface MulFloatingPoint

pow

public void pow(BigComplex c)

Specified by:

pow in interface Pow<BigComplex>

pow

public void pow(double power)

Specified by:

pow in interface PowFloatingPoint

complexConjugate

public void complexConjugate()

Does complex conjugation on self.

Specified by:

complexConjugate in interface ComplexType<BigComplex>

getRealDouble

public double getRealDouble()

Gets real component as a double (narrowing possible).

Specified by:

getRealDouble in interface ComplexType<BigComplex>

getRealFloat

public float getRealFloat()

Gets real component as a float (narrowing possible).

Specified by:

getRealFloat in interface ComplexType<BigComplex>

getImaginaryDouble

public double getImaginaryDouble()

Gets imaginary component as a double (narrowing possible).

Specified by:

getImaginaryDouble in interface ComplexType<BigComplex>

getImaginaryFloat

public float getImaginaryFloat()

Gets imaginary component as a float (narrowing possible).

Specified by:

getImaginaryFloat in interface ComplexType<BigComplex>

getPowerFloat

public float getPowerFloat()

Gets magnitude as a float (narrowing possible).

Specified by:

getPowerFloat in interface ComplexType<BigComplex>

getPowerDouble

public double getPowerDouble()

Gets magnitude as a double (narrowing possible).

Specified by:

getPowerDouble in interface ComplexType<BigComplex>

getPower

public BigDecimal getPower()

Gets magnitude as a BigDecimal.

getPhaseFloat

public float getPhaseFloat()

Gets phase as a float (narrowing possible).

Specified by:

getPhaseFloat in interface ComplexType<BigComplex>

getPhaseDouble

public double getPhaseDouble()

Gets phase as a double (narrowing possible).

Specified by:

getPhaseDouble in interface ComplexType<BigComplex>

getPhase

public BigDecimal getPhase()

Gets phase as a BigDecimal.

PI

public void PI()

Fills self with the representation of pi for the given type.

E

public void E()

Fills self with the representation of e for the given type.

valueEquals

public boolean valueEquals(BigComplex t)

Specified by:

valueEquals in interface ValueEquals<BigComplex>