divide.json

{
    "id": "divide",
    "summary": "Division of two numbers",
    "description": "Divides argument `x` by the argument `y` (*`x / y`*) and returns the computed result.\n\nNo-data values are taken into account so that `null` is returned if any element is such a value.\n\nThe computations follow [IEEE Standard 754](https://ieeexplore.ieee.org/document/8766229) whenever the processing environment supports it. Therefore, a division by zero results in ±infinity if the processing environment supports it. Otherwise, a `DivisionByZero` exception must the thrown.",
    "categories": [
        "math"
    ],
    "parameters": [
        {
            "name": "x",
            "description": "The dividend.",
            "schema": {
                "type": [
                    "number",
                    "null"
                ]
            }
        },
        {
            "name": "y",
            "description": "The divisor.",
            "schema": {
                "type": [
                    "number",
                    "null"
                ]
            }
        }
    ],
    "returns": {
        "description": "The computed result.",
        "schema": {
            "type": [
                "number",
                "null"
            ]
        }
    },
    "exceptions": {
        "DivisionByZero": {
            "message": "Division by zero is not supported."
        }
    },
    "examples": [
        {
            "arguments": {
                "x": 5,
                "y": 2.5
            },
            "returns": 2
        },
        {
            "arguments": {
                "x": -2,
                "y": 4
            },
            "returns": -0.5
        },
        {
            "arguments": {
                "x": 1,
                "y": null
            },
            "returns": null
        }
    ],
    "links": [
        {
            "rel": "about",
            "href": "http://mathworld.wolfram.com/Division.html",
            "title": "Division explained by Wolfram MathWorld"
        },
        {
            "rel": "about",
            "href": "https://ieeexplore.ieee.org/document/8766229",
            "title": "IEEE Standard 754-2019 for Floating-Point Arithmetic"
        }
    ]
}