Package com.singularsys.jep.functions

Class ArcTanH

java.lang.Object

com.singularsys.jep.functions.PostfixMathCommand

com.singularsys.jep.functions.UnaryFunction

com.singularsys.jep.functions.ArcTanH

All Implemented Interfaces:

PostfixMathCommandI, RealUnaryFunction, Serializable

public class ArcTanH
extends UnaryFunction
implements RealUnaryFunction

Implements the arcTanH function.

Since:

2.3.0 beta 2 - Now returns Double result rather than Complex for -1<x<1

Author:

Nathan Funk

See Also:

• Serialized Form

Field Summary

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

curNumberOfParameters, name, NaN, numberOfParameters

Constructor Summary

Constructors

Constructor	Description
ArcTanH()	Standard constructor.
ArcTanH(boolean strict)	Controls the behaviour for out of range real arguments

Method Summary

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

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

instanceOf, instanceOf, run

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

asArray, asBool, asDouble, asInt, asLong, asStrictInt, asString, checkNumberOfParameters, getName, getNumberOfParameters, setCurNumberOfParameters, setName, toString, toString

Methods inherited from class java.lang.Object

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

Constructor Details

ArcTanH

public ArcTanH()

Standard constructor. For real x with |x|>1 return NaN.

ArcTanH

public ArcTanH(boolean strict)

Controls the behaviour for out of range real arguments

Parameters:

strict - if false returns corresponding complex result if true return NaN

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

atanh

public Object atanh(Object param)
             throws EvaluationException

Throws:

EvaluationException

evaluate

public double evaluate(double val)

Specified by:

evaluate in interface RealUnaryFunction