matrix

Class AbstractMatrix

java.lang.Object

matrix.AbstractMatrix

All Implemented Interfaces:

Matrix

Direct Known Subclasses:

ArrayImplementation, ArrayListImplementation

public abstract class AbstractMatrix
extends java.lang.Object
implements Matrix

This abstract class partially implements the Matrix API. Only the number of rows and columns are stored. A subclass should create the data structure used to store matrix elements.

Constructor Summary

Constructors

Constructor and Description
AbstractMatrix()

Method Summary

Modifier and Type	Method and Description
Matrix	add(Matrix other) Adds this matrix to another.
boolean	equals(java.lang.Object obj) Tests for equality of this matrix with another.
int	getNumColumns() Returns the number of columns in this matrix.
int	getNumRows() Returns the number of rows in this matrix.
Matrix	multiply(Matrix other) Multiplies this matrix by another.
void	setNumColumns(int numColumns) Sets the number of columns in this matrix.
void	setNumRows(int numRows) Sets the number of rows in this matrix.
java.lang.String	toString() Creates a visual representation of this matrix as a string.

Methods inherited from class java.lang.Object

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

Methods inherited from interface matrix.Matrix

checkBounds, checkColumnBounds, checkRowBounds, clear, create, fillColumnWise, fillRowWise, get, incrColumns, incrRows, insertColumn, insertRow, isIdentity, makeIdentity, set, sumColumn, sumRow, transpose

Constructor Detail

AbstractMatrix

public AbstractMatrix()

Method Detail

getNumRows

public int getNumRows()

Returns the number of rows in this matrix.

Specified by:

getNumRows in interface Matrix

Returns:

the number of rows in this matrix.

getNumColumns

public int getNumColumns()

Returns the number of columns in this matrix.

Specified by:

getNumColumns in interface Matrix

Returns:

the number of columns in this matrix.

setNumRows

public void setNumRows(int numRows)

Sets the number of rows in this matrix.

Specified by:

setNumRows in interface Matrix

Parameters:

numRows - the number of rows in this matrix

Throws:

MatrixException - if numRows is not positive

setNumColumns

public void setNumColumns(int numColumns)

Sets the number of columns in this matrix.

Specified by:

setNumColumns in interface Matrix

Parameters:

numColumns - the number of columns in this matrix

Throws:

MatrixException - if numColumns is not positive

equals

public boolean equals(java.lang.Object obj)

Tests for equality of this matrix with another. Matrices are equal if they have the same dimensions and all elements are equal by ==. This is a template method; it uses a method (get) that must be implemented by a subclass. This method overrides a method in the Object class, so it must type check and cast its argument to the correct type.

Overrides:

equals in class java.lang.Object

Parameters:

obj - the other matrix to be tested for equality with this matrix

Returns:

true if the other matrix is equal to this matrix, false otherwise

toString

public java.lang.String toString()

Creates a visual representation of this matrix as a string. This method can be used for debugging. This is a template method; it uses a method (get) that must be implemented by a subclass. This method overrides a method in the Object class.

Overrides:

toString in class java.lang.Object

Returns:

the string representation of this matrix.

add

public Matrix add(Matrix other)

Adds this matrix to another.

Specified by:

add in interface Matrix

Parameters:

other - the other matrix to add

Returns:

a new matrix that is the sum of this matrix and other

Throws:

MatrixException - if this matrix and the other matrix do not have the same dimensions

multiply

public Matrix multiply(Matrix other)

Multiplies this matrix by another.

Specified by:

multiply in interface Matrix

Parameters:

other - the other matrix to multiply

Returns:

a new matrix that is the product of this matrix and other

Throws:

MatrixException - if the number of columns in this matrix does not match the number of rows in the other