com.singularsys.extensions.fastmatrix

Class MrpRes

java.lang.Object

com.singularsys.extensions.fastmatrix.MrpRes

public abstract class MrpRes
extends java.lang.Object

The values returned by the evaluator and the base type for internal types.

Constructor Summary

Constructors

Constructor and Description
MrpRes()

Method Summary

Modifier and Type	Method and Description
abstract void	copyToMat(MatrixI res) Copy result to an existing matrix
abstract void	copyToVec(VectorI res) Copy result to an existing vector
double	doubleValue() If the result is a scaler return the value
abstract Dimensions	getDimensions() The Dimension of the object.
abstract double[][]	toArrayMat() If the result is a matrix return a two dimensional array of doubles.
abstract double[]	toArrayVec() If the result is a vector return a one dimensional array of doubles.
abstract java.lang.Double[][]	toDoubleMat()
abstract java.lang.Double[]	toDoubleVec()

Methods inherited from class java.lang.Object

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

Constructor Detail

MrpRes

public MrpRes()

Method Detail

getDimensions

public abstract Dimensions getDimensions()

The Dimension of the object. Use getDimensions().order() to tell if this object represents a scaler (0), vector (1) or matrix (2).

Returns:

an object representing the dimensions

doubleValue

public double doubleValue()

If the result is a scaler return the value

Returns:

result of a scaler computation.

toArrayMat

public abstract double[][] toArrayMat()

If the result is a matrix return a two dimensional array of doubles. Returns null for vectors and scalers.

Returns:

a new matrix

toDoubleMat

public abstract java.lang.Double[][] toDoubleMat()
                                          throws EvaluationException

Throws:

EvaluationException

toArrayVec

public abstract double[] toArrayVec()

If the result is a vector return a one dimensional array of doubles. Returns null for matrices and a single element vector for scalers.

Returns:

a new vector

toDoubleVec

public abstract java.lang.Double[] toDoubleVec()
                                        throws EvaluationException

Throws:

EvaluationException

copyToMat

public abstract void copyToMat(MatrixI res)
                        throws EvaluationException

Copy result to an existing matrix

Parameters:

res - the matrix to copy into

Throws:

EvaluationException - if the dimensions do not match or result is the wrong type

copyToVec

public abstract void copyToVec(VectorI res)
                        throws EvaluationException

Copy result to an existing vector

Parameters:

res - the vector to copy into

Throws:

EvaluationException - if the dimensions do not match or result is the wrong type