Menu Docs

Página inicial do Docs → Desenvolver aplicações → Manual do MongoDB

$atanh (agregação)

Nesta página

  • Comportamento
  • Exemplo
$atanh

Novidades na versão 4.2.

Retorna a tangente hiperbólica inversa (tangente do arco hiperbólico) de um valor.

$atanh tem a seguinte sintaxe:

{ $atanh: <expression> }

$atanh usa qualquer expressão válida que resulte em um número entre -1 e 1, por exemplo, -1 <= value <= 1.

$atanh retorna valores em radianos. Use o operador $radiansToDegrees para converter o valor de saída de radianos para graus.

Por padrão , $atanh retorna valores como double. $atanh também pode retornar valores como um decimal128bits , desde que o <expression> resolva para um valor decimal 128bits.

Para mais informações sobre expressões, consulte Operadores de Expressão.

Comportamento

null, NaN e +/- Infinity

Se o argumento for resolvido para um valor de null ou se referir a um campo ausente, $atanh retornará null. Se o argumento se resolve em NaN, $atanh retorna NaN. Se o argumento resolver para infinito negativo ou positivo, $atanh lançará um erro. Se o argumento se resolve em +1 ou -1, $atanh retornará Infinity e -Infinity respectivamente.

Exemplo
Resultados
{ $atanh: NaN }
NaN
{ $atanh: null }
null
{ $atanh: 1 }
Infinity
{ $atanh: -1}
-Infinity

{ $atanh : Infinity}

ou

{ $atanh : -Infinity }

Lança uma mensagem de erro semelhante à seguinte saída formatada:

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

Exemplo

← $atan2 (agregação)
$avg (agregação) →

Nesta página