ln.json

{
    "id": "ln",
    "summary": "Natural logarithm",
    "description": "The natural logarithm is the logarithm to the base *e* of the number `x`, which equals to using the *log* process with the base set to *e*. The natural logarithm is the inverse function of taking *e* to the power x.\n\nThe no-data value `null` is passed through.\n\nThe computations follow [IEEE Standard 754](https://ieeexplore.ieee.org/document/8766229) whenever the processing environment supports it. Therefore, *`ln(0)`* results in ±infinity 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 natural logarithm for.",
            "schema": {
                "type": [
                    "number",
                    "null"
                ]
            }
        }
    ],
    "returns": {
        "description": "The computed natural logarithm.",
        "schema": {
            "type": [
                "number",
                "null"
            ]
        }
    },
    "examples": [
        {
            "arguments": {
                "x": 1
            },
            "returns": 0
        }
    ],
    "links": [
        {
            "rel": "about",
            "href": "http://mathworld.wolfram.com/NaturalLogarithm.html",
            "title": "Natural logarithm explained by Wolfram MathWorld"
        },
        {
            "rel": "about",
            "href": "https://ieeexplore.ieee.org/document/8766229",
            "title": "IEEE Standard 754-2019 for Floating-Point Arithmetic"
        }
    ],
    "process_graph": {
        "e": {
            "process_id": "e",
            "arguments": {}
        },
        "log": {
            "process_id": "log",
            "arguments": {
                "x": {
                    "from_parameter": "x"
                },
                "base": {
                    "from_node": "e"
                }
            },
            "result": true
        }
    }
}