|
MVT API | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--math.objects.Expression | +--math.objects.BinaryExpression | +--math.functions.Subtract
The class Subtract is used to create mathematical Subtract objects. It extends the BinaryExpressionclass. The current version of this is generated automatically. See the README file in the current directory.
Field Summary |
Fields inherited from class math.objects.BinaryExpression |
leftChild, rightChild |
Constructor Summary | |
Subtract(Expression left,
Expression right)
|
Method Summary | |
Expression |
differentiate(Variable var)
A method that returns the derivative of the Subtract object using the chain rule of differentiation |
double |
evaluate(VariableSet vars,
double[] values)
A method used to evaluate a Subtract object given an ordered variable vector and a corresponding array of constant double values |
Expression |
evaluateVariables(VariableSet variables,
double[] values)
An method used to evaluate a Subtract object containing multiple variables given only one variable name and one value |
Expression |
simplify()
A method that returns a Expression representation of the Subtract object's Children in a simplified form with redundant terms combined and terms multiplied by zero eliminated. |
java.lang.String |
toString()
Overrides the toString() method of the Object class. |
Methods inherited from class math.objects.BinaryExpression |
getLeftChild, getRightChild, setLeftChild, setRightChild |
Methods inherited from class math.objects.Expression |
evaluate, evaluate, evaluate, evaluate, evaluate |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
public Subtract(Expression left, Expression right)
Method Detail |
public java.lang.String toString()
toString
in class java.lang.Object
public double evaluate(VariableSet vars, double[] values) throws java.lang.ArithmeticException, IllegalEvaluationException, VariableUndefinedException
evaluate
in class Expression
vars
- the name of the VariableVector of Variables
associated with the function.
java.lang.ArithmeticException
- for NaN and Divide by Zero
IllegalEvaluationException
- if an error occurs
VariableUndefinedException
- for Variables not definedpublic Expression evaluateVariables(VariableSet variables, double[] values) throws java.lang.ArithmeticException, IllegalEvaluationException
evaluateVariables
in class Expression
variables
- a VariableSet
valuevalues
- a double[]
value
IllegalEvaluationException
- if the number of variables
do not equal the number of values.
java.lang.ArithmeticException
- for NaN and Divide by Zeropublic Expression differentiate(Variable var)
differentiate
in class Expression
var
- the variable of differentiation
public Expression simplify()
simplify
in class BinaryExpression
|
MVT API | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |