net.sourceforge.jeval.function.math
Class Pow

java.lang.Object
  extended by net.sourceforge.jeval.function.math.Pow
All Implemented Interfaces:
Function

public class Pow
extends java.lang.Object
implements Function

This class is a function that executes within Evaluator. The function returns the value of the first argument raised to the second power of the second argument. See the Math.pow(double, double) method in the JDK for a complete description of how this function works.


Constructor Summary
Pow()
           
 
Method Summary
 java.lang.String execute(Evaluator evaluator, java.lang.String arguments)
          Executes the function for the specified argument.
 java.lang.String getName()
          Returns the name of the function - "pow".
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Pow

public Pow()
Method Detail

getName

public java.lang.String getName()
Returns the name of the function - "pow".

Specified by:
getName in interface Function
Returns:
The name of this function class.

execute

public java.lang.String execute(Evaluator evaluator,
                                java.lang.String arguments)
                         throws FunctionException
Executes the function for the specified argument. This method is called internally by Evaluator.

Specified by:
execute in interface Function
Parameters:
evaluator - An instance of Evaluator.
arguments - A string argument that will be converted into two double values and evaluated.
Returns:
The value of the first argument raised to the second power of the second argument.
Throws:
FunctionException - Thrown if the argument(s) are not valid for this function.


Copyright (C) 2002-2007 Robert Breidecker.