Docs Home → MongoDB Manual

$asinh (aggregation)

On this page

$asinh

New in version 4.2.

Returns the inverse hyperbolic sine (hyperbolic arc sine) of a value.

$asinh has the following syntax:

{ $asinh: <expression> }

$asinh takes any valid expression that resolves to a number.

$asinh returns values in radians. Use $radiansToDegrees operator to convert the output value from radians to degrees.

By default $asinh returns values as a double. $asinh can also return values as a 128-bit decimal as long as the <expression> resolves to a 128-bit decimal value.

For more information on expressions, see Expressions.

Behavior

null, NaN, and +/- Infinity

If the argument resolves to a value of null or refers to a field that is missing, $asinh returns null. If the argument resolves to NaN, $asinh returns NaN. If the argument resolves to negative or positive infinity, $asinh returns negative or positive infinity respectively.

ExampleResults
{ $asinh: NaN }NaN
{ $asinh: null }null
{ $asinh : Infinity}Infinity
{ $asinh : -Infinity }-Infinity

Example