diff --git a/docs/src/functions/images/hyperbolicarccosine-curve.png b/docs/src/functions/images/hyperbolicarccosine-curve.png new file mode 100644 index 0000000..a11792d Binary files /dev/null and b/docs/src/functions/images/hyperbolicarccosine-curve.png differ diff --git a/docs/src/functions/images/hyperbolicarcsine-curve.png b/docs/src/functions/images/hyperbolicarcsine-curve.png new file mode 100644 index 0000000..8319565 Binary files /dev/null and b/docs/src/functions/images/hyperbolicarcsine-curve.png differ diff --git a/docs/src/functions/images/hyperbolicarctangent-curve.png b/docs/src/functions/images/hyperbolicarctangent-curve.png new file mode 100644 index 0000000..d4cdb0e Binary files /dev/null and b/docs/src/functions/images/hyperbolicarctangent-curve.png differ diff --git a/docs/src/functions/math-and-trigonometry.md b/docs/src/functions/math-and-trigonometry.md index 1466c53..f7ef6fd 100644 --- a/docs/src/functions/math-and-trigonometry.md +++ b/docs/src/functions/math-and-trigonometry.md @@ -13,16 +13,16 @@ You can track the progress in this [GitHub issue](https://github.com/ironcalc/Ir | --------------- | ---------------------------------------------- | ------------- | | ABS | | – | | ACOS | | [ACOS](math_and_trigonometry/acos) | -| ACOSH | | – | +| ACOSH | | [ACOSH](math_and_trigonometry/acosh) | | ACOT | | – | | ACOTH | | – | | AGGREGATE | | – | | ARABIC | | – | | ASIN | | [ASIN](math_and_trigonometry/asin) | -| ASINH | | – | +| ASINH | | [ASINH](math_and_trigonometry/asinh) | | ATAN | | [ATAN](math_and_trigonometry/atan) | -| ATAN2 | | – | -| ATANH | | – | +| ATAN2 | | [ATAN2](math_and_trigonometry/atan2) | +| ATANH | | [ATANH](math_and_trigonometry/atanh) | | BASE | | – | | CEILING | | – | | CEILING.MATH | | – | diff --git a/docs/src/functions/math_and_trigonometry/acosh.md b/docs/src/functions/math_and_trigonometry/acosh.md index 750042d..db59df0 100644 --- a/docs/src/functions/math_and_trigonometry/acosh.md +++ b/docs/src/functions/math_and_trigonometry/acosh.md @@ -3,9 +3,40 @@ layout: doc outline: deep lang: en-US --- +# ACOSH function +## Overview +ACOSH is a function of the Math and Trigonometry category that calculates the inverse hyperbolic cosine (hyperbolic arccosine) of a number, returning a non-negative value in the range [0, +∞). +## Usage +### Syntax +**ACOSH(number) => acosh** +### Argument descriptions +* *number* ([number](/features/value-types#numbers), required). The value whose hyperbolic arccosine is to be calculated. The value must be greater than or equal to 1. -# ACOSH +### Additional guidance +The hyperbolic arccosine function is defined as: -::: warning -🚧 This function is implemented but currently lacks detailed documentation. For guidance, you may refer to the equivalent functionality in [Microsoft Excel documentation](https://support.microsoft.com/en-us/office/excel-functions-by-category-5f91f4e9-7b42-46d2-9bd1-63f26a86c0eb). -::: \ No newline at end of file +$$ +\operatorname{acosh}(x) = \ln(x + \sqrt{x^2 - 1}) +$$ + +### Returned value +ACOSH returns a [number](/features/value-types#numbers) in the range [0, +∞) that is the hyperbolic arccosine of the specified value, expressed in radians. +### Error conditions +* In common with many other IronCalc functions, ACOSH propagates errors that are found in its argument. +* If no argument, or more than one argument, is supplied, then ACOSH returns the [`#ERROR!`](/features/error-types.md#error) error. +* If the value of the *number* argument is not (or cannot be converted to) a [number](/features/value-types#numbers), then ACOSH returns the [`#VALUE!`](/features/error-types.md#value) error. +* If the value of the *number* argument is less than 1, then ACOSH returns the [`#NUM!`](/features/error-types.md#num) error. + +## Details +* The ACOSH function utilizes the *acosh()* method provided by the [Rust Standard Library](https://doc.rust-lang.org/std/). +* The figure below illustrates the output of the ACOSH function for values $x \geq 1$ in the range [0, +∞). +
Graph showing acosh(x) for x ≥ 1.
+ +## Examples +[See some examples in IronCalc](https://app.ironcalc.com/?example=acosh). + +## Links +* For more information about inverse hyperbolic functions, visit Wikipedia's [Inverse hyperbolic functions](https://en.wikipedia.org/wiki/Inverse_hyperbolic_functions) page. +* See also IronCalc's [COSH](/functions/math_and_trigonometry/cosh), [ASINH](/functions/math_and_trigonometry/asinh) and [ATANH](/functions/math_and_trigonometry/atanh) functions. +* Visit Microsoft Excel's [ACOSH function](https://support.microsoft.com/en-us/office/acosh-function-e3992cc1-103f-4e72-9f04-624b9ef5ebfe) page. +* Both [Google Sheets](https://support.google.com/docs/answer/3093391) and [LibreOffice Calc](https://wiki.documentfoundation.org/Documentation/Calc_Functions/ACOSH) provide versions of the ACOSH function. \ No newline at end of file diff --git a/docs/src/functions/math_and_trigonometry/asinh.md b/docs/src/functions/math_and_trigonometry/asinh.md index c222e0d..c81ffb5 100644 --- a/docs/src/functions/math_and_trigonometry/asinh.md +++ b/docs/src/functions/math_and_trigonometry/asinh.md @@ -4,8 +4,36 @@ outline: deep lang: en-US --- -# ASINH +# ASINH function +## Overview +ASINH is a function of the Math and Trigonometry category that calculates the inverse hyperbolic sine (hyperbolic arcsine) of a number, returning the hyperbolic angle expressed in radians. +## Usage +### Syntax +**ASINH(number) => asinh** +### Argument descriptions +* *number* ([number](/features/value-types#numbers), required). The value whose inverse hyperbolic sine is to be calculated. +### Additional guidance +The hyperbolic arcsine function is defined as: +$$ +\operatorname{asinh}(x) = \ln\!\left(x + \sqrt{x^2 + 1}\,\right) +$$ +### Returned value +ASINH returns a real [number](/features/value-types#numbers) in the range (-∞, +∞) that is the hyperbolic arcsine of the specified value, expressed in radians. +### Error conditions +* In common with many other IronCalc functions, ASINH propagates errors that are found in its argument. +* If no argument, or more than one argument, is supplied, then ASINH returns the [`#ERROR!`](/features/error-types.md#error) error. +* If the value of the *number* argument is not (or cannot be converted to) a [number](/features/value-types#numbers), then ASINH returns the [`#VALUE!`](/features/error-types.md#value) error. + +## Details +* The ASINH function utilizes the *asinh()* method provided by the [Rust Standard Library](https://doc.rust-lang.org/std/). +* The figure below illustrates the output of the ASINH function. +
Graph showing asinh(x).
-::: warning -🚧 This function is implemented but currently lacks detailed documentation. For guidance, you may refer to the equivalent functionality in [Microsoft Excel documentation](https://support.microsoft.com/en-us/office/excel-functions-by-category-5f91f4e9-7b42-46d2-9bd1-63f26a86c0eb). -::: \ No newline at end of file +## Examples +[See some examples in IronCalc](https://app.ironcalc.com/?example=asinh). + +## Links +* For more information about inverse hyperbolic functions, visit Wikipedia's [Inverse hyperbolic functions](https://en.wikipedia.org/wiki/Inverse_hyperbolic_functions) page. +* See also IronCalc's [SINH](/functions/math_and_trigonometry/sinh), [ACOSH](/functions/math_and_trigonometry/acosh) and [ATANH](/functions/math_and_trigonometry/atanh) functions. +* Visit Microsoft Excel's [ASINH function](https://support.microsoft.com/de-de/office/asinh-function-62b4f5b6-d9cc-4c17-9d04-aa5371806c74) page. +* Both [Google Sheets](https://support.google.com/docs/answer/3093393) and [LibreOffice Calc](https://wiki.documentfoundation.org/Documentation/Calc_Functions/ASINH) provide versions of the ASINH function. \ No newline at end of file diff --git a/docs/src/functions/math_and_trigonometry/atan2.md b/docs/src/functions/math_and_trigonometry/atan2.md index ade779c..73a6dac 100644 --- a/docs/src/functions/math_and_trigonometry/atan2.md +++ b/docs/src/functions/math_and_trigonometry/atan2.md @@ -4,8 +4,34 @@ outline: deep lang: en-US --- -# ATAN2 +# ATAN2 function +## Overview +ATAN2 is a function of the Math and Trigonometry category that calculates the inverse tangent (arctangent) for the specified *x* and *y* coordinates. The arctangent returns the angle defined by the x-axis and a line defined by the origin and a point with coordinates (x,y). The returned angle is expressed in radians, in the range (-$\pi$, +$\pi$]. +## Usage +### Syntax +**ATAN2(x,y) => atan2** +### Argument descriptions +* *x* ([number](/features/value-types#numbers), required). Value of the x coordinate. +* *y* ([number](/features/value-types#numbers), required). Value of the y coordinate. +### Additional guidance +If the returned value is positive, it represents a counterclockwise angle from the x-axis, while a negative value represents a clockwise angle. +ATAN2(x,y) is equivalent to ATAN(y/x), with the difference that the x argument in ATAN2 can be 0. +### Returned value +ATAN2 returns a number in radians in the range (-$\pi$, +$\pi$] that is the inverse tangent for the specified x and y coordinates. +### Error conditions +* In common with many other IronCalc functions, ATAN2 propagates errors that are found in its argument. +* If no argument, or arguments other than 2, are supplied, then ATAN2 returns the [`#ERROR!`](/features/error-types.md#error) error. +* If the value of either the *x* or *y* argument is not (or cannot be converted to) a [number](/features/value-types#numbers), then ATAN2 returns the [`#VALUE!`](/features/error-types.md#value) error. +* If both *x* and *y* are equal to 0, ATAN2 returns a [`#DIV/0!`](/features/error-types.md#div-0) error. + +## Details +* The ATAN2 function utilizes the *atan2()* method provided by the [Rust Standard Library](https://doc.rust-lang.org/std/). +## Examples +[See some examples in IronCalc](https://app.ironcalc.com/?example=atan2). + +## Links +* For more information about inverse trigonometric functions, visit Wikipedia's [Inverse trigonometric functions](https://en.wikipedia.org/wiki/Inverse_trigonometric_functions) page. +* See also IronCalc's [ATAN](/functions/math_and_trigonometry/atan), [TAN](/functions/math_and_trigonometry/tan) and [ASIN](/functions/math_and_trigonometry/asin) functions. +* Visit Microsoft Excel's [ATAN2 function](https://support.microsoft.com/en-us/office/atan2-function-51123ced-348c-416a-b2e2-833f7868569f) page. +* Both [Google Sheets](https://support.google.com/docs/answer/3093468) and [LibreOffice Calc](https://wiki.documentfoundation.org/Documentation/Calc_Functions/ATAN2) provide versions of the ATAN2 function. -::: warning -🚧 This function is implemented but currently lacks detailed documentation. For guidance, you may refer to the equivalent functionality in [Microsoft Excel documentation](https://support.microsoft.com/en-us/office/excel-functions-by-category-5f91f4e9-7b42-46d2-9bd1-63f26a86c0eb). -::: \ No newline at end of file diff --git a/docs/src/functions/math_and_trigonometry/atanh.md b/docs/src/functions/math_and_trigonometry/atanh.md index 59b2a9f..63e28f4 100644 --- a/docs/src/functions/math_and_trigonometry/atanh.md +++ b/docs/src/functions/math_and_trigonometry/atanh.md @@ -4,8 +4,37 @@ outline: deep lang: en-US --- -# ATANH +# ATANH function +## Overview +ATANH is a function of the Math and Trigonometry category that calculates the inverse hyperbolic tangent (hyperbolic arctangent) of a number in the range (-1, +1), returning the hyperbolic angle expressed in radians. +## Usage +### Syntax +**ATANH(number) => atanh** +### Argument descriptions +* *number* ([number](/features/value-types#numbers), required). The value whose inverse hyperbolic tangent is to be calculated, in the range (-1,+1). +### Additional guidance +The hyperbolic arctangent function is defined as: +$$ +\operatorname{atanh}(x) = \tfrac{1}{2}\,\ln\!\left(\dfrac{1+x}{1-x}\right),\quad |x| < 1 +$$ +### Returned value +ATANH returns a real [number](/features/value-types#numbers) in the range (-∞, +∞) that is the hyperbolic arctangent of the specified value, expressed in radians. +### Error conditions +* In common with many other IronCalc functions, ATANH propagates errors that are found in its argument. +* If no argument, or more than one argument, is supplied, then ATANH returns the [`#ERROR!`](/features/error-types.md#error) error. +* If the value of the *number* argument is not (or cannot be converted to) a [number](/features/value-types#numbers), then ATANH returns the [`#VALUE!`](/features/error-types.md#value) error. +* If the value of the *number* argument lies outside the domain (-1, +1), then ATANH returns the [`#NUM!`](/features/error-types.md#num) error. + +## Details +* The ATANH function utilizes the *atanh()* method provided by the [Rust Standard Library](https://doc.rust-lang.org/std/). +* The figure below illustrates the output of the ATANH function. +
Graph showing atanh(x).
-::: warning -🚧 This function is implemented but currently lacks detailed documentation. For guidance, you may refer to the equivalent functionality in [Microsoft Excel documentation](https://support.microsoft.com/en-us/office/excel-functions-by-category-5f91f4e9-7b42-46d2-9bd1-63f26a86c0eb). -::: \ No newline at end of file +## Examples +[See some examples in IronCalc](https://app.ironcalc.com/?example=atanh). + +## Links +* For more information about inverse hyperbolic functions, visit Wikipedia's [Inverse hyperbolic functions](https://en.wikipedia.org/wiki/Inverse_hyperbolic_functions) page. +* See also IronCalc's [ASINH](/functions/math_and_trigonometry/asinh), [ACOSH](/functions/math_and_trigonometry/acosh) and [TANH](/functions/math_and_trigonometry/tanh) functions. +* Visit Microsoft Excel's [ATANH function](https://support.microsoft.com/de-de/office/atanh-function-453534d1-76a5-4f17-8c04-c3f2feee0dd5) page. +* Both [Google Sheets](https://support.google.com/docs/answer/3093397) and [LibreOffice Calc](https://wiki.documentfoundation.org/Documentation/Calc_Functions/ATANH) provide versions of the ATANH function. \ No newline at end of file