/ /

$stdDevPop（アキュムレータ演算子）

定義

$stdDevPop

バージョン5.0で変更。

Calculates the population standard deviation of the input values. Use if the values encompass the entire population of data you want to represent and do not wish to generalize about a larger population. $stdDevPop ignores non-numeric values.

値が母集団を一般化するデータのサンプルのみを表す場合は、代わりに$stdDevSampを使用します。

$stdDevPop は、次のステージで使用できます。

$addFields
$group
$expr 式を含む $match ステージ
$project
$replaceRoot
$replaceWith
$set
$setWindowFields （MongoDB 5.0 以降で使用可能）

構文

When used in the $bucket, $bucketAuto, $group, and $setWindowFields stages, $stdDevPop has this syntax:

{ $stdDevPop: <expression> }

When used in other supported stages, $stdDevPop has one of two syntaxes:

$stdDevPop にはオペランドとして指定された式が 1 つあります。
{ $stdDevPop: <expression> }
$stdDevPop にはオペランドとして指定された式のリストがあります。
{ $stdDevPop: [ <expression1>, <expression2> ... ] }

The argument for $stdDevPop can be any expression as long as it resolves to an array.

式の詳細については、「式」を参照してください。

動作

結果の型

$stdDevPop 入力値の母集団標準偏差をdoubleとして返します。

Non-numeric Values

$stdDevPop ignores non-numeric values. If all operands for a $stdDevPop are non-numeric, $stdDevPop returns null.

単一の値

If the sample consists of a single numeric value, $stdDevPop returns 0.

配列オペランド

In the $group and $setWindowFields stages, if the expression resolves to an array, $stdDevPop treats the operand as a non-numerical value and has no effect on the calculation.

サポートされている他のステージでは、次のようになります。

With a single expression as its operand, if the expression resolves to an array, $stdDevPop traverses into the array to operate on the numeric elements of the array to return a single value.
With a list of expressions as its operand, if any of the expressions resolves to an array, $stdDevPop does not traverse into the array but instead treats the array as a non-numeric value.

Window Values

$setWindowFieldsステージウィンドウ内の値に関する動作

ウィンドウ内の数値以外の値、 null値、欠落しているフィールドは無視されます。
ウィンドウが空の場合、はnullを返します。
ウィンドウにNaNの値が含まれている場合、はnullを返します。
ウィンドウにInfinityの値が含まれている場合、はnullを返します。
上記の点のいずれにも当てはまらない場合、はdouble値を返します。

例

`$group` ステージで使用

次のドキュメントを含むusersというコレクションを作成します。

db.users.insertMany( [
   { _id : 1, name : "dave123", quiz : 1, score : 85 },
   { _id : 2, name : "dave2", quiz : 1, score : 90 },
   { _id : 3, name : "ahn", quiz : 1, score : 71 },
   { _id : 4, name : "li", quiz : 2, score : 96 },
   { _id : 5, name : "annT", quiz : 2, score : 77 },
   { _id : 6, name : "ty", quiz : 2, score : 82 }
] )

次の例では、各クイズの標準偏差を計算します。

db.users.aggregate( [
   { $group: { _id: "$quiz", stdDev: { $stdDevPop: "$score" } } }
] )

この操作は次の結果を返します。

{ "_id" : 2, "stdDev" : 8.04155872120988 }
{ "_id" : 1, "stdDev" : 8.04155872120988 }

`$project` ステージで使用

次のドキュメントを使用して、 quizzesという名前のサンプルコレクションを作成します。

db.quizzes.insertMany( [
   {
      _id : 1,
      scores : [
         { name : "dave123", score : 85 },
         { name : "dave2", score : 90 },
         { name : "ahn", score : 71 }
      ]
   },
   {
      _id : 2,
      scores : [
         { name : "li", quiz : 2, score : 96 },
         { name : "annT", score : 77 },
         { name : "ty", score : 82 }
      ]
   }
] )

次の例では、各クイズの標準偏差を計算します。

db.quizzes.aggregate( [
   { $project: { stdDev: { $stdDevPop: "$scores.score" } } }
] )

この操作は次の結果を返します。

{ _id : 1, stdDev : 8.04155872120988 }
{ _id : 2, stdDev : 8.04155872120988 }

`$setWindowFields` ステージで使用

バージョン 5.0 の新機能。

カリフォルニア州（CA）とワシントン州（WA）のケーキ販売を含む cakeSales コレクションを作成します。

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 }
] )

This example uses $stdDevPop in the $setWindowFields stage to output the population standard deviation of the cake sales quantity for each state:

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

この例では、次のことが行われます。

partitionBy: "$state" はコレクション内のドキュメントを state で分割します。CA と WA のパーティションがあります。
sortBy: { orderDate: 1 } は、各パーティション内のドキュメントを orderDate で昇順（1）に並べ替えるので、最も古い orderDate が最初になります。

output sets the stdDevPopQuantityForState field to the quantity population standard deviation value using $stdDevPop that is run in a documents window.

The window contains documents between an unbounded lower limit and the current document in the output. This means $stdDevPop returns the quantity population standard deviation value for the documents between the beginning of the partition and the current document.

この出力例では、 CAとWAのquantity母標準偏差がstdDevPopQuantityForStateフィールドに表示されています。

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