$atanh（聚合）

在此页面上

行为

例子

$atanh

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

$atanh 通过以下语法实现：

{ $atanh: <expression> }

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

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

默认情况下， $atanh以double形式返回值。只要<expression>解析为128位十进制值， $atanh也可以返回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" : NumberDecimal("0.5")
}

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

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

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

该命令返回以下输出：

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

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

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

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

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

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

该命令返回以下输出：

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

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

后退

$atan2

来年

$avg

行为

null、NaN 和+/- Infinity

例子

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