jmathlib.toolbox.jmathlib.matrix
Class submatrix

java.lang.Object
  extended by jmathlib.core.interpreter.RootObject
      extended by jmathlib.core.functions.Function
          extended by jmathlib.core.functions.ExternalFunction
              extended by jmathlib.toolbox.jmathlib.matrix.submatrix
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable, ErrorCodes, TokenConstants

public class submatrix
extends ExternalFunction

An external function for creating a sub matrix of a DoubleNumberToken

See Also:
Serialized Form

Field Summary
(package private)  boolean leftCellB
           
 
Fields inherited from class jmathlib.core.functions.ExternalFunction
IMAG, REAL
 
Fields inherited from class jmathlib.core.functions.Function
lastModified, name, pathAndFileName
 
Fields inherited from interface jmathlib.core.constants.ErrorCodes
ERR_BRACKET_OPEN, ERR_BRACKET_ORDER, ERR_FUNCTION_NOT_FOUND, ERR_FUNCTION_NOT_IMPLEMENTED, ERR_INSUFFICIENT_PARAMETERS, ERR_INVALID_PARAMETER, ERR_LVALUE_REQUIRED, ERR_MATRIX_SINGULAR, ERR_NOT_SQUARE_MATRIX, ERR_OPNOTSUPPORTED, ERR_TOO_MANY_PARAMETERS, ERR_USER_ERROR, ERR_VARIABLE_NOTDEFINED, OK, OK_FUNCTION_PROCESS
 
Fields inherited from interface jmathlib.core.constants.TokenConstants
ADDSUB_PRIORITY, AND_PRIORITY, ANDAND_PRIORITY, ASSIGN_PRIORITY, BRACKET_PRIORITY, COMPARE_PRIORITY, CONCAT, MATRIX, MULDIV_PRIORITY, OR_PRIORITY, OROR_PRIORITY, PARAMETER, POWER_PRIORITY, RELATION_PRIORITY, SINGLE, ttDelimiter, ttNotSet, ttOperand, ttOperator
 
Constructor Summary
submatrix()
           
 
Method Summary
 OperandToken evaluate(Token[] operands, GlobalValues globals)
          return a sub matrix
 void setLeftCell()
           
 
Methods inherited from class jmathlib.core.functions.ExternalFunction
getParamCount
 
Methods inherited from class jmathlib.core.functions.Function
debugLine, equals, getLastModified, getName, getNArgIn, getNArgOut, getNoOfLeftHandArguments, getPathAndFileName, setLastModified, setName, setNoOfLeftHandArguments, setPathAndFileName, throwMathLibException
 
Methods inherited from class jmathlib.core.interpreter.RootObject
clone, toString
 
Methods inherited from class java.lang.Object
finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

leftCellB

boolean leftCellB
Constructor Detail

submatrix

public submatrix()
Method Detail

setLeftCell

public void setLeftCell()

evaluate

public OperandToken evaluate(Token[] operands,
                             GlobalValues globals)
return a sub matrix

Specified by:
evaluate in class Function
Parameters:
operands[0] - = matrix
operands[1] - = vertical limits (1 or 1:3 or : )
operands[2] - = horizontal limits (optional) (1 or 1:3 or : ) (e.g.: submatrix(a,0,0) returns the top left element of a,
submatrix(a,:,2) returns the second column of a,
submatrix(a,2:3,0:2) returns a 2-by-3 submatrix of a,
submatrix(a,2) returns the first element of the second row of a
e.g.: a=[1,2,3,4,5;
6,7,8,9,10;
1,2,3,4,5]
then submatrix(a,1,2) returns 2
then submatrix(a,3,:) returns [3,8,3]'
then submatrix(a,2:5,2) returns [7,8,9,10]
then submatrix(a,:) return [1,2,3,4,5,6,7,8,9...]' column
(also see subassign() )
Returns:
the result as an OperandToken

FOOTER

BOTTOM