fr.expression4j.core.predefine
Class SqrtFunction

java.lang.Object
  fr.expression4j.core.predefine.AbstractFunction
      fr.expression4j.core.predefine.SqrtFunction

All Implemented Interfaces:

Expression

public class SqrtFunction
extends AbstractFunction

Constructor Summary

SqrtFunction()

Method Summary

MathematicalElement	evaluate(OperatorManager operatorManager, Parameters parameters) Evaluate the value of the expression.
MathematicalElement	evaluate(Parameters parameters) Evaluate the value of the expression with the default operator manager.
Catalog	getCatalog() return the catalog of the expression.
java.lang.String	getName() Get the name of the function.
java.util.List	getParameters() Get the parameter list associated to the function.

Methods inherited from class fr.expression4j.core.predefine.AbstractFunction

getExpressionModel, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SqrtFunction

public SqrtFunction()

Method Detail

getCatalog

public Catalog getCatalog()

Description copied from interface: Expression

return the catalog of the expression.

Returns:

catalog of current expression, null if no catalog is needed of define.

evaluate

public MathematicalElement evaluate(OperatorManager operatorManager,
                                    Parameters parameters)
                             throws EvalException

Description copied from interface: Expression

Evaluate the value of the expression.

Parameters:

operatorManager - operator manager to use to evaluate expression.

parameters - parameters values for evaluating expression.

Returns:

value of the evaluated expression as a double.

Throws:

EvalException - when error occurd (parameter not found ...)

getParameters

public java.util.List getParameters()

Description copied from interface: Expression

Get the parameter list associated to the function. If function is f(x,y,z), parameter list is an ordered list of String with "x", "y" and "z".

Returns:

parameter list associated to the expression.

getName

public java.lang.String getName()

Description copied from interface: Expression

Get the name of the function. If function is f(x,y,z), name if "f".

Returns:

name of the function.

evaluate

public MathematicalElement evaluate(Parameters parameters)
                             throws EvalException

Description copied from interface: Expression

Evaluate the value of the expression with the default operator manager.

Parameters:

parameters - parameters values for evaluating expression.

Returns:

value of the evaluated expression as a double.

Throws:

EvalException - when error occurd (parameter not found ...)