Asin

Defined in header <cmath>.

Description

Computes the principal value of the arc sine of num. The library provides overloads of std::asin for all cv-unqualified floating-point types as the type of the parameter num.  (since C++23)
Additional Overloads are provided for all integer types, which are treated as double.  (since C++11)

Declarations

C++23

// 1)
/* floating-point-type */ asin( /* floating-point-type */ num );
// 2)
float asinf( float num );
// 3)
long double asinl( long double num );

Additional Overloads

// 4)
template< class Integer >
double asin ( Integer num );

C++11

// 1)
float asin ( float num );
// 2)
double asin ( double num );
// 3)
long double asin ( long double num );
// 4)
float asinf( float num );
// 5)
long double asinl( long double num );

Additional Overloads

// 6)
template< class Integer >
double asin ( Integer num );

Parameters

​num - floating-point or integer value

Return value

If no errors occur, the arc sine of num (arcsin(num)) in the range [-π/2, π/2] is returned. If a domain error occurs, an implementation-defined value is returned (NaN where supported).

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

Error handling

Errors are reported as specified in math_errhandling.

Domain error occurs if num is outside the range [-1.0, 1.0].

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

If the argument is ±0, it is returned unmodified If |num| > 1, a domain error occurs and NaN is returned if the argument is NaN, NaN is returned

Notes

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

Examples

#include <cerrno>
#include <cfenv>
#include <cmath>
#include <cstring>
#include <iostream>
 
// #pragma STDC FENV_ACCESS ON
 
int main()
{
    std::cout 
        << "asin(1.0) = " 
        << asin(1) << '\n'
        << "2*asin(1.0) = " 
        << 2 * asin(1) << '\n'
        << "asin(-0.5) = " 
        << asin(-0.5) << '\n'
        << "6*asin(-0.5) =" 
        << 6 * asin(-0.5) << '\n';
 
    // special values
    std::cout 
        << "asin(0.0) = " 
        << asin(0) 
        << " asin(-0.0)=" 
        << asin(-0.0) << '\n';
 
    // error handling
    errno = 0;
    std::feclearexcept(FE_ALL_EXCEPT);
 
    std::cout 
        << "asin(1.1) = " 
        << asin(1.1) << '\n';
 
    if (errno == EDOM)
        std::cout 
            << "errno == EDOM: " 
            << std::strerror(errno) 
            << '\n';
    if (std::fetestexcept(FE_INVALID))
        std::cout 
            << "FE_INVALID raised" 
            << '\n';
}

Possible Result

asin(1.0) = 1.5708
2*asin(1.0) = 3.14159
asin(-0.5) = -0.523599
6*asin(-0.5) = -3.14159
asin(0.0) = 0 asin(-0.0)=-0
asin(1.1) = nan
errno == EDOM: Numerical argument out of domain
FE_INVALID raised