Package pulse.math.linear

Class RectangularMatrix

java.lang.Object

pulse.math.linear.RectangularMatrix

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

SquareMatrix

public class RectangularMatrix
extends Object
implements Serializable

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected double[][]	x

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	RectangularMatrix(double[][] args)
protected	RectangularMatrix(double[] data, int n)

Method Summary

Modifier and Type	Method	Description
boolean	dimensionsMatch(RectangularMatrix m)	Checks if the dimension of this Matrix and m match, i.e.
boolean	equals(Object o)	Checks whether o is a SquareMatrix with matching dimensions and all elements of which are (approximately) equal to the respective elements of this matrix}.
double	get(int m, int k)
double[][]	getData()
RectangularMatrix	multiply(double f)	Scales this Matrix by f, which results in element-wise multiplication by f.
RectangularMatrix	multiply(RectangularMatrix m)	Performs Matrix multiplication.
Vector	multiply(Vector v)	Multiplies this Matrix by the vector v, which is represented by a $$n × 1 Matrix, where n is the dimension of v.
RectangularMatrix	subtract(RectangularMatrix m)	Performs an element-wise subtraction of m from this if these matrices have matching dimensions.
RectangularMatrix	sum(RectangularMatrix m)	Performs an element-wise summation if this and m have matching dimensions.
String	toString()	Prints out matrix dimensions and all the elements contained in it.
RectangularMatrix	transpose()	Transposes this Matrix, i.e.

Methods inherited from class java.lang.Object

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

Field Detail

x

protected final double[][] x

Constructor Detail

RectangularMatrix

protected RectangularMatrix(double[][] args)

RectangularMatrix

protected RectangularMatrix(double[] data,
                            int n)

Method Detail

sum

public RectangularMatrix sum(RectangularMatrix m)

Performs an element-wise summation if this and m have matching dimensions.

Parameters:

m - another Matrix of the same size as this one

Returns:

the result of summation

subtract

public RectangularMatrix subtract(RectangularMatrix m)

Performs an element-wise subtraction of m from this if these matrices have matching dimensions.

Parameters:

m - another Matrix of the same size as this one

Returns:

the result of subtraction

multiply

public RectangularMatrix multiply(RectangularMatrix m)

Performs Matrix multiplication. Checks whether the dimensions of each matrix are appropriate (number of columns in this matrix should be equal to the number of rows in m.

Parameters:

m - another Matrix suitable for multiplication

Returns:

a Matrix, which is the result of multiplying this by m

multiply

public RectangularMatrix multiply(double f)

Scales this Matrix by f, which results in element-wise multiplication by f.

Parameters:

f - a numeric value

Returns:

the scaled Matrix

transpose

public RectangularMatrix transpose()

Transposes this Matrix, i.e. reflects it over the main diagonal.

Returns:

a transposed Matrix

get

public double get(int m,
                  int k)

getData

public double[][] getData()

multiply

public Vector multiply(Vector v)

Multiplies this Matrix by the vector v, which is represented by a $$n × 1 Matrix, where n is the dimension of v. Note n should be equal to the number of rows in this Matrix.

Parameters:

v - a Vector.

Returns:

the result of multiplication, which is a Vector.

toString

public String toString()

Prints out matrix dimensions and all the elements contained in it.

Overrides:

toString in class Object

dimensionsMatch

public boolean dimensionsMatch(RectangularMatrix m)

Checks if the dimension of this Matrix and m match, i.e. if the number of rows is the same and the number of columns is the same

Parameters:

m - another Matrix

Returns:

true if the dimensions match, false otherwise.

equals

public boolean equals(Object o)

Checks whether o is a SquareMatrix with matching dimensions and all elements of which are (approximately) equal to the respective elements of this matrix}.

Overrides:

equals in class Object