mod.json

{
    "id": "mod",
    "summary": "Modulo",
    "description": "Remainder after division of `x` by `y`.\n\nThe result of a modulo operation has the sign of the divisor. The handling regarding the sign of the result [differs between programming languages](https://en.wikipedia.org/wiki/Modulo_operation) and needs careful consideration while implementing this process.\n\nThe no-data value `null` is passed through and therefore gets propagated if any of the arguments is `null`.",
    "categories": [
        "math"
    ],
    "parameter_order": ["x", "y"],
    "parameters": {
        "x": {
            "description": "A number to be used as dividend.",
            "schema": {
                "type": [
                    "number",
                    "null"
                ]
            },
            "required": true
        },
        "y": {
            "description": "A number to be used as divisor.",
            "schema": {
                "type": [
                    "number",
                    "null"
                ]
            },
            "required": true
        }
    },
    "returns": {
        "description": "The remainder after division.",
        "schema": {
            "type": [
                "number",
                "null"
            ]
        }
    },
    "examples": [
        {
            "arguments": {
                "x": 27,
                "y": 5
            },
            "returns": 2
        },
        {
            "arguments": {
                "x": -27,
                "y": 5
            },
            "returns": 3
        },
        {
            "arguments": {
                "x": 27,
                "y": -5
            },
            "returns": -3
        },
        {
            "arguments": {
                "x": -27,
                "y": -5
            },
            "returns": -2
        },
        {
            "arguments": {
                "x": 27,
                "y": null
            },
            "returns": null
        },
        {
            "arguments": {
                "x": null,
                "y": 5
            },
            "returns": null
        }
    ],
    "links": [
        {
            "rel": "about",
            "href": "https://en.wikipedia.org/wiki/Modulo_operation",
            "title": "Modulo explained by Wikipedia"
        }
    ]
}