jmathlib.core.tokens
Class NumberToken

java.lang.Object
  extended by jmathlib.core.interpreter.RootObject
      extended by jmathlib.core.tokens.Token
          extended by jmathlib.core.tokens.OperandToken
              extended by jmathlib.core.tokens.DataToken
                  extended by jmathlib.core.tokens.NumberToken
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable, ErrorCodes, TokenConstants
Direct Known Subclasses:
DoubleNumberToken, Int16NumberToken, Int32NumberToken, Int64NumberToken, Int8NumberToken, SingleNumberToken, UInt16NumberToken, UInt32NumberToken, UInt64NumberToken, UInt8NumberToken

public class NumberToken
extends DataToken

Class representing numbers used in expression holds a 2D array of complex numers in a 3d array values[yx][REAL/IMAG] All operations on a NumberToken create a new NumberToken

See Also:
Serialized Form

Field Summary
protected static int IMAG
          Index for Imaginary values within array
protected  java.text.NumberFormat numFormat
          stores the number format for displaying the number
protected static int REAL
          Index for real values within array
 
Fields inherited from class jmathlib.core.tokens.DataToken
dataType, noElem, sizeA, sizeX, sizeY
 
Fields inherited from class jmathlib.core.tokens.Token
priority
 
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
 
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
 
Constructor Summary
NumberToken()
           
NumberToken(int priority, java.lang.String type)
           
 
Method Summary
 OperandToken evaluate(Token[] operands, GlobalValues globals)
          Evaluate the token.
 OperandToken getElement(int y, int x)
           
 int index2n(int[] index)
          Convert from index to n (e.g. index={2,3,5} -> n)
 boolean isNumeric()
          Checks if this operand is a numeric value
 boolean isScalar()
           
 void setElement(int y, int x, OperandToken num)
           
 java.lang.String toString()
           
 java.lang.String toString(GlobalValues globals)
           
protected  int yx2n(int y, int x)
          Convert y,x points to element number n
 
Methods inherited from class jmathlib.core.tokens.DataToken
checkEqualDimensions, getDataType, getDimensions, getElement, getElementSized, getNumberOfElements, getSize, getSizeX, getSizeY, setElement, setSize
 
Methods inherited from class jmathlib.core.tokens.OperandToken
add, asArray, Children, ctranspose, derivative, divide, expand, factorial, integral, isLeaf, isNull, leftDivide, mpower, mPower, multiply, negate, power, scalarDivide, scalarLeftDivide, scalarMultiply, simplify, subst, subtract, transpose
 
Methods inherited from class jmathlib.core.tokens.Token
isDisplayResult, setDisplayResult, toMathMlString
 
Methods inherited from class jmathlib.core.interpreter.RootObject
clone, toString
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

numFormat

protected java.text.NumberFormat numFormat
stores the number format for displaying the number


REAL

protected static final int REAL
Index for real values within array

See Also:
Constant Field Values

IMAG

protected static final int IMAG
Index for Imaginary values within array

See Also:
Constant Field Values
Constructor Detail

NumberToken

public NumberToken()

NumberToken

public NumberToken(int priority,
                   java.lang.String type)
Method Detail

yx2n

protected int yx2n(int y,
                   int x)
Convert y,x points to element number n

Parameters:
y -
x -
Returns:
n

index2n

public int index2n(int[] index)
Convert from index to n (e.g. index={2,3,5} -> n)

Parameters:
-
Returns:

getElement

public OperandToken getElement(int y,
                               int x)
Overrides:
getElement in class DataToken
Parameters:
y -
x -
Returns:

setElement

public void setElement(int y,
                       int x,
                       OperandToken num)
Overrides:
setElement in class DataToken
Parameters:
y -
x -
num -

evaluate

public OperandToken evaluate(Token[] operands,
                             GlobalValues globals)
Evaluate the token. This causes it to return itself

Specified by:
evaluate in class Token
Parameters:
operands - = an array of RootObject containing the tokens operands
Returns:
the result of the token evaluation as a RootObject

isNumeric

public boolean isNumeric()
Checks if this operand is a numeric value

Overrides:
isNumeric in class OperandToken
Returns:
true if this is a number, false if it's an algebraic expression

isScalar

public boolean isScalar()
Returns:
true if this number token is a scalar (1*1 matrix)

toString

public java.lang.String toString()
Specified by:
toString in class Token
Returns:
a string representation of the token

toString

public java.lang.String toString(GlobalValues globals)
Overrides:
toString in class Token
Returns:

FOOTER

BOTTOM