std::atan2(std::valarray)
Template:ddcl list begin <tr class="t-dsc-header">
<td><valarray>
<td></td> <td></td> </tr> <tr class="t-dcl ">
<td >valarray<T> atan2( const valarray<T>& y, const valarray<T>& x );
<td > (1) </td> <td class="t-dcl-nopad"> </td> </tr> <tr class="t-dcl ">
<td >valarray<T> atan2( const valarray<T>& y, const T& vx );
<td > (2) </td> <td class="t-dcl-nopad"> </td> </tr> <tr class="t-dcl ">
<td >valarray<T> atan2( const T& vy, const valarray<T>& x );
<td > (3) </td> <td class="t-dcl-nopad"> </td> </tr> Template:ddcl list end
Computes the inverse tangent of y/x
using the signs of arguments to correctly determine quadrant.
y
and x
.The behavior is undefined if x.size() != y.size().
vx
and each value in the numeric array y
.vy
and each value in the numeric array x
.Contents |
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:
- All const member functions of std::valarray are provided.
- std::valarray, std::slice_array, std::gslice_array, std::mask_array and std::indirect_array can be constructed from the replacement type.
- For every function taking a const std::valarray<T>& except begin() and end()(since C++11), identical functions taking the replacement types shall be added;
- For every function taking two const std::valarray<T>& arguments, identical functions taking every combination of const std::valarray<T>& and replacement types shall be added.
- The return type does not add more than two levels of template nesting over the most deeply-nested argument type.
Example
This section is incomplete Reason: no example |