scale.clef.expr
Class TranscendentalOp

java.lang.Object
  extended by scale.common.Root
      extended by scale.clef.Node
          extended by scale.clef.expr.Expression
              extended by scale.clef.expr.MonadicOp
                  extended by scale.clef.expr.TranscendentalOp
All Implemented Interfaces:
AnnotationInterface, DisplayNode

public class TranscendentalOp
extends MonadicOp

This class represents the monadic intrinsic functions.

$Id: TranscendentalOp.java,v 1.20 2007-03-21 13:31:54 burrill Exp $

Copyright 2008 by the Scale Compiler Group,
Department of Computer Science
University of Massachusetts,
Amherst MA. 01003, USA
All Rights Reserved.

If would have been better to name this class the BuiltInOperation class. It represents those complex operations which it may be possible to implement on the target architecture with a simple sequence of instructions. An example is the square root function which some architectures provide as a single instruction.


Constructor Summary
TranscendentalOp(Type type, Expression e, TransFtn ftn)
           
 
Method Summary
 Literal getConstantValue()
          Return the constant value of the expression.
 java.lang.String getDisplayLabel()
          Return a String suitable for labeling this node in a graphical display.
 TransFtn getFtn()
          Return a value indicating the transcendental function represented.
 java.lang.String toStringSpecial()
          This method allows sub-classes to provide class specific stuff to the string.
 void visit(Predicate p)
          Process a node by calling its associated routine.
 
Methods inherited from class scale.clef.expr.MonadicOp
containsDeclaration, equivalent, getChild, getDeclList, getExpr, isSimpleOp, numChildren, setExpr
 
Methods inherited from class scale.clef.expr.Expression
canonical, getCoreType, getDisplayColorHint, getDisplayShapeHint, getPointedToCore, getType, hasTrueFalseResult, setType
 
Methods inherited from class scale.clef.Node
getDecl, getSourceLineNumber, setAnnotationLevel, setReportLevel, setSourceLineNumber, toString, toString, toStringChildren
 
Methods inherited from class scale.common.Root
addAnnotation, allAnnotations, allMatchingAnnotations, getAnnotation, getDisplayName, getDisplayString, getNodeCount, getNodeID, hasAnnotation, hasEqualAnnotation, hashCode, removeAnnotation, removeAnnotations, toStringAnnotations, toStringClass, trace, trace, trace
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

TranscendentalOp

public TranscendentalOp(Type type,
                        Expression e,
                        TransFtn ftn)
Method Detail

getFtn

public TransFtn getFtn()
Return a value indicating the transcendental function represented.


getDisplayLabel

public java.lang.String getDisplayLabel()
Description copied from class: Expression
Return a String suitable for labeling this node in a graphical display. This method should be over-ridden as it simplay returns the class name.

Specified by:
getDisplayLabel in interface DisplayNode
Overrides:
getDisplayLabel in class Expression
Returns:
short description of current node.

visit

public void visit(Predicate p)
Description copied from class: Node
Process a node by calling its associated routine. See the "visitor" design pattern in Design Patterns: Elements of Reusable Object-Oriented Software by E. Gamma, et al, Addison Wesley, ISBN 0-201-63361-2.

Each class has a visit(Predicate p) method. For example, in class ABC:

   public void visit(Predicate p)
   {
     p.visitABC(this);
   }
 
and the class that implements Predicate has a method
   public void visitABC(Node n)
   {
     ABC a = (ABC) n;
     ...
   }
 
Thus, the class that implements Predicate can call
   n.visit(this);
 
where n is a Node sub-class without determining which specific sub-class n is. The visit pattern basically avoids implementing a large switch statement or defining different methods in each class for some purpose.

Overrides:
visit in class MonadicOp
See Also:
Predicate

getConstantValue

public Literal getConstantValue()
Return the constant value of the expression.

Overrides:
getConstantValue in class Expression
See Also:
Lattice

toStringSpecial

public java.lang.String toStringSpecial()
Description copied from class: Node
This method allows sub-classes to provide class specific stuff to the string.

Overrides:
toStringSpecial in class Expression