com.singularsys.jep.functions
Class Average

java.lang.Object
  extended by com.singularsys.jep.functions.PostfixMathCommand
      extended by com.singularsys.jep.functions.Average
All Implemented Interfaces:
PostfixMathCommandI, RealUnaryFunction, java.io.Serializable

public class Average
extends PostfixMathCommand
implements RealUnaryFunction

Average function class.

This class is very similar to MinMax, so when making changes, also consider changing MinMax.

Since:
3.1.0
See Also:
Serialized Form

Field Summary
 
Fields inherited from class com.singularsys.jep.functions.PostfixMathCommand
curNumberOfParameters, numberOfParameters
 
Constructor Summary
Average()
           
 
Method Summary
 java.lang.Object average(java.lang.Object param)
           
 java.lang.Object average(java.util.Vector vals)
          Returns the average of a set of values.
 double evaluate(double val)
           
 void run(java.util.Stack<java.lang.Object> stack)
          Run the function on the stack.
 
Methods inherited from class com.singularsys.jep.functions.PostfixMathCommand
checkNumberOfParameters, checkStack, getNumberOfParameters, setCurNumberOfParameters
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Average

public Average()
Method Detail

run

public void run(java.util.Stack<java.lang.Object> stack)
         throws EvaluationException
Description copied from interface: PostfixMathCommandI
Run the function on the stack. Pops the arguments from the stack, and pushes the result on the top of the stack.

Specified by:
run in interface PostfixMathCommandI
Throws:
EvaluationException

average

public java.lang.Object average(java.lang.Object param)
                         throws EvaluationException
Throws:
EvaluationException

average

public java.lang.Object average(java.util.Vector vals)
                         throws EvaluationException
Returns the average of a set of values. Depends on the Add and Divide classes to perform the calculation.

Parameters:
vals - Values to be averaged
Returns:
the average of vals
Throws:
EvaluationException

evaluate

public double evaluate(double val)
Specified by:
evaluate in interface RealUnaryFunction


Copyright © 2008 Singular Systems http://www.singularsys.com/jep