    All Packages  Class Hierarchy  This Package  Previous  Next  Index

# Class JSci.maths.IntegerMatrix

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

public class IntegerMatrix
extends Matrix

The IntegerMatrix class provides an object for encapsulating matrices containing integers.

##

ARRAY_2D
  Storage format identifier.
matrix
  Array containing the elements of the matrix.
storageFormat

##

IntegerMatrix()
  Constructs a matrix.
IntegerMatrix(int, int)
  Constructs an empty matrix.
IntegerMatrix(int[][])
  Constructs a matrix by wrapping an array.
IntegerMatrix(IntegerVector[])
  Constructs a matrix from an array of vectors (columns).

##

add(AbelianGroupMember)
  Returns the addition of this matrix and another.
add(IntegerMatrix)
  Returns the addition of this matrix and another.
columns()
  Returns the number of columns.
equals(Object)
  Compares two integer 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.
infNorm()
  Returns the l(infinity)-norm.
multiply(IntegerMatrix)
  Returns the multiplication of this matrix and another.
multiply(IntegerVector)
  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.
rows()
  Returns the number of rows.
scalarMultiply(int)
  Returns the multiplication of this matrix by a scalar.
scalarMultiply(RingMember)
  Returns the multiplication of this matrix by a scalar.
setElement(int, int, int)
  Sets the value of an element of the matrix.
subtract(AbelianGroupMember)
  Returns the subtraction of this matrix by another.
subtract(IntegerMatrix)
  Returns the subtraction of this matrix by another.
toComplexMatrix()
  Converts this matrix to a complex matrix.
toDoubleMatrix()
  Converts this matrix to a double matrix.
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 int matrix[][]

  Array containing the elements of the matrix.

##

IntegerMatrix

     protected IntegerMatrix()

  Constructs a matrix.

IntegerMatrix

     public IntegerMatrix(int row,
                          int col)

  Constructs an empty matrix.

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

IntegerMatrix

     public IntegerMatrix(int array[][])

  Constructs a matrix by wrapping an array.

  Parameters:
    array - an assigned value

IntegerMatrix

     public IntegerMatrix(IntegerVector 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 integer matrices for equality.

  Parameters:
    m - an integer 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

toDoubleMatrix

     public DoubleMatrix toDoubleMatrix()

  Converts this matrix to a double matrix.

  Returns:
    a double matrix

toComplexMatrix

     public ComplexMatrix toComplexMatrix()

  Converts this matrix to a complex matrix.

  Returns:
    a complex matrix

getElement

     public int 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,
                            int x)

  Sets the value of an element of the matrix.

  Parameters:
    i - row index of the element
    j - column index of the element
    x - an integer
  Throws: MatrixDimensionException
    If attempting to access an invalid element.

infNorm

     public int 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 IntegerMatrix add(IntegerMatrix m)

  Returns the addition of this matrix and another.

  Parameters:
    m - an integer 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 IntegerMatrix subtract(IntegerMatrix m)

  Returns the subtraction of this matrix by another.

  Parameters:
    m - an integer 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 IntegerMatrix scalarMultiply(int x)

  Returns the multiplication of this matrix by a scalar.

  Parameters:
    x - an integer
  Returns:
    an integer matrix

multiply

     public IntegerVector multiply(IntegerVector v)

  Returns the multiplication of a vector by this matrix.

  Parameters:
    v - an integer 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 IntegerMatrix multiply(IntegerMatrix m)

  Returns the multiplication of this matrix and another.

  Parameters:
    m - an integer matrix
  Returns:
    an IntegerMatrix or a IntegerSquareMatrix as appropriate
  Throws: MatrixDimensionException
    If the matrices are incompatible.

transpose

     public Matrix transpose()

  Returns the transpose of this matrix.

  Returns:
    an integer matrix
  Overrides:
    transpose in class Matrix

    All Packages  Class Hierarchy  This Package  Previous  Next  Index