Package com.singularsys.extensions.matrix.externalmat

Class ExternalMatrixFactory<M extends MatrixI,V extends VectorI>

java.lang.Object

com.singularsys.extensions.matrix.externalmat.ExternalMatrixFactory<M,V>

Type Parameters:

M - Type of matrix used

V - Type of vector used

All Implemented Interfaces:

MatrixFactoryI, JepComponent, Serializable

public abstract class ExternalMatrixFactory<M extends MatrixI,V extends VectorI>
extends Object
implements MatrixFactoryI

Base class for MatrixFactories where external matrix libraries are used for the matrix implementation.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
ExternalMatrixFactory()

Method Summary

Modifier and Type	Method	Description
Object	elementValue(Object o)	Try to convert argument to base type of elements of Vector/Matrix.
abstract M	identity(int size)	Create a square identity matrix
abstract M	identity(int rows, int cols)	Create an identity matrix.
abstract M	newMatrix(Object[][] data)	Create a new MatrixI using the given data
abstract V	newVector(Object... data)	Create a new VectorI using the given data
abstract M	zeroMat(int rows, int cols)	Create an zero matrix.
M	zeroMat(Dimensions dimensions)	Create a zero matrix of given size
abstract V	zeroVec(int size)	Create a vector with zeros
V	zeroVec(Dimensions dimensions)	Create a zero vector of given size

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.singularsys.jep.JepComponent

getLightWeightInstance, init

Methods inherited from interface com.singularsys.extensions.matrix.MatrixFactoryI

duplicate, duplicate, newVector

Constructor Details

ExternalMatrixFactory

public ExternalMatrixFactory()

Method Details

newVector

public abstract V newVector(Object... data)
                     throws EvaluationException

Description copied from interface: MatrixFactoryI

Create a new VectorI using the given data

Specified by:

newVector in interface MatrixFactoryI

Parameters:

data -

Returns:

a new VectorI the precise type depends on the implementing class

Throws:

EvaluationException

zeroVec

public abstract V zeroVec(int size)
                   throws EvaluationException

Description copied from interface: MatrixFactoryI

Create a vector with zeros

Specified by:

zeroVec in interface MatrixFactoryI

Parameters:

size -

Returns:

a vector of zeros

Throws:

EvaluationException

newMatrix

public abstract M newMatrix(Object[][] data)
                     throws EvaluationException

Description copied from interface: MatrixFactoryI

Create a new MatrixI using the given data

Specified by:

newMatrix in interface MatrixFactoryI

Parameters:

data -

Returns:

a new MatrixI the precise type depends on the implementing class

Throws:

EvaluationException

zeroMat

public abstract M zeroMat(int rows,
 int cols)
                   throws EvaluationException

Description copied from interface: MatrixFactoryI

Create an zero matrix.

Specified by:

zeroMat in interface MatrixFactoryI

Parameters:

rows -

cols -

Returns:

a rows by cols matrix

Throws:

EvaluationException

identity

public abstract M identity(int size)
                    throws EvaluationException

Description copied from interface: MatrixFactoryI

Create a square identity matrix

Specified by:

identity in interface MatrixFactoryI

Parameters:

size - size

Returns:

a size by size identity matrix

Throws:

EvaluationException

identity

public abstract M identity(int rows,
 int cols)
                    throws EvaluationException

Description copied from interface: MatrixFactoryI

Create an identity matrix.

Specified by:

identity in interface MatrixFactoryI

Parameters:

rows -

cols -

Returns:

a rows by cols identity matrix

Throws:

EvaluationException

zeroMat

public M zeroMat(Dimensions dimensions)
          throws EvaluationException

Create a zero matrix of given size

Specified by:

zeroMat in interface MatrixFactoryI

Parameters:

dimensions - of desired matrix

Returns:

matrix of desired type

Throws:

EvaluationException - if dimensions are not 2D

zeroVec

public V zeroVec(Dimensions dimensions)
          throws EvaluationException

Create a zero vector of given size

Specified by:

zeroVec in interface MatrixFactoryI

Parameters:

dimensions - of desired matrix

Returns:

vector of desired type

Throws:

EvaluationException - if dimensions are not 1D

elementValue

public Object elementValue(Object o)
                    throws EvaluationException

Try to convert argument to base type of elements of Vector/Matrix. Subclass can call this method to ensure elements are not vectors or matrices.

Specified by:

elementValue in interface MatrixFactoryI

Parameters:

o - item to convert

Returns:

o

Throws:

EvaluationException