/ /

$atanh（表达式操作符）

$atanh

返回某个值的反双曲正切（双曲弧正切）值。

$atanh 通过以下语法实现：

{ $atanh: <expression> }

$atanh-1可接受解析为和1 之间数字的任何有效表达式，例如-1 <= value <= 1 。

$atanh以弧度为单位返回值。使用$radiansToDegrees 操作符将输出值从弧度转换为度数。

默认下，$atanh 128 $atanh返回double<expression> 128形式的值。只要解析为位十进制值，也可以返回位十进制值。

有关表达式的更多信息，请参阅表达式。

行为

`null`、`NaN` 和`+/- Infinity`

如果参数解析为null 的值或引用了缺失的字段，$atanh 将返回null 。如果参数解析为NaN ，$atanh 将返回NaN $atanh。如果参数解析为负无穷大或正无穷大，会引发错误。如果参数解析为+1 或-1 ，则$atanh 分别返回Infinity 和-Infinity 。

例子

结果

{ $atanh: NaN }

NaN

{ $atanh: null }

null

{ $atanh: 1 }

Infinity

{ $atanh: -1}

-Infinity

{ $atanh : Infinity}

{ $atanh : -Infinity }

抛出一条类似以下格式化输出的错误消息：

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

例子

trigonometry 集合包含一个文档，该文档沿 2-D 图的 x 轴存储值：

{
  "_id" : ObjectId("5c50782193f833234ba90d85"),
  "x-coordinate" : Decimal128("0.5")
}

以下聚合操作使用表达式计算$atanh x-coordinate的反双曲正切，并使用$addFields 管道阶段将其添加到输入文档。

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

$radiansToDegrees表达式将$atanh 返回的弧度值转换为等效的度数值。

该命令返回以下输出：

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

由于x-coordinate 128存储为位十进制数，因此$atanh 的输出为128 位十进制数。

trigonometry 集合包含一个文档，该文档沿 2-D 图的 x 轴存储值：

{
  "_id" : ObjectId("5c50782193f833234ba90d85"),
  "x-coordinate" : Decimal128("0.5")
}

以下聚合操作使用表达式计算$atanh x-coordinate的反双曲正切，并使用$addFields 管道阶段将其添加到输入文档。

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

该命令返回以下输出：

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

由于x-coordinate 128存储为位十进制数，因此$asin 的输出为128 位十进制数。

$atanh（表达式操作符）

行为

null、NaN 和+/- Infinity

例子

`null`、`NaN` 和`+/- Infinity`