Vector Hyperbolic Tangent

Technical Analysis Indicator: tanh

Fork me on GitHub

Function Prototype

/* Vector Hyperbolic Tangent */
/* Type: simple */
/* Input arrays: 1    Options: 0    Output arrays: 1 */
/* Inputs: real */
/* Options: none */
/* Outputs: tanh */
int ti_tanh_start(TI_REAL const *options);
int ti_tanh(int size,
      TI_REAL const *const *inputs,
      TI_REAL const *options,
      TI_REAL *const *outputs);

Description

This documentation is still a work in progress. It has omissions, and it probably has errors too. If you see any issues, or have any general feedback, please get in touch.

Vector Hyperbolic Tangent calculates the Trigonometric hyperbolic tanine of each element in the input array.

$$tanh_{t} = \tanh{input_{t}}$$

This is sometimes useful as a building block to more complex functions.

See Also

References

Example Usage

Calling From C

/* Example usage of Vector Hyperbolic Tangent */
/* Assuming that 'input' is a pre-loaded array of size 'in_size'. */
TI_REAL *inputs[] = {input};
TI_REAL options[] = {}; /* No options */
TI_REAL *outputs[1]; /* tanh */

/* Determine how large the output size is for our options. */
const int out_size = in_size - ti_tanh_start(options);

/* Allocate memory for output. */
outputs[0] = malloc(sizeof(TI_REAL) * out_size); assert(outputs[0] != 0); /* tanh */

/* Run the actual calculation. */
const int ret = ti_tanh(in_size, inputs, options, outputs);
assert(ret == TI_OKAY);

Calling From Lua (with Tulip Chart bindings)

-- Example usage of Vector Hyperbolic Tangent
tanh = ti.tanh(input)

Example Calculation

dateinputtanh
2005-11-010.200.20
2005-11-020.300.29
2005-11-030.400.38
2005-11-040.300.29
2005-11-070.500.46
2005-11-080.700.60
2005-11-090.750.64
2005-11-100.900.72
2005-11-110.900.72
2005-11-141.000.76
2005-11-151.000.76
2005-11-160.200.20
2005-11-170.100.10
2005-11-18-0.10-0.10
2005-11-21-0.50-0.46

Chart

 

Other Indicators

Previous indicator: Vector Tangent

Next indicator: Triple Exponential Moving Average

Random indicator: Vector Truncate