    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

The ComplexMatrix class provides an object for encapsulating matrices containing complex numbers.

##

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.

##

ARRAY_2D

     protected static final int ARRAY_2D

  Storage format identifier.

storageFormat

     protected static final int storageFormat

matrix

     protected Complex matrix[][]

  Array containing the elements of the matrix.

##

ComplexMatrix

     protected ComplexMatrix()

  Constructs a matrix.

ComplexMatrix

     public ComplexMatrix(int row,
                          int col)

  Constructs an empty matrix.

  Parameters:
    row - the number of rows
    col - the number of columns

ComplexMatrix

     public ComplexMatrix(Complex array[][])

  Constructs a matrix by wrapping an array.

  Parameters:
    array - an assigned value

ComplexMatrix

     public ComplexMatrix(ComplexVector array[])

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

  Parameters:
    array - an assigned value

##

finalize

     protected void finalize() throws Throwable

  Finalize.

  Throws: Throwable
    Any that occur.
  Overrides:
    finalize in class Object

equals

     public boolean equals(Object m)

  Compares two complex matrices for equality.

  Parameters:
    m - a complex matrix
  Overrides:
    equals in class Object

toString

     public String toString()

  Returns a string representing this matrix.

  Overrides:
    toString in class Object

hashCode

     public int hashCode()

  Returns a hashcode for this matrix.

  Overrides:
    hashCode in class Object

real

     public DoubleMatrix real()

  Returns the real part of this complex matrix.

  Returns:
    a double matrix

imag

     public DoubleMatrix imag()

  Returns the imaginary part of this complex matrix.

  Returns:
    a double matrix

getElement

     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.

setElement

     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.

infNorm

     public double infNorm()

  Returns the l(infinity)-norm.

frobeniusNorm

     public double frobeniusNorm()

  Returns the Frobenius norm.

rows

     public int rows()

  Returns the number of rows.

  Overrides:
    rows in class Matrix

columns

     public int columns()

  Returns the number of columns.

  Overrides:
    columns in class Matrix

negate

     public AbelianGroupMember negate()

  Returns the negative of this matrix.

  Overrides:
    negate in class Matrix

add

     public AbelianGroupMember add(AbelianGroupMember m)

  Returns the addition of this matrix and another.

  Overrides:
    add in class Matrix

add

     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.

subtract

     public AbelianGroupMember subtract(AbelianGroupMember m)

  Returns the subtraction of this matrix by another.

  Overrides:
    subtract in class Matrix

subtract

     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.

scalarMultiply

     public AlgebraMember scalarMultiply(RingMember x)

  Returns the multiplication of this matrix by a scalar.

  Overrides:
    scalarMultiply in class Matrix

scalarMultiply

     public ComplexMatrix scalarMultiply(Complex z)

  Returns the multiplication of this matrix by a scalar.

  Parameters:
    z - a complex number
  Returns:
    a complex matrix

scalarMultiply

     public ComplexMatrix scalarMultiply(double x)

  Returns the multiplication of this matrix by a scalar.

  Parameters:
    x - a double
  Returns:
    a complex matrix

multiply

     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.

multiply

     public RingMember multiply(RingMember m)

  Returns the multiplication of this matrix and another.

  Overrides:
    multiply in class Matrix

multiply

     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.

hermitianAdjoint

     public ComplexMatrix hermitianAdjoint()

  Returns the hermitian adjoint of this matrix.

  Returns:
    a complex matrix

conjugate

     public ComplexMatrix conjugate()

  Returns the complex conjugate of this matrix.

  Returns:
    a complex matrix

transpose

     public Matrix transpose()

  Returns the transpose of this matrix.

  Returns:
    a complex matrix
  Overrides:
    transpose in class Matrix

mapElements

     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