scale.score.expr
Class EqualityExpr

java.lang.Object
  scale.common.Root
      scale.score.Note
          scale.score.expr.Expr
              scale.score.expr.BinaryExpr
                  scale.score.expr.MatchExpr
                      scale.score.expr.EqualityExpr

All Implemented Interfaces:

AnnotationInterface, DisplayNode

public final class EqualityExpr
extends MatchExpr

This class represents the test for equality.

$Id: EqualityExpr.java,v 1.29 2007-10-18 15:56:37 burrill Exp $

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

Field Summary

Fields inherited from class scale.score.expr.Expr

fpReorder, SE_DOMAIN, SE_NONE, SE_OVERFLOW, SE_STATE

Constructor Summary

EqualityExpr(Type t, Expr e1, Expr e2)

Method Summary

MatchExpr	complement() Return the complement expression.
Expr	copy() Perform a deep copy of the expression tree.
Expr	create(Type t, Expr e1, Expr e2) This method of creating a EqualityExpr instance will return a reduced expression if possible.
Literal	getConstantValue() Return the constant value of the expression.
Literal	getConstantValue(HashMap<Expr,Literal> cvMap) Return the constant value of the expression.
java.lang.String	getDisplayLabel() Return a String suitable for labeling this node in a graphical display.
CompareMode	getMatchOp() Return an integer representing the type of comparison.
boolean	isCommutative() Return true if this expression is commutative.
void	visit(Predicate p) Process a node by calling its associated routine.

Methods inherited from class scale.score.expr.MatchExpr

hasTrueFalseResult, isMatchExpr, reduce

Methods inherited from class scale.score.expr.BinaryExpr

associativeSwapOperands, containsDeclaration, dependsOnDeclaration, equivalent, executionCostEstimate, getAliasAnnote, getDeclList, getExprList, getLeftArg, getLoadExprList, getOperand, getOperandArray, getRightArg, isAssociative, isLeftDistributive, isRightDistributive, loopClean, numOperands, optimizationCandidate, pushOperands, recordRefs, removeRefs, removeUseDef, replaceDecl, setLeftArg, setOperand, setRightArg, sideEffects, swapOperands, unlinkExpression, validate

Methods inherited from class scale.score.expr.Expr

addCast, addCast, canonical, changeInDataEdge, conditionalCopy, conditionalUnlinkExpression, deleteOutDataEdge, executionOrder, executionOrdinal, findCriticalChord, findLinearCoefficient, findSubscriptExpr, getAffineExpr, getAffineRepresentation, getCall, getCoreType, getCriticalChord, getDefExpr, getDisplayColorHint, getDisplayShapeHint, getDualExpr, getInDataEdge, getInDataEdgeArray, getLoopHeader, getLow, getLValue, getOutDataEdge, getPointedToCore, getReference, getReuseLevel, getRValue, getType, getUseDef, isCast, isDefined, isDefined, isLiteralExpr, isLoopInvariant, isMemoryDef, isMemRefExpr, isScalar, isSimpleExpr, mayGenerateCall, numInDataEdges, removeDualExprs, setCrossloopReuse, setOutDataEdge, setSpatialReuse, setStep, setTemporalReuse, setType, setUseDef, toStringSpecial, validLValue

Methods inherited from class scale.score.Note

getChord, getEssentialUse, setAnnotationLevel, setReportLevel, toString

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

EqualityExpr

public EqualityExpr(Type t,
                    Expr e1,
                    Expr e2)

Method Detail

create

public Expr create(Type t,
                   Expr e1,
                   Expr e2)

This method of creating a EqualityExpr instance will return a reduced expression if possible.

Specified by:

create in class MatchExpr

copy

public Expr copy()

Description copied from class: Expr

Perform a deep copy of the expression tree. By deep copy, we mean that copies are made of the expression tree.

Specified by:

copy in class Expr

Returns:

a copy of this expression

complement

public MatchExpr complement()

Return the complement expression. The complement of "==" is "!=".

Specified by:

complement in class MatchExpr

visit

public void visit(Predicate p)

Description copied from class: Note

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(Note n)
   {
     ABC a = (ABC) n;
     ...
   }
 

Thus, the class that implements Predicate can call

   n.visit(this);
 

where n is a Note 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.

Specified by:

visit in class Note

See Also:

Predicate

getDisplayLabel

public java.lang.String getDisplayLabel()

Description copied from class: Expr

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 Expr

getMatchOp

public CompareMode getMatchOp()

Return an integer representing the type of comparison.

Specified by:

getMatchOp in class MatchExpr

getConstantValue

public Literal getConstantValue(HashMap<Expr,Literal> cvMap)

Return the constant value of the expression. Follow use-def links.

Overrides:

getConstantValue in class Expr

See Also:

Lattice

getConstantValue

public Literal getConstantValue()

Return the constant value of the expression. Do not follow use-def links.

Overrides:

getConstantValue in class Expr

See Also:

Lattice

isCommutative

public boolean isCommutative()

Return true if this expression is commutative.

Overrides:

isCommutative in class BinaryExpr