jmathlib.toolbox.jmathlib.matrix
Class eye

java.lang.Object
  jmathlib.core.interpreter.RootObject
      jmathlib.core.functions.Function
          jmathlib.core.functions.ExternalFunction
              jmathlib.toolbox.jmathlib.matrix.eye

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, ErrorCodes, TokenConstants

public class eye
extends ExternalFunction

An external function for creating matrices that consist of zeros * everywhere except in the diagonal. The diagonal consists of ones. * (e.g.: eye(3) will return a 3-by-3 matrix [1,0,0;0,1,0;0,0,1], * eye(4,3) will return a 4-by-3 matrix with diagonal set to 1

See Also:

Serialized Form

Field Summary

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

eye()

Method Summary

OperandToken

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

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

Constructor Detail

eye

public eye()

Method Detail

evaluate

public OperandToken evaluate(Token[] operands,
                             GlobalValues globals)

return a matrix

Specified by:

evaluate in class Function

Parameters:

operands[0] - = number of rows

operands[1] - = number of columns

Returns:

the result as an OperandToken