scale.score.expr
Class BitXorExpr

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

All Implemented Interfaces:

AnnotationInterface, DisplayNode

public class BitXorExpr
extends BinaryExpr

This class represents the bit exclusive or operation.

$Id: BitXorExpr.java,v 1.26 2007-04-27 18:04:35 burrill Exp $

Copyright 2008 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

BitXorExpr(Expr e1, Expr e2)
The expression type is the same as the type of expression e1.

BitXorExpr(Type t, Expr e1, Expr e2)

Method Summary

Expr	copy() Perform a deep copy of the expression tree.
static Expr	create(Type type, Expr la, Expr ra) This method of creating a BitXorExpr instance will return a simpler 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.
boolean	isAssociative() Return true if the binary operation is associative: (a α b) α c ≡ a α (b α c).
boolean	isCommutative() Return true if the binary operation is commutative: (a α b) ≡ (b &alpha a).
void	visit(Predicate p) Process a node by calling its associated routine.

Methods inherited from class scale.score.expr.BinaryExpr

associativeSwapOperands, containsDeclaration, dependsOnDeclaration, equivalent, executionCostEstimate, getAliasAnnote, getDeclList, getExprList, getLeftArg, getLoadExprList, getOperand, getOperandArray, getRightArg, 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, hasTrueFalseResult, isCast, isDefined, isDefined, isLiteralExpr, isLoopInvariant, isMatchExpr, isMemoryDef, isMemRefExpr, isScalar, isSimpleExpr, mayGenerateCall, numInDataEdges, reduce, 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

BitXorExpr

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

BitXorExpr

public BitXorExpr(Expr e1,
                  Expr e2)

The expression type is the same as the type of expression e1.

Method Detail

create

public static Expr create(Type type,
                          Expr la,
                          Expr ra)

This method of creating a BitXorExpr instance will return a simpler expression if possible.

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

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

isCommutative

public boolean isCommutative()

Description copied from class: BinaryExpr

Return true if the binary operation is commutative: (a α b) ≡ (b &alpha a).

Overrides:

isCommutative in class BinaryExpr

isAssociative

public boolean isAssociative()

Description copied from class: BinaryExpr

Return true if the binary operation is associative: (a α b) α c ≡ a α (b α c).

Overrides:

isAssociative in class BinaryExpr

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