multiply.json

{
    "id": "multiply",
    "summary": "Multiplication of a sequence of numbers",
    "description": "Multiplies all elements in a sequential array of numbers and returns the computed product.\n\nThe computations should follow [IEEE Standard 754](https://ieeexplore.ieee.org/document/4610935) whenever the processing environment supports it. Otherwise an exception must the thrown for incomputable results.\n\nBy default no-data values are ignored. Setting `ignore_nodata` to `false` considers no-data values so that `null` is returned if any element is such a value.",
    "categories": [
        "math",
        "reducer"
    ],
    "parameter_order": ["data", "ignore_nodata"],
    "parameters": {
        "data": {
            "description": "An array of numbers with at least two elements.",
            "schema": {
                "type": "array",
                "items": {
                    "type": [
                        "number",
                        "null"
                    ]
                },
                "minItems": 2
            },
            "required": true
        },
        "ignore_nodata": {
            "description": "Indicates whether no-data values are ignored or not. Ignores them by default. Setting this flag to `false` considers no-data values so that `null` is returned if any value is such a value.",
            "schema": {
                "type": "boolean",
                "default": true
            }
        }
    },
    "returns": {
        "description": "The computed product of the sequence of numbers.",
        "schema": {
            "type": [
                "number",
                "null"
            ]
        }
    },
    "exceptions": {
        "MultiplicandMissing": {
            "message": "Multiplication requires at least two numbers."
        }
    },
    "examples": [
        {
            "arguments": {
                "data": [5,0]
            },
            "returns": 0
        },
        {
            "arguments": {
                "data": [-2,4,2.5]
            },
            "returns": -20
        },
        {
            "arguments": {
                "data": [1,null],
                "ignore_nodata": false
            },
            "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/4610935",
            "title": "IEEE Standard 754-2008 for Floating-Point Arithmetic"
        }
    ]
}