引数が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ビットの 10 進数として保存されているため、 $atanhの出力は128ビットの 10 進数になります。

trigonometryコレクションには、 2 -D グラフのx軸に沿って値を保存するドキュメントが含まれています。

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

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ビットの 10 進数として保存されているため、 $asinの出力は128ビットの 10 進数になります。

戻る

$atan2

$avg

動作

null、NaN 、+/- Infinity

例

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