multiply.json

{
    "id": "multiply",
    "summary": "Multiplication of two numbers",
    "description": "Multiplies the two numbers `x` and `y` (*`x * y`*) and returns the computed product.\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.",
    "categories": [
        "math"
    ],
    "parameters": [
        {
            "name": "x",
            "description": "The multiplier.",
            "schema": {
                "type": [
                    "number",
                    "null"
                ]
            }
        },
        {
            "name": "y",
            "description": "The multiplicand.",
            "schema": {
                "type": [
                    "number",
                    "null"
                ]
            }
        }
    ],
    "returns": {
        "description": "The computed product of the two numbers.",
        "schema": {
            "type": [
                "number",
                "null"
            ]
        }
    },
    "exceptions": {
        "MultiplicandMissing": {
            "message": "Multiplication requires at least two numbers."
        }
    },
    "examples": [
        {
            "arguments": {
                "x": 5,
                "y": 2.5
            },
            "returns": 12.5
        },
        {
            "arguments": {
                "x": -2,
                "y": -4
            },
            "returns": 8
        },
        {
            "arguments": {
                "x": 1,
                "y": null
            },
            "returns": null
        }
    ],
    "links": [
        {
            "rel": "about",
            "href": "http://mathworld.wolfram.com/Product.html",
            "title": "Product explained by Wolfram MathWorld"
        },
        {
            "rel": "about",
            "href": "https://ieeexplore.ieee.org/document/8766229",
            "title": "IEEE Standard 754-2019 for Floating-Point Arithmetic"
        }
    ],
    "process_graph": {
        "product": {
            "process_id": "product",
            "arguments": {
                "data": [
                    {
                        "from_parameter": "x"
                    },
                    {
                        "from_parameter": "y"
                    }
                ],
                "ignore_nodata": false
            },
            "result": true
        }
    }
}