Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

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

このコミットは、Go言語の標準ライブラリである sort パッケージの example_keys_test.go ファイルにおける、惑星の質量単位の修正に関するものです。具体的には、例で使用されている惑星の質量が「太陽質量 (solarMass)」ではなく「地球質量 (earthMass)」で与えられているという事実に基づき、型定義と構造体フィールドの型を solarMass から earthMass へと変更しています。これにより、コードの正確性と可読性が向上しています。

コミット

commit 73c21b13127c8dfad73d4477aa3dd9785515bf2b
Author: Volker Dobler <dr.volker.dobler@gmail.com>
Date:   Wed Feb 27 10:44:50 2013 -0800

    sort: use proper mass unit in example
    
    The values for the planet masses are given in
    earth mass, not solar mass.
    
    R=golang-dev, dave, r
    CC=golang-dev
    https://golang.org/cl/7368054

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

https://github.com/golang/go/commit/73c21b13127c8dfad73d4477aa3dd9785515bf2b

元コミット内容

このコミットは、src/pkg/sort/example_keys_test.go ファイル内のコメントと型定義を修正するものです。元のコードでは、惑星の質量を表す型が solarMass と定義されていましたが、実際に例で使用されている数値は地球質量を基準としたものでした。この不整合を解消するために、型名を earthMass に変更し、それに伴い Planet 構造体の mass フィールドの型も修正しています。

変更の背景

Go言語の sort パッケージの例では、惑星のデータをソートするデモンストレーションが含まれていました。この例の中で、各惑星の質量が数値として与えられていましたが、その数値がどの単位に基づいているのかが不明確でした。元のコードでは solarMass (太陽質量) という型が使われていましたが、実際の数値（例えば地球の質量を1とした場合の他の惑星の質量）は太陽質量を基準としたものではなく、地球質量を基準としたものでした。

この不整合は、コードの読者に対して誤解を与える可能性がありました。例えば、木星の質量が地球の約318倍であるという事実を、太陽質量を基準とした数値として解釈してしまうと、実際の値とは大きく異なることになります。

このコミットの目的は、この誤解を解消し、例の正確性を高めることです。例で使用されている数値が地球質量を基準としていることを明確にするために、関連する型定義を solarMass から earthMass に変更しました。これにより、コードの意図がより明確になり、読者が例を正しく理解できるようになります。

前提知識の解説

Go言語の sort パッケージ

Go言語の標準ライブラリには、ソート機能を提供する sort パッケージが含まれています。このパッケージは、プリミティブ型（整数、浮動小数点数、文字列など）のスライスだけでなく、カスタムデータ構造のスライスもソートするための汎用的なインターフェースを提供します。

カスタムデータ構造をソートするには、その型が sort.Interface インターフェースを実装する必要があります。このインターフェースは以下の3つのメソッドを定義しています。

  1. Len() int: ソート対象の要素の数を返します。
  2. Less(i, j int) bool: インデックス i の要素がインデックス j の要素よりも小さい（ソート順で前に来る）場合に true を返します。
  3. Swap(i, j int): インデックス i と j の要素を入れ替えます。

sort パッケージの Sort 関数は、この sort.Interface を実装した任意のデータ構造を受け取り、ソートを実行します。

質量単位：太陽質量 (solarMass) と地球質量 (earthMass)

天文学では、非常に大きな質量を扱うため、特定の天体の質量を基準とした単位がよく用いられます。

  • 太陽質量 (Solar Mass, M☉): 太陽の質量を基準とした単位です。太陽の質量は約 1.989 × 10^30 kg です。これは、恒星や銀河などの非常に大きな天体の質量を表す際に便利です。例えば、他の恒星の質量を「太陽質量のX倍」という形で表現します。
  • 地球質量 (Earth Mass, M⊕): 地球の質量を基準とした単位です。地球の質量は約 5.972 × 10^24 kg です。これは、太陽系内の惑星や衛星などの質量を表す際に便利です。例えば、火星の質量は地球質量の約0.107倍、木星の質量は地球質量の約318倍といった形で表現されます。

このコミットの文脈では、example_keys_test.go の例で使われている惑星の質量データが、地球の質量を1とした相対的な値であったため、earthMass という単位が適切であると判断されました。

技術的詳細

このコミットは、Go言語の型システムと、コードの可読性・正確性に関するベストプラクティスに焦点を当てています。

Go言語では、type NewType OldType の形式で既存の型から新しい型を宣言できます。これは、基底となる型（この場合は float64）と同じ操作をサポートしつつ、異なる意味を持つ型を作成する際に役立ちます。この機能は、コードの意図を明確にし、型安全性を高めるために使用されます。

元のコードでは、type solarMass float64 と定義されていましたが、これは「惑星の質量は太陽質量単位で表現される」という誤った示唆を与えていました。実際のデータが地球質量単位であったため、この型定義は誤解を招くものでした。

このコミットでは、以下の変更が行われました。

  1. type solarMass float64 を type earthMass float64 に変更。これにより、mass フィールドが地球質量単位であることを明示します。
  2. Planet 構造体の mass フィールドの型を solarMass から earthMass に変更。これにより、構造体の定義が新しい型定義と一致し、データの一貫性が保たれます。

これらの変更は、プログラムのロジック自体には影響を与えません。float64 の基底型は変わらないため、数値計算の動作は同じままです。しかし、コードを読んだ人が、惑星の質量がどの単位で表現されているのかを正確に理解できるようになります。これは、特に科学計算やデータ処理の文脈において、データの解釈ミスを防ぐ上で非常に重要です。

また、この変更はテストファイル (example_keys_test.go) 内で行われているため、Go言語の標準ライブラリの例がより正確で教育的なものになるという効果もあります。

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

変更は src/pkg/sort/example_keys_test.go ファイルの以下の部分です。

--- a/src/pkg/sort/example_keys_test.go
+++ b/src/pkg/sort/example_keys_test.go
@@ -10,13 +10,13 @@ import (
 )
 
 // A couple of type definitions to make the units clear.
-type solarMass float64
+type earthMass float64
 type au float64
 
 // A Planet defines the properties of a solar system object.
 type Planet struct {
  	name     string
-	mass     solarMass
+	mass     earthMass
  	distance au
 }

コアとなるコードの解説

この変更は、Go言語の型エイリアス（または基底型に基づく新しい型定義）と構造体のフィールド定義に関するものです。

  1. type solarMass float64 から type earthMass float64 への変更:

    • 元のコードでは、solarMass という新しい型が float64 を基底として定義されていました。これは、惑星の質量が太陽質量単位で表現されることを意図していた可能性があります。
    • しかし、実際の例で使用されている数値が地球質量を基準としたものであったため、この型名は誤解を招くものでした。
    • 変更後、earthMass という型名に変更することで、この型が地球質量単位の数値を表すことを明確にしています。これにより、コードの意図が正確に伝わるようになります。

  2. Planet 構造体の mass フィールドの型変更:

    • Planet 構造体は、惑星の名前、質量、および太陽からの距離を保持するために定義されています。
    • 元のコードでは、mass フィールドの型が solarMass でした。
    • 型定義の変更に伴い、Planet 構造体の mass フィールドの型も solarMass から earthMass に変更されました。これにより、構造体の定義と新しい型定義との間に一貫性が保たれ、コード全体の整合性が向上します。

これらの変更は、Go言語の静的型付けの利点を活用し、コードのセマンティクス（意味）をより正確に表現するためのものです。プログラムの実行時の動作には影響を与えませんが、コードの保守性、可読性、および正確性を大幅に向上させます。特に、科学計算やデータ分析の分野では、単位の正確な表現がデータの誤解釈を防ぐ上で極めて重要です。

関連リンク

参考にした情報源リンク