$asinh (aggregation)

On this page本页内容

$asinh

New in version 4.2.在版本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.使用$radiansToDegrees运算符将输出值从弧度转换为度。

By default $asinh returns values as a double. 默认情况下,$asinhdouble返回值。$asinh can also return values as a 128-bit decimal as long as the <expression> resolves to a 128-bit decimal value.只要<expression>解析为128位十进制值,也可以以128位十进制返回值。

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. 如果参数解析为null值或引用缺少的字段,$asinh返回null值。If the argument resolves to NaN, $asinh returns NaN. 如果参数解析为NaN$asinh返回NaNIf the argument resolves to negative or positive infinity, $asinh returns negative or positive infinity respectively.如果参数解析为负或正无穷大,$asinh分别返回负或正无限大。

Example示例Results结果
{ $asinh: NaN }NaN
{ $asinh: null }null
{ $asinh : Infinity}Infinity
{ $asinh : -Infinity }-Infinity

Example示例

The trigonometry collection contains a document that stores a value along the x axis of a 2-D graph:

{
  "_id" : ObjectId("5c50782193f833234ba90d85"),
  "x-coordinate" : NumberDecimal("1")
}

The following aggregation operation uses the $asinh expression to calculate inverse hyperbolic sine of x-coordinate and add it to the input document using the $addFields pipeline stage.

db.trigonometry.aggregate([
  {
    $addFields : {
      "y-coordinate" : {
        $radiansToDegrees : { $asinh : "$x-coordinate" }
      }
    }
  }
])

The $radiansToDegrees expression converts the radian value returned by $asinh to the equivalent value in degrees.

The command returns the following output:

{
  "_id" : ObjectId("5c50782193f833234ba90d85"),
  "x-coordinate" : NumberDecimal("1"),
  "y-coordinate" : NumberDecimal("50.49898671052621144221476300417157")
}

Since x-coordinate is stored as a 128-bit decimal, the output of $asinh is a 128-bit decimal.

The trigonometry collection contains a document that stores a value along the x axis of a 2-D graph:

{
  "_id" : ObjectId("5c50782193f833234ba90d85"),
  "x-coordinate" : NumberDecimal("1")
}

The following aggregation operation uses the $asinh expression to calculate inverse hyperbolic sine of x-coordinate and add it to the input document using the $addFields pipeline stage.

db.trigonometry.aggregate([
  {
    $addFields : {
      "y-coordinate" : {
        $asinh : "$x-coordinate"
      }
    }
  }
])

The command returns the following output:

{
  "_id" : ObjectId("5c50782193f833234ba90d85"),
  "x-coordinate" : NumberDecimal("1"),
  "y-coordinate" : NumberDecimal("1.818446459232066823483698963560709")
}

Since x-coordinate is stored as a 128-bit decimal, the output of $asinh is a 128-bit decimal.

←  $asin (aggregation)$atan (aggregation) →