MongoDB $atanh

En MongoDB, el $atanh El operador de canalización de agregación devuelve la arcotangente hiperbólica (tangente hiperbólica inversa) de un valor.

El valor de retorno está en radianes.

$atanh acepta cualquier expresión válida que se resuelva en un número entre -1 y 1 .

El $atanh El operador se introdujo en MongoDB 4.2.

Ejemplo

Supongamos que tenemos una colección llamada test con el siguiente documento:

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

Podemos usar el $atanh operador para devolver la arcotangente hiperbólica de los data campo:

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

Resultado:

{ "hyperbolicArctangent" : 0.5493061443340549 }

Convertir a Grados

Como se mencionó, $atanh devuelve su resultado en radianes. Puede usar el $radiansToDegrees operador si desea el resultado en grados.

Ejemplo:

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

Resultado:

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

En este ejemplo, el primer campo presenta el resultado en radianes y el segundo campo lo presenta en grados.

Valores decimales de 128 bits

Por defecto, el $atanh el operador devuelve valores como double , pero también puede devolver valores como un decimal de 128 bits siempre que la expresión se resuelva en un valor decimal de 128 bits.

Supongamos que agregamos el siguiente documento a nuestra colección:

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

Ejecutemos el $atanh operador contra ese documento:

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

Resultado:

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

La salida es decimal de 128 bits.

Valores fuera de rango

El $atanh el operador acepta cualquier expresión válida que se resuelva en un número entre -1 y 1 . Los valores fuera de ese rango generarán un error.

Supongamos que agregamos el siguiente documento a nuestra colección:

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

Ejecutemos el $atanh operador contra ese 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

Los valores nulos devuelven null cuando se usa el $atanh operador.

Supongamos que agregamos el siguiente documento a nuestra colección:

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

Ejecutemos el $atanh operador contra ese documento:

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

Resultado:

{ "result" : null }

Podemos ver que el resultado es null .

Valores NaN

Si el argumento se resuelve en NaN , $atanh devuelve NaN .

Ejemplo:

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

Resultado:

{ "result" : NaN }

Campos Inexistentes

Si el $atanh el operador se aplica a un campo que no existe, null es devuelto.

Ejemplo:

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

Resultado:

{ "result" : null }

Infinito

Proporcionando Infinity o -Infinity devolverá un error de fuera de rango (como vimos antes).

Supongamos que agregamos el siguiente documento a la colección:

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

Ejecutemos $atanh de nuevo:

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