|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectptolemy.data.Token
ptolemy.data.ScalarToken
ptolemy.data.ComplexToken
A token that contains a Complex number represented by a 64-bit double-precision floating point real and imaginary parts.
Token,
Complex,
Serialized Form
| Green (cxh) |
| Green (neuendor) |
| Field Summary |
| Fields inherited from class ptolemy.data.ScalarToken |
_unitCategoryExponents |
| Constructor Summary | |
ComplexToken()
Construct a ComplexToken with Complex 0.0+0.0i |
|
ComplexToken(Complex value)
Construct a ComplexToken with the specified value. |
|
ComplexToken(java.lang.String init)
Construct a ComplexToken from the specified string. |
|
| Method Summary | |
protected ScalarToken |
_absolute()
Return a ScalarToken containing the absolute value of the value of this token. |
protected ScalarToken |
_add(ScalarToken rightArgument)
Return a new token whose value is the value of the argument Token added to the value of this Token. |
protected ScalarToken |
_bitwiseAnd(ScalarToken rightArgument)
Throw an exception because bitwise AND is not supported. |
protected ScalarToken |
_bitwiseNot()
Throw an exception because bitwise NOT is not supported. |
protected ScalarToken |
_bitwiseOr(ScalarToken rightArgument)
Throw an exception because bitwise OR is not supported. |
protected ScalarToken |
_bitwiseXor(ScalarToken rightArgument)
Throw an exception because bitwise XOR is not supported. |
protected ScalarToken |
_divide(ScalarToken rightArgument)
Return a new token whose value is the value of this token divided by the value of the argument token. |
protected BooleanToken |
_isCloseTo(ScalarToken rightArgument,
double epsilon)
Test that the value of this rightArgument is close to the first argument, where "close" means that the distance between their values is less than or equal to the second argument. |
protected BooleanToken |
_isLessThan(ScalarToken rightArgument)
Throw an exception because complex values cannot be compared. |
protected ScalarToken |
_modulo(ScalarToken rightArgument)
Throw an exception because the modulo operation does not make sense for complex values. |
protected ScalarToken |
_multiply(ScalarToken rightArgument)
Return a new token whose value is the value of this token multiplied by the value of the argument token. |
protected ScalarToken |
_subtract(ScalarToken rightArgument)
Return a new token whose value is the value of the argument token subtracted from the value of this token. |
Complex |
complexValue()
Return the value of this token as a Complex. |
static ComplexToken |
convert(Token token)
Convert the specified token into an instance of ComplexToken. |
boolean |
equals(java.lang.Object object)
Return true if the argument's class is IntToken and it has the same values as this token. |
Type |
getType()
Return the type of this token. |
int |
hashCode()
Return a hash code value for this token. |
Token |
one()
Returns a new ComplexToken with value 1.0. |
java.lang.String |
toString()
Return the value of this token as a string that can be parsed by the expression language to recover a token with the same value. |
Token |
zero()
Returns a new ComplexToken with value Complex.ZERO. |
| Methods inherited from class ptolemy.data.ScalarToken |
_addCategoryExponents, _areUnitsEqual, _copyOfCategoryExponents, _isEqualTo, _isUnitless, _subtractCategoryExponents, absolute, add, addReverse, bitwiseAnd, bitwiseNot, bitwiseOr, bitwiseXor, byteValue, divide, divideReverse, doubleValue, fixValue, intValue, inUnitsOf, isCloseTo, isEqualTo, isGreaterThan, isLessThan, leftShift, logicalRightShift, longValue, modulo, moduloReverse, multiply, multiplyReverse, rightShift, setUnitCategory, subtract, subtractReverse, unitsString |
| Methods inherited from class ptolemy.data.Token |
isCloseTo, notSupportedConversionMessage, notSupportedIncomparableConversionMessage, notSupportedIncomparableMessage, notSupportedMessage, pow, zeroReturnType |
| Methods inherited from class java.lang.Object |
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
| Constructor Detail |
public ComplexToken()
public ComplexToken(Complex value)
public ComplexToken(java.lang.String init)
throws IllegalActionException
IllegalActionException - If the string does not represent
a parsable complex number.| Method Detail |
public Complex complexValue()
complexValue in class ScalarToken
public static ComplexToken convert(Token token)
throws IllegalActionException
token - The token to be converted to a ComplexToken.
IllegalActionException - If the conversion
cannot be carried out.public boolean equals(java.lang.Object object)
object - An instance of Object.
public Type getType()
getType in class ScalarTokenpublic int hashCode()
public Token one()
one in class Tokenpublic java.lang.String toString()
toString in class Tokenpublic Token zero()
zero in class Tokenprotected ScalarToken _absolute()
_absolute in class ScalarTokenprotected ScalarToken _add(ScalarToken rightArgument)
_add in class ScalarTokenrightArgument - The token to add to this token.
protected ScalarToken _bitwiseAnd(ScalarToken rightArgument)
throws IllegalActionException
_bitwiseAnd in class ScalarTokenIllegalActionException - Always thrown.
protected ScalarToken _bitwiseNot()
throws IllegalActionException
_bitwiseNot in class ScalarTokenIllegalActionException - Always thrown.
protected ScalarToken _bitwiseOr(ScalarToken rightArgument)
throws IllegalActionException
_bitwiseOr in class ScalarTokenIllegalActionException - Always thrown.
protected ScalarToken _bitwiseXor(ScalarToken rightArgument)
throws IllegalActionException
_bitwiseXor in class ScalarTokenIllegalActionException - Always thrown.
protected ScalarToken _divide(ScalarToken rightArgument)
throws IllegalActionException
_divide in class ScalarTokenrightArgument - The token to divide this token by.
IllegalActionException - If this method is not
supported by the derived class.
protected BooleanToken _isCloseTo(ScalarToken rightArgument,
double epsilon)
_isCloseTo in class ScalarTokenrightArgument - The rightArgument to compare to this
rightArgument.epsilon - The value that we use to determine whether two
tokens are close.
protected BooleanToken _isLessThan(ScalarToken rightArgument)
throws IllegalActionException
_isLessThan in class ScalarTokenrightArgument - The token to compare to this token.
IllegalActionException - Always thrown.
protected ScalarToken _modulo(ScalarToken rightArgument)
throws IllegalActionException
_modulo in class ScalarTokenrightArgument - The token to modulo this token by.
IllegalActionException - Always thrown.protected ScalarToken _multiply(ScalarToken rightArgument)
_multiply in class ScalarTokenrightArgument - The token to multiply this token by.
protected ScalarToken _subtract(ScalarToken rightArgument)
_subtract in class ScalarTokenrightArgument - The token to subtract from this token.
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||