Difference between revisions of "SHIP:Sail:atanh"

From Serious Documentation
Jump to: navigation, search
(Created page with "__NOTOC__ {{SailFuncTableStart|}}<onlyinclude> |{{SailFunc|asinh}}||{{DataType|Float}}||style="text-align:center;"|v5.1.0||Returns the arc hyperbolic sin of the given value{{v...")
 
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
 
{{SailFuncTableStart|}}<onlyinclude>
 
{{SailFuncTableStart|}}<onlyinclude>
|{{SailFunc|asinh}}||{{DataType|Float}}||style="text-align:center;"|v5.1.0||Returns the arc hyperbolic sin of the given value{{v5}}</onlyinclude>
+
|{{SailFunc|atanh}}||{{DataType|Float}}||style="text-align:center;"|v5.1.0||Returns the arc hyperbolic tan of the given value{{v5}}</onlyinclude>
 
|}
 
|}
 
== See Also: ==
 
== See Also: ==
Line 18: Line 18:
 
! scope="col" style="text-align:left" | Description
 
! scope="col" style="text-align:left" | Description
 
|-
 
|-
|value||{{DataType|Float}}||the value to take the arc hyperbolic tan of
+
|value||{{DataType|Float}}||the value to take the arc hyperbolic tan of, in the range -1 < value < 1.
 
|-
 
|-
 
! scope="col" style="text-align:left" | Return
 
! scope="col" style="text-align:left" | Return

Revision as of 16:35, 3 October 2016

Function Returns Introduced Description
atanh Float v5.1.0 Returns the arc hyperbolic tan of the given valueBadge SHIPv5.gif

See Also:

Prototype

Float atanh(Float value);

Parameters/Return Value

Parameter Data Type Description
value Float the value to take the arc hyperbolic tan of, in the range -1 < value < 1.
Return Float atanh(value)

Detailed Description

The atanh() function returns the arc hyperbolic tan of the supplied value</code>

Examples

Example Result Notes
atanh(-1); inf...
atanh(-0.5); -0.549306...
atanh(0.707) 0.881160...