MongoDB $atanh

No MongoDB, o $atanh o operador de pipeline de agregação retorna o arco tangente hiperbólico (tangente hiperbólica inversa) de um valor.

O valor de retorno está em radianos.

$atanh aceita qualquer expressão válida que resolva um número entre -1 e 1 .

O $atanh O operador foi introduzido no MongoDB 4.2.

Exemplo

Suponha que tenhamos uma coleção chamada test com o seguinte documento:

{ "_id" : 1, "data" : 0.5 }

Podemos usar o $atanh operador para retornar o arco tangente hiperbólico do data campo:

db.test.aggregate(
  [
    { $match: { _id: 1 } },
    { $project: { 
        _id: 0,
        hyperbolicArctangent: { $atanh: "$data" }
      }
    }
  ]
)

Resultado:

{ "hyperbolicArctangent" : 0.5493061443340549 }

Converter em graus

Como mencionado, $atanh retorna seu resultado em radianos. Você pode usar o $radiansToDegrees operador se você quiser o resultado em graus.

Exemplo:

db.test.aggregate(
  [
    { $match: { _id: 1 } },
    { $project: { 
        _id: 0,
        radians: { $atanh: "$data" },
        degrees: { $radiansToDegrees: { $atanh: "$data" } }
      }
    }
  ]
)

Resultado:

{ "radians" : 0.5493061443340549, "degrees" : 31.472923730945382 }

Neste exemplo, o primeiro campo apresenta o resultado em radianos e o segundo campo o apresenta em graus.

Valores decimais de 128 bits

Por padrão, o $atanh operador retorna valores como um double , mas também pode retornar valores como um decimal de 128 bits, desde que a expressão resolva para um valor decimal de 128 bits.

Suponha que adicionamos o seguinte documento à nossa coleção:

{ "_id" : 2, "data" : NumberDecimal("0.1301023541559787031443874490659") }

Vamos executar o $atanh operador contra esse documento:

db.test.aggregate(
  [
    { $match: { _id: 2 } },
    { $project: { 
        _id: 0,
        result: { $atanh: "$data" }
      }
    }
  ]
)

Resultado:

{ "result" : NumberDecimal("0.1308439651155512740523796431117568") }

A saída é decimal de 128 bits.

Valores fora do intervalo

O $atanh operador aceita qualquer expressão válida que resolva um número entre -1 e 1 . Valores fora desse intervalo causarão um erro.

Suponha que adicionamos o seguinte documento à nossa coleção:

{ "_id" : 3, "data" : 2 }

Vamos executar o $atanh operador contra esse documento:

db.test.aggregate(
  [
    { $match: { _id: 3 } },
    { $project: { 
        _id: 0,
        result: { $atanh: "$data" }
      }
    }
  ]
)

Resultado:

uncaught exception: Error: command failed: {
	"ok" : 0,
	"errmsg" : "cannot apply $atanh to 2, value must in [-1,1]",
	"code" : 50989,
	"codeName" : "Location50989"
} : aggregate failed :
example@sqldat.com/mongo/shell/utils.js:25:13
example@sqldat.com/mongo/shell/assert.js:18:14
example@sqldat.com/mongo/shell/assert.js:618:17
example@sqldat.com/mongo/shell/assert.js:708:16
example@sqldat.com/mongo/shell/db.js:266:5
example@sqldat.com/mongo/shell/collection.js:1046:12
@(shell):1:1

Valores nulos

Valores nulos retornam null ao usar o $atanh operador.

Suponha que adicionamos o seguinte documento à nossa coleção:

{ "_id" : 4, "data" : null }

Vamos executar o $atanh operador contra esse documento:

db.test.aggregate(
  [
    { $match: { _id: 4 } },
    { $project: { 
        _id: 0,
        result: { $atanh: "$data" }
      }
    }
  ]
)

Resultado:

{ "result" : null }

Podemos ver que o resultado é null .

Valores NaN

Se o argumento for resolvido para NaN , $atanh retorna NaN .

Exemplo:

db.test.aggregate(
  [
    { $match: { _id: 1 } },
    { $project: { 
        _id: 0,
        result: { $atanh: 1 * "$data" }
      }
    }
  ]
)

Resultado:

{ "result" : NaN }

Campos inexistentes

Se o $atanh operador é aplicado em um campo que não existe, null é devolvido.

Exemplo:

db.test.aggregate(
  [
    { $match: { _id: 1 } },
    { $project: { 
        _id: 0,
        result: { $atanh: "$name" }
      }
    }
  ]
)

Resultado:

{ "result" : null }

Infinito

Fornecendo Infinity ou -Infinity retornará um erro fora do intervalo (como vimos anteriormente).

Suponha que adicionamos o seguinte documento à coleção:

{ "_id" : 5, "data" : Infinity }

Vamos executar $atanh novamente:

db.test.aggregate(
  [
    { $match: { _id: 5 } },
    { $project: { 
        _id: 0,
        result: { $atanh: "$data" }
      }
    }
  ]
)

Resultado:

uncaught exception: Error: command failed: {
	"ok" : 0,
	"errmsg" : "cannot apply $atanh to inf, value must in [-1,1]",
	"code" : 50989,
	"codeName" : "Location50989"
} : aggregate failed :
example@sqldat.com/mongo/shell/utils.js:25:13
example@sqldat.com/mongo/shell/assert.js:18:14
example@sqldat.com/mongo/shell/assert.js:618:17
example@sqldat.com/mongo/shell/assert.js:708:16
example@sqldat.com/mongo/shell/db.js:266:5
example@sqldat.com/mongo/shell/collection.js:1046:12
@(shell):1:1