Package Exports

@stdlib/math-base-special-atan2

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@stdlib/math-base-special-atan2) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

atan2

$NPM version$ $Build Status$ $Coverage Status$ $dependencies$

Compute the angle in the plane (in radians) between the positive x-axis and the ray from (0,0) to the point (x,y).

Installation

npm install @stdlib/math-base-special-atan2

Usage

var atan2 = require( '@stdlib/math-base-special-atan2' );

atan2( y, x )

Computes the angle in the plane (in radians) between the positive x-axis and the ray from (0,0) to the point (x,y).

var v = atan2( 2.0, 2.0 ); // => atan(1.0)
// returns ~0.785

v = atan2( 6.0, 2.0 ); // => atan(3.0)
// returns ~1.249

v = atan2( -1.0, -1.0 ); // => atan(1.0) - π
// returns ~-2.356

v = atan2( 3.0, 0.0 ); // => π/2
// returns ~1.571

v = atan2( -2.0, 0.0 ); // => -π/2
// returns ~-1.571

v = atan2( 0.0, 0.0 );
// returns 0.0

v = atan2( 3.0, NaN );
// returns NaN

Examples

var randu = require( '@stdlib/random-base-randu' );
var atan2 = require( '@stdlib/math-base-special-atan2' );

var y;
var x;
var i;

for ( i = 0; i < 100; i++ ) {
    y = randu() * 100.0;
    x = randu() * 100.0;
    console.log( 'y: %d, \t x: %d, \t atan2(y,x): %d', y.toFixed( 4 ), x.toFixed( 4 ), atan2( y, x ).toFixed( 4 ) );
}

Notice

This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.

Community

License

See LICENSE.

@stdlib/math-base-special-atan2