MongoDB $ln

En MongoDB, el $ln El operador de tubería de agregación calcula el logaritmo natural (ln ) de un número y devuelve el resultado como un doble.

Sintaxis

La sintaxis es así:

{ $ln: <number> }

Donde <number> puede ser cualquier expresión válida que se resuelva en un número no negativo.

Ejemplo

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

{ "_id" : 1, "data" : 0.5 }
{ "_id" : 2, "data" : 20 }
{ "_id" : 3, "data" : 200 }

Podemos usar el $ln operador para devolver el logaritmo natural de los data campo:

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

Resultado:

{ "data" : 0.5, "result" : -0.6931471805599453 }
{ "data" : 20, "result" : 2.995732273553991 }
{ "data" : 200, "result" : 5.298317366548036 }

Otra forma de hacer esto habría sido usar el $log operador con un segundo argumento de Math.E . Ver MongoDB $log para un ejemplo.

Logaritmo Natural

El logaritmo natural de un número es su logaritmo en base a la constante matemática e , donde e es un número irracional y trascendental que comienza con 2.7182818284590452353602874713527 y continúa para siempre.

La constante matemática e también se conoce como número de Euler.

En JavaScript, podemos usar Math.E para representar e . Por lo tanto, podemos obtener el logaritmo natural de e usando Math.E como argumento cuando se usa $ln .

Supongamos que tenemos un documento como este:

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

El campo de datos contiene e hasta 15 decimales.

Este ejemplo utiliza dos formas de devolver el logaritmo natural de e :

db.test.aggregate(
  [
    { $match: { _id: { $in: [ 4 ] } } },
    {
      $project:
        { 
          _id: 0,
          e_1: { $ln: [ "$data" ] },
          e_2: { $ln: [ Math.E ] }
        }
    }
  ]
)

Resultado:

{ "e_1" : 1, "e_2" : 1 }

El primer resultado utiliza los datos del documento. Para el segundo resultado, usamos Math.E para generar e .

De cualquier manera, el resultado es 1 .

Valores fuera de rango

Como se mencionó, el $ln El operador acepta cualquier expresión válida que se resuelva en un número no negativo. Los valores fuera de ese rango generarán un error.

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

{ "_id" : 5, "data" : -20 }

Ejecutemos el $ln operador contra ese documento:

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

Resultado:

uncaught exception: Error: command failed: {
	"ok" : 0,
	"errmsg" : "$ln's argument must be a positive number, but is -20",
	"code" : 28766,
	"codeName" : "Location28766"
} : aggregate failed :
[email protected]/mongo/shell/utils.js:25:13
[email protected]/mongo/shell/assert.js:18:14
[email protected]/mongo/shell/assert.js:639:17
[email protected]/mongo/shell/assert.js:729:16
[email protected]/mongo/shell/db.js:266:5
[email protected]/mongo/shell/collection.js:1058:12
@(shell):1:1

Tipo de datos incorrecto

Proporcionar el tipo de datos incorrecto también provocará un error.

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

{ "_id" : 6, "data" : "Ten" }

Ejecutemos el $ln operador contra ese documento:

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

Resultado:

uncaught exception: Error: command failed: {
	"ok" : 0,
	"errmsg" : "$ln only supports numeric types, not string",
	"code" : 28765,
	"codeName" : "Location28765"
} : aggregate failed :
[email protected]/mongo/shell/utils.js:25:13
[email protected]/mongo/shell/assert.js:18:14
[email protected]/mongo/shell/assert.js:639:17
[email protected]/mongo/shell/assert.js:729:16
[email protected]/mongo/shell/db.js:266:5
[email protected]/mongo/shell/collection.js:1058:12
@(shell):1:1

Proporcionamos una cadena, por lo que el mensaje de error nos dice que $ln only supports numeric types, not string .

Valores nulos

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

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

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

Ejecutemos el $ln operador contra ese documento:

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

Resultado:

{ "data" : null, "result" : null }

Podemos ver que el resultado es null .

Valores NaN

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

Ejemplo:

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

Resultado:

{ "data" : 0.5, "result" : NaN }

Campos Inexistentes

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

Ejemplo:

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

Resultado:

{ "data" : 0.5, "result" : null }

En este caso intentamos aplicar $ln contra un campo llamado age , pero ese campo no existe en el documento, por lo que obtenemos null .