Namespaces
Variants
Views
Actions

Difference between revisions of "cpp/numeric/math/asinh"

From cppreference.com
< cpp‎ | numeric‎ | math
m (Text replace - "Integral arg" to "IntegralType arg")
m (., http -> https)
 
(5 intermediate revisions by 4 users not shown)
Line 1: Line 1:
−
{{cpp/title|asinh}}
+
{{cpp/title|asinh|asinhf|asinhl}}
 
{{cpp/numeric/math/navbar}}
 
{{cpp/numeric/math/navbar}}
−
{{dcl begin}}
+
{{cpp/numeric/math/declarations
−
{{dcl header | cmath}}
+
|family=asinh
−
{{dcl | since=c++11 | num=1 |
+
|param1=num
−
float      asinh( float arg );
+
|constexpr_since=26
 +
|desc=Computes the inverse hyperbolic sine of {{c|num}}.
 
}}
 
}}
−
{{dcl | since=c++11 | num=2 |
 
−
double      asinh( double arg );
 
−
}}
 
−
{{dcl | since=c++11 | num=3 |
 
−
long double asinh( long double arg );
 
−
}}
 
−
{{dcl | since=c++11 | num=4 |
 
−
double      asinh( IntegralType arg );
 
−
}}
 
−
{{dcl end}}
 
−
 
−
Computes the inverse hyperbolic sine of {{tt|arg}}.
 
−
@4@ A set of overloads or a function template accepting an argument of any [[cpp/types/is_integral|integral type]]. Equivalent to 2) (the argument is cast to {{c|double}}).
 
  
 
===Parameters===
 
===Parameters===
 
{{par begin}}
 
{{par begin}}
−
{{par | arg | value of a floating-point or [[cpp/types/is_integral|Integral type]]}}
+
{{par|num|floating-point or integer value}}
 
{{par end}}
 
{{par end}}
  
 
===Return value===
 
===Return value===
−
If no errors occur, the inverse hyperbolic sine of {{tt|arg}} ({{math|sinh{{su|p=-1}}(arg)}}, or {{math|arsinh(arg)}}), is returned.
+
If no errors occur, the inverse hyperbolic sine of {{c|num}} ({{math|sinh{{su|p=-1}}(num)}}, or {{math|arsinh(num)}}), is returned.
  
 
If a range error occurs due to underflow, the correct result (after rounding) is returned.
 
If a range error occurs due to underflow, the correct result (after rounding) is returned.
  
 
===Error handling===
 
===Error handling===
−
Errors are reported as specified in [[cpp/numeric/math/math_errhandling|math_errhandling]]
+
Errors are reported as specified in {{lc|math_errhandling}}.
  
 
If the implementation supports IEEE floating-point arithmetic (IEC 60559),
 
If the implementation supports IEEE floating-point arithmetic (IEC 60559),
−
* if the argument is ±0 or ±∞, it is returned unmodified
+
* if the argument is ±0 or ±∞, it is returned unmodified.
−
* if the argument is NaN, NaN is returned
+
* if the argument is NaN, NaN is returned.
  
 
===Notes===
 
===Notes===
 
Although the C standard (to which C++ refers for this function) names this function "arc hyperbolic sine", the inverse functions of the hyperbolic functions are the area functions. Their argument is the area of a hyperbolic sector, not an arc. The correct name is "inverse hyperbolic sine" (used by POSIX) or "area hyperbolic sine".
 
Although the C standard (to which C++ refers for this function) names this function "arc hyperbolic sine", the inverse functions of the hyperbolic functions are the area functions. Their argument is the area of a hyperbolic sector, not an arc. The correct name is "inverse hyperbolic sine" (used by POSIX) or "area hyperbolic sine".
 +
 +
{{cpp/numeric/math/additional integer overload note|asinh}}
  
 
===Examples===
 
===Examples===
 
{{example
 
{{example
 
|code=
 
|code=
−
#include <iostream>
 
 
#include <cmath>
 
#include <cmath>
 +
#include <iostream>
  
 
int main()
 
int main()
Line 50: Line 40:
 
     std::cout << "asinh(1) = " << std::asinh(1) << '\n'
 
     std::cout << "asinh(1) = " << std::asinh(1) << '\n'
 
               << "asinh(-1) = " << std::asinh(-1) << '\n';
 
               << "asinh(-1) = " << std::asinh(-1) << '\n';
 +
   
 
     // special values
 
     // special values
 
     std::cout << "asinh(+0) = " << std::asinh(+0.0) << '\n'
 
     std::cout << "asinh(+0) = " << std::asinh(+0.0) << '\n'
Line 63: Line 54:
 
===See also===
 
===See also===
 
{{dsc begin}}
 
{{dsc begin}}
−
{{dsc inc | cpp/numeric/math/dsc acosh}}
+
{{dsc inc|cpp/numeric/math/dsc acosh}}
−
{{dsc inc | cpp/numeric/math/dsc atanh}}
+
{{dsc inc|cpp/numeric/math/dsc atanh}}
−
{{dsc inc | cpp/numeric/math/dsc sinh}}
+
{{dsc inc|cpp/numeric/math/dsc sinh}}
−
{{dsc inc | cpp/numeric/complex/dsc asinh}}
+
{{dsc inc|cpp/numeric/complex/dsc asinh}}
−
{{dsc see c | c/numeric/math/asinh}}
+
{{dsc see c|c/numeric/math/asinh}}
 
{{dsc end}}
 
{{dsc end}}
  
 
===External links===
 
===External links===
−
[http://mathworld.wolfram.com/InverseHyperbolicSine.html Weisstein, Eric W. "Inverse Hyperbolic Sine."] From MathWorld--A Wolfram Web Resource.
+
{{eli|[https://mathworld.wolfram.com/InverseHyperbolicSine.html Weisstein, Eric W. "Inverse Hyperbolic Sine."] From MathWorld &mdash; A Wolfram Web Resource.}}
  
−
[[de:cpp/numeric/math/asinh]]
+
{{langlinks|de|es|fr|it|ja|pt|ru|zh}}
−
[[es:cpp/numeric/math/asinh]]
+
−
[[fr:cpp/numeric/math/asinh]]
+
−
[[it:cpp/numeric/math/asinh]]
+
−
[[ja:cpp/numeric/math/asinh]]
+
−
[[pt:cpp/numeric/math/asinh]]
+
−
[[ru:cpp/numeric/math/asinh]]
+
−
[[zh:cpp/numeric/math/asinh]]
+

Latest revision as of 08:00, 14 September 2023

 
C++
 
Numerics library
Common mathematical functions
Mathematical special functions (C++17)
Mathematical constants (C++20)
Basic linear algebra algorithms (C++26)
Floating-point environment (C++11)
Complex numbers
Numeric array (valarray)
Pseudo-random number generation
Factor operations
(C++17)
(C++17)
Interpolations
(C++20)
(C++20)
Saturation arithmetic
(C++26)
(C++26)
(C++26)
(C++26)
(C++26)

Generic numeric operations
Bit operations
(C++20)    
(C++20)
(C++20)
(C++20)
(C++20)
(C++20)
(C++20)
(C++20)
(C++20)
(C++20)
(C++20)
(C++20)
(C++23)
(C++20)
 
Common mathematical functions
Functions
Basic operations
(C++11)  
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)(C++11)(C++11)
Exponential functions
(C++11)
(C++11)

(C++11)
(C++11)
Power functions
(C++11)
(C++11)
Trigonometric and
hyperbolic functions
asinh
(C++11)
(C++11)
(C++11)

Error and gamma functions
(C++11)
(C++11)
(C++11)
(C++11)
Nearest integer floating point operations
(C++11)(C++11)(C++11)
(C++11)
(C++11)
(C++11)(C++11)(C++11)
Floating point manipulation functions
(C++11)(C++11)
(C++11)
(C++11)
(C++11)(C++11)
(C++11)
Classification and comparison
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
Types
(C++11)
(C++11)
(C++11)
Macro constants
 
Defined in header <cmath>
(1)
float       asinh ( float num );

double      asinh ( double num );

long double asinh ( long double num );
 (until C++23)
/* floating-point-type */
            asinh ( /* floating-point-type */ num );
 (since C++23)
(constexpr since C++26)
float       asinhf( float num );
 (2) (since C++11)
(constexpr since C++26)
long double asinhl( long double num );
 (3) (since C++11)
(constexpr since C++26)
Additional overloads (since C++11)
Defined in header <cmath>
template< class Integer >
double      asinh ( Integer num );
 (A) (constexpr since C++26)
1-3) Computes the inverse hyperbolic sine of num. The library provides overloads of std::asinh for all cv-unqualified floating-point types as the type of the parameter.(since C++23)
A) Additional overloads are provided for all integer types, which are treated as double.
 (since C++11)

Contents

[edit] Parameters

num - floating-point or integer value

[edit] Return value

If no errors occur, the inverse hyperbolic sine of num (sinh-1(num), or arsinh(num)), is returned.

If a range error occurs due to underflow, the correct result (after rounding) is returned.

[edit] Error handling

Errors are reported as specified in math_errhandling.

If the implementation supports IEEE floating-point arithmetic (IEC 60559),

  • if the argument is ±0 or ±∞, it is returned unmodified.
  • if the argument is NaN, NaN is returned.

[edit] Notes

Although the C standard (to which C++ refers for this function) names this function "arc hyperbolic sine", the inverse functions of the hyperbolic functions are the area functions. Their argument is the area of a hyperbolic sector, not an arc. The correct name is "inverse hyperbolic sine" (used by POSIX) or "area hyperbolic sine".

The additional overloads are not required to be provided exactly as (A). They only need to be sufficient to ensure that for their argument num of integer type, std::asinh(num) has the same effect as std::asinh(static_cast<double>(num)).

[edit] Examples

Run this code
#include <cmath>
#include <iostream>
 
int main()
{
    std::cout << "asinh(1) = " << std::asinh(1) << '\n'
              << "asinh(-1) = " << std::asinh(-1) << '\n';
 
    // special values
    std::cout << "asinh(+0) = " << std::asinh(+0.0) << '\n'
              << "asinh(-0) = " <<  std::asinh(-0.0) << '\n';
}

Output: 

asinh(1) = 0.881374
asinh(-1) = -0.881374
asinh(+0) = 0
asinh(-0) = -0

[edit] See also

(C++11)(C++11)(C++11)
 computes the inverse hyperbolic cosine (arcosh(x))
(function) [edit]
(C++11)(C++11)(C++11)
 computes the inverse hyperbolic tangent (artanh(x))
(function) [edit]
(C++11)(C++11)
 computes hyperbolic sine (sinh(x))
(function) [edit]
(C++11)
 computes area hyperbolic sine of a complex number (arsinh(z))
(function template) [edit]
C documentation for asinh

[edit] External links

Weisstein, Eric W. "Inverse Hyperbolic Sine." From MathWorld — A Wolfram Web Resource.
Retrieved from "https://en.cppreference.com/mwiki/index.php?title=cpp/numeric/math/asinh&oldid=159040"