TANH macro

The TANH macro is available only in Unica Campaign.

Syntax

TANH(data [, units_keyword])

Parameters

data

The numerical values to compute the hyperbolic tangent of. This can be a constant value, a column, a cell range, or an expression evaluating to any of the above. For the format definition of data, see the "Macro Function Parameters" section in the chapter in this guide for your product.

units_keyword

This optional keyword determines whether the input values and results are interpreted as degrees or radians. Select one of the following:

RADIAN - Performs the calculations in radians (default)

DEGREE - Performs the calculations in degrees

If this parameter is not specified, the default is radians. (To convert from radians to degrees, divide by PI and multiply by 180.)

For more details on using keywords in Unica Campaign, see Format Specifications.

Description

TANH calculates the hyperbolic tangent of the values in the specified data range. It returns one new column for each input column, each containing the hyperbolic tangent of numbers in the corresponding input column. The hyperbolic tangent of a number is calculated as follows:

Note: If the value x is too large, an overflow error is returned. This occurs if tanh (x) exceeds the maximum 32-bit floating-point value. If cosh (x) is zero, TANH returns the maximum 32-bit floating point value.

Examples


`TEMP = TANH(PI)` or `TEMP = TANH(PI, 0)` or `TEMP = TANH(PI, RADIAN)` Creates a new column named `TEMP` containing the value one.
`TEMP = TANH(V1)` Creates a new column named `TEMP`, where each value is the hyperbolic tangent (in radians) of the contents of column `V1`.
`TEMP = TANH(V1:V3, 1)` or `TEMP = TANH(V1:V3, DEGREE)` Creates three new columns named `TEMP`, `VX`, and `VY`. The values in the `TEMP` column are the hyperbolic tangents of the contents of column `V1`, the values of the `VX` column are the hyperbolic tangents of the contents of column `V2`, and the values of the `VY` column are the hyperbolic tangents of the contents of column `V3`. All values are in degrees.
`TEMP = TANH(V1[1:5]:V2)` Creates two new columns named `TEMP` and `VX`, each with values in rows 1-5 (the other cells are empty). The values in column `TEMP` are the hyperbolic tangents of the corresponding rows of column `V1`, and the values in column `VX` are the hyperbolic tangents of the corresponding rows of column `V2`. All values are in radians.

Related functions


Function	Description
`ATAN`	Computes the arctangent of the contents of the specified data range
`COSH`	Computes the hyperbolic cosine of the contents of the specified data range
`COT`	Computes the cotangent of the contents of the specified data range
`SINH`	Computes the hyperbolic sine of the contents of the specified data range
`TAN`	Computes the tangent of the contents of the specified data range