[インデックス 14902] ファイルの概要

このコミットは、Go言語の公式仕様書である doc/go_spec.html の内容を更新し、マップのイテレーション中に要素が挿入された場合の挙動に関する記述を明確化したものです。特に、イテレーション中に新しく作成されたエントリがイテレーション中に生成されるかスキップされるか、その選択がエントリごと、およびイテレーションごとに異なる可能性があることを明記しています。

コミット

commit ced57153df76f501b3f9b7efdc974c0725bcd594
Author: Shenghou Ma <minux.ma@gmail.com>
Date:   Thu Jan 17 23:11:25 2013 +0800

    doc/go_spec.html: clarification about insertion during map iteration

    R=mdempsky, iant, r, gri, rsc, ken
    CC=golang-dev
    https://golang.org/cl/7100046

GitHub上でのコミットページへのリンク

https://github.com/golang/go/commit/ced57153df76f501b3f9b7efdc974c0725bcd594

元コミット内容

doc/go_spec.html: clarification about insertion during map iteration

このコミットは、Go言語の仕様書において、マップのイテレーション中に要素が挿入された場合の挙動について明確化を行うものです。

変更の背景

Go言語のマップ（map）は、キーと値のペアを格納するハッシュテーブルとして実装されています。その性質上、要素の順序は保証されず、イテレーションの順序も特定されません。初期のGo言語の仕様では、マップのイテレーション中に要素が削除された場合の挙動は明確に記述されていましたが、要素が挿入された場合の挙動については「実装依存」とされており、その詳細が不明瞭でした。

この曖昧さは、開発者がマップをイテレーションしながら要素を追加するコードを書いた際に、その挙動が予測不可能であるという問題を引き起こす可能性がありました。例えば、新しく追加された要素が現在のイテレーションで処理されるのか、それとも次のイテレーションで処理されるのか、あるいは全く処理されないのか、といった点が不明確でした。

このコミットは、この「実装依存」という記述をより具体的に、かつ厳密に定義することで、Go言語の仕様の明確性を高め、開発者がより正確にマップのイテレーション挙動を理解し、予測可能なコードを書けるようにすることを目的としています。特に、イテレーション中に要素が追加された場合に、その要素がイテレーション中に処理されるかスキップされるか、そしてその選択が非決定論的であるという事実を明記することが重要でした。

前提知識の解説

Go言語のマップ (map)

Go言語の map は、キーと値のペアを格納する組み込みのデータ構造です。他の言語におけるハッシュマップ、ハッシュテーブル、連想配列などと同様の機能を提供します。

• 非順序性: マップ内の要素は特定の順序で格納されません。イテレーションの順序も保証されず、実行ごとに異なる場合があります。
• 動的サイズ: マップは動的にサイズが変更され、必要に応じてメモリを割り当てます。
• ゼロ値: マップのゼロ値は nil です。nil マップは要素を持たず、読み取りは可能ですが、書き込みはできません（パニックが発生します）。

for...range ループとマップのイテレーション

Go言語では、for...range ループを使用してマップの要素をイテレーションできます。

m := map[string]int{"a": 1, "b": 2, "c": 3}
for key, value := range m {
    fmt.Printf("Key: %s, Value: %d\n", key, value)
}

このループは、マップ内のすべてのキーと値のペアを順に処理します。しかし、前述の通り、イテレーションの順序は保証されません。

イテレーション中のマップの変更

マップをイテレーション中にそのマップを変更する（要素の追加、削除、更新）ことは、一般的に注意が必要です。

• 要素の削除: イテレーション中にまだ到達していない要素が削除された場合、その要素はイテレーション中に生成されません。これは直感的で、多くの言語で同様の挙動を示します。
• 要素の挿入/追加: イテレーション中に新しい要素が挿入された場合の挙動は、言語や実装によって異なります。Go言語では、このコミット以前は「実装依存」とされていました。これは、新しい要素がイテレーション中に含まれるか、あるいはスキップされるか、その挙動がGoのランタイムの実装に委ねられており、特定の保証がなかったことを意味します。

このコミットは、特に「要素の挿入/追加」に関する挙動を明確化し、その非決定論的な性質を強調しています。

技術的詳細

このコミットの技術的な核心は、Go言語の仕様書におけるマップのイテレーションに関する記述の厳密化です。特に、イテレーション中にマップに新しいエントリが追加された場合の挙動について、以前の曖昧な表現をより具体的かつ正確なものに修正しています。

変更前の仕様では、マップのイテレーション中に要素が挿入された場合、「挙動は実装依存だが、各エントリのイテレーション値は最大で一度生成される」と記述されていました。この表現は、新しいエントリがイテレーションに含まれる可能性を示唆しつつも、その保証はせず、かつ「最大で一度」という表現で重複がないことを示していました。

しかし、Go言語のマップの実装（ハッシュテーブル）の性質上、イテレーション中に要素が追加されると、ハッシュテーブルの内部構造が変更される可能性があります（例えば、リハッシュによるバケットの再配置など）。このような変更は、イテレーションの進行状況に影響を与え、新しく追加された要素が現在のイテレーションで「発見」されるかどうかが非決定論的になる原因となります。

このコミットによる変更は、この非決定論的な性質を明確に反映しています。新しい記述では、「イテレーション中に作成されたエントリは、イテレーション中に生成されることもあれば、スキップされることもある。その選択は、作成された各エントリごと、およびイテレーションごとに異なる可能性がある」と述べています。

これは以下の点を意味します。

1. 非決定論性: 新しく追加された要素が現在のイテレーションで処理されるかどうかは保証されません。処理されることもあれば、スキップされることもあります。
2. エントリごとの変動: あるイテレーションで追加された複数の要素のうち、一部は処理され、一部はスキップされる可能性があります。
3. イテレーションごとの変動: 同じコードを複数回実行した場合でも、イテレーション中に新しく追加された要素が処理されるかどうかの挙動は、実行ごとに異なる可能性があります。

この明確化は、開発者がマップをイテレーション中に変更する際に、その挙動が予測不可能であることを認識し、そのような操作に依存しないコードを書くよう促すものです。一般的に、イテレーション中にコレクションを変更することは、多くのプログラミング言語で予期せぬ挙動を引き起こす可能性があるため、推奨されません。Go言語のこの仕様変更は、そのベストプラクティスを仕様レベルで裏付けるものと言えます。

コアとなるコードの変更箇所

変更は doc/go_spec.html ファイルの以下の部分に集中しています。

--- a/doc/go_spec.html
+++ b/doc/go_spec.html
@@ -1,6 +1,6 @@
 <!--{\
 	\"Title\": \"The Go Programming Language Specification\",
-\t\"Subtitle\": \"Version of January 9, 2013\",
+\t\"Subtitle\": \"Version of January 11, 2013\",
 	\"Path\": \"/ref/spec\"\
 }-->
 
@@ -4382,7 +4382,7 @@ Range expression                          1st value          2nd value (if 2nd v\
 array or slice  a  [n]E, *[n]E, or []E    index    i  int    a[i]       E\
 string          s  string type            index    i  int    see below  rune\
 map             m  map[K]V                key      k  K      m[k]       V\
-channel         c  chan E, <-chan E       element  e  E\
+channel         c  chan E, &lt;-chan E       element  e  E\
 </pre>\
 \
 <ol>\
@@ -4408,11 +4408,12 @@ a single byte in the string.\
 <li>\
 The iteration order over maps is not specified\
 and is not guaranteed to be the same from one iteration to the next.\
-If map entries that have not yet been reached are deleted during iteration,\
+If map entries that have not yet been reached are removed during iteration,\
 the corresponding iteration values will not be produced. If map entries are\
-inserted during iteration, the behavior is implementation-dependent, but the\
-iteration values for each entry will be produced at most once. If the map\
-is <code>nil</code>, the number of iterations is 0.\
+created during iteration, that entry may be produced during the iteration or\
+may be skipped. The choice may vary for each entry created and from one\
+iteration to the next.\
+If the map is <code>nil</code>, the number of iterations is 0.\
 </li>\
 \
 <li>\

コアとなるコードの解説

このコミットにおける主要な変更は、Go言語の仕様書 doc/go_spec.html 内のマップのイテレーションに関する記述の修正です。

1. 日付の更新:

   -\t\"Subtitle\": \"Version of January 9, 2013\",
   +\t\"Subtitle\": \"Version of January 11, 2013\",
   

   これは仕様書のバージョン日付を2013年1月9日から2013年1月11日に更新したもので、このコミットが適用された日付を反映しています。

2. HTMLエンティティの修正:

   -channel         c  chan E, <-chan E       element  e  E
   +channel         c  chan E, &lt;-chan E       element  e  E
   

   <- がHTMLエンティティ <- に修正されています。これはHTMLドキュメント内で特殊文字を正しく表示するための一般的な修正です。

3. マップのイテレーション挙動の明確化（核心部分）:

   -If map entries that have not yet been reached are deleted during iteration,
   +If map entries that have not yet been reached are removed during iteration,
    the corresponding iteration values will not be produced. If map entries are
   -inserted during iteration, the behavior is implementation-dependent, but the
   -iteration values for each entry will be produced at most once. If the map
   -is <code>nil</code>, the number of iterations is 0.
   +created during iteration, that entry may be produced during the iteration or
   +may be skipped. The choice may vary for each entry created and from one
   +iteration to the next.
   +If the map is <code>nil</code>, the number of iterations is 0.
   

   この部分が最も重要な変更です。

   • 削除に関する表現の変更: "deleted" が "removed" に変更されています。意味合いは同じですが、より一般的な表現に統一された可能性があります。
   • 挿入に関する挙動の明確化:
     • 変更前: 「マップのエントリがイテレーション中に挿入された場合、挙動は実装依存だが、各エントリのイテレーション値は最大で一度生成される。」
     • 変更後: 「マップのエントリがイテレーション中に作成された場合、そのエントリはイテレーション中に生成されることもあれば、スキップされることもある。その選択は、作成された各エントリごと、およびイテレーションごとに異なる可能性がある。」

   この変更により、イテレーション中にマップに新しい要素が追加された場合の挙動が、より詳細かつ厳密に定義されました。特に、「実装依存」という曖昧な表現が削除され、新しく追加された要素がイテレーションに含まれるかどうかが非決定論的であり、その挙動が実行ごとに、あるいは追加された要素ごとに異なる可能性があることが明記されました。これは、開発者がマップをイテレーション中に変更する際に、その挙動に依存すべきではないという強いメッセージを伝えています。

関連リンク

• Go Programming Language Specification: https://go.dev/ref/spec
• Go言語のマップに関する公式ドキュメント: https://go.dev/blog/maps

参考にした情報源リンク

• Go言語の公式ドキュメントおよび仕様書
• Go言語のコミット履歴 (GitHub)
• Go言語のマップのイテレーションに関する一般的なプログラミングの知識とベストプラクティス# [インデックス 14902] ファイルの概要

このコミットは、Go言語の公式仕様書である doc/go_spec.html の内容を更新し、マップのイテレーション中に要素が挿入された場合の挙動に関する記述を明確化したものです。特に、イテレーション中に新しく作成されたエントリがイテレーション中に生成されるかスキップされるか、その選択がエントリごと、およびイテレーションごとに異なる可能性があることを明記しています。

コミット

commit ced57153df76f501b3f9b7efdc974c0725bcd594
Author: Shenghou Ma <minux.ma@gmail.com>
Date:   Thu Jan 17 23:11:25 2013 +0800

    doc/go_spec.html: clarification about insertion during map iteration

    R=mdempsky, iant, r, gri, rsc, ken
    CC=golang-dev
    https://golang.org/cl/7100046

GitHub上でのコミットページへのリンク

https://github.com/golang/go/commit/ced57153df76f501b3f9b7efdc974c0725bcd594

元コミット内容

doc/go_spec.html: clarification about insertion during map iteration

このコミットは、Go言語の仕様書において、マップのイテレーション中に要素が挿入された場合の挙動について明確化を行うものです。

変更の背景

Go言語のマップ（map）は、キーと値のペアを格納するハッシュテーブルとして実装されています。その性質上、要素の順序は保証されず、イテレーションの順序も特定されません。初期のGo言語の仕様では、マップのイテレーション中に要素が削除された場合の挙動は明確に記述されていましたが、要素が挿入された場合の挙動については「実装依存」とされており、その詳細が不明瞭でした。

この曖昧さは、開発者がマップをイテレーションしながら要素を追加するコードを書いた際に、その挙動が予測不可能であるという問題を引き起こす可能性がありました。例えば、新しく追加された要素が現在のイテレーションで処理されるのか、それとも次のイテレーションで処理されるのか、あるいは全く処理されないのか、といった点が不明確でした。

このコミットは、この「実装依存」という記述をより具体的に、かつ厳密に定義することで、Go言語の仕様の明確性を高め、開発者がより正確にマップのイテレーション挙動を理解し、予測可能なコードを書けるようにすることを目的としています。特に、イテレーション中に要素が追加された場合に、その要素がイテレーション中に処理されるかスキップされるか、そしてその選択が非決定論的であるという事実を明記することが重要でした。

前提知識の解説

Go言語のマップ (map)

Go言語の map は、キーと値のペアを格納する組み込みのデータ構造です。他の言語におけるハッシュマップ、ハッシュテーブル、連想配列などと同様の機能を提供します。

• 非順序性: マップ内の要素は特定の順序で格納されません。イテレーションの順序も保証されず、実行ごとに異なる場合があります。
• 動的サイズ: マップは動的にサイズが変更され、必要に応じてメモリを割り当てます。
• ゼロ値: マップのゼロ値は nil です。nil マップは要素を持たず、読み取りは可能ですが、書き込みはできません（パニックが発生します）。

for...range ループとマップのイテレーション

Go言語では、for...range ループを使用してマップの要素をイテレーションできます。

m := map[string]int{"a": 1, "b": 2, "c": 3}
for key, value := range m {
    fmt.Printf("Key: %s, Value: %d\n", key, value)
}

このループは、マップ内のすべてのキーと値のペアを順に処理します。しかし、前述の通り、イテレーションの順序は保証されません。

イテレーション中のマップの変更

マップをイテレーション中にそのマップを変更する（要素の追加、削除、更新）ことは、一般的に注意が必要です。

• 要素の削除: イテレーション中にまだ到達していない要素が削除された場合、その要素はイテレーション中に生成されません。これは直感的で、多くの言語で同様の挙動を示します。
• 要素の挿入/追加: イテレーション中に新しい要素が挿入された場合の挙動は、言語や実装によって異なります。Go言語では、このコミット以前は「実装依存」とされていました。これは、新しい要素がイテレーション中に含まれるか、あるいはスキップされるか、その挙動がGoのランタイムの実装に委ねられており、特定の保証がなかったことを意味します。

このコミットは、特に「要素の挿入/追加」に関する挙動を明確化し、その非決定論的な性質を強調しています。

技術的詳細

このコミットの技術的な核心は、Go言語の仕様書におけるマップのイテレーションに関する記述の厳密化です。特に、イテレーション中にマップに新しいエントリが追加された場合の挙動について、以前の曖昧な表現をより具体的かつ正確なものに修正しています。

変更前の仕様では、マップのイテレーション中に要素が挿入された場合、「挙動は実装依存だが、各エントリのイテレーション値は最大で一度生成される」と記述されていました。この表現は、新しいエントリがイテレーションに含まれる可能性を示唆しつつも、その保証はせず、かつ「最大で一度」という表現で重複がないことを示していました。

しかし、Go言語のマップの実装（ハッシュテーブル）の性質上、イテレーション中に要素が追加されると、ハッシュテーブルの内部構造が変更される可能性があります（例えば、リハッシュによるバケットの再配置など）。このような変更は、イテレーションの進行状況に影響を与え、新しく追加された要素が現在のイテレーションで「発見」されるかどうかが非決定論的になる原因となります。

このコミットによる変更は、この非決定論的な性質を明確に反映しています。新しい記述では、「イテレーション中に作成されたエントリは、イテレーション中に生成されることもあれば、スキップされることもある。その選択は、作成された各エントリごと、およびイテレーションごとに異なる可能性がある」と述べています。

これは以下の点を意味します。

1. 非決定論性: 新しく追加された要素が現在のイテレーションで処理されるかどうかは保証されません。処理されることもあれば、スキップされることもあります。
2. エントリごとの変動: あるイテレーションで追加された複数の要素のうち、一部は処理され、一部はスキップされる可能性があります。
3. イテレーションごとの変動: 同じコードを複数回実行した場合でも、イテレーション中に新しく追加された要素が処理されるかどうかの挙動は、実行ごとに異なる可能性があります。

この明確化は、開発者がマップをイテレーション中に変更する際に、その挙動が予測不可能であることを認識し、そのような操作に依存しないコードを書くよう促すものです。一般的に、イテレーション中にコレクションを変更することは、多くのプログラミング言語で予期せぬ挙動を引き起こす可能性があるため、推奨されません。Go言語のこの仕様変更は、そのベストプラクティスを仕様レベルで裏付けるものと言えます。

コアとなるコードの変更箇所

変更は doc/go_spec.html ファイルの以下の部分に集中しています。

--- a/doc/go_spec.html
+++ b/doc/go_spec.html
@@ -1,6 +1,6 @@
 <!--{\
 	\"Title\": \"The Go Programming Language Specification\",
-\t\"Subtitle\": \"Version of January 9, 2013\",
+\t\"Subtitle\": \"Version of January 11, 2013\",
 	\"Path\": \"/ref/spec\"\
 }-->
 
@@ -4382,7 +4382,7 @@ Range expression                          1st value          2nd value (if 2nd v\
 array or slice  a  [n]E, *[n]E, or []E    index    i  int    a[i]       E\
 string          s  string type            index    i  int    see below  rune\
 map             m  map[K]V                key      k  K      m[k]       V\
-channel         c  chan E, <-chan E       element  e  E\
+channel         c  chan E, &lt;-chan E       element  e  E\
 </pre>\
 \
 <ol>\
@@ -4408,11 +4408,12 @@ a single byte in the string.\
 <li>\
 The iteration order over maps is not specified\
 and is not guaranteed to be the same from one iteration to the next.\
-If map entries that have not yet been reached are deleted during iteration,\
+If map entries that have not yet been reached are removed during iteration,\
 the corresponding iteration values will not be produced. If map entries are\
-inserted during iteration, the behavior is implementation-dependent, but the
-iteration values for each entry will be produced at most once. If the map
-is <code>nil</code>, the number of iterations is 0.\
+created during iteration, that entry may be produced during the iteration or
+may be skipped. The choice may vary for each entry created and from one
+iteration to the next.\
+If the map is <code>nil</code>, the number of iterations is 0.\
 </li>\
 \
 <li>\

コアとなるコードの解説

このコミットにおける主要な変更は、Go言語の仕様書 doc/go_spec.html 内のマップのイテレーションに関する記述の修正です。

1. 日付の更新:

   -\t\"Subtitle\": \"Version of January 9, 2013\",
   +\t\"Subtitle\": \"Version of January 11, 2013\",
   

   これは仕様書のバージョン日付を2013年1月9日から2013年1月11日に更新したもので、このコミットが適用された日付を反映しています。

2. HTMLエンティティの修正:

   -channel         c  chan E, <-chan E       element  e  E
   +channel         c  chan E, &lt;-chan E       element  e  E
   

   <- がHTMLエンティティ <- に修正されています。これはHTMLドキュメント内で特殊文字を正しく表示するための一般的な修正です。

3. マップのイテレーション挙動の明確化（核心部分）:

   -If map entries that have not yet been reached are deleted during iteration,
   +If map entries that have not yet been reached are removed during iteration,
    the corresponding iteration values will not be produced. If map entries are
   -inserted during iteration, the behavior is implementation-dependent, but the
   -iteration values for each entry will be produced at most once. If the map
   -is <code>nil</code>, the number of iterations is 0.
   +created during iteration, that entry may be produced during the iteration or
   +may be skipped. The choice may vary for each entry created and from one
   +iteration to the next.
   +If the map is <code>nil</code>, the number of iterations is 0.
   

   この部分が最も重要な変更です。

   • 削除に関する表現の変更: "deleted" が "removed" に変更されています。意味合いは同じですが、より一般的な表現に統一された可能性があります。
   • 挿入に関する挙動の明確化:
     • 変更前: 「マップのエントリがイテレーション中に挿入された場合、挙動は実装依存だが、各エントリのイテレーション値は最大で一度生成される。」
     • 変更後: 「マップのエントリがイテレーション中に作成された場合、そのエントリはイテレーション中に生成されることもあれば、スキップされることもある。その選択は、作成された各エントリごと、およびイテレーションごとに異なる可能性がある。」

   この変更により、イテレーション中にマップに新しい要素が追加された場合の挙動が、より詳細かつ厳密に定義されました。特に、「実装依存」という曖昧な表現が削除され、新しく追加された要素がイテレーションに含まれるかどうかが非決定論的であり、その挙動が実行ごとに、あるいは追加された要素ごとに異なる可能性があることが明記されました。これは、開発者がマップをイテレーション中に変更する際に、その挙動に依存すべきではないという強いメッセージを伝えています。

関連リンク

• Go Programming Language Specification: https://go.dev/ref/spec
• Go言語のマップに関する公式ドキュメント: https://go.dev/blog/maps

参考にした情報源リンク

• Go言語の公式ドキュメントおよび仕様書
• Go言語のコミット履歴 (GitHub)
• Go言語のマップのイテレーションに関する一般的なプログラミングの知識とベストプラクティス