All files / atan2d/lib main.js

96% Statements 72/75
100% Branches 1/1
0% Functions 0/1
96% Lines 72/75

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 761x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x       1x 1x 1x 1x 1x  
/**
* @license Apache-2.0
*
* Copyright (c) 2025 The Stdlib Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*    http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
 
'use strict';
 
// MODULES //
 
var rad2deg = require( '@stdlib/math/base/special/rad2deg' );
var atan2 = require( '@stdlib/math/base/special/atan2' );
 
 
// MAIN //
 
/**
* Computes the angle in the plane (in degrees) between the positive x-axis and the ray from `(0,0)` to the point `(x,y)`.
*
* @param {number} y - `y` coordinate
* @param {number} x - `x` coordinate
* @returns {number} angle (in degrees)
*
* @example
* var v = atan2d( 2.0, 2.0 ); // => atand(1.0)
* // returns ~45.0
*
* @example
* var v = atan2d( 6.0, 2.0 ); // => atand(3.0)
* // returns ~71.565
*
* @example
* var v = atan2d( -1.0, -1.0 ); // => atand(1.0) - 180.0
* // returns ~-135.0
*
* @example
* var v = atan2d( 3.0, 0.0 );
* // returns 90.0
*
* @example
* var v = atan2d( -2.0, 0.0 );
* // returns -90.0
*
* @example
* var v = atan2d( 0.0, 0.0 );
* // returns 0.0
*
* @example
* var v = atan2d( 3.0, NaN );
* // returns NaN
*
* @example
* var v = atan2d( NaN, 2.0 );
* // returns NaN
*/
function atan2d( y, x ) {
	return rad2deg( atan2( y, x ) );
}
 
 
// EXPORTS //
 
module.exports = atan2d;