Package com.singularsys.jep.functions

Class StrictNaturalLogarithm

java.lang.Object

com.singularsys.jep.functions.PostfixMathCommand

com.singularsys.jep.functions.UnaryFunction

com.singularsys.jep.functions.StrictNaturalLogarithm

All Implemented Interfaces:

PostfixMathCommandI, RealUnaryFunction, Serializable

public class StrictNaturalLogarithm
extends UnaryFunction
implements RealUnaryFunction

A strict version of Natural logarithm. For negative Double arguments his class will return Double.NaN. The standard NaturalLogarithm class will convert treat the argument and compute the complex logarithm.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.singularsys.jep.functions.UnaryFunction

UnaryFunction.FunctionWithException<T>

Field Summary

Fields inherited from class com.singularsys.jep.functions.PostfixMathCommand

curNumberOfParameters, description, name, NaN, numberOfParameters

Constructor Summary

Constructors

Constructor	Description
StrictNaturalLogarithm()	Standard base-e logarithm.
StrictNaturalLogarithm(double base)	Logarithm to any other base.

Method Summary

Modifier and Type	Method	Description
Object	eval(Object arg)	Evaluate the function
double	evaluate(double val)	Evaluate the function
Object	ln(Object param)

Methods inherited from class com.singularsys.jep.functions.UnaryFunction

instanceOf, instanceOf, instanceOf, instanceOf, run

Methods inherited from class com.singularsys.jep.functions.PostfixMathCommand

asArray, asBool, asDouble, asInt, asLong, asStrictInt, asString, asType, checkNumberOfParameters, getDescription, getDescription, getDescriptionWithType, getName, getNumberOfParameters, setCurNumberOfParameters, setDescription, setName, toString, toString

Methods inherited from class java.lang.Object

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

Constructor Details

StrictNaturalLogarithm

public StrictNaturalLogarithm(double base)

Logarithm to any other base. new StrictNaturalLogarithm(10) for base 10, new StrictNaturalLogarithm(2) for base 2.

Parameters:

base - base to use

StrictNaturalLogarithm

public StrictNaturalLogarithm()

Standard base-e logarithm.

Method Details

eval

public Object eval(Object arg)
            throws EvaluationException

Description copied from class: UnaryFunction

Evaluate the function

Specified by:

eval in class UnaryFunction

Parameters:

arg - the single argument passed in

Returns:

the result of the function

Throws:

EvaluationException - on error

ln

public Object ln(Object param)
          throws EvaluationException

Throws:

EvaluationException

evaluate

public double evaluate(double val)

Description copied from interface: RealUnaryFunction

Evaluate the function

Specified by:

evaluate in interface RealUnaryFunction

Parameters:

val - the argument

Returns:

the result of applying the function to the argument