hirondelle.formula.function.builtin
Class HyperbolicTangent

Object
  hirondelle.formula.function.builtin.HyperbolicTangent

All Implemented Interfaces:

Function

public final class HyperbolicTangent
extends Object
implements Function

tanh(x): the hyperbolic tangent of a number.

Constructor Summary

HyperbolicTangent()

Method Summary

Decimal

calculate(Decimal... aArgs) Calculate the value of a function.

Methods inherited from class Object

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

Constructor Detail

HyperbolicTangent

public HyperbolicTangent()

Method Detail

calculate

public Decimal calculate(Decimal... aArgs)

Description copied from interface: Function

Calculate the value of a function.

It's highly recommended that the implementation validate the number of arguments passed to the function. The Check class can be used for doing the most common argument validations.

Specified by:

calculate in interface Function

Parameters:

aArgs - 0 or more arguments to the function.