com.graphbuilder.math.FuncNode Class Reference

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

Inheritance diagram for com.graphbuilder.math.FuncNode:

Collaboration diagram for com.graphbuilder.math.FuncNode:

Public Member Functions
	FuncNode (String name, boolean negate)
void	add (Expression x)
	Adds the expression as a child.
void	insert (Expression x, int i)
	Adds the expression as a child at the specified index.
void	remove (Expression x)
	Removes the specified expression as a child.
int	numChildren ()
	Returns the number of child expressions.
Expression	child (int i)
	Returns the child expression at the specified index.
double	eval (VarMap v, FuncMap f)
	Evaluates each of the children, storing the result in an internal double array.
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
Private Attributes
Bag	bag = new Bag(1)
double[]	of = new double[1]

Detailed Description

A node of an expression tree that represents a function.

A FuncNode can have 0 or more children.

Definition at line 8 of file FuncNode.java.

Constructor & Destructor Documentation

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

Definition at line 13 of file FuncNode.java.

Member Function Documentation

void com.graphbuilder.math.FuncNode.add ( Expression x )

Adds the expression as a child.

Definition at line 20 of file FuncNode.java.

References com.graphbuilder.math.FuncNode.bag, com.graphbuilder.math.FuncNode.insert(), and com.graphbuilder.struc.Bag.size.

Referenced by com.graphbuilder.math.ExpressionTree.build().

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().

Expression com.graphbuilder.math.FuncNode.child ( int i )

Returns the child expression at the specified index.

Definition at line 59 of file FuncNode.java.

References com.graphbuilder.math.FuncNode.bag, and com.graphbuilder.struc.Bag.get().

Referenced by com.graphbuilder.math.FuncNode.eval(), com.graphbuilder.math.Expression.getTermNames(), and com.graphbuilder.math.Expression.toString().

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

Evaluates each of the children, storing the result in an internal double array.

The FuncMap is used to obtain a Function object based on the name of this FuncNode. The function is passed the double array and returns a result. If negate is true, the result is negated. The result is then returned. The numParam passed to the function is the number of children of this FuncNode.

Implements com.graphbuilder.math.Expression.

Definition at line 69 of file FuncNode.java.

References com.graphbuilder.math.FuncNode.bag, com.graphbuilder.math.FuncNode.child(), com.graphbuilder.math.Expression.eval(), com.graphbuilder.math.FuncMap.getFunction(), com.graphbuilder.math.TermNode.name, com.graphbuilder.math.TermNode.negate, com.graphbuilder.math.FuncNode.of, and com.graphbuilder.struc.Bag.size.