All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class JSci.maths.ComplexMatrix

java.lang.Object
   |
   +----JSci.maths.Matrix
           |
           +----JSci.maths.ComplexMatrix

public class ComplexMatrix

extends Matrix

ARRAY_2D

Storage format identifier.

matrix

Array containing the elements of the matrix.

storageFormat

ComplexMatrix()

Constructs a matrix.

ComplexMatrix(Complex[][])

Constructs a matrix by wrapping an array.

ComplexMatrix(ComplexVector[])

Constructs a matrix from an array of vectors (columns).

ComplexMatrix(int, int)

Constructs an empty matrix.

add(AbelianGroupMember)

Returns the addition of this matrix and another.

add(ComplexMatrix)

Returns the addition of this matrix and another.

columns()

Returns the number of columns.

conjugate()

Returns the complex conjugate of this matrix.

equals(Object)

Compares two complex matrices for equality.

finalize()

Finalize.

frobeniusNorm()

Returns the Frobenius norm.

getElement(int, int)

Returns an element of the matrix.

hashCode()

Returns a hashcode for this matrix.

hermitianAdjoint()

Returns the hermitian adjoint of this matrix.

imag()

Returns the imaginary part of this complex matrix.

infNorm()

Returns the l(infinity)-norm.

mapElements(Mapping)

Applies a function on all the matrix elements.

multiply(ComplexMatrix)

Returns the multiplication of this matrix and another.

multiply(ComplexVector)

Returns the multiplication of a vector by this matrix.

multiply(RingMember)

Returns the multiplication of this matrix and another.

negate()

Returns the negative of this matrix.

real()

Returns the real part of this complex matrix.

rows()

Returns the number of rows.

scalarMultiply(Complex)

Returns the multiplication of this matrix by a scalar.

scalarMultiply(double)

Returns the multiplication of this matrix by a scalar.

scalarMultiply(RingMember)

Returns the multiplication of this matrix by a scalar.

setElement(int, int, Complex)

Sets the value of an element of the matrix.

subtract(AbelianGroupMember)

Returns the subtraction of this matrix by another.

subtract(ComplexMatrix)

Returns the subtraction of this matrix by another.

toString()

Returns a string representing this matrix.

transpose()

Returns the transpose of this matrix.

 protected static final int ARRAY_2D

Storage format identifier.

 protected static final int storageFormat

 protected Complex matrix[][]

Array containing the elements of the matrix.

 protected ComplexMatrix()

Constructs a matrix.

 public ComplexMatrix(int row,
                      int col)

Constructs an empty matrix.

Parameters:

row - the number of rows

col - the number of columns

 public ComplexMatrix(Complex array[][])

Constructs a matrix by wrapping an array.

Parameters:

array - an assigned value

 public ComplexMatrix(ComplexVector array[])

Constructs a matrix from an array of vectors (columns).

Parameters:

array - an assigned value

 protected void finalize() throws Throwable

Finalize.

Throws: Throwable

Any that occur.

Overrides:

finalize in class Object

 public boolean equals(Object m)

Compares two complex matrices for equality.

Parameters:

m - a complex matrix

Overrides:

equals in class Object

 public String toString()

Returns a string representing this matrix.

Overrides:

toString in class Object

 public int hashCode()

Returns a hashcode for this matrix.

Overrides:

hashCode in class Object

 public DoubleMatrix real()

Returns the real part of this complex matrix.

Returns:

a double matrix

 public DoubleMatrix imag()

Returns the imaginary part of this complex matrix.

Returns:

a double matrix

 public Complex getElement(int i,
                           int j)

Returns an element of the matrix.

Parameters:

i - row index of the element

j - column index of the element

Throws: MatrixDimensionException

If attempting to access an invalid element.

 public void setElement(int i,
                        int j,
                        Complex z)

Sets the value of an element of the matrix.

Parameters:

i - row index of the element

j - column index of the element

z - a complex number

Throws: MatrixDimensionException

If attempting to access an invalid element.

 public double infNorm()

Returns the l(infinity)-norm.

 public double frobeniusNorm()

Returns the Frobenius norm.

 public int rows()

Returns the number of rows.

Overrides:

rows in class Matrix

 public int columns()

Returns the number of columns.

Overrides:

columns in class Matrix

 public AbelianGroupMember negate()

Returns the negative of this matrix.

Overrides:

negate in class Matrix

 public AbelianGroupMember add(AbelianGroupMember m)

Returns the addition of this matrix and another.

Overrides:

add in class Matrix

 public ComplexMatrix add(ComplexMatrix m)

Returns the addition of this matrix and another.

Parameters:

m - a complex matrix

Throws: MatrixDimensionException

If the matrices are different sizes.

 public AbelianGroupMember subtract(AbelianGroupMember m)

Returns the subtraction of this matrix by another.

Overrides:

subtract in class Matrix

 public ComplexMatrix subtract(ComplexMatrix m)

Returns the subtraction of this matrix by another.

Parameters:

m - a complex matrix

Throws: MatrixDimensionException

If the matrices are different sizes.

 public AlgebraMember scalarMultiply(RingMember x)

Returns the multiplication of this matrix by a scalar.

Overrides:

scalarMultiply in class Matrix

 public ComplexMatrix scalarMultiply(Complex z)

Returns the multiplication of this matrix by a scalar.

Parameters:

z - a complex number

Returns:

a complex matrix

 public ComplexMatrix scalarMultiply(double x)

Returns the multiplication of this matrix by a scalar.

Parameters:

x - a double

Returns:

a complex matrix

 public ComplexVector multiply(ComplexVector v)

Returns the multiplication of a vector by this matrix.

Parameters:

v - a complex vector

Throws: DimensionException

If the matrix and vector are incompatible.

 public RingMember multiply(RingMember m)

Returns the multiplication of this matrix and another.

Overrides:

multiply in class Matrix

 public ComplexMatrix multiply(ComplexMatrix m)

Returns the multiplication of this matrix and another.

Parameters:

m - a complex matrix

Returns:

a ComplexMatrix or a ComplexSquareMatrix as appropriate

Throws: MatrixDimensionException

If the matrices are incompatible.

 public ComplexMatrix hermitianAdjoint()

Returns the hermitian adjoint of this matrix.

Returns:

a complex matrix

 public ComplexMatrix conjugate()

Returns the complex conjugate of this matrix.

Returns:

a complex matrix

 public Matrix transpose()

Returns the transpose of this matrix.

Returns:

a complex matrix

Overrides:

transpose in class Matrix

 public ComplexMatrix mapElements(Mapping f)

Applies a function on all the matrix elements.

Parameters:

f - a user-defined function

Returns:

a complex matrix

All Packages  Class Hierarchy  This Package  Previous  Next  Index