gov.llnl.babel.symbols
Class DComplexLiteral

java.lang.Object
  extended by gov.llnl.babel.symbols.AssertionExpression
      extended by gov.llnl.babel.symbols.Literal
          extended by gov.llnl.babel.symbols.DComplexLiteral

public class DComplexLiteral
extends Literal


Field Summary
 
Fields inherited from class gov.llnl.babel.symbols.AssertionExpression
d_context, ERROR_SEMANTIC_VALIDATION
 
Constructor Summary
DComplexLiteral(DoubleLiteral r, DoubleLiteral i, Context context)
          Create a new object.
DComplexLiteral(DoubleLiteral r, LongLiteral i, Context context)
          Create a new object.
DComplexLiteral(LongLiteral r, DoubleLiteral i, Context context)
          Create a new object.
 
Method Summary
 java.lang.Object accept(ExprVisitor ev, java.lang.Object data)
          Implement the "visitor pattern".
 java.lang.String cExpression(java.lang.String epvVar, int[] startInd)
          Return the C version of the expression.
 java.util.ArrayList getArrayIterMacros(java.lang.String epvVar, int[] startInd)
          Return the list of array iteration macro messages, if any.
 java.lang.String getImaginaryImage()
          Return the string image of the imaginary part of this object.
 DoubleLiteral getImaginaryLiteral()
          Return the literal of the imaginary part of this object.
 java.lang.Double getImaginaryValue()
          Return the value of the imaginary part of this object.
 int getNumArrayIterMacrosByType(char type)
          Returns the number of macros supported by this assertion of the specified type.
 java.lang.String getRealImage()
          Return the string image of the real part of this object.
 DoubleLiteral getRealLiteral()
          Return the literal of the real part of this object.
 java.lang.Double getRealValue()
          Return the value of the real part of this object.
 boolean hasMethodCall()
          Return TRUE if the expression is, or has, at least one method call; otherwise, return FALSE.
 boolean hasPure()
          Return TRUE if the expression is, or has, a PURE clause; otherwise, return FALSE.
 boolean hasReservedMethod(int type)
          Return TRUE if the expression is, or has, the specified reserved method call; otherwise, return FALSE.
 boolean hasResult()
          Return TRUE if the expression contains RESULT; otherwise, return FALSE.
 boolean hasUnreservedMethod(boolean any)
          Return TRUE if the method is any unreserved method (when any is TRUE) or it is an unreserved method with a throws clause (if any is FALSE); otherwise, return FALSE.
 boolean requiresExtendableContext()
          Return TRUE if extendable context is required to validate the expression; otherwise, return FALSE.
 boolean requiresMethodContext()
          Return TRUE if method context is required to validate the expression; otherwise, return FALSE.
 java.lang.String toString()
          Return the stringified version of the expression (in SIDL form).
protected  void validateSemantics(Extendable ext, Method m)
          Validate the expression semantics, if necessary, within the context of the extendable and optional method.
 
Methods inherited from class gov.llnl.babel.symbols.AssertionExpression
getExceptionPrefix, getExceptionPrefix, getReturnType, getReturnTypeName, getReturnTypeValue, hasParens, isValid, leftAssociative, returnIsArray, returnIsBoolean, returnIsCharacter, returnIsDComplex, returnIsDouble, returnIsFComplex, returnIsFloat, returnIsInteger, returnIsLong, returnIsNumericArray, returnIsOpaque, returnIsString, setParens, setReturnToBoolean, setReturnToCharacter, setReturnToDComplex, setReturnToDouble, setReturnToFComplex, setReturnToFloat, setReturnToInteger, setReturnToLong, setReturnToOpaque, setReturnToString, setReturnType, setReturnType, validateExpression
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

DComplexLiteral

public DComplexLiteral(DoubleLiteral r,
                       DoubleLiteral i,
                       Context context)
                throws AssertionException
Create a new object. Assumption(s): 1) The double literals that make up the real and imaginary parts are already marked as valid. This is reasonable since all basic literals are assumed to be valid immediately after creation.

Parameters:
r - The real part of the number.
i - The imaginary part of the number.
Throws:
AssertionException - The exception raised if errors in any validation.

DComplexLiteral

public DComplexLiteral(DoubleLiteral r,
                       LongLiteral i,
                       Context context)
                throws AssertionException
Create a new object. Assumption(s): 1) The double literal that makes up the real part and the long literal that makes up the imaginary part are already marked as valid. This is reasonable since all basic literals are assumed to be valid immediately after creation.

Parameters:
r - The double literal real part of the number.
i - The long literal imaginary part of the number.
Throws:
AssertionException - The exception raised if errors in any validation.

DComplexLiteral

public DComplexLiteral(LongLiteral r,
                       DoubleLiteral i,
                       Context context)
                throws AssertionException
Create a new object. Assumption(s): 1) The long literal that makes up the real and the double literal that makes up the imaginary part are already marked as valid. This is reasonable since all basic literals are assumed to be valid immediately after creation.

Parameters:
r - The long literal real part of the number.
i - The double literal imaginary part of the number.
Throws:
AssertionException - The exception raised if errors in any validation.
Method Detail

getRealLiteral

public DoubleLiteral getRealLiteral()
Return the literal of the real part of this object.


getRealValue

public java.lang.Double getRealValue()
Return the value of the real part of this object.


getRealImage

public java.lang.String getRealImage()
Return the string image of the real part of this object.


getImaginaryLiteral

public DoubleLiteral getImaginaryLiteral()
Return the literal of the imaginary part of this object.


getImaginaryValue

public java.lang.Double getImaginaryValue()
Return the value of the imaginary part of this object.


getImaginaryImage

public java.lang.String getImaginaryImage()
Return the string image of the imaginary part of this object.


hasPure

public boolean hasPure()
Return TRUE if the expression is, or has, a PURE clause; otherwise, return FALSE.

Specified by:
hasPure in class AssertionExpression

hasResult

public boolean hasResult()
Return TRUE if the expression contains RESULT; otherwise, return FALSE.

Specified by:
hasResult in class AssertionExpression

hasMethodCall

public boolean hasMethodCall()
Return TRUE if the expression is, or has, at least one method call; otherwise, return FALSE.

Specified by:
hasMethodCall in class AssertionExpression

hasReservedMethod

public boolean hasReservedMethod(int type)
Return TRUE if the expression is, or has, the specified reserved method call; otherwise, return FALSE.

Specified by:
hasReservedMethod in class AssertionExpression

hasUnreservedMethod

public boolean hasUnreservedMethod(boolean any)
Return TRUE if the method is any unreserved method (when any is TRUE) or it is an unreserved method with a throws clause (if any is FALSE); otherwise, return FALSE.

Specified by:
hasUnreservedMethod in class AssertionExpression

requiresExtendableContext

public boolean requiresExtendableContext()
Return TRUE if extendable context is required to validate the expression; otherwise, return FALSE.

Specified by:
requiresExtendableContext in class AssertionExpression

requiresMethodContext

public boolean requiresMethodContext()
Return TRUE if method context is required to validate the expression; otherwise, return FALSE.

Specified by:
requiresMethodContext in class AssertionExpression

validateSemantics

protected void validateSemantics(Extendable ext,
                                 Method m)
                          throws AssertionException
Validate the expression semantics, if necessary, within the context of the extendable and optional method.

Specified by:
validateSemantics in class AssertionExpression
Parameters:
ext - The interface or class that owns this expression.
m - The method that owns this expression.
Throws:
AssertionException - The exception that can be raised during any validation.

getArrayIterMacros

public java.util.ArrayList getArrayIterMacros(java.lang.String epvVar,
                                              int[] startInd)
Return the list of array iteration macro messages, if any. Each message is a string where the first character indicates the return type associated with the iteration. The remaining characters will be the actual macro invocation.

Specified by:
getArrayIterMacros in class AssertionExpression

getNumArrayIterMacrosByType

public int getNumArrayIterMacrosByType(char type)
Returns the number of macros supported by this assertion of the specified type. Valid types are given in MethodCall.java.

Specified by:
getNumArrayIterMacrosByType in class AssertionExpression

cExpression

public java.lang.String cExpression(java.lang.String epvVar,
                                    int[] startInd)
Return the C version of the expression. ToDo...This is actually more involved if this is part of a unary or binary expression because the .real and .imaginary parts of a sidl_complex must be used instead of this. However, this should be okay for passing the literal to a method call.

Specified by:
cExpression in class AssertionExpression

toString

public java.lang.String toString()
Return the stringified version of the expression (in SIDL form).

Specified by:
toString in class AssertionExpression

accept

public java.lang.Object accept(ExprVisitor ev,
                               java.lang.Object data)
Implement the "visitor pattern".

Specified by:
accept in class AssertionExpression