arctan2.json

{
    "id": "arctan2",
    "summary": "Inverse tangent of two numbers",
    "description": "Computes the arc tangent of two numbers `x` and `y`. It is similar to calculating the arc tangent of *`y / x`*, except that the signs of both arguments are used to determine the quadrant of the result.\n\nWorks on radians only.\nThe no-data value `null` is passed through and therefore gets propagated if any of the arguments is `null`.",
    "categories": [
        "math > trigonometric"
    ],
    "parameters": [
        {
            "name": "y",
            "description": "A number to be used as the dividend.",
            "schema": {
                "type": [
                    "number",
                    "null"
                ]
            }
        },
        {
            "name": "x",
            "description": "A number to be used as the divisor.",
            "schema": {
                "type": [
                    "number",
                    "null"
                ]
            }
        }
    ],
    "returns": {
        "description": "The computed angle in radians.",
        "schema": {
            "type": [
                "number",
                "null"
            ]
        }
    },
    "examples": [
        {
            "arguments": {
                "y": 0,
                "x": 0
            },
            "returns": 0
        },
        {
            "arguments": {
                "y": null,
                "x": 1.5
            },
            "returns": null
        }
    ],
    "links": [
        {
            "rel": "about",
            "href": "https://en.wikipedia.org/wiki/Atan2",
            "title": "Two-argument inverse tangent explained by Wikipedia"
        }
    ]
}