$atanh (aggregation)

On this page本页内容

$atanh

New in version 4.2.在版本4.2中新增。

Returns the inverse hyperbolic tangent (hyperbolic arc tangent) of a value.返回值的反双曲正切（双曲正切）。

$atanh has the following syntax:语法如下：

{ $atanh: <expression> }

$atanh takes any valid expression that resolves to a number between -1 and 1, e.g. -1 <= value <= 1.接受解析为-1和1之间的数字的任何有效表达式，例如-1<=value<=1。

$atanh returns values in radians. 返回以弧度为单位的值。Use $radiansToDegrees operator to convert the output value from radians to degrees.使用$radiansToDegrees运算符将输出值从弧度转换为度。

By default $atanh returns values as a double. 默认情况下，$atanh以double返回值。$atanh can also return values as a 128-bit decimal as long as the <expression> resolves to a 128-bit decimal value.$atanh还可以以128位十进制返回值，只要<expression>解析为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, $atanh returns null. 如果参数解析为null值或引用缺少的字段，$atanh返回null值。If the argument resolves to NaN, $atanh returns NaN. 如果参数解析为NaN，$atanh返回NaN。If the argument resolves to negative or positive infinity, $atanh throws an error. 如果参数解析为负或正无穷大，$atanh抛出错误。If the argument resolves to +1 or -1, $atanh returns Infinity and -Infinity respectively.如果参数解析为+1或-1，$atanh分别返回Infinity和-Infinity。

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

{ $atanh : Infinity}

or

{ $atanh : -Infinity }

Throws an error message resembling the following formatted output:抛出类似以下格式化输出的错误消息：

"errmsg" :
  "Failed to optimize pipeline :: caused by :: cannot
  apply $atanh to -inf, value must in (-inf,inf)"

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("0.5")
}

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

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

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

The command returns the following output:

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

Since x-coordinate is stored as a 128-bit decimal, the output of $atanh 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("0.5")
}

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

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

The command returns the following output:

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

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

←  $atan2 (aggregation)$avg (aggregation) →