diff --git a/docs/src/functions/images/arctangent-curve.png b/docs/src/functions/images/arctangent-curve.png new file mode 100644 index 0000000..05dc9e7 Binary files /dev/null and b/docs/src/functions/images/arctangent-curve.png differ diff --git a/docs/src/functions/math_and_trigonometry/atan.md b/docs/src/functions/math_and_trigonometry/atan.md index cb387e4..3e4b3d6 100644 --- a/docs/src/functions/math_and_trigonometry/atan.md +++ b/docs/src/functions/math_and_trigonometry/atan.md @@ -4,8 +4,34 @@ outline: deep lang: en-US --- -# ATAN +# ATAN function +## Overview +ATAN is a function of the Math and Trigonometry category that calculates the inverse tangent (arctangent) of a number, returning an angle in the range [-$\pi$/2 to +$\pi$/2], expressed in radians. +## Usage +### Syntax +**ATAN (number) => atan** +### Argument descriptions +* *number* ([number](/features/value-types#numbers), required). The number whose arctangent is to be calculated, in the range [-$\infty$, +$\infty$]. +### Additional guidance +None. +### Returned value +ATAN returns a number in radians in the range [-$\pi$/2 to +$\pi$/2] that is the angle whose tangent is the specified number. +### Error conditions +* In common with many other IronCalc functions, ATAN propagates errors that are found in its argument. +* If no argument, or more than one argument, is supplied, then ATAN 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 ATAN returns the [`#VALUE!`](/features/error-types.md#value) error. +* For some argument values, ATAN may return a [`#DIV/0!`](/features/error-types.md#div-0) error. + +## Details +* The ATAN function utilizes the *atan()* method provided by the [Rust Standard Library](https://doc.rust-lang.org/std/). +* The figure below illustrates the output of the ATAN function for angles $x$ in the range [-$\infty$, +$\infty$]. +
Graph showing atan(x) for x between [-$\infty$, +$\infty$].
-::: 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=acos). + +## 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 [SIN](/functions/math_and_trigonometry/sin), [COS](/functions/math_and_trigonometry/cos) and [TAN](/functions/math_and_trigonometry/tan) functions. +* Visit Microsoft Excel's [ATAN function](https://support.microsoft.com/en-us/office/atan-function-50746fa8-630a-406b-81d0-4a2aed395543) page. +* Both [Google Sheets](https://support.google.com/docs/answer/3093395) and [LibreOffice Calc](https://wiki.documentfoundation.org/Documentation/Calc_Functions/ATAN) provide versions of the ATAN function.