W3cubDocs

/C++

std::atan2(std::valarray)

Defined in header <valarray>
template< class T > 
valarray<T> atan2( const valarray<T>& y, const valarray<T>& x );
(1)
template< class T > 
valarray<T> atan2( const valarray<T>& y, const T& vx );
(2)
template< class T > 
valarray<T> atan2( const T& vy, const valarray<T>& x );
(3)

Computes the inverse tangent of y/x using the signs of arguments to correctly determine quadrant.

1) Computes the inverse tangent of each pair of corresponding values from y and x.

The behavior is undefined if x.size() != y.size().

2) Computes the inverse tangent of vx and each value in the numeric array y.
3) Computes the inverse tangent of vy and each value in the numeric array x.

Parameters

x, y - numeric arrays to compute inverse tangent of
vy, vx - values to compute inverse tangent of

Return value

A numeric array containing the results of computation of inverse tangent.

Notes

Unqualified function (atan2) is used to perform the computation. If such function is not available, std::atan2 is used due to argument dependent lookup.

The function can be implemented with the return type different from std::valarray. In this case, the replacement type has the following properties:

Example

See also

applies the function std::asin to each element of valarray
(function template)
applies the function std::acos to each element of valarray
(function template)
applies the function std::atan to each element of valarray
(function template)
arc tangent, using signs to determine quadrants
(function)
returns the phase angle
(function template)

© cppreference.com
Licensed under the Creative Commons Attribution-ShareAlike Unported License v3.0.
http://en.cppreference.com/w/cpp/numeric/valarray/atan2