README.md (1591B)
1 <!-- 2 3 @license Apache-2.0 4 5 Copyright (c) 2018 The Stdlib Authors. 6 7 Licensed under the Apache License, Version 2.0 (the "License"); 8 you may not use this file except in compliance with the License. 9 You may obtain a copy of the License at 10 11 http://www.apache.org/licenses/LICENSE-2.0 12 13 Unless required by applicable law or agreed to in writing, software 14 distributed under the License is distributed on an "AS IS" BASIS, 15 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 16 See the License for the specific language governing permissions and 17 limitations under the License. 18 19 --> 20 21 # tanh 22 23 > Compute the [hyperbolic tangent][hyperbolic-tangent] of a number. 24 25 <section class="usage"> 26 27 ## Usage 28 29 ```javascript 30 var tanh = require( '@stdlib/math/base/special/tanh' ); 31 ``` 32 33 #### tanh( x ) 34 35 Computes the [hyperbolic tangent][hyperbolic-tangent] of a `number` (in radians). 36 37 ```javascript 38 var v = tanh( 0.0 ); 39 // returns 0.0 40 41 v = tanh( -0.0 ); 42 // returns -0.0 43 44 v = tanh( 2.0 ); 45 // returns ~0.964 46 47 v = tanh( -2.0 ); 48 // returns ~-0.964 49 50 v = tanh( NaN ); 51 // returns NaN 52 ``` 53 54 </section> 55 56 <!-- /.usage --> 57 58 <section class="examples"> 59 60 ## Examples 61 62 <!-- eslint no-undef: "error" --> 63 64 ```javascript 65 var linspace = require( '@stdlib/array/linspace' ); 66 var tanh = require( '@stdlib/math/base/special/tanh' ); 67 68 var x = linspace( -4.0, 4.0, 100 ); 69 var i; 70 71 for ( i = 0; i < x.length; i++ ) { 72 console.log( tanh( x[ i ] ) ); 73 } 74 ``` 75 76 </section> 77 78 <!-- /.examples --> 79 80 <section class="links"> 81 82 [hyperbolic-tangent]: http://mathworld.wolfram.com/HyperbolicTangent.html 83 84 </section> 85 86 <!-- /.links -->