diff --git a/docs/src/functions/images/hyperboliccosine-curve.png b/docs/src/functions/images/hyperboliccosine-curve.png new file mode 100644 index 0000000..587b11d Binary files /dev/null and b/docs/src/functions/images/hyperboliccosine-curve.png differ diff --git a/docs/src/functions/images/hyperbolicsine-curve.png b/docs/src/functions/images/hyperbolicsine-curve.png new file mode 100644 index 0000000..564c338 Binary files /dev/null and b/docs/src/functions/images/hyperbolicsine-curve.png differ diff --git a/docs/src/functions/images/hyperbolictangent-curve.png b/docs/src/functions/images/hyperbolictangent-curve.png new file mode 100644 index 0000000..0b9d1de Binary files /dev/null and b/docs/src/functions/images/hyperbolictangent-curve.png differ diff --git a/docs/src/functions/math-and-trigonometry.md b/docs/src/functions/math-and-trigonometry.md index 936dbee..51d212f 100644 --- a/docs/src/functions/math-and-trigonometry.md +++ b/docs/src/functions/math-and-trigonometry.md @@ -30,7 +30,7 @@ You can track the progress in this [GitHub issue](https://github.com/ironcalc/Ir | COMBIN | | – | | COMBINA | | – | | COS | | [COS](math_and_trigonometry/cos) | -| COSH | | – | +| COSH | | [COSH](math_and_trigonometry/cosh) | | COT | | – | | COTH | | – | | CSC | | – | @@ -78,7 +78,7 @@ You can track the progress in this [GitHub issue](https://github.com/ironcalc/Ir | SEQUENCE | | – | | SIGN | | – | | SIN | | [SIN](math_and_trigonometry/sin) | -| SINH | | – | +| SINH | | [SINH](math_and_trigonometry/sinh) | | SQRT | | – | | SQRTPI | | – | | SUBTOTAL | | – | @@ -91,5 +91,5 @@ You can track the progress in this [GitHub issue](https://github.com/ironcalc/Ir | SUMX2PY2 | | – | | SUMXMY2 | | – | | TAN | | [TAN](math_and_trigonometry/tan) | -| TANH | | – | +| TANH | | [TANH](math_and_trigonometry/tanh) | | TRUNC | | – | diff --git a/docs/src/functions/math_and_trigonometry/cosh.md b/docs/src/functions/math_and_trigonometry/cosh.md index 121f79a..577b876 100644 --- a/docs/src/functions/math_and_trigonometry/cosh.md +++ b/docs/src/functions/math_and_trigonometry/cosh.md @@ -3,9 +3,37 @@ layout: doc outline: deep lang: en-US --- +# COSH function +## Overview +COSH is a function of the Math and Trigonometry category that calculates the hyperbolic cosine of a number. +## Usage +### Syntax +**COSH(number) => cosh** +### Argument descriptions +* *number* ([number](/features/value-types#numbers), required). The hyperbolic angle whose hyperbolic cosine is to be calculated, expressed in radians. +### Additional guidance +The formula for the hyperbolic cosine is: +$$ +\text{cosh(x)} = \dfrac{e^x+e^{-x}}{2} +$$ +### Returned value +COSH returns a real [number](/features/value-types#numbers) that is the hyperbolic cosine of the specified hyperbolic angle. +### Error conditions +* In common with many other IronCalc functions, COSH propagates errors that are found in its argument. +* If no argument, or more than one argument, is supplied, then COSH 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 COSH returns the [`#VALUE!`](/features/error-types.md#value) error. +* For some argument values, COSH may return a [`#DIV/0!`](/features/error-types.md#div-0) error. + +## Details +* The COSH function utilizes the *cosh()* method provided by the [Rust Standard Library](https://doc.rust-lang.org/std/). +* The figure below illustrates the COSH function. +
Graph showing cosh(x).
-# COSH +## Examples +[See some examples in IronCalc](https://app.ironcalc.com/?example=cosh). -::: 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 +## Links +* For more information about hyperbolic functions, visit Wikipedia's [Hyperbolic functions](https://en.wikipedia.org/wiki/Hyperbolic_functions) page. +* See also IronCalc's [SINH](/functions/math_and_trigonometry/sinh), [COS](/functions/math_and_trigonometry/cos) and [TAN](/functions/math_and_trigonometry/tan) functions. +* Visit Microsoft Excel's [COSH function](https://support.microsoft.com/en-us/office/cosh-function-e460d426-c471-43e8-9540-a57ff3b70555) page. +* Both [Google Sheets](https://support.google.com/docs/answer/3093477) and [LibreOffice Calc](https://wiki.documentfoundation.org/Documentation/Calc_Functions/COSH) provide versions of the COSH function. \ No newline at end of file diff --git a/docs/src/functions/math_and_trigonometry/sinh.md b/docs/src/functions/math_and_trigonometry/sinh.md index 29a6a2d..7d0a686 100644 --- a/docs/src/functions/math_and_trigonometry/sinh.md +++ b/docs/src/functions/math_and_trigonometry/sinh.md @@ -3,9 +3,37 @@ layout: doc outline: deep lang: en-US --- +# SINH function +## Overview +SINH is a function of the Math and Trigonometry category that calculates the hyperbolic sine of a number. +## Usage +### Syntax +**SINH(number) => sinh** +### Argument descriptions +* *number* ([number](/features/value-types#numbers), required). The hyperbolic angle whose hyperbolic sine is to be calculated, expressed in radians. +### Additional guidance +The formula for the hyperbolic sine is: +$$ +\text{sinh(x)} = \dfrac{e^x-e^{-x}}{2} +$$ +### Returned value +SINH returns a real [number](/features/value-types#numbers) that is the hyperbolic sine of the specified hyperbolic angle. +### Error conditions +* In common with many other IronCalc functions, SINH propagates errors that are found in its argument. +* If no argument, or more than one argument, is supplied, then SINH 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 SINH returns the [`#VALUE!`](/features/error-types.md#value) error. +* For some argument values, SINH may return a [`#DIV/0!`](/features/error-types.md#div-0) error. + +## Details +* The SINH function utilizes the *sinh()* method provided by the [Rust Standard Library](https://doc.rust-lang.org/std/). +* The figure below illustrates the SINH function. +
Graph showing sinh(x).
-# SINH +## Examples +[See some examples in IronCalc](https://app.ironcalc.com/?example=sinh). -::: 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 +## Links +* For more information about hyperbolic functions, visit Wikipedia's [Hyperbolic functions](https://en.wikipedia.org/wiki/Hyperbolic_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 [SINH function](https://support.microsoft.com/en-us/office/sinh-function-4958f7e2-0d2b-4846-8ef5-8475f3aea5fb) page. +* Both [Google Sheets](https://support.google.com/docs/answer/3093517) and [LibreOffice Calc](https://wiki.documentfoundation.org/Documentation/Calc_Functions/SINH) provide versions of the SINH function. \ No newline at end of file diff --git a/docs/src/functions/math_and_trigonometry/tanh.md b/docs/src/functions/math_and_trigonometry/tanh.md index 561856b..189a378 100644 --- a/docs/src/functions/math_and_trigonometry/tanh.md +++ b/docs/src/functions/math_and_trigonometry/tanh.md @@ -3,9 +3,37 @@ layout: doc outline: deep lang: en-US --- +# TANH function +## Overview +TANH is a function of the Math and Trigonometry category that calculates the hyperbolic tangent of a number. +## Usage +### Syntax +**TANH(number) => tanh** +### Argument descriptions +* *number* ([number](/features/value-types#numbers), required). The hyperbolic angle whose hyperbolic tangent is to be calculated, expressed in radians. +### Additional guidance +The formula for the hyperbolic tangent is: +$$ +\text{tanh(x)} = \dfrac{sinh(x)}{cosh(x)} = \dfrac{e^x-e^{-x}}{e^x+e^{-x}} +$$ +### Returned value +TANH returns a real [number](/features/value-types#numbers) in the range (-1,+1) that is the hyperbolic tangent of the specified hyperbolic angle. +### Error conditions +* In common with many other IronCalc functions, TANH propagates errors that are found in its argument. +* If no argument, or more than one argument, is supplied, then TANH 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 TANH returns the [`#VALUE!`](/features/error-types.md#value) error. +* For some argument values, TANH may return a [`#DIV/0!`](/features/error-types.md#div-0) error. + +## Details +* The TANH function utilizes the *tanh()* method provided by the [Rust Standard Library](https://doc.rust-lang.org/std/). +* The figure below illustrates the TANH function. +
Graph showing tanh(x).
-# TANH +## Examples +[See some examples in IronCalc](https://app.ironcalc.com/?example=tanh). -::: 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 +## Links +* For more information about hyperbolic functions, visit Wikipedia's [Hyperbolic functions](https://en.wikipedia.org/wiki/Hyperbolic_functions) page. +* See also IronCalc's [SINH](/functions/math_and_trigonometry/sinh), [COSH](/functions/math_and_trigonometry/cosh) and [TAN](/functions/math_and_trigonometry/tan) functions. +* Visit Microsoft Excel's [TANH function](https://support.microsoft.com/en-us/office/tanh-function-017222f0-a0c3-4f69-9787-b3202295dc6c) page. +* Both [Google Sheets](https://support.google.com/docs/answer/3093755) and [LibreOffice Calc](https://wiki.documentfoundation.org/Documentation/Calc_Functions/TANH) provide versions of the TANH function. \ No newline at end of file