scale.clef.expr
Class Transcendental2Op

java.lang.Object
  scale.common.Root
      scale.clef.Node
          scale.clef.expr.Expression
              scale.clef.expr.DyadicOp
                  scale.clef.expr.Transcendental2Op

All Implemented Interfaces:

AnnotationInterface, DisplayNode

public class Transcendental2Op
extends DyadicOp

This class represents dyadic intrinsic functions.

$Id: Transcendental2Op.java,v 1.15 2006-09-11 19:07:17 burrill Exp $

Copyright 2005 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.

Field Summary

static int	cAtan2 The atan(a,b) function.
static int	cDim The dim(a,b) function.
static int	cSign The sign(a,b) function.
static java.lang.String[]	trans2Ftn Map from function index to string.

Constructor Summary

Transcendental2Op(Type type, Expression e1, Expression e2, int ftn)

Method Summary

Literal	getConstantValue() Return the constant value of the expression
java.lang.String	getDisplayLabel() Return short description of current node.
int	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.DyadicOp

containsDeclaration, equivalent, getChild, getDeclList, getExpr1, getExpr2, getLhs, getRhs, isSimpleOp, numChildren, setExpr1, setExpr2, setLhs, setRhs

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

Field Detail

cAtan2

public static final int cAtan2

The atan(a,b) function.

See Also:

Constant Field Values

cSign

public static final int cSign

The sign(a,b) function.

See Also:

Constant Field Values

cDim

public static final int cDim

The dim(a,b) function.

See Also:

Constant Field Values

trans2Ftn

public static final java.lang.String[] trans2Ftn

Map from function index to string.

Constructor Detail

Transcendental2Op

public Transcendental2Op(Type type,
                         Expression e1,
                         Expression e2,
                         int ftn)

Method Detail

getFtn

public int getFtn()

Return a value indicating the transcendental function represented.

getDisplayLabel

public java.lang.String getDisplayLabel()

Return short description of current node.

Specified by:

getDisplayLabel in interface DisplayNode

Overrides:

getDisplayLabel in class Expression

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 DyadicOp

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