Package com.singularsys.extensions.matrix

Interface MatrixFieldI

All Superinterfaces:

FieldI, IntegerConvertor, JepComponent, Serializable

All Known Implementing Classes:

AbstractMatrixField, ComplexMatrixField, DoubleMatrixField, ExternalMatrixField, FieldMatrixField, GenericFieldMatrixField, GenericMatrixField, MatrixFieldCollection, SequenceMatrixField, SimpleMatrixField

public interface MatrixFieldI
extends FieldI, IntegerConvertor, JepComponent

Defines all the basic operations which can be carried out on matrices and vectors.

Since:

Jep 3.5 / Extensions 2.0

Author:

Richard Morris

Method Summary

Modifier and Type	Method	Description
Object	cross(Object l, Object r)	The cross product of two vectors
Object	det(Object mat)	The determinant of a matrix
Object	dot(Object l, Object r)	The dot product of two vectors
Object	inv(Object mat)	Returns the inverse of a square matrix.
Object	solve(Object A, Object B)	Solve equation A * X = B
Object	trace(Object mat)	Returns the trace of a matrix.
Object	trans(Object mat)	Transpose of a matrix

Methods inherited from interface com.singularsys.extensions.field.FieldI

add, and, div, eq, ge, getOne, getZero, gt, le, lt, mod, mul, ne, neg, not, or, pow, sub

Methods inherited from interface com.singularsys.extensions.field.IntegerConvertor

convertFromInt, convertToInt

Methods inherited from interface com.singularsys.jep.JepComponent

getLightWeightInstance, init

Method Details

det

Object det(Object mat)
    throws EvaluationException

The determinant of a matrix

Parameters:

mat -

Returns:

the determinant of mat if it is a matrix

Throws:

EvaluationException

trans

Object trans(Object mat)
      throws EvaluationException

Transpose of a matrix

Parameters:

mat - the matrix

Returns:

a matrix containing the transpose

Throws:

EvaluationException

dot

Object dot(Object l,
 Object r)
    throws EvaluationException

The dot product of two vectors

Parameters:

l -

r -

Returns:

the dot product if both arguments are vectors, null otherwise.

Throws:

EvaluationException

cross

Object cross(Object l,
 Object r)
      throws EvaluationException

The cross product of two vectors

Parameters:

l -

r -

Returns:

a vector with the cross product

Throws:

EvaluationException - if either vectors not of length 3

trace

Object trace(Object mat)
      throws EvaluationException

Returns the trace of a matrix.

Parameters:

mat - the matrix

Returns:

the trace

Throws:

EvaluationException

inv

Object inv(Object mat)
    throws EvaluationException

Returns the inverse of a square matrix.

Parameters:

mat - the matrix

Returns:

the trace

Throws:

EvaluationException - if matrix is not square or is singular

solve

Object solve(Object A,
 Object B)
      throws EvaluationException

Solve equation A * X = B

Parameters:

A - a square matrix

B - either a vector or matrix with same number of rows as A

Returns:

a vector or matrix solving equations

Throws:

EvaluationException - if matrix is not square or is singular