TreeUtils

java.lang.Object
- org.lsmp.djep.xjep.TreeUtils

```
public class TreeUtils
extends Object
```
A set of Utility functions for working with JEP expression trees. Main methods are
- isConstant test if its a constant. Many other is... methods.
- getValue extracts the value from a node without needing to cast and check types.

Constructor Summary

Constructors
Constructor and Description

TreeUtils()
Default constructor.

Constructors
Constructor and Description
`TreeUtils()` Default constructor.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Complex`	`complexValue(Node node)` Returns the Complex value represented by node
`static Node`	`copyChildrenIfNeeded(Node node, Node[] children)` Sets the children of a node if they have changed for it current children.
`double`	`doubleValue(Node node)` Returns the double value represented by node
`static Node[]`	`getChildrenAsArray(Node node)` returns the children of a node as an array of nodes.
`Object`	`getCI()`
`Object`	`getCMINUSI()`
`Object`	`getCMINUSONE()`
`Object`	`getCONE()`
`Object`	`getCZERO()`
`Object`	`getMINUSONE()`
`String`	`getName(Node node)` Returns the value represented by node
`Object`	`getNAN()`
`Object`	`getNegativeInfinity()`
`Object`	`getNumber(double val)`
`Object`	`getONE()`
`Operator`	`getOperator(Node node)` returns the operator for a node or null if it is not an operator node.
`Object`	`getPositiveInfinity()`
`Object`	`getValue(Node node)` Returns the value represented by node
`Object`	`getZERO()`
`int`	`intValue(Node node)` Returns the int value represented by node
`boolean`	`isBinaryOperator(Node node)`
`boolean`	`isComplex(Node node)` returns true if node is an ASTConstant of type Complex
`boolean`	`isConstant(Node node)` returns true if node is a ASTConstant
`boolean`	`isFunction(Node node)` returns true if node is an ASTFunNode
`boolean`	`isInfinity(Node node)` returns true if node is a ASTConstant with a Infinite component TODO do proper treatment of signed infinity
`boolean`	`isInteger(Node node)` returns true if node is a ASTConstant with Double value representing an integer.
`boolean`	`isMinusOne(Node node)` returns true if node is a ASTConstant with value Double(-1) or Complex(-1,0)
`boolean`	`isNaN(Node node)` returns true if node is a ASTConstant with a NaN component
`boolean`	`isNegative(Node node)` returns true if node is an ASTConstant with a negative Double value
`boolean`	`isOne(Node node)` returns true if node is a ASTConstant with value Double(1) or Complex(1,0)
`boolean`	`isOperator(Node node)` returns true if node is an ASTOpNode
`boolean`	`isPositive(Node node)` returns true if node is an ASTConstant with a positive Double value
`boolean`	`isReal(Node node)` returns true if node is a ASTConstant with Double value
`boolean`	`isUnaryOperator(Node node)`
`boolean`	`isVariable(Node node)` returns true if node is an ASTVarNode
`boolean`	`isZero(Node node)` returns true if node is a ASTConstant with value Double(0) or Complex(0,0)
`boolean`	`isZero(Node node, double tol)` returns true if node is a ASTConstant with value Double(0) or Complex(0,0)
`long`	`longValue(Node node)` Returns the long value represented by node

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - TreeUtils
```
public TreeUtils()
```
    Default constructor. TODO Should use the NumberFactory to create numbers!
- Method Detail
  - getName
```
public String getName(Node node)
               throws IllegalArgumentException
```
    Returns the value represented by node
    
    Throws:
    
    IllegalArgumentException - if given something which is not an ASTConstant
  - getValue
```
public Object getValue(Node node)
                throws IllegalArgumentException
```
    Returns the value represented by node
    
    Throws:
    
    IllegalArgumentException - if given something which is not an ASTConstant
  - doubleValue
```
public double doubleValue(Node node)
                   throws IllegalArgumentException
```
    Returns the double value represented by node
    
    Throws:
    
    IllegalArgumentException - if given something which is not an ASTConstant with a Double value
  - longValue
```
public long longValue(Node node)
               throws IllegalArgumentException
```
    Returns the long value represented by node
    
    Throws:
    
    IllegalArgumentException - if given something which is not an ASTConstant with a Double value
  - intValue
```
public int intValue(Node node)
             throws IllegalArgumentException
```
    Returns the int value represented by node
    
    Throws:
    
    IllegalArgumentException - if given something which is not an ASTConstant with a Double value
  - complexValue
```
public Complex complexValue(Node node)
                     throws IllegalArgumentException
```
    Returns the Complex value represented by node
    
    Throws:
    
    IllegalArgumentException - if given something which is not an ASTConstant with a Complex value
  - isConstant
```
public boolean isConstant(Node node)
```
    returns true if node is a ASTConstant
  - isReal
```
public boolean isReal(Node node)
```
    returns true if node is a ASTConstant with Double value
  - isInteger
```
public boolean isInteger(Node node)
```
    returns true if node is a ASTConstant with Double value representing an integer.
  - isZero
```
public boolean isZero(Node node)
```
    returns true if node is a ASTConstant with value Double(0) or Complex(0,0)
  - isZero
```
public boolean isZero(Node node,
                      double tol)
```
    returns true if node is a ASTConstant with value Double(0) or Complex(0,0)
    
    Parameters:
    
    tol - tolerance for testing for zero
  - isOne
```
public boolean isOne(Node node)
```
    returns true if node is a ASTConstant with value Double(1) or Complex(1,0)
  - isMinusOne
```
public boolean isMinusOne(Node node)
```
    returns true if node is a ASTConstant with value Double(-1) or Complex(-1,0)
  - isInfinity
```
public boolean isInfinity(Node node)
```
    returns true if node is a ASTConstant with a Infinite component TODO do proper treatment of signed infinity
  - isNaN
```
public boolean isNaN(Node node)
```
    returns true if node is a ASTConstant with a NaN component
  - isNegative
```
public boolean isNegative(Node node)
```
    returns true if node is an ASTConstant with a negative Double value
  - isPositive
```
public boolean isPositive(Node node)
```
    returns true if node is an ASTConstant with a positive Double value
  - isComplex
```
public boolean isComplex(Node node)
```
    returns true if node is an ASTConstant of type Complex
  - isVariable
```
public boolean isVariable(Node node)
```
    returns true if node is an ASTVarNode
  - isOperator
```
public boolean isOperator(Node node)
```
    returns true if node is an ASTOpNode
  - isBinaryOperator
```
public boolean isBinaryOperator(Node node)
```
  - isUnaryOperator
```
public boolean isUnaryOperator(Node node)
```
  - getOperator
```
public Operator getOperator(Node node)
```
    returns the operator for a node or null if it is not an operator node.
  - isFunction
```
public boolean isFunction(Node node)
```
    returns true if node is an ASTFunNode
  - copyChildrenIfNeeded
```
public static Node copyChildrenIfNeeded(Node node,
                                        Node[] children)
                                 throws ParseException
```
    Sets the children of a node if they have changed for it current children.
    
    Throws:
    
    ParseException
  - getChildrenAsArray
```
public static Node[] getChildrenAsArray(Node node)
```
    returns the children of a node as an array of nodes.
  - getCI
```
public Object getCI()
```
  - getCMINUSI
```
public Object getCMINUSI()
```
  - getCMINUSONE
```
public Object getCMINUSONE()
```
  - getCONE
```
public Object getCONE()
```
  - getCZERO
```
public Object getCZERO()
```
  - getMINUSONE
```
public Object getMINUSONE()
```
  - getONE
```
public Object getONE()
```
  - getZERO
```
public Object getZERO()
```
  - getNAN
```
public Object getNAN()
```
  - getPositiveInfinity
```
public Object getPositiveInfinity()
```
  - getNegativeInfinity
```
public Object getNegativeInfinity()
```
  - getNumber
```
public Object getNumber(double val)
```

Class TreeUtils

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TreeUtils

Method Detail

getName

getValue

doubleValue

longValue

intValue

complexValue

isConstant

isReal

isInteger

isZero

isZero

isOne

isMinusOne

isInfinity

isNaN

isNegative

isPositive

isComplex

isVariable

isOperator

isBinaryOperator

isUnaryOperator

getOperator

isFunction

copyChildrenIfNeeded

getChildrenAsArray

getCI

getCMINUSI

getCMINUSONE

getCONE

getCZERO

getMINUSONE

getONE

getZERO

getNAN

getPositiveInfinity

getNegativeInfinity

getNumber