

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

# $atanah
<a name="atanh"></a>

Novo na versão 8.0.1.

O `$atanh` operador no Amazon DocumentDB retorna a tangente hiperbólica inversa (tangente do arco hiperbólico) de um valor.

A expressão de entrada deve ser resolvida para um número no intervalo de `-1` até `1` (inclusive). Valores fora desse intervalo causam um erro.

O tipo de retorno é `double` por padrão. Se a entrada for decimal de 128 bits, a saída também será decimal de 128 bits.

**Parâmetros**
+ `expression`: uma expressão que se resolve em um número entre `-1` e`1`, inclusive.

## Comportamento
<a name="atanh-behavior"></a>

**null, NaN e \+/- Infinito **


| Exemplo | Resultados | 
| --- | --- | 
| { $atanh: NaN } | NaN | 
| { $atanh: null } | null | 
| { $atanh: 1 } | Infinity | 
| { $atanh: -1 } | -Infinity | 
| { $atanh: Infinity } ou { $atanh: -Infinity } | Lança um erro. | 

Quando a entrada está `null` ou o campo referenciado está ausente, o resultado é`null`. Uma entrada de `NaN` produtos`NaN`. Os valores limite `1` e `-1` produzem `Infinity` e, `-Infinity` respectivamente. Qualquer valor fora do `[-1, 1]` intervalo (inclusive`±Infinity`) causa um erro.

## Exemplo (MongoDB Shell)
<a name="atanh-examples"></a>

O exemplo a seguir mostra como usar o `$atanh` operador para calcular a tangente hiperbólica inversa de um valor.

**Crie documentos de amostra **

```
db.values.insertMany([
  { "_id": 1, "value": 0 },
  { "_id": 2, "value": 0.5 },
  { "_id": 3, "value": -0.5 }
]);
```

**Exemplo de consulta **

```
db.values.aggregate([
  { $project: {
    "result": { $atanh: "$value" }
  }}
]);
```

**Saída**

```
[
  { "_id": 1, "result": 0 },
  { "_id": 2, "result": 0.5493061443340548 },
  { "_id": 3, "result": -0.5493061443340548 }
]
```

## Exemplos de código
<a name="atanh-code"></a>

Para ver um exemplo de código para usar o `$atanh` operador, escolha a guia do idioma que você deseja usar:

------
#### [ Node.js ]

```
const { MongoClient } = require('mongodb');

async function main() {
  const client = await MongoClient.connect('mongodb://<username>:<password>@<cluster-endpoint>:27017/?tls=true&tlsCAFile=global-bundle.pem&replicaSet=rs0&readPreference=secondaryPreferred&retryWrites=false');
  const db = client.db('test');
  const collection = db.collection('values');

  const result = await collection.aggregate([
    { $project: {
      "result": { $atanh: "$value" }
    }}
  ]).toArray();

  console.log(result);
  await client.close();
}

main();
```

------
#### [ Python ]

```
from pymongo import MongoClient

def main():
    client = MongoClient('mongodb://<username>:<password>@<cluster-endpoint>:27017/?tls=true&tlsCAFile=global-bundle.pem&replicaSet=rs0&readPreference=secondaryPreferred&retryWrites=false')
    db = client['test']
    collection = db['values']

    result = list(collection.aggregate([
        { '$project': {
            'result': { '$atanh': '$value' }
        }}
    ]))

    print(result)
    client.close()

if __name__ == "__main__":
    main()
```

------