Table of Contents

Search

  1. Preface
  2. The Transformation Language
  3. Constants
  4. Operators
  5. Variables
  6. Dates
  7. Functions
  8. Creating Custom Functions
  9. Custom Function API Reference

Transformation Language Reference

Transformation Language Reference

TANH

TANH

Returns the hyperbolic tangent of the numeric value passed to this function.

Syntax

TANH(
numeric_value
)
The following table describes the argument for this command:
Argument
Required/
Optional
Description
numeric_value
Required
Numeric datatype. Numeric data expressed in radians (degrees multiplied by pi divided by 180). Passes the numeric values for which you want to calculate the hyperbolic tangent. You can enter any valid transformation expression.

Return Value

Double value.
NULL if a value passed to the function is NULL.

Example

The following expression returns the hyperbolic tangent for the values in the Angles port:
TANH( ANGLES )
ANGLES  
RETURN VALUE
1.0
0.761594155955765
2.897
0.993926947790665
3.66
0.998676551914886
5.45
0.999963084213409
0
0.0
0.345
0.331933853503641
NULL
NULL

Tip

You can perform arithmetic on the values passed to TANH before the function calculates the hyperbolic tangent. For example:
TANH( ARCS / 360 )