com.graphbuilder.math.VarNode Class Reference

A node of an expression tree that represents a variable. More...

Inheritance diagram for com.graphbuilder.math.VarNode:

Inheritance graph

Collaboration diagram for com.graphbuilder.math.VarNode:

Collaboration graph

List of all members.

Public Member Functions
	VarNode (String name, boolean negate)
double	eval (VarMap v, FuncMap f)
	Returns the value associated with the variable name in the VarMap.
boolean	getNegate ()
	Returns true if the term should negate the result before returning it in the eval method.
void	setNegate (boolean b)
String	getName ()
	Returns the name of the term.
void	setName (String s)
	Sets the name of the term.
boolean	isDescendent (Expression x)
	Returns true if this node is a descendent of the specified node, false otherwise.
Expression	getParent ()
	Returns the parent of this node.
String[]	getVariableNames ()
	Returns an array of exact length of the variable names contained in the expression tree rooted at this node.
String[]	getFunctionNames ()
	Returns an array of exact length of the function names contained in the expression tree rooted at this node.
String	toString ()
	Returns a string that represents the expression tree rooted at this node.
Protected Member Functions
void	checkBeforeAccept (Expression x)
	Protected method used to verify that the specified expression can be included as a child expression of this node.
Protected Attributes
String	name = null
boolean	negate = false
Expression	parent = null

Detailed Description

A node of an expression tree that represents a variable.

A VarNode cannot have any children.

Definition at line 6 of file VarNode.java.

Constructor & Destructor Documentation

com.graphbuilder.math.VarNode.VarNode	(	String	name,
		boolean	negate
	)

Definition at line 8 of file VarNode.java.

Member Function Documentation

void com.graphbuilder.math.Expression.checkBeforeAccept ( Expression x ) [protected, inherited]

Protected method used to verify that the specified expression can be included as a child expression of this node.

Exceptions:

IllegalArgumentException

If the specified expression is not accepted.

Definition at line 51 of file Expression.java.

References com.graphbuilder.math.Expression.isDescendent(), and com.graphbuilder.math.Expression.parent.

Referenced by com.graphbuilder.math.FuncNode.insert(), com.graphbuilder.math.OpNode.setLeftChild(), and com.graphbuilder.math.OpNode.setRightChild().

double com.graphbuilder.math.VarNode.eval	(	VarMap	v,
		FuncMap	f
	)			`[virtual]`

Returns the value associated with the variable name in the VarMap.

Implements com.graphbuilder.math.Expression.

Definition at line 15 of file VarNode.java.

References com.graphbuilder.math.VarMap.getValue(), com.graphbuilder.math.TermNode.name, and com.graphbuilder.math.TermNode.negate.

String [] com.graphbuilder.math.Expression.getFunctionNames ( ) [inherited]

Returns an array of exact length of the function names contained in the expression tree rooted at this node.

Definition at line 72 of file Expression.java.

References com.graphbuilder.math.Expression.getTermNames().

String com.graphbuilder.math.TermNode.getName ( ) [inherited]

Returns the name of the term.

Definition at line 30 of file TermNode.java.

References com.graphbuilder.math.TermNode.name.

Referenced by com.graphbuilder.math.Expression.toString().

boolean com.graphbuilder.math.TermNode.getNegate ( ) [inherited]

Returns true if the term should negate the result before returning it in the eval method.

Definition at line 19 of file TermNode.java.

References com.graphbuilder.math.TermNode.negate.

Referenced by com.graphbuilder.math.Expression.toString().

Expression com.graphbuilder.math.Expression.getParent ( ) [inherited]

Returns the parent of this node.

Definition at line 41 of file Expression.java.

References com.graphbuilder.math.Expression.parent.

String [] com.graphbuilder.math.Expression.getVariableNames ( ) [inherited]

Returns an array of exact length of the variable names contained in the expression tree rooted at this node.

Definition at line 65 of file Expression.java.

References com.graphbuilder.math.Expression.getTermNames().

boolean com.graphbuilder.math.Expression.isDescendent ( Expression x ) [inherited]

Returns true if this node is a descendent of the specified node, false otherwise.

By this methods definition, a node is a descendent of itself.

Definition at line 26 of file Expression.java.

References com.graphbuilder.math.Expression.parent.

Referenced by com.graphbuilder.math.Expression.checkBeforeAccept().

void com.graphbuilder.math.TermNode.setName ( String s ) [inherited]

Sets the name of the term.

Valid names must not begin with a digit or a decimal, and must not contain round brackets, operators, commas or whitespace.

Exceptions:

IllegalArgumentException

If the name is null or invalid.

Definition at line 40 of file TermNode.java.

References com.graphbuilder.math.TermNode.isValidName(), and com.graphbuilder.math.TermNode.name.

Referenced by com.graphbuilder.math.TermNode.TermNode().

void com.graphbuilder.math.TermNode.setNegate ( boolean b ) [inherited]

Definition at line 23 of file TermNode.java.

References com.graphbuilder.math.TermNode.negate.

Referenced by com.graphbuilder.math.TermNode.TermNode().

String com.graphbuilder.math.Expression.toString ( ) [inherited]

Returns a string that represents the expression tree rooted at this node.

Definition at line 114 of file Expression.java.

Referenced by edu.rice.cs.hpc.viewer.metric.ExtDerivedMetricDlg.createDialogArea(), and com.graphbuilder.math.Expression.toString().

Member Data Documentation

String com.graphbuilder.math.TermNode.name = null [protected, inherited]

Definition at line 8 of file TermNode.java.

Referenced by com.graphbuilder.math.VarNode.eval(), com.graphbuilder.math.FuncNode.eval(), com.graphbuilder.math.TermNode.getName(), com.graphbuilder.math.Expression.getTermNames(), and com.graphbuilder.math.TermNode.setName().

boolean com.graphbuilder.math.TermNode.negate = false [protected, inherited]

Definition at line 9 of file TermNode.java.

Referenced by com.graphbuilder.math.VarNode.eval(), com.graphbuilder.math.FuncNode.eval(), com.graphbuilder.math.TermNode.getNegate(), and com.graphbuilder.math.TermNode.setNegate().

Expression com.graphbuilder.math.Expression.parent = null [protected, inherited]

Definition at line 15 of file Expression.java.

Referenced by com.graphbuilder.math.Expression.checkBeforeAccept(), com.graphbuilder.math.Expression.getParent(), com.graphbuilder.math.FuncNode.insert(), com.graphbuilder.math.Expression.isDescendent(), com.graphbuilder.math.OpNode.setLeftChild(), and com.graphbuilder.math.OpNode.setRightChild().

The documentation for this class was generated from the following file:

edu.rice.cs.hpc.data/externals/com/graphbuilder/math/VarNode.java

Generated on 5 May 2015 for HPCVIEWER by 1.6.1