scale.clef.expr
Class DyadicOp

java.lang.Object
  extended by scale.common.Root
      extended by scale.clef.Node
          extended by scale.clef.expr.Expression
              extended by scale.clef.expr.DyadicOp
All Implemented Interfaces:
AnnotationInterface, DisplayNode
Direct Known Subclasses:
AdditionOp, AndConditionalOp, AndOp, AssignmentOp, BitAndOp, BitOrOp, BitShiftOp, BitXorOp, ComplexOp, DivisionOp, EqualityOp, ExponentiationOp, GreaterEqualOp, GreaterOp, LessEqualOp, LessOp, MaximumOp, MinimumOp, ModulusOp, MultiplicationOp, NotEqualOp, OrConditionalOp, OrOp, RemainderOp, SeriesOp, SubtractionOp, Transcendental2Op

public abstract class DyadicOp
extends Expression

This class is the abstract class for operations with two arguments.

$Id: DyadicOp.java,v 1.27 2007-08-28 17:58:20 burrill Exp $

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


Constructor Summary
DyadicOp(Type type, Expression left, Expression right)
           
 
Method Summary
 boolean containsDeclaration(Declaration decl)
          Return true if this expression contains a reference to the variable.
 boolean equivalent(java.lang.Object exp)
          Return true if the two expressions are equivalent.
 Node getChild(int i)
          Return the specified AST child of this node.
 void getDeclList(java.util.AbstractCollection<Declaration> varList)
          Add all declarations referenced in this expression to the collection.
 Expression getExpr1()
          Return the left argument of the operator.
 Expression getExpr2()
          Return the right argument of the operator.
 Expression getLhs()
          Return the left argument of the operator.
 Expression getRhs()
          Return the right argument of the operator.
 boolean isSimpleOp()
          Return true if compilation of this expression will not result in the generation of a CFG node.
 int numChildren()
          Return the number of AST children of this node.
protected  void setExpr1(Expression expr1)
          Specify the left argument of the operator.
protected  void setExpr2(Expression expr2)
          Specify the right argument of the operator.
protected  void setLhs(Expression e)
          Specify the left argument of the operator.
protected  void setRhs(Expression e)
          Specify the right argument of the operator.
 void visit(Predicate p)
          Process a node by calling its associated routine.
 
Methods inherited from class scale.clef.expr.Expression
canonical, getConstantValue, getCoreType, getDisplayColorHint, getDisplayLabel, getDisplayShapeHint, getPointedToCore, getType, hasTrueFalseResult, setType, toStringSpecial
 
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

DyadicOp

public DyadicOp(Type type,
                Expression left,
                Expression right)
Method Detail

equivalent

public boolean equivalent(java.lang.Object exp)
Return true if the two expressions are equivalent.

Overrides:
equivalent 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 Expression
See Also:
Predicate

getExpr1

public final Expression getExpr1()
Return the left argument of the operator.


getLhs

public final Expression getLhs()
Return the left argument of the operator.


getRhs

public final Expression getRhs()
Return the right argument of the operator.


setExpr1

protected final void setExpr1(Expression expr1)
Specify the left argument of the operator.


setLhs

protected final void setLhs(Expression e)
Specify the left argument of the operator.


setRhs

protected final void setRhs(Expression e)
Specify the right argument of the operator.


getExpr2

public final Expression getExpr2()
Return the right argument of the operator.


setExpr2

protected final void setExpr2(Expression expr2)
Specify the right argument of the operator.


getChild

public Node getChild(int i)
Return the specified AST child of this node.

Overrides:
getChild in class Node

numChildren

public int numChildren()
Return the number of AST children of this node.

Overrides:
numChildren in class Node

isSimpleOp

public boolean isSimpleOp()
Description copied from class: Expression
Return true if compilation of this expression will not result in the generation of a CFG node. For example, (a && b) may require a branch to represent and i++ requires a store.

Overrides:
isSimpleOp in class Expression

containsDeclaration

public boolean containsDeclaration(Declaration decl)
Return true if this expression contains a reference to the variable.

Overrides:
containsDeclaration in class Expression

getDeclList

public void getDeclList(java.util.AbstractCollection<Declaration> varList)
Description copied from class: Expression
Add all declarations referenced in this expression to the collection.

Specified by:
getDeclList in class Expression