arcosh.json

{
    "id": "arcosh",
    "summary": "Inverse hyperbolic cosine",
    "description": "Computes the inverse hyperbolic cosine of `x`. It is the inverse function of the hyperbolic cosine so that *arcosh(cosh(x)) = x*.\n\nWorks on radians only.\nThe no-data value `null` is passed through and therefore gets propagated.",
    "categories": [
        "math > trigonometric"
    ],
    "parameters": {
        "x": {
            "description": "A number.",
            "schema": {
                "type": [
                    "number",
                    "null"
                ]
            },
            "required": true
        }
    },
    "returns": {
        "description": "The computed angle in radians.",
        "schema": {
            "type": [
                "number",
                "null"
            ]
        }
    },
    "examples": [
        {
            "arguments": {
                "x": 1
            },
            "returns": 0
        },
        {
            "process_graph": {
                "cosh1": {
                    "process_id": "cosh",
                    "arguments": {
                        "x": 0.5
                    }
                },
                "arccosh1": {
                    "process_id": "arcosh",
                    "arguments": {
                        "x": {
                            "from_node": "cosh1"
                        }
                    },
                    "result": true
                }
            },
            "returns": 0.5
        }
    ],
    "links": [
        {
            "rel": "about",
            "href": "http://mathworld.wolfram.com/InverseHyperbolicCosine.html",
            "title": "Inverse hyperbolic cosine explained by Wolfram MathWorld"
        }
    ]
}