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

update: adds SINH documentation page

Browse Source
This commit is contained in:
Elsa Minsut
2025-08-20 18:02:23 +02:00
parent f3f59dbda7
commit f7a3b95db5
2 changed files with 32 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

BIN
docs/src/functions/images/hyperbolicsine-curve.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 66 KiB

37
docs/src/functions/math_and_trigonometry/sinh.md
View File

@@ -3,9 +3,36 @@ 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(<span title="Number" style="color:#1E88E5">number</span>) => <span title="Number" style="color:#1E88E5">sinh</span>**
### 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.
<!--@include: ../markdown-snippets/error-type-details.txt-->
## 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.
<center><img src="/functions/images/hyperbolicsine-curve.png" width="350" alt="Graph showing sinh(x)."></center>
## Examples
[See some examples in IronCalc](https://app.ironcalc.com/?example=sinh).
# 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).
:::
## 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.