@stdlib/math-base-special-tanh NPM

tanh

$NPM version$ $Build Status$ $Coverage Status$

Compute the hyperbolic tangent of a double-precision floating-point number.

Installation

npm install @stdlib/math-base-special-tanh

Usage

var tanh = require( '@stdlib/math-base-special-tanh' );

tanh( x )

Computes the hyperbolic tangent of double-precision floating-point number x.

var v = tanh( 0.0 );
// returns 0.0

v = tanh( -0.0 );
// returns -0.0

v = tanh( 2.0 );
// returns ~0.964

v = tanh( -2.0 );
// returns ~-0.964

v = tanh( NaN );
// returns NaN

Examples

var linspace = require( '@stdlib/array-base-linspace' );
var tanh = require( '@stdlib/math-base-special-tanh' );

var x = linspace( -4.0, 4.0, 100 );

var i;
for ( i = 0; i < x.length; i++ ) {
    console.log( tanh( x[ i ] ) );
}

C APIs

Usage

#include "stdlib/math/base/special/tanh.h"

stdlib_base_tanh( x )

Computes the hyperbolic tangent of double-precision floating-point number x.

double out = stdlib_base_tanh( 2.0 );
// returns ~0.964

out = stdlib_base_tanh( -2.0 );
// returns ~-0.964

The function accepts the following arguments:

x: [in] double input value.

double stdlib_base_tanh( const double x );

Examples

#include "stdlib/math/base/special/tanh.h"
#include <stdio.h>

int main( void ) {
    const double x[] = { -4.0, -3.11, -2.22, -1.33, -0.44, 0.44, 1.33, 2.22, 3.11, 4.0 };
    
    double v;
    int i;
    for ( i = 0; i < 10; i++ ) {
        v = stdlib_base_tanh( x[ i ] );
        printf( "tanh(%lf) = %lf\n", x[ i ], v );
    }
}

Notice

This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.