Package com.singularsys.extensions.matrix

Interface MatrixFactoryI

All Superinterfaces:

JepComponent, Serializable

All Known Implementing Classes:

ComplexMatrixFactory, DoubleMatrixFactory, ExternalMatrixFactory, GenericMatrixFactory, ObjectMatrixFactory, RationalMatrixFactory, SequenceMatrixFactory

public interface MatrixFactoryI
extends JepComponent

Defines basic methods for constructing matrices.

Since:

Jep 3.5 / Extensions 2.0

Author:

Richard Morris

Method Summary

Modifier and Type	Method	Description
default MatrixI	duplicate(MatrixI mat)	Return a copy of the matrix.
default VectorI	duplicate(VectorI l)	Return a copy of the vector.
Object	elementValue(Object o)	Converts the argument to the type of elements of the matrix
MatrixI	identity(int size)	Create a square identity matrix
MatrixI	identity(int rows, int cols)	Create an identity matrix.
MatrixI	newMatrix(Object[][] data)	Create a new MatrixI using the given data
VectorI	newVector(Object... data)	Create a new VectorI using the given data
default VectorI	newVector(Collection<?> set)	Create a new VectorI from a collection.
MatrixI	zeroMat(int rows, int cols)	Create an zero matrix.
MatrixI	zeroMat(Dimensions dimensions)	Create a matrix with zero elements
VectorI	zeroVec(int size)	Create a vector with zeros
default VectorI	zeroVec(Dimensions dimensions)	Create a vector with zeros

Methods inherited from interface com.singularsys.jep.JepComponent

getLightWeightInstance, init

Method Details

elementValue

Object elementValue(Object o)
             throws EvaluationException

Converts the argument to the type of elements of the matrix

Parameters:

o -

Returns:

the element value or null if it cannot be converted

Throws:

EvaluationException

newVector

VectorI newVector(Object... data)
           throws EvaluationException

Create a new VectorI using the given data

Parameters:

data -

Returns:

a new VectorI the precise type depends on the implementing class

Throws:

EvaluationException

newVector

default VectorI newVector(Collection<?> set)
                   throws EvaluationException

Create a new VectorI from a collection. Default implementation simple calls newVector(set.toArray()). Implementing classes can override this method to provide more efficient implementations.

Parameters:

set - any collection including Lists.

Returns:

a new vector

Throws:

EvaluationException

newMatrix

MatrixI newMatrix(Object[][] data)
           throws EvaluationException

Create a new MatrixI using the given data

Parameters:

data -

Returns:

a new MatrixI the precise type depends on the implementing class

Throws:

EvaluationException

identity

MatrixI identity(int size)
          throws EvaluationException

Create a square identity matrix

Parameters:

size - size

Returns:

a size by size identity matrix

Throws:

EvaluationException

identity

MatrixI identity(int rows,
 int cols)
          throws EvaluationException

Create an identity matrix.

Parameters:

rows -

cols -

Returns:

a rows by cols identity matrix

Throws:

EvaluationException

zeroMat

MatrixI zeroMat(int rows,
 int cols)
         throws EvaluationException

Create an zero matrix.

Parameters:

rows -

cols -

Returns:

a rows by cols matrix

Throws:

EvaluationException

zeroVec

VectorI zeroVec(int size)
         throws EvaluationException

Create a vector with zeros

Parameters:

size -

Returns:

a vector of zeros

Throws:

EvaluationException

zeroMat

MatrixI zeroMat(Dimensions dimensions)
         throws EvaluationException

Create a matrix with zero elements

Parameters:

dimensions - dimensions specifying the size of a matrix.

Returns:

a matrix filled with zeros

Throws:

EvaluationException - if the dimensions are not of order 2

zeroVec

default VectorI zeroVec(Dimensions dimensions)
                 throws EvaluationException

Create a vector with zeros

Parameters:

dimensions - size of vector

Returns:

a vector filled with zeros

Throws:

EvaluationException - if the dimensions are not 1 dimensional

Since:

Jep 4.0/Extensions 2.0

duplicate

default MatrixI duplicate(MatrixI mat)
                   throws EvaluationException

Return a copy of the matrix. Default implementation is a little inefficient creating a temporary data array.

Parameters:

mat - matrix to copy

Returns:

a copy

Throws:

EvaluationException

duplicate

default VectorI duplicate(VectorI l)
                   throws EvaluationException

Return a copy of the vector. Default implementation is a little inefficient.

Parameters:

l - vector to copy

Returns:

a copy

Throws:

EvaluationException