<commit_before>atan2
===

> Evaluate the [arctangent][arctangent] of the quotient of two numbers.

<!-- <usage> -->

## Usage

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

#### atan2( y, x )

Evaluates the [arctangent][arctangent] of `y / x`.

``` javascript
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 ) - PI
// returns ~-2.356

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

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

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

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

<!-- </usage> -->


<!-- <examples> -->

## Examples

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

var x;
var y;
var i;

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

<!-- </examples> -->


<!-- <links> -->

[arctangent]: https://en.wikipedia.org/wiki/Inverse_trigonometric_functions

<!-- </links> --><commit_msg>Fix argument order in example code<commit_after>atan2
===

> Evaluate the [arctangent][arctangent] of the quotient of two numbers.

<!-- <usage> -->

## Usage

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

#### atan2( y, x )

Evaluates the [arctangent][arctangent] of `y / x`.

``` javascript
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 ) - PI
// returns ~-2.356

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

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

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

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

<!-- </usage> -->


<!-- <examples> -->

## Examples

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

var y;
var x;
var i;

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

<!-- </examples> -->


<!-- <links> -->

[arctangent]: https://en.wikipedia.org/wiki/Inverse_trigonometric_functions

<!-- </links> -->
{'fraction_non_alphanumeric': 0.25091649694501017, 'fraction_numerical': 0.06843177189409369, 'mean_word_length': 2.18961038961039, 'pattern_counts': {'":': 0, '<': 29, '<?xml version=': 0, '>': 39, 'https://': 2, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '254303', 'n_tokens_mistral': 1184, 'n_tokens_neox': 1055, 'n_words': 265}