MongoDB $ ln

Dans MongoDB, le $ln l'opérateur de pipeline d'agrégation calcule le logarithme népérien (ln ) d'un nombre et renvoie le résultat sous la forme d'un double.

Syntaxe

La syntaxe ressemble à ceci :

{ $ln: <number> }

Où <number> peut être n'importe quelle expression valide qui se résout en un nombre non négatif.

Exemple

Supposons que nous ayons une collection appelée test avec le document suivant :

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

Nous pouvons utiliser le $ln opérateur pour retourner le logarithme népérien de la data champ :

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

Résultat :

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

Une autre façon de faire cela aurait été d'utiliser le $log opérateur avec un deuxième argument de Math.E . Voir MongoDB $log pour un exemple.

Logarithme naturel

Le logarithme naturel d'un nombre est son logarithme à la base de la constante mathématique e , où e est un nombre irrationnel et transcendantal qui commence par 2,7182818284590452353602874713527 et continue indéfiniment.

La constante mathématique e est également connu sous le nom de nombre d'Euler.

En JavaScript, nous pouvons utiliser Math.E représenter e . On peut donc obtenir le logarithme népérien de e en utilisant Math.E comme argument lors de l'utilisation de $ln .

Supposons que nous ayons un document comme celui-ci :

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

Le champ de données contient e à 15 décimales.

Cet exemple utilise deux façons de renvoyer le logarithme naturel de e :

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

Résultat :

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

Le premier résultat utilise les données du document. Pour le deuxième résultat, nous utilisons Math.E pour générer e .

Dans tous les cas, le résultat est 1 .

Valeurs hors plage

Comme mentionné, le $ln L'opérateur accepte toute expression valide qui se résout en un nombre non négatif. Les valeurs en dehors de cette plage entraîneront une erreur.

Supposons que nous ajoutions le document suivant à notre collection :

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

Exécutons le $ln opérateur sur ce document :

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

Résultat :

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 :
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:639:17
example@sqldat.com/mongo/shell/assert.js:729:16
example@sqldat.com/mongo/shell/db.js:266:5
example@sqldat.com/mongo/shell/collection.js:1058:12
@(shell):1:1

Type de données incorrect

Fournir le mauvais type de données entraînera également une erreur.

Supposons que nous ajoutions le document suivant à notre collection :

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

Exécutons le $ln opérateur sur ce document :

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

Résultat :

uncaught exception: Error: command failed: {
	"ok" : 0,
	"errmsg" : "$ln only supports numeric types, not string",
	"code" : 28765,
	"codeName" : "Location28765"
} : 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:639:17
example@sqldat.com/mongo/shell/assert.js:729:16
example@sqldat.com/mongo/shell/db.js:266:5
example@sqldat.com/mongo/shell/collection.js:1058:12
@(shell):1:1

Nous avons fourni une chaîne, et donc le message d'erreur nous indique que $ln only supports numeric types, not string .

Valeurs nulles

Les valeurs nulles renvoient null lors de l'utilisation du $ln opérateur.

Supposons que nous ajoutions le document suivant à notre collection :

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

Exécutons le $ln opérateur sur ce document :

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

Résultat :

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

Nous pouvons voir que le résultat est null .

Valeurs NaN

Si l'argument se résout en NaN , $ln renvoie NaN .

Exemple :

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

Résultat :

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

Champs inexistants

Si le $ln l'opérateur est appliqué sur un champ qui n'existe pas, null est renvoyé.

Exemple :

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

Résultat :

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

Dans ce cas, nous avons essayé d'appliquer $ln contre un champ appelé age , mais ce champ n'existe pas dans le document, et nous obtenons donc null .