$stdDevSamp (agregação)

Tipo de resultado

$stdDevSamp retorna o desvio padrão da amostra dos valores de entrada como double.

Valores não numéricos

$stdDevSamp ignora valores não numéricos. Se todos os operandos de uma soma não forem numéricos, $stdDevSamp retornará null.

Valor único

Se a amostra consistir em um único valor numérico, $stdDevSamp retornará null.

Operando de array

Nos estágios $group e $setWindowFields, se a expressão for resolvida em uma array, $stdDevSamp tratará o operando como um valor não numérico.

Nos outros estágios suportados:

• Com uma única expressão como operando, se a expressão for resolvida em uma array, $stdDevSamp percorre a array para operar nos elementos numéricos da array e retornar um único valor.

• Com uma lista de expressões como seu operando, se qualquer uma das expressões for resolvida para uma array, $stdDevSamp não atravessará a array, mas tratará a array como um valor não numérico.

Valores da janela

Comportamento com valores em uma $setWindowFields janela de estágio :

• Ignora valores não numéricos, valores null e campos ausentes em uma janela.

• Se a janela estiver vazia, retorna null.

• Se a janela contiver um valor NaN , retorna null.

• Se a janela contiver Infinity valores, retorna null.

• Se nenhum dos pontos anteriores se aplicar, retorna um valor double .

Uso no $group estágio

Uma collection users contém documento com os seguintes campo:

{_id: 0, username: "user0", age: 20}
{_id: 1, username: "user1", age: 42}
{_id: 2, username: "user2", age: 28}
...

Para calcular o desvio padrão de uma amostra de usuários, a operação de agregação a seguir usa primeiro o pipeline $sample para obter uma amostra de 100 usuários e, em seguida, usa $stdDevSamp para calcular o desvio padrão dos usuários amostrados.

db.users.aggregate(
   [
      { $sample: { size: 100 } },
      { $group: { _id: null, ageStdDev: { $stdDevSamp: "$age" } } }
   ]
)

A operação retorna um resultado como o seguinte:

{ "_id" : null, "ageStdDev" : 7.811258386185771 }

Uso no $setWindowFields estágio

Crie uma collection cakeSales que contenha vendas de bolo nos estados da Califórnia (CA) e de Washington (WA):

db.cakeSales.insertMany( [
   { _id: 0, type: "chocolate", orderDate: new Date("2020-05-18T14:10:30Z"),
     state: "CA", price: 13, quantity: 120 },
   { _id: 1, type: "chocolate", orderDate: new Date("2021-03-20T11:30:05Z"),
     state: "WA", price: 14, quantity: 140 },
   { _id: 2, type: "vanilla", orderDate: new Date("2021-01-11T06:31:15Z"),
     state: "CA", price: 12, quantity: 145 },
   { _id: 3, type: "vanilla", orderDate: new Date("2020-02-08T13:13:23Z"),
     state: "WA", price: 13, quantity: 104 },
   { _id: 4, type: "strawberry", orderDate: new Date("2019-05-18T16:09:01Z"),
     state: "CA", price: 41, quantity: 162 },
   { _id: 5, type: "strawberry", orderDate: new Date("2019-01-08T06:12:03Z"),
     state: "WA", price: 43, quantity: 134 }
] )

Este exemplo usa $stdDevSamp no estágio $setWindowFields para gerar o desvio padrão amostral dos valores quantity das vendas de bolo para cada state:

db.cakeSales.aggregate( [
   {
      $setWindowFields: {
         partitionBy: "$state",
         sortBy: { orderDate: 1 },
         output: {
            stdDevSampQuantityForState: {
               $stdDevSamp: "$quantity",
               window: {
                  documents: [ "unbounded", "current" ]
               }
            }
         }
      }
   }
] )

No exemplo:

• partitionBy: "$state" particiona os documentos na collection por state. Existem partições para CA e WA.

• sortBy: { orderDate: 1 } classifica os documentos em cada partição por orderDate em ordem crescente (1), para que o orderDate mais antigo seja o primeiro.

• output define o campo stdDevSampQuantityForState como o desvio padrão da amostra dos valores quantity usando $stdDevSamp que é executado em uma janela de documentos .

  A janela contém documentos entre um limite inferior unbounded e o documento current na saída. Isso significa que $stdDevSamp retorna o desvio padrão da amostra dos valores quantity para os documentos entre o início da partição e o documento atual.

Nessa saída, o valor do desvio padrão da amostra quantity para CA e WA é mostrado no campo stdDevSampQuantityForState :

{ "_id" : 4, "type" : "strawberry", "orderDate" : ISODate("2019-05-18T16:09:01Z"),
  "state" : "CA", "price" : 41, "quantity" : 162, "stdDevSampQuantityForState" : null }
{ "_id" : 0, "type" : "chocolate", "orderDate" : ISODate("2020-05-18T14:10:30Z"),
  "state" : "CA", "price" : 13, "quantity" : 120, "stdDevSampQuantityForState" : 29.698484809834994 }
{ "_id" : 2, "type" : "vanilla", "orderDate" : ISODate("2021-01-11T06:31:15Z"),
  "state" : "CA", "price" : 12, "quantity" : 145, "stdDevSampQuantityForState" : 21.1266025033211 }
{ "_id" : 5, "type" : "strawberry", "orderDate" : ISODate("2019-01-08T06:12:03Z"),
  "state" : "WA", "price" : 43, "quantity" : 134, "stdDevSampQuantityForState" : null }
{ "_id" : 3, "type" : "vanilla", "orderDate" : ISODate("2020-02-08T13:13:23Z"),
  "state" : "WA", "price" : 13, "quantity" : 104, "stdDevSampQuantityForState" : 21.213203435596427 }
{ "_id" : 1, "type" : "chocolate", "orderDate" : ISODate("2021-03-20T11:30:05Z"),
  "state" : "WA", "price" : 14, "quantity" : 140, "stdDevSampQuantityForState" : 19.28730152198591 }