Namespaces
Variants
Views
Actions

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

From cppreference.com
< cpp‎ | numeric‎ | math
m (+see also complex and valarray overloads)
m (→‎Return value: {{closed range}})
 
(23 intermediate revisions by 9 users not shown)
Line 1: Line 1:
−
{{cpp/title|cos}}
+
{{cpp/title|cos|cosf|cosl}}
−
{{cpp/numeric/math/sidebar}}
+
{{cpp/numeric/math/navbar}}
−
{{ddcl list begin}}
+
{{cpp/numeric/math/declarations
−
{{ddcl list header | cmath}}
+
|family=cos
−
{{ddcl list item |
+
|param1=num
−
float      cos( float arg );
+
|constexpr_since=26
 +
|desc=Computes the cosine of {{c|num}} (measured in radians).
 
}}
 
}}
−
{{ddcl list item |
 
−
double      cos( double arg );
 
−
}}
 
−
{{ddcl list item |
 
−
long double cos( long double arg );
 
−
}}
 
−
{{ddcl list end}}
 
−
 
−
Computes cosine of {{tt|arg}}
 
  
 
===Parameters===
 
===Parameters===
−
{{param list begin}}
+
{{par begin}}
−
{{param list item | arg | floating point value representing angle in radians}}
+
{{par|num|floating-point or integer value representing angle in radians}}
−
{{param list end}}
+
{{par end}}
  
 
===Return value===
 
===Return value===
 +
If no errors occur, the cosine of {{c|num}} ({{math|cos(num)}}) in the range {{closed range|-1.0|+1.0}}, is returned.
  
−
cosine of {{tt|arg}} in the range {{tt|[-1.0 ; 1.0]}}.
+
{{rrev|until=c++11|
 +
The result may have little or no significance if the magnitude of {{c|num}} is large.
 +
}}
  
−
Domain error occurs if {{tt|arg}} is infinite. {{cpp|NAN}} is returned in that case.
+
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 {{lc|math_errhandling}}.
 +
 
 +
If the implementation supports IEEE floating-point arithmetic (IEC 60559),
 +
* if the argument is ±0, the result is {{c|1.0}}.
 +
* if the argument is ±∞, NaN is returned and {{lc|FE_INVALID}} is raised.
 +
* if the argument is NaN, NaN is returned.
 +
 
 +
===Notes===
 +
The case where the argument is infinite is not specified to be a domain error in C, but it is defined as a [https://pubs.opengroup.org/onlinepubs/9699919799/functions/cos.html domain error in POSIX].
 +
 
 +
{{cpp/numeric/math/additional integer overload note|cos}}
 +
 
 +
===Example===
 +
{{example
 +
|code=
 +
#include <cerrno>
 +
#include <cfenv>
 +
#include <cmath>
 +
#include <iomanip>
 +
#include <iostream>
 +
#include <numbers>
 +
 
 +
// #pragma STDC FENV_ACCESS ON
 +
 
 +
constexpr double pi = std::numbers::pi; // or std::acos(-1) before C++20
 +
 
 +
constexpr double your_cos(double x)
 +
{
 +
    double cos{1}, pow{x};
 +
    for (auto fac{1ull}, n{1ull}; n != 19; fac *= ++n, pow *= x)
 +
        if ((n & 1) == 0)
 +
            cos += (n & 2 ? -pow : pow) / fac;
 +
    return cos;
 +
}
 +
 
 +
int main()
 +
{
 +
    std::cout << std::setprecision(10) << std::showpos
 +
              << "Typical usage:\n"
 +
              << "std::cos(pi/3) = " << std::cos(pi / 3) << '\n'
 +
              << "your cos(pi/3) = " << your_cos(pi / 3) << '\n'
 +
              << "std::cos(pi/2) = " << std::cos(pi / 2) << '\n'
 +
              << "your cos(pi/2) = " << your_cos(pi / 2) << '\n'
 +
              << "std::cos(-3*pi/4) = " << std::cos(-3 * pi / 4) << '\n'
 +
              << "your cos(-3*pi/4) = " << your_cos(-3 * pi / 4) << '\n'
 +
              << "Special values:\n"
 +
              << "std::cos(+0) = " << std::cos(0.0) << '\n'
 +
              << "std::cos(-0) = " << std::cos(-0.0) << '\n';
 +
 
 +
    // error handling
 +
    std::feclearexcept(FE_ALL_EXCEPT);
 +
 
 +
    std::cout << "cos(INFINITY) = " << std::cos(INFINITY) << '\n';
 +
    if (std::fetestexcept(FE_INVALID))
 +
        std::cout << "    FE_INVALID raised\n";
 +
}
 +
|p=true
 +
|output=
 +
Typical usage:
 +
std::cos(pi/3) = +0.5
 +
your cos(pi/3) = +0.5
 +
std::cos(pi/2) = +6.123233996e-17
 +
your cos(pi/2) = -3.373452105e-15
 +
std::cos(-3*pi/4) = -0.7071067812
 +
your cos(-3*pi/4) = -0.7071067812
 +
Special values:
 +
std::cos(+0) = +1
 +
std::cos(-0) = +1
 +
cos(INFINITY) = -nan
 +
    FE_INVALID raised
 +
}}
  
 
===See also===
 
===See also===
 +
{{dsc begin}}
 +
{{dsc inc|cpp/numeric/math/dsc sin}}
 +
{{dsc inc|cpp/numeric/math/dsc tan}}
 +
{{dsc inc|cpp/numeric/math/dsc acos}}
 +
{{dsc inc|cpp/numeric/complex/dsc cos}}
 +
{{dsc inc|cpp/numeric/valarray/dsc cos}}
 +
{{dsc see c|c/numeric/math/cos}}
 +
{{dsc end}}
  
−
{{dcl list begin}}
+
{{langlinks|de|es|fr|it|ja|pl|pt|ru|zh}}
−
{{dcl list template | cpp/numeric/math/dcl list sin}}
+
−
{{dcl list template | cpp/numeric/math/dcl list tan}}
+
−
{{dcl list template | cpp/numeric/math/dcl list acos}}
+
−
{{dcl list template | cpp/numeric/complex/dcl list cos}}
+
−
{{dcl list template | cpp/numeric/valarray/dcl list cos}}
+
−
{{dcl list end}}
+

Latest revision as of 08:47, 13 November 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
(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       cos ( float num );

double      cos ( double num );

long double cos ( long double num );
 (until C++23)
/* floating-point-type */
            cos ( /* floating-point-type */ num );
 (since C++23)
(constexpr since C++26)
float       cosf( float num );
 (2) (since C++11)
(constexpr since C++26)
long double cosl( long double num );
 (3) (since C++11)
(constexpr since C++26)
Additional overloads (since C++11)
Defined in header <cmath>
template< class Integer >
double      cos ( Integer num );
 (A) (constexpr since C++26)
1-3) Computes the cosine of num (measured in radians). The library provides overloads of std::cos 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 representing angle in radians

[edit] Return value

If no errors occur, the cosine of num (cos(num)) in the range [-1.0, +1.0], is returned.

The result may have little or no significance if the magnitude of num is large.

(until C++11)

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.

[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, the result is 1.0.
  • if the argument is ±∞, NaN is returned and FE_INVALID is raised.
  • if the argument is NaN, NaN is returned.

[edit] Notes

The case where the argument is infinite is not specified to be a domain error in C, but it is defined as a domain error in POSIX.

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::cos(num) has the same effect as std::cos(static_cast<double>(num)).

[edit] Example

Run this code
#include <cerrno>
#include <cfenv>
#include <cmath>
#include <iomanip>
#include <iostream>
#include <numbers>
 
// #pragma STDC FENV_ACCESS ON
 
constexpr double pi = std::numbers::pi; // or std::acos(-1) before C++20
 
constexpr double your_cos(double x)
{
    double cos{1}, pow{x};
    for (auto fac{1ull}, n{1ull}; n != 19; fac *= ++n, pow *= x)
        if ((n & 1) == 0)
            cos += (n & 2 ? -pow : pow) / fac;
    return cos;
}
 
int main()
{
    std::cout << std::setprecision(10) << std::showpos
              << "Typical usage:\n"
              << "std::cos(pi/3) = " << std::cos(pi / 3) << '\n'
              << "your cos(pi/3) = " << your_cos(pi / 3) << '\n'
              << "std::cos(pi/2) = " << std::cos(pi / 2) << '\n'
              << "your cos(pi/2) = " << your_cos(pi / 2) << '\n'
              << "std::cos(-3*pi/4) = " << std::cos(-3 * pi / 4) << '\n'
              << "your cos(-3*pi/4) = " << your_cos(-3 * pi / 4) << '\n'
              << "Special values:\n"
              << "std::cos(+0) = " << std::cos(0.0) << '\n'
              << "std::cos(-0) = " << std::cos(-0.0) << '\n';
 
    // error handling
    std::feclearexcept(FE_ALL_EXCEPT);
 
    std::cout << "cos(INFINITY) = " << std::cos(INFINITY) << '\n';
    if (std::fetestexcept(FE_INVALID))
        std::cout << "    FE_INVALID raised\n";
}

Possible output: 

Typical usage:
std::cos(pi/3) = +0.5
your cos(pi/3) = +0.5
std::cos(pi/2) = +6.123233996e-17
your cos(pi/2) = -3.373452105e-15
std::cos(-3*pi/4) = -0.7071067812
your cos(-3*pi/4) = -0.7071067812
Special values:
std::cos(+0) = +1
std::cos(-0) = +1
cos(INFINITY) = -nan
    FE_INVALID raised

[edit] See also

(C++11)(C++11)
 computes sine (sin(x))
(function) [edit]
(C++11)(C++11)
 computes tangent (tan(x))
(function) [edit]
(C++11)(C++11)
 computes arc cosine (arccos(x))
(function) [edit]
computes cosine of a complex number (cos(z))
(function template) [edit]
applies the function std::cos to each element of valarray
(function template) [edit]
C documentation for cos
Retrieved from "https://en.cppreference.com/mwiki/index.php?title=cpp/numeric/math/cos&oldid=162683"