2.4. 関数を定義して使う

これまで、np.sin を始めとする関数を用いてきました。 このように、何か操作をして値を返すもの（ファイルを保存するなど値を返さないものもある） を関数と呼びます。 本節ではこのような関数を定義して用いる方法について述べます。

なお、もし NumPy などの外部パッケージが同様の操作を行う関数を定義している場合は そちらを用いる方がよいことがほとんどです。 既存のパッケージは、大勢で作成・動作確認しているため、 個人が作成したものよりもバグが圧倒的に少なくなっています。 さらに NumPyのように、 C や Fortranを裏で利用して高速化を行っていることも多いでしょう。

以下に例として、極座標変数 (r, theta) から直行座標での値 (x, y) への変換を行う 関数を定義してみます。

In [1]: def get_xy(r, theta):
   ...:     """
   ...:     Returns x, y values from polar coordinate variable r (radial coordinate)
   ...:     and theta (angular coordinate).
   ...:     """
   ...:     x = r * np.cos(theta)
   ...:     y = r * np.sin(theta)
   ...:     return x, y
   ...:

上記のように、関数の定義は def 文から始め、関数名( get_xy )の次にカッコ内に引数( r, theta) を 指定し、コロンの後に改行します。 関数の範囲はインデントにより示すことが必要です。 なお、慣習として関数名は小文字で始めることになっています。

また動作上必須ではありませんが、 def 文の次の行にはその関数の説明、操作の内容や引数・戻り値の意味などを ３つのダブルコーテーションで囲った文字列として書いておくことが推奨されています （この説明はdocstringsと呼ばれます）。 docstrings を記述しておくことで、メンテナンス時に関数の役割を思い出しやすいほか、 Jupyter-notebookなどの開発環境ではその使用法をソースコードを読むことなく理解できるという利点があります。 自身で使うだけのプログラムでも、簡単に記述しておくことが重要でしょう。

関数の内部（インデントで示される領域）では必要な計算を行い、 必要であれば return 文で値を返します。 なお、Pythonの関数は複数の値を返すことも可能です。 その場合、戻り値はそれらを含むタプルとなります。

定義した関数は以下のように、引数にオブジェクトを渡すことで実行します。

In [2]: r = np.linspace(0, 1, 21)  # 0 ~ 1 を21等分した点列

In [3]: theta = np.linspace(0, 4.0 * np.pi, 21)  # 0 ~ 4π を21等分した点列

In [4]: x, y = get_xy(r, theta)

In [5]: plt.plot(x, y)
Out[5]: [<matplotlib.lines.Line2D at 0x7f58fd1b1d30>]
../_images/tutorial3_plot1.png