com.singularsys.jep.functions
Class ArcTanH

java.lang.Object
  extended by com.singularsys.jep.functions.PostfixMathCommand
      extended by com.singularsys.jep.functions.UnaryFunction
          extended by com.singularsys.jep.functions.ArcTanH
All Implemented Interfaces:
PostfixMathCommandI, RealUnaryFunction, java.io.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
Author:
Nathan Funk
See Also:
Serialized Form

Field Summary
 
Fields inherited from class com.singularsys.jep.functions.PostfixMathCommand
curNumberOfParameters, name, NaN, numberOfParameters
 
Constructor Summary
ArcTanH()
          Standard constructor.
ArcTanH(boolean strict)
          Controls the behaviour for out of range real arguments
 
Method Summary
 java.lang.Object atanh(java.lang.Object param)
           
 java.lang.Object eval(java.lang.Object arg)
           
 double evaluate(double val)
           
 
Methods inherited from class com.singularsys.jep.functions.UnaryFunction
run
 
Methods inherited from class com.singularsys.jep.functions.PostfixMathCommand
asArray, asBool, asDouble, asInt, asLong, asStrictInt, asString, checkNumberOfParameters, checkStack, getName, getNumberOfParameters, setCurNumberOfParameters, setName, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

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 Detail

eval

public java.lang.Object eval(java.lang.Object arg)
                      throws EvaluationException
Specified by:
eval in class UnaryFunction
Throws:
EvaluationException

atanh

public java.lang.Object atanh(java.lang.Object param)
                       throws EvaluationException
Throws:
EvaluationException

evaluate

public double evaluate(double val)
Specified by:
evaluate in interface RealUnaryFunction


Copyright © 2010 Singular Systems http://www.singularsys.com/jep