product.json

{
    "id": "product",
    "summary": "Compute the product by multiplying numbers",
    "description": "Multiplies all elements in a sequential array of numbers and returns the computed product.\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.\n\nThe computations follow [IEEE Standard 754](https://ieeexplore.ieee.org/document/8766229) whenever the processing environment supports it.",
    "categories": [
        "math",
        "reducer"
    ],
    "parameters": [
        {
            "name": "data",
            "description": "An array of numbers.",
            "schema": {
                "type": "array",
                "items": {
                    "type": [
                        "number",
                        "null"
                    ]
                }
            }
        },
        {
            "name": "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,
            "optional": true
        }
    ],
    "returns": {
        "description": "The computed product of the sequence of numbers.",
        "schema": {
            "type": [
                "number",
                "null"
            ]
        }
    },
    "examples": [
        {
            "arguments": {
                "data": [
                    5,
                    0
                ]
            },
            "returns": 0
        },
        {
            "arguments": {
                "data": [
                    -2,
                    4,
                    2.5
                ]
            },
            "returns": -20
        },
        {
            "arguments": {
                "data": [
                    1,
                    null
                ],
                "ignore_nodata": false
            },
            "returns": null
        },
        {
            "arguments": {
                "data": [
                    -1
                ]
            },
            "returns": -1
        },
        {
            "arguments": {
                "data": [
                    null
                ],
                "ignore_nodata": false
            },
            "returns": null
        },
        {
            "arguments": {
                "data": []
            },
            "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"
        }
    ]
}