sirtimbly/IronCalc
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: improve consistency in ATAN2, ASINH, ACOSH, ATANH documentation

Browse Source
This commit is contained in:
Elsa Minsut
2025-09-24 19:36:30 +02:00
parent 9bbf94e033
commit e39bfe912a
4 changed files with 10 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/src/functions/math_and_trigonometry/acosh.md
View File

@@ -16,11 +16,11 @@ ACOSH is a function of the Math and Trigonometry category that calculates the in
The hyperbolic arccosine function is defined as: The hyperbolic arccosine function is defined as:
$$ $$
\text{acosh(x)} = \ln(x + \sqrt{x^2 - 1}) \operatorname{acosh}(x) = \ln(x + \sqrt{x^2 - 1})
$$ $$
### Returned value ### Returned value
ACOSH returns a [number](/features/value-types#numbers) that is the hyperbolic arccosine of the specified value, expressed in radians. 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 ### Error conditions
* In common with many other IronCalc functions, ACOSH propagates errors that are found in its argument. * 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 no argument, or more than one argument, is supplied, then ACOSH returns the [`#ERROR!`](/features/error-types.md#error) error.
@@ -30,7 +30,7 @@ ACOSH returns a [number](/features/value-types#numbers) that is the hyperbolic a
## Details ## Details
* The ACOSH function utilizes the *acosh()* method provided by the [Rust Standard Library](https://doc.rust-lang.org/std/). * 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, +∞). * The figure below illustrates the output of the ACOSH function for values $x \geq 1$ in the range [0, +∞).
<center><img src="/functions/images/hyperbolicarccosine-curve.png" width="350" alt="Graph showing acosh(x) for x ≥ 0."></center> <center><img src="/functions/images/hyperbolicarccosine-curve.png" width="350" alt="Graph showing acosh(x) for x ≥ 1."></center>
## Examples ## Examples
[See some examples in IronCalc](https://app.ironcalc.com/?example=acosh). [See some examples in IronCalc](https://app.ironcalc.com/?example=acosh).

5
docs/src/functions/math_and_trigonometry/asinh.md
View File

@@ -18,12 +18,11 @@ $$
\operatorname{asinh}(x) = \ln\!\left(x + \sqrt{x^2 + 1}\,\right) \operatorname{asinh}(x) = \ln\!\left(x + \sqrt{x^2 + 1}\,\right)
$$ $$
### Returned value ### Returned value
ASINH returns a real [number](/features/value-types#numbers) that is the hyperbolic arcsine of the specified value, expressed in radians. 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 ### Error conditions
* In common with many other IronCalc functions, ASINH propagates errors that are found in its argument. * 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 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. * 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.
* For some argument values, ASINH may return a [`#DIV/0!`](/features/error-types.md#div-0) error.
<!--@include: ../markdown-snippets/error-type-details.txt--> <!--@include: ../markdown-snippets/error-type-details.txt-->
## Details ## Details
* The ASINH function utilizes the *asinh()* method provided by the [Rust Standard Library](https://doc.rust-lang.org/std/). * The ASINH function utilizes the *asinh()* method provided by the [Rust Standard Library](https://doc.rust-lang.org/std/).
@@ -35,6 +34,6 @@ ASINH returns a real [number](/features/value-types#numbers) that is the hyperbo
## Links ## Links
* For more information about inverse hyperbolic functions, visit Wikipedia's [Inverse hyperbolic functions](https://en.wikipedia.org/wiki/Inverse_hyperbolic_functions) page. * 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), [COSH](/functions/math_and_trigonometry/cosh) and [TANH](/functions/math_and_trigonometry/tanh) functions. * 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. * 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. * 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.

6
docs/src/functions/math_and_trigonometry/atan2.md
View File

@@ -9,15 +9,15 @@ lang: en-US
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$]. 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 ## Usage
### Syntax ### Syntax
**ATAN2 (<span title="Number" style="color:#1E88E5">x,y</span>) => <span title="Number" style="color:#1E88E5">atan2</span>** **ATAN2(<span title="Number" style="color:#1E88E5">x,y</span>) => <span title="Number" style="color:#1E88E5">atan2</span>**
### Argument descriptions ### Argument descriptions
* *x* ([number](/features/value-types#numbers), required). Value of the x coordinate. * *x* ([number](/features/value-types#numbers), required). Value of the x coordinate.
* *y* ([number](/features/value-types#numbers), required). Value of the y coordinate. * *y* ([number](/features/value-types#numbers), required). Value of the y coordinate.
### Additional guidance ### 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. 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. ATAN2(x,y) is equivalent to ATAN(y/x), with the difference that the x argument in ATAN2 can be 0.
### Returned value ### Returned value
ATAN2 returns a number in radians in the range (-$\pi$ to +$\pi$] that is the inverse tangent for the specified x and y coordinates. 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 ### Error conditions
* In common with many other IronCalc functions, ATAN2 propagates errors that are found in its argument. * 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 no argument, or arguments other than 2, are supplied, then ATAN2 returns the [`#ERROR!`](/features/error-types.md#error) error.

5
docs/src/functions/math_and_trigonometry/atanh.md
View File

@@ -6,7 +6,7 @@ lang: en-US
# ATANH function # ATANH function
## Overview ## Overview
ATANH is a function of the Math and Trigonometry category that calculates the inverse hyperbolic tangent (hyperbolic arctangent) of a number, returning the hyperbolic angle expressed in radians. 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 ## Usage
### Syntax ### Syntax
**ATANH(<span title="Number" style="color:#1E88E5">number</span>) => <span title="Number" style="color:#1E88E5">atanh</span>** **ATANH(<span title="Number" style="color:#1E88E5">number</span>) => <span title="Number" style="color:#1E88E5">atanh</span>**
@@ -18,13 +18,12 @@ $$
\operatorname{atanh}(x) = \tfrac{1}{2}\,\ln\!\left(\dfrac{1+x}{1-x}\right),\quad |x| < 1 \operatorname{atanh}(x) = \tfrac{1}{2}\,\ln\!\left(\dfrac{1+x}{1-x}\right),\quad |x| < 1
$$ $$
### Returned value ### Returned value
ATANH returns a real [number](/features/value-types#numbers) that is the hyperbolic arctangent of the specified value, expressed in radians. 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 ### Error conditions
* In common with many other IronCalc functions, ATANH propagates errors that are found in its argument. * 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 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 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. * If the value of the *number* argument lies outside the domain (-1, +1), then ATANH returns the [`#NUM!`](/features/error-types.md#num) error.
* For some argument values, ATANH may return a [`#DIV/0!`](/features/error-types.md#div-0) error.
<!--@include: ../markdown-snippets/error-type-details.txt--> <!--@include: ../markdown-snippets/error-type-details.txt-->
## Details ## Details
* The ATANH function utilizes the *atanh()* method provided by the [Rust Standard Library](https://doc.rust-lang.org/std/). * The ATANH function utilizes the *atanh()* method provided by the [Rust Standard Library](https://doc.rust-lang.org/std/).