Package com.singularsys.jep.functions

Class LogBase2

java.lang.Object

com.singularsys.jep.functions.PostfixMathCommand

com.singularsys.jep.functions.UnaryFunction

com.singularsys.jep.functions.LogBase2

All Implemented Interfaces:

PostfixMathCommandI, RealUnaryFunction, Serializable

public class LogBase2
extends UnaryFunction
implements RealUnaryFunction

Log base 2. Other bases can be specified in constructor. Behaviour for negative real values are specified by the strict argument.

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
LogBase2()	Standard constructor, allows complex results for negative arguments
LogBase2(boolean strict)	Constructor with control for behaviour for complex results
LogBase2(double base, boolean strict)	Constructor for bases other than 2.

Method Summary

Modifier and Type	Method	Description
Object	eval(Object arg)	Evaluate the function
double	evaluate(double val)	Evaluate the function
Object	logbase2(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

LogBase2

public LogBase2()

Standard constructor, allows complex results for negative arguments

LogBase2

public LogBase2(boolean strict)

Constructor with control for behaviour for complex results

Parameters:

strict - if true negative real arguments return NaN, otherwise complex results are returned

LogBase2

public LogBase2(double base,
 boolean strict)

Constructor for bases other than 2.

Parameters:

base - base to use.

strict - if true negative real arguments return NaN, otherwise complex results are returned

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

logbase2

public Object logbase2(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