BigDecimalUtils (oakgp 0.1.0-SNAPSHOT API)

java.lang.Object
- org.oakgp.function.math.BigDecimalUtils

```
public final class BigDecimalUtils
extends Object
```
Provides support for working with instances of java.math.BigDecimal.

Field Summary

Fields
Modifier and Type Field and Description

static BigDecimalUtils BIG_DECIMAL_UTILS
Singleton instance.

Fields
Modifier and Type	Field and Description
`static BigDecimalUtils`	`BIG_DECIMAL_UTILS` Singleton instance.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected BigDecimal`	`add(BigDecimal i1, BigDecimal i2)`
`ConstantNode`	`add(Node n1, Node n2)` Returns the result of adding the numeric values represented by the given `Node`s.
`ConstantNode`	`add(Node n1, Node n2, Assignments assignments)` Returns the result of adding the result of evaluating the given `Node`s with the given `Assignments`.
`ConstantNode`	`decrement(Node n)` Returns the result of subtracting one from the numeric value represented by the given node.
`protected BigDecimal`	`divide(BigDecimal i1, BigDecimal i2)`
`ConstantNode`	`divide(Node n1, Node n2, Assignments assignments)` Returns the result of dividing the result of evaluating the given `Node`s with the given `Assignments`.
`org.oakgp.function.math.Add`	`getAdd()` Returns an addition operator for the numeric type this instance is concerned with.
`org.oakgp.function.math.Divide`	`getDivide()` Returns a division operator for the numeric type this instance is concerned with.
`org.oakgp.function.math.Multiply`	`getMultiply()` Returns a multiplication operator for the numeric type this instance is concerned with.
`org.oakgp.function.math.ArithmeticExpressionSimplifier`	`getSimplifier()` Returns a `ArithmeticExpressionSimplifier` for the numeric type this instance is concerned with.
`org.oakgp.function.math.Subtract`	`getSubtract()` Returns a subtraction operator for the numeric type this instance is concerned with.
`Type`	`getType()` Returns the `Type` associated with the numeric values this instance is concerned with.
`ConstantNode`	`increment(Node n)` Returns the result of adding one to the numeric value represented by the given node.
`boolean`	`isAdd(Function f)` Returns `true` if the given `Function` is the same as returned from `getAdd()`.
`boolean`	`isAddOrSubtract(Function f)` Returns `true` if the given `Function` is the same as the values returned from `getAdd()` or `getSubtract()`.
`boolean`	`isArithmeticExpression(Node n)` Returns `true` if the given `Node` is a `FunctionNode` with the same `Function` as returned from `getAdd()`, `getSubtract()`, `getMultiply()` or `getDivide()`.
`boolean`	`isMultiply(Function f)` Returns `true` if the given `Function` is the same as returned from `getMultiply()`.
`boolean`	`isMultiply(FunctionNode n)` Returns `true` if the `Function` of the given `FunctionNode` is the same as returned from `getMultiply()`.
`boolean`	`isNegative(Node n)` Returns `true` if the numeric value represented by the given node is less than zero.
`boolean`	`isOne(Node n)` Returns true if the given `Node` is a `ConstantNode` with the value `1` of type `#T`.
`boolean`	`isSubtract(Function f)` Returns `true` if the given `Function` is the same as returned from `getSubtract()`.
`boolean`	`isSubtract(FunctionNode n)` Returns `true` if the `Function` of the given `FunctionNode` is the same as returned from `getSubtract()`.
`boolean`	`isSubtract(Node n)` Returns `true` if the given `Node` is a `FunctionNode` with the same `Function` as returned from `getSubtract()`.
`boolean`	`isZero(Node n)` Returns true if the given `Node` is a `ConstantNode` with the value `0` of type `#T`.
`protected BigDecimal`	`multiply(BigDecimal i1, BigDecimal i2)`
`ConstantNode`	`multiply(Node n1, Node n2)` Returns the result of multiplying the numeric values represented by the given `Node`s.
`ConstantNode`	`multiply(Node n1, Node n2, Assignments assignments)` Returns the result of multiplying the result of evaluating the given `Node`s with the given `Assignments`.
`FunctionNode`	`multiplyByTwo(Node arg)` Returns a new expression which multiplies the given `Node` by two.
`Node`	`negate(Node arg)` Returns the result of negating the numeric value represented by the given node.
`ConstantNode`	`negateConstant(Node n)` Returns the result of negating the numeric value represented by the given node.
`ConstantNode`	`one()` Returns a `ConstantNode` with the value `1` of type `#T`.
`protected BigDecimal`	`subtract(BigDecimal i1, BigDecimal i2)`
`ConstantNode`	`subtract(Node n1, Node n2)` Returns the result of subtracting the numeric values represented by the given `Node`s.
`ConstantNode`	`subtract(Node n1, Node n2, Assignments assignments)` Returns the result of subtracting the result of evaluating the given `Node`s with the given `Assignments`.
`ConstantNode`	`zero()` Returns a `ConstantNode` with the value `0` of type `#T`.

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

- Field Detail
  - BIG_DECIMAL_UTILS
```
public static final BigDecimalUtils BIG_DECIMAL_UTILS
```
    Singleton instance.
- Method Detail
  - add
```
protected BigDecimal add(BigDecimal i1,
                         BigDecimal i2)
```
  - subtract
```
protected BigDecimal subtract(BigDecimal i1,
                              BigDecimal i2)
```
  - multiply
```
protected BigDecimal multiply(BigDecimal i1,
                              BigDecimal i2)
```
  - divide
```
protected BigDecimal divide(BigDecimal i1,
                            BigDecimal i2)
```
  - getType
```
public final Type getType()
```
    Returns the Type associated with the numeric values this instance is concerned with.
  - getSimplifier
```
public final org.oakgp.function.math.ArithmeticExpressionSimplifier getSimplifier()
```
    Returns a ArithmeticExpressionSimplifier for the numeric type this instance is concerned with.
  - getAdd
```
public final org.oakgp.function.math.Add getAdd()
```
    Returns an addition operator for the numeric type this instance is concerned with.
  - getSubtract
```
public final org.oakgp.function.math.Subtract getSubtract()
```
    Returns a subtraction operator for the numeric type this instance is concerned with.
  - getMultiply
```
public final org.oakgp.function.math.Multiply getMultiply()
```
    Returns a multiplication operator for the numeric type this instance is concerned with.
  - getDivide
```
public final org.oakgp.function.math.Divide getDivide()
```
    Returns a division operator for the numeric type this instance is concerned with.
  - isZero
```
public final boolean isZero(Node n)
```
    Returns true if the given Node is a ConstantNode with the value 0 of type #T.
  - isOne
```
public final boolean isOne(Node n)
```
    Returns true if the given Node is a ConstantNode with the value 1 of type #T.
  - zero
```
public final ConstantNode zero()
```
    Returns a ConstantNode with the value 0 of type #T.
  - one
```
public final ConstantNode one()
```
    Returns a ConstantNode with the value 1 of type #T.
  - add
```
public final ConstantNode add(Node n1,
                              Node n2,
                              Assignments assignments)
```
    Returns the result of adding the result of evaluating the given Nodes with the given Assignments.
  - add
```
public final ConstantNode add(Node n1,
                              Node n2)
```
    Returns the result of adding the numeric values represented by the given Nodes.
    
    Parameters:
    
    n1 - a ConstantNode with a value of type #T
    
    n2 - a ConstantNode with a value of type #T
  - increment
```
public final ConstantNode increment(Node n)
```
    Returns the result of adding one to the numeric value represented by the given node.
    
    Parameters:
    
    n - a ConstantNode with a value of type #T
  - decrement
```
public final ConstantNode decrement(Node n)
```
    Returns the result of subtracting one from the numeric value represented by the given node.
    
    Parameters:
    
    n - a ConstantNode with a value of type #T
  - subtract
```
public final ConstantNode subtract(Node n1,
                                   Node n2,
                                   Assignments assignments)
```
    Returns the result of subtracting the result of evaluating the given Nodes with the given Assignments.
    
    Returns:
    
    n1 - n2
  - subtract
```
public final ConstantNode subtract(Node n1,
                                   Node n2)
```
    Returns the result of subtracting the numeric values represented by the given Nodes.
    
    Parameters:
    
    n1 - a ConstantNode with a value of type #T
    
    n2 - a ConstantNode with a value of type #T
    
    Returns:
    
    n1 - n2
  - negate
```
public final Node negate(Node arg)
```
    Returns the result of negating the numeric value represented by the given node.
    
    Parameters:
    
    n - the expression to negate (may be a ConstantNode, VariableNode or a FunctionNode)
  - negateConstant
```
public final ConstantNode negateConstant(Node n)
```
    Returns the result of negating the numeric value represented by the given node.
    
    Parameters:
    
    n - a ConstantNode with a value of type #T
  - multiply
```
public final ConstantNode multiply(Node n1,
                                   Node n2,
                                   Assignments assignments)
```
    Returns the result of multiplying the result of evaluating the given Nodes with the given Assignments.
  - multiply
```
public final ConstantNode multiply(Node n1,
                                   Node n2)
```
    Returns the result of multiplying the numeric values represented by the given Nodes.
    
    Parameters:
    
    n1 - a ConstantNode with a value of type #T
    
    n2 - a ConstantNode with a value of type #T
  - multiplyByTwo
```
public final FunctionNode multiplyByTwo(Node arg)
```
    Returns a new expression which multiplies the given Node by two.
  - divide
```
public final ConstantNode divide(Node n1,
                                 Node n2,
                                 Assignments assignments)
```
    Returns the result of dividing the result of evaluating the given Nodes with the given Assignments.
    
    Returns:
    
    n1 / n2
  - isNegative
```
public final boolean isNegative(Node n)
```
    Returns true if the numeric value represented by the given node is less than zero.
    
    Parameters:
    
    n - a ConstantNode with a value of type #T
  - isAddOrSubtract
```
public final boolean isAddOrSubtract(Function f)
```
    Returns true if the given Function is the same as the values returned from getAdd() or getSubtract().
  - isAdd
```
public final boolean isAdd(Function f)
```
    Returns true if the given Function is the same as returned from getAdd().
  - isSubtract
```
public final boolean isSubtract(Node n)
```
    Returns true if the given Node is a FunctionNode with the same Function as returned from getSubtract().
  - isSubtract
```
public final boolean isSubtract(FunctionNode n)
```
    Returns true if the Function of the given FunctionNode is the same as returned from getSubtract().
  - isSubtract
```
public final boolean isSubtract(Function f)
```
    Returns true if the given Function is the same as returned from getSubtract().
  - isMultiply
```
public final boolean isMultiply(FunctionNode n)
```
    Returns true if the Function of the given FunctionNode is the same as returned from getMultiply().
  - isMultiply
```
public final boolean isMultiply(Function f)
```
    Returns true if the given Function is the same as returned from getMultiply().
  - isArithmeticExpression
```
public final boolean isArithmeticExpression(Node n)
```
    Returns true if the given Node is a FunctionNode with the same Function as returned from getAdd(), getSubtract(), getMultiply() or getDivide().

Class BigDecimalUtils

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

BIG_DECIMAL_UTILS

Method Detail

add

subtract

multiply

divide

getType

getSimplifier

getAdd

getSubtract

getMultiply

getDivide

isZero

isOne

zero

one

add

add

increment

decrement

subtract

subtract

negate

negateConstant

multiply

multiply

multiplyByTwo

divide

isNegative

isAddOrSubtract

isAdd

isSubtract

isSubtract

isSubtract

isMultiply

isMultiply

isArithmeticExpression