scale.clef.expr
Class ComplexLiteral

java.lang.Object
  scale.common.Root
      scale.clef.Node
          scale.clef.expr.Expression
              scale.clef.expr.Literal
                  scale.clef.expr.ComplexLiteral

All Implemented Interfaces:

AnnotationInterface, DisplayNode

public class ComplexLiteral
extends Literal

A class which represents a floating point literal value.

$Id: ComplexLiteral.java,v 1.4 2007-10-04 19:58:05 burrill Exp $

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

Constructor Summary

ComplexLiteral(Type type, double real, double imag)

Method Summary

long	canonical() Return a unique value representing this particular expression.
boolean	equivalent(java.lang.Object exp) Return true if the two expressions are equivalent.
int	executionCostEstimate() Return a relative cost estimate for executing the expression.
java.lang.String	getGenericValue() Get the string version of the literal using C syntax.
double	getImaginary() Return the imaginary part.
Literal	getImaginaryPart() Return the imaginary part as a Literal.
double	getReal() Return the real part.
Literal	getRealPart() Return the imaginary part as a Literal.
boolean	isOne() Return true if the value of this literal is known to be one.
boolean	isZero() Return true if the value of this literal is known to be zero.
protected void	setValue(double real, double imag)
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.Literal

findCoefficient, formatRealValue, getConstantValue, getCount, getDeclList, getDisplayLabel, getElement, linearity

Methods inherited from class scale.clef.expr.Expression

containsDeclaration, getCoreType, getDisplayColorHint, getDisplayShapeHint, getPointedToCore, getType, hasTrueFalseResult, isSimpleOp, setType

Methods inherited from class scale.clef.Node

getChild, getDecl, getSourceLineNumber, numChildren, 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

ComplexLiteral

public ComplexLiteral(Type type,
                      double real,
                      double imag)

Method Detail

equivalent

public boolean equivalent(java.lang.Object exp)

Return true if the two expressions are equivalent.

Overrides:

equivalent in class Expression

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

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 Literal

See Also:

Predicate

getGenericValue

public final java.lang.String getGenericValue()

Get the string version of the literal using C syntax.

Overrides:

getGenericValue in class Literal

Returns:

a String already converted for display using C syntax.

setValue

protected final void setValue(double real,
                              double imag)

getReal

public double getReal()

Return the real part.

getRealPart

public Literal getRealPart()

Return the imaginary part as a Literal.

getImaginary

public double getImaginary()

Return the imaginary part.

getImaginaryPart

public Literal getImaginaryPart()

Return the imaginary part as a Literal.

canonical

public long canonical()

Return a unique value representing this particular expression.

Overrides:

canonical in class Expression

executionCostEstimate

public int executionCostEstimate()

Return a relative cost estimate for executing the expression.

Overrides:

executionCostEstimate in class Literal

isZero

public boolean isZero()

Return true if the value of this literal is known to be zero.

Overrides:

isZero in class Literal

isOne

public boolean isOne()

Return true if the value of this literal is known to be one.

Overrides:

isOne in class Literal