log.json

{
    "id": "log",
    "summary": "Logarithm to a base",
    "description": "Logarithm to the base `base` of the number `x` is defined to be the inverse function of taking b to the power of x.\n\nThe no-data value `null` is passed through and therefore gets propagated if any of the arguments is `null`.\n\nThe computations follow [IEEE Standard 754](https://ieeexplore.ieee.org/document/8766229) whenever the processing environment supports it. Therefore, `log(0, 2)` results in \u00b1infinity if the processing environment supports it or otherwise an exception is thrown.",
    "categories": [
        "math > exponential & logarithmic"
    ],
    "parameters": [
        {
            "name": "x",
            "description": "A number to compute the logarithm for.",
            "schema": {
                "type": [
                    "number",
                    "null"
                ]
            }
        },
        {
            "name": "base",
            "description": "The numerical base.",
            "schema": {
                "type": [
                    "number",
                    "null"
                ]
            }
        }
    ],
    "returns": {
        "description": "The computed logarithm.",
        "schema": {
            "type": [
                "number",
                "null"
            ]
        }
    },
    "examples": [
        {
            "arguments": {
                "x": 10,
                "base": 10
            },
            "returns": 1
        },
        {
            "arguments": {
                "x": 2,
                "base": 2
            },
            "returns": 1
        },
        {
            "arguments": {
                "x": 4,
                "base": 2
            },
            "returns": 2
        },
        {
            "arguments": {
                "x": 1,
                "base": 16
            },
            "returns": 0
        }
    ],
    "links": [
        {
            "rel": "about",
            "href": "http://mathworld.wolfram.com/Logarithm.html",
            "title": "Logarithm explained by Wolfram MathWorld"
        },
        {
            "rel": "about",
            "href": "https://ieeexplore.ieee.org/document/8766229",
            "title": "IEEE Standard 754-2019 for Floating-Point Arithmetic"
        }
    ]
}