MVT API

math.functions
Class Subtract

java.lang.Object
  |
  +--math.objects.Expression
        |
        +--math.objects.BinaryExpression
              |
              +--math.functions.Subtract

public class Subtract
extends BinaryExpression

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.

Since:
JDK1.1
Author:
Peter Staab
, Pete Fox , both for the Mathematical Visualization Project for the Department of Applied Mathematics, University of Colorado at Boulder

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

Subtract

public Subtract(Expression left,
                Expression right)
Method Detail

toString

public java.lang.String toString()
Overrides the toString() method of the Object class. This gives a string represenation of the Symbolic Object.

Overrides:
toString in class java.lang.Object
Returns:
a string representation of the Add Object

evaluate

public double evaluate(VariableSet vars,
                       double[] values)
                throws java.lang.ArithmeticException,
                       IllegalEvaluationException,
                       VariableUndefinedException
A method used to evaluate a Subtract object given an ordered variable vector and a corresponding array of constant double values

Specified by:
evaluate in class Expression
Parameters:
vars - the name of the VariableVector of Variables associated with the function.
Returns:
a double representing the value of the Expression for the entered value.
Throws:
java.lang.ArithmeticException - for NaN and Divide by Zero
IllegalEvaluationException - if an error occurs
VariableUndefinedException - for Variables not defined
Since:
JDK1.1

evaluateVariables

public Expression evaluateVariables(VariableSet variables,
                                    double[] values)
                             throws java.lang.ArithmeticException,
                                    IllegalEvaluationException
An method used to evaluate a Subtract object containing multiple variables given only one variable name and one value

Specified by:
evaluateVariables in class Expression
Parameters:
variables - a VariableSet value
values - a double[] value
Returns:
a Expression object representing the given Expression with one of it's variables evaluated for the given value.
Throws:
IllegalEvaluationException - if the number of variables do not equal the number of values.
java.lang.ArithmeticException - for NaN and Divide by Zero
Since:
JDK1.1

differentiate

public Expression differentiate(Variable var)
A method that returns the derivative of the Subtract object using the chain rule of differentiation

Specified by:
differentiate in class Expression
Parameters:
var - the variable of differentiation
Returns:
an Expression object representing the derivative of the Subtract object

simplify

public 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.

Overrides:
simplify in class BinaryExpression
Returns:
an Expression object in a simplified form

MVT API

mvt.icons