com.numericalmethod.suanshu.matrix.generic.matrixtype
Class ComplexMatrix

java.lang.Object
  com.numericalmethod.suanshu.matrix.generic.matrixtype.ComplexMatrix

All Implemented Interfaces:

AbelianGroup<ComplexMatrix>, Monoid<ComplexMatrix>, Ring<ComplexMatrix>, VectorSpace<ComplexMatrix,Complex>, Matrix<ComplexMatrix,Complex>, MatrixAccessor<Complex>, MatrixDimension

public class ComplexMatrix
extends java.lang.Object
implements Matrix<ComplexMatrix,Complex>

This class represents a matrix of Complex numbers.

Constructor Summary

ComplexMatrix(Complex[][] data)
Construct a matrix from a 2D array of Complex numbers.

ComplexMatrix(double[][] data)
Construct a ComplexMatrix from a 2D array of doubles.

ComplexMatrix(int nRows, int nCols)
Construct a nRows x nCols matrix of Complex numbers.

Method Summary

ComplexMatrix	add(ComplexMatrix that) + : G × G → G
DenseMatrix	doubleValue() Create a DenseMatrix of double values from this complex matrix.
boolean	equals(java.lang.Object obj)
Complex	get(int row, int col) Get the matrix element at [row, col].
int	hashCode()
ComplexMatrix	minus(ComplexMatrix that) - : G × G → G - is not in the definition of of an additive group but can be deduced.
ComplexMatrix	multiply(ComplexMatrix that) · : G × G → G
int	nCols() Get the number of columns.
int	nRows() Get the number of rows.
ComplexMatrix	ONE() The multiplicative element 1 in the group such that for any elements a in the group, the equation 1 × a = a × 1 = a holds.
ComplexMatrix	opposite() For each a in G, there exists an element b in G such that a + b = b + a = 0 That is, it is the object such as this.add(this.opposite()) == this.ZERO
ComplexMatrix	scaled(Complex scalar) * : F × V → V The result of applying this function to scalar, c, in F and v in V is denoted cv.
void	set(int row, int col, Complex value) Set the matrix element at [row, col] to value.
java.lang.String	toString()
ComplexMatrix	ZERO() The additive element 0 in the group, such that for all elements a in the group, the equation 0 + a = a + 0 = a holds.

Methods inherited from class java.lang.Object

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

Constructor Detail

ComplexMatrix

public ComplexMatrix(int nRows,
                     int nCols)

Construct a nRows x nCols matrix of Complex numbers.

Parameters:

nRows - number of rows

nCols - number of columns

ComplexMatrix

public ComplexMatrix(Complex[][] data)

Construct a matrix from a 2D array of Complex numbers.

Parameters:

data - a matrix arrangement of Complex numbers in a 2D array

ComplexMatrix

public ComplexMatrix(double[][] data)

Construct a ComplexMatrix from a 2D array of doubles.

Parameters:

data - a matrix arrangement of doubles in a 2D array

Method Detail

nRows

public int nRows()

Description copied from interface: MatrixDimension

Get the number of rows. Rows count from 1.

Specified by:

nRows in interface MatrixDimension

Returns:

the number of rows

nCols

public int nCols()

Description copied from interface: MatrixDimension

Get the number of columns. Columns count from 1.

Specified by:

nCols in interface MatrixDimension

Returns:

the number of columns

set

public void set(int row,
                int col,
                Complex value)

Description copied from interface: MatrixAccessor

Set the matrix element at [row, col] to value.

This is the only function that may change the entries of a matrix.

Specified by:

set in interface MatrixAccessor<Complex>

Parameters:

row - the row index

col - the column index

value - the value to set A[row, col] to

get

public Complex get(int row,
                   int col)

Description copied from interface: MatrixAccessor

Get the matrix element at [row, col].

Specified by:

get in interface MatrixAccessor<Complex>

Parameters:

row - the row index

col - the column index

Returns:

A[row, col]

add

public ComplexMatrix add(ComplexMatrix that)

Description copied from interface: AbelianGroup

+ : G × G → G

Specified by:

add in interface AbelianGroup<ComplexMatrix>

Parameters:

that - the object to be added

Returns:

this + that

minus

public ComplexMatrix minus(ComplexMatrix that)

Description copied from interface: AbelianGroup

- : G × G → G

- is not in the definition of of an additive group but can be deduced. This function is provided for convenience purpose. It is equivalent to

this.add(that.opposite())

Specified by:

minus in interface AbelianGroup<ComplexMatrix>

Parameters:

that - the object to be subtracted (subtrahend)

Returns:

this - that

multiply

public ComplexMatrix multiply(ComplexMatrix that)

Description copied from interface: Monoid

· : G × G → G

Specified by:

multiply in interface Monoid<ComplexMatrix>

Parameters:

that - the multiplicand

Returns:

this × that

scaled

public ComplexMatrix scaled(Complex scalar)

Description copied from interface: VectorSpace

* : F × V → V

The result of applying this function to scalar, c, in F and v in V is denoted cv.

Specified by:

scaled in interface VectorSpace<ComplexMatrix,Complex>

Parameters:

scalar - a multiplier

Returns:

scalar * this

See Also:

Wikipedia: Scalar multiplication

opposite

public ComplexMatrix opposite()

Description copied from interface: AbelianGroup

For each a in G, there exists an element b in G such that

a + b = b + a = 0

That is, it is the object such as

this.add(this.opposite()) == this.ZERO

Specified by:

opposite in interface AbelianGroup<ComplexMatrix>

Returns:

-this

See Also:

Wikipedia: Additive inverse

ZERO

public ComplexMatrix ZERO()

Description copied from interface: AbelianGroup

The additive element 0 in the group, such that for all elements a in the group, the equation

0 + a = a + 0 = a

holds.

Specified by:

ZERO in interface AbelianGroup<ComplexMatrix>

Returns:

0

ONE

public ComplexMatrix ONE()

Description copied from interface: Monoid

The multiplicative element 1 in the group such that for any elements a in the group, the equation

1 × a = a × 1 = a

holds.

Specified by:

ONE in interface Monoid<ComplexMatrix>

Returns:

1

doubleValue

public DenseMatrix doubleValue()

Create a DenseMatrix of double values from this complex matrix.

Returns:

a double matrix of type com.numericalmethod.suanshu.matrix.doubles.dense.DenseMatrix

Throws:

java.lang.IllegalArgumentException - if any element is not a double

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object