index.js (1423B)
1 /** 2 * @license Apache-2.0 3 * 4 * Copyright (c) 2018 The Stdlib Authors. 5 * 6 * Licensed under the Apache License, Version 2.0 (the "License"); 7 * you may not use this file except in compliance with the License. 8 * You may obtain a copy of the License at 9 * 10 * http://www.apache.org/licenses/LICENSE-2.0 11 * 12 * Unless required by applicable law or agreed to in writing, software 13 * distributed under the License is distributed on an "AS IS" BASIS, 14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 * See the License for the specific language governing permissions and 16 * limitations under the License. 17 */ 18 19 'use strict'; 20 21 /** 22 * Compute the angle in the plane (in radians) between the positive x-axis and the ray from `(0,0)` to the point `(x,y)`. 23 * 24 * @module @stdlib/math/base/special/atan2 25 * 26 * @example 27 * var atan2 = require( '@stdlib/math/base/special/atan2' ); 28 * 29 * var v = atan2( 2.0, 2.0 ); // => atan(1.0) 30 * // returns ~0.785 31 * 32 * v = atan2( 6.0, 2.0 ); // => atan(3.0) 33 * // returns ~1.249 34 * 35 * v = atan2( -1.0, -1.0 ); // => atan(1.0) - π 36 * // returns ~-2.356 37 * 38 * v = atan2( 3.0, 0.0 ); // => π/2 39 * // returns ~1.571 40 * 41 * v = atan2( -2.0, 0.0 ); // => -π/2 42 * // returns ~-1.571 43 * 44 * v = atan2( 0.0, 0.0 ); 45 * // returns 0.0 46 * 47 * v = atan2( 3.0, NaN ); 48 * // returns NaN 49 * 50 * v = atan2( NaN, 2.0 ); 51 * // returns NaN 52 */ 53 54 // MODULES // 55 56 var atan2 = require( './main.js' ); 57 58 59 // EXPORTS // 60 61 module.exports = atan2;