org.ojalgo.scalar

Class ComplexNumber

java.lang.Object

java.lang.Number

org.ojalgo.scalar.ComplexNumber

All Implemented Interfaces:

Serializable, Comparable<ComplexNumber>, Iterable<Double>, Access1D<Double>, Access2D<Double>, Access2D.Collectable<Double,Mutate2D.Receiver<Double>>, AccessScalar<ComplexNumber>, Structure1D, Structure2D, Field<Scalar<ComplexNumber>>, Group, Group.Additive<Scalar<ComplexNumber>>, Group.Multiplicative<Scalar<ComplexNumber>>, NormedVectorSpace<Scalar<ComplexNumber>,ComplexNumber>, Operation, Operation.Addition<Scalar<ComplexNumber>>, Operation.Division<Scalar<ComplexNumber>>, Operation.Multiplication<Scalar<ComplexNumber>>, Operation.Subtraction<Scalar<ComplexNumber>>, Ring<Scalar<ComplexNumber>>, ScalarOperation, ScalarOperation.Addition<Scalar<ComplexNumber>,ComplexNumber>, ScalarOperation.Division<Scalar<ComplexNumber>,ComplexNumber>, ScalarOperation.Multiplication<Scalar<ComplexNumber>,ComplexNumber>, ScalarOperation.Subtraction<Scalar<ComplexNumber>,ComplexNumber>, VectorSpace<Scalar<ComplexNumber>,ComplexNumber>, TransformationMatrix<Double,PhysicalStore<Double>>, Scalar<ComplexNumber>, NumberContext.Enforceable<ComplexNumber>

Direct Known Subclasses:

ComplexNumber.Normalised

public class ComplexNumber
extends Number
implements Scalar<ComplexNumber>, NumberContext.Enforceable<ComplexNumber>, Access2D<Double>, TransformationMatrix<Double,PhysicalStore<Double>>, Access2D.Collectable<Double,Mutate2D.Receiver<Double>>

ComplexNumber is an immutable complex number class. It only implements the most basic complex number operations. ComplexFunction implements some of the more complicated ones.

Author:

apete

See Also:

ComplexFunction, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ComplexNumber.Normalised

Nested classes/interfaces inherited from interface org.ojalgo.scalar.Scalar

Scalar.Factory<N extends Number>

Nested classes/interfaces inherited from interface org.ojalgo.algebra.ScalarOperation

ScalarOperation.Addition<T,N extends Number>, ScalarOperation.Division<T,N extends Number>, ScalarOperation.Multiplication<T,N extends Number>, ScalarOperation.Subtraction<T,N extends Number>

Nested classes/interfaces inherited from interface org.ojalgo.access.Access2D

Access2D.Aggregatable<N extends Number>, Access2D.Collectable<N extends Number,R extends Mutate2D.Receiver<N>>, Access2D.Elements, Access2D.ElementView<N extends Number>, Access2D.IndexOf, Access2D.Sliceable<N extends Number>, Access2D.Visitable<N extends Number>

Nested classes/interfaces inherited from interface org.ojalgo.matrix.transformation.TransformationMatrix

TransformationMatrix.Transformable<N extends Number>

Nested classes/interfaces inherited from interface org.ojalgo.access.Structure2D

Structure2D.IntRowColumn, Structure2D.LongRowColumn, Structure2D.ReducibleTo1D<R extends Structure1D>, Structure2D.RowColumnCallback, Structure2D.RowColumnKey<R,C>, Structure2D.RowColumnMapper<R,C>

Nested classes/interfaces inherited from interface org.ojalgo.access.Structure1D

Structure1D.BasicMapper<T>, Structure1D.IndexCallback, Structure1D.IndexMapper<T>, Structure1D.IntIndex, Structure1D.LongIndex, Structure1D.LoopCallback

Field Summary

Fields

Modifier and Type	Field and Description
static Scalar.Factory<ComplexNumber>	FACTORY
double	i
static ComplexNumber	I
static ComplexNumber	INFINITY
static ComplexNumber	NEG
static ComplexNumber	ONE
static ComplexNumber	TWO
static ComplexNumber	ZERO

Constructor Summary

Constructors

Constructor and Description
ComplexNumber()

Method Summary

Modifier and Type	Method and Description
ComplexNumber	add(ComplexNumber arg)
ComplexNumber	add(double arg)
int	compareTo(ComplexNumber reference)
ComplexNumber	conjugate() This method will (most likely) be moved to some other interface in the future! Just have to figure out where it fits...
long	count() count() == countRows() * countColumns()
long	countColumns()
long	countRows()
ComplexNumber	divide(ComplexNumber arg)
ComplexNumber	divide(double arg)
double	doubleValue()
double	doubleValue(long index)
double	doubleValue(long row, long col) Extracts one element of this matrix as a double.
ComplexNumber	enforce(NumberContext context) Will call NumberContext.enforce(double) on the real and imaginary parts separately.
boolean	equals(Object obj)
float	floatValue()
ComplexNumber	get()
Double	get(long index)
Double	get(long row, long col)
double	getArgument()
double	getImaginary()
double	getModulus()
double	getReal()
int	hashCode()
int	intValue()
ComplexNumber	invert() The multiplicative inverse.
boolean	isAbsolute()
static boolean	isAbsolute(ComplexNumber value)
static boolean	isInfinite(ComplexNumber value)
static boolean	isNaN(ComplexNumber value)
boolean	isReal()
static boolean	isReal(ComplexNumber value)
boolean	isSmall(double comparedTo)
static boolean	isSmall(double comparedTo, ComplexNumber value)
long	longValue()
static ComplexNumber	makePolar(double norm, double phase)
static ComplexNumber.Normalised	makeRotation(double angle)
ComplexNumber	multiply(ComplexNumber arg)
ComplexNumber	multiply(double arg)
ComplexNumber	negate() The additive inverse of this.
double	norm() this == this.signum().multiply(this.norm())
static ComplexNumber	of(double real, double imaginary)
double	phase()
ComplexNumber.Normalised	signum() this == this.signum().multiply(this.norm())
ComplexNumber	subtract(ComplexNumber arg)
ComplexNumber	subtract(double arg)
void	supplyTo(Mutate2D.Receiver<Double> receiver)
BigDecimal	toBigDecimal()
MatrixStore<Double>	toMultiplicationMatrix()
MatrixStore<Double>	toMultiplicationVector()
MatrixStore<Double>	toRotationMatrix()
String	toString()
String	toString(NumberContext context)
void	transform(PhysicalStore<Double> matrix)
static ComplexNumber	valueOf(double value)
static ComplexNumber	valueOf(Number number)

Methods inherited from class java.lang.Number

byteValue, shortValue

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ojalgo.scalar.Scalar

add, divide, multiply, subtract, toPlainString

Methods inherited from interface org.ojalgo.access.AccessScalar

byteValue, getNumber, shortValue

Methods inherited from interface org.ojalgo.access.Access2D

asCollectable2D, asPrimitive2D, columns, elements, equals, newPrimitiveColumnCollectable, newPrimitiveRowCollectable, rows, toRawCopy2D, toString, wrap, wrap, wrapAccess2D, wrapAccess2D

Methods inherited from interface org.ojalgo.access.Access1D

asCollectable1D, asPrimitive1D, axpy, dot, equals, hashCode, iterator, nonzeros, stream, supplyTo, toRawCopy1D, wrap, wrap, wrap, wrapAccess1D, wrapAccess1D, wrapAccess1D

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface org.ojalgo.access.Access2D.Collectable

collect

Methods inherited from interface org.ojalgo.access.Structure2D

column, column, column, column, column, index, index, isEmpty, isFat, isScalar, isSquare, isTall, isVector, loopAll, loopColumn, loopColumn, loopDiagonal, loopMatching, loopRow, loopRow, mapperOf, row, row, row, row, row

Methods inherited from interface org.ojalgo.access.Structure1D

loopAll, loopMatching, loopRange, mapper

Field Detail

FACTORY

public static final Scalar.Factory<ComplexNumber> FACTORY

I

public static final ComplexNumber I

INFINITY

public static final ComplexNumber INFINITY

NEG

public static final ComplexNumber NEG

ONE

public static final ComplexNumber ONE

TWO

public static final ComplexNumber TWO

ZERO

public static final ComplexNumber ZERO

i

public final double i

Constructor Detail

ComplexNumber

public ComplexNumber()

Method Detail

isAbsolute

public static boolean isAbsolute(ComplexNumber value)

isInfinite

public static boolean isInfinite(ComplexNumber value)

isNaN

public static boolean isNaN(ComplexNumber value)

isReal

public static boolean isReal(ComplexNumber value)

isSmall

public static boolean isSmall(double comparedTo,
                              ComplexNumber value)

makePolar

public static ComplexNumber makePolar(double norm,
                                      double phase)

makeRotation

public static ComplexNumber.Normalised makeRotation(double angle)

of

public static ComplexNumber of(double real,
                               double imaginary)

valueOf

public static ComplexNumber valueOf(double value)

valueOf

public static ComplexNumber valueOf(Number number)

add

public ComplexNumber add(ComplexNumber arg)

Specified by:

add in interface ScalarOperation.Addition<Scalar<ComplexNumber>,ComplexNumber>

Returns:

this + scalarAddend.

add

public ComplexNumber add(double arg)

Specified by:

add in interface ScalarOperation.Addition<Scalar<ComplexNumber>,ComplexNumber>

Returns:

this + scalarAddend.

compareTo

public int compareTo(ComplexNumber reference)

Specified by:

compareTo in interface Comparable<ComplexNumber>

conjugate

public ComplexNumber conjugate()

Description copied from interface: VectorSpace

This method will (most likely) be moved to some other interface in the future! Just have to figure out where it fits...

The conjugate transpose of a matrix and/or the conjugate of a scalar/field like ComplexNumber or Quaternion.

The conjugate transpose of a real matrix is simply its transpose.

Specified by:

conjugate in interface VectorSpace<Scalar<ComplexNumber>,ComplexNumber>

count

public long count()

Description copied from interface: Structure2D

count() == countRows() * countColumns()

Specified by:

count in interface Structure1D

Specified by:

count in interface Structure2D

Returns:

The total number of elements in this structure.

countColumns

public long countColumns()

Specified by:

countColumns in interface Structure2D

Returns:

The number of columns

countRows

public long countRows()

Specified by:

countRows in interface Structure2D

Returns:

The number of rows

divide

public ComplexNumber divide(ComplexNumber arg)

Specified by:

divide in interface ScalarOperation.Division<Scalar<ComplexNumber>,ComplexNumber>

Returns:

this / scalarDivisor.

divide

public ComplexNumber divide(double arg)

Specified by:

divide in interface ScalarOperation.Division<Scalar<ComplexNumber>,ComplexNumber>

Returns:

this / scalarDivisor.

doubleValue

public double doubleValue()

Specified by:

doubleValue in interface AccessScalar<ComplexNumber>

Specified by:

doubleValue in class Number

See Also:

Number.doubleValue()

doubleValue

public double doubleValue(long index)

Specified by:

doubleValue in interface Access1D<Double>

Specified by:

doubleValue in interface Access2D<Double>

doubleValue

public double doubleValue(long row,
                          long col)

Description copied from interface: Access2D

Extracts one element of this matrix as a double.

Specified by:

doubleValue in interface Access2D<Double>

Parameters:

row - A row index.

col - A column index.

Returns:

One matrix element

enforce

public ComplexNumber enforce(NumberContext context)

Will call NumberContext.enforce(double) on the real and imaginary parts separately.

Specified by:

enforce in interface NumberContext.Enforceable<ComplexNumber>

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

floatValue

public float floatValue()

Specified by:

floatValue in interface AccessScalar<ComplexNumber>

Specified by:

floatValue in class Number

See Also:

Number.floatValue()

get

public ComplexNumber get()

Specified by:

get in interface AccessScalar<ComplexNumber>

get

public Double get(long index)

Specified by:

get in interface Access1D<Double>

Specified by:

get in interface Access2D<Double>

get

public Double get(long row,
                  long col)

Specified by:

get in interface Access2D<Double>

getArgument

public double getArgument()

getImaginary

public double getImaginary()

getModulus

public double getModulus()

getReal

public double getReal()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

intValue

public int intValue()

Specified by:

intValue in interface AccessScalar<ComplexNumber>

Specified by:

intValue in class Number

See Also:

Number.intValue()

invert

public ComplexNumber invert()

Description copied from interface: Group.Multiplicative

The multiplicative inverse.

Specified by:

invert in interface Group.Multiplicative<Scalar<ComplexNumber>>

Returns:

IDENTITY / this.

isAbsolute

public boolean isAbsolute()

Specified by:

isAbsolute in interface Scalar<ComplexNumber>

Returns:

true if this is equal to its own norm, modulus or absolute value (non-negative real part and no imaginary part); otherwise false.

See Also:

Scalar.isAbsolute()

isReal

public boolean isReal()

isSmall

public boolean isSmall(double comparedTo)

Specified by:

isSmall in interface NormedVectorSpace<Scalar<ComplexNumber>,ComplexNumber>

Parameters:

comparedTo - What to compare with

Returns:

true if this is small compared to the magnitude of the input reference value.

longValue

public long longValue()

Specified by:

longValue in interface AccessScalar<ComplexNumber>

Specified by:

longValue in class Number

See Also:

Number.longValue()

multiply

public ComplexNumber multiply(ComplexNumber arg)

Specified by:

multiply in interface ScalarOperation.Multiplication<Scalar<ComplexNumber>,ComplexNumber>

Returns:

this * multiplicand.

multiply

public ComplexNumber multiply(double arg)

Specified by:

multiply in interface ScalarOperation.Multiplication<Scalar<ComplexNumber>,ComplexNumber>

Returns:

this * scalarMultiplicand.

negate

public ComplexNumber negate()

Description copied from interface: Group.Additive

The additive inverse of this.

Specified by:

negate in interface Group.Additive<Scalar<ComplexNumber>>

Returns:

-this.

norm

public double norm()

Description copied from interface: NormedVectorSpace

this == this.signum().multiply(this.norm())

Specified by:

norm in interface NormedVectorSpace<Scalar<ComplexNumber>,ComplexNumber>

Returns:

The norm

phase

public double phase()

signum

public ComplexNumber.Normalised signum()

Description copied from interface: NormedVectorSpace

this == this.signum().multiply(this.norm())

Specified by:

signum in interface NormedVectorSpace<Scalar<ComplexNumber>,ComplexNumber>

Returns:

A unit "vector"

subtract

public ComplexNumber subtract(ComplexNumber arg)

Specified by:

subtract in interface ScalarOperation.Subtraction<Scalar<ComplexNumber>,ComplexNumber>

Returns:

this - scalarSubtrahend.

subtract

public ComplexNumber subtract(double arg)

Specified by:

subtract in interface ScalarOperation.Subtraction<Scalar<ComplexNumber>,ComplexNumber>

Returns:

this - scalarSubtrahend.

supplyTo

public void supplyTo(Mutate2D.Receiver<Double> receiver)

Specified by:

supplyTo in interface Access2D.Collectable<Double,Mutate2D.Receiver<Double>>

toBigDecimal

public BigDecimal toBigDecimal()

Specified by:

toBigDecimal in interface Scalar<ComplexNumber>

toMultiplicationMatrix

public MatrixStore<Double> toMultiplicationMatrix()

toMultiplicationVector

public MatrixStore<Double> toMultiplicationVector()

toRotationMatrix

public MatrixStore<Double> toRotationMatrix()

toString

public String toString()

Overrides:

toString in class Object

See Also:

Object.toString()

toString

public String toString(NumberContext context)

Specified by:

toString in interface Scalar<ComplexNumber>

transform

public void transform(PhysicalStore<Double> matrix)

Specified by:

transform in interface TransformationMatrix<Double,PhysicalStore<Double>>