【初心者向け】NumPy ndarray.__str__() メソッド：N次元配列を理解する最初のステップ

NumPy ndarray.str() メソッドの詳細解説：N次元配列の文字列表現を理解する

本解説では、ndarray.__str__() メソッドの動作を詳細に分析し、以下の3つの観点から理解を深めていきます。

1. 出力形式の詳細： メソッドが生成する文字列の構成要素と、各要素がどのように解釈されるのかを解説します。
2. オプション設定によるカスタマイズ： 文字列出力のフォーマットを調整するためのオプションと、それぞれの影響について説明します。
3. 応用と注意点： ndarray.__str__() メソッドの出力結果を活用する場面と、使用時の注意点について紹介します。

出力形式の詳細：ndarrayの内容を可視化する

ndarray.__str__() メソッドは、以下の要素で構成される文字列を返します。

• 配列形状： 角括弧で囲まれたカンマ区切りの数値リストで、各次元の長さを表します。
• データ型： 配列に格納されているデータの型を表す文字列です。
• 要素値： 配列の各要素の値を、行ごとにカンマ区切りで表示します。

以下は、ndarray.__str__() メソッドの出力例と、各要素の詳細な説明です。

import numpy as np

# 3次元配列の生成
arr = np.arange(24).reshape(2, 3, 4)

# 文字列出力
print(arr)

# 出力例：
# [[[ 0  1  2  3]
#  [ 4  5  6  7]
#  [ 8  9 10 11]]
#
# [[12 13 14 15]
#  [16 17 18 19]
#  [20 21 22 23]]]

要素解説

1. array([： 出力文字列の開始を示す文字列です。
2. [[： 3次元配列の開始を示す3重の角括弧です。
3. 0, 1, 2, 3： 最初の行の最初の要素から4番目の要素までの値です。
4. ： 省略記号で、出力結果が長すぎる場合に省略された要素を表します。
5. 20, 21, 22, 23]]： 最後の行の最後の要素までの値です。
6. ])： 出力文字列の終了を示す文字列です。

オプション設定によるカスタマイズ：出力形式を調整する

ndarray.__str__() メソッドには、出力形式を調整するためのオプションがいくつか用意されています。

主なオプションと効果

• threshold： 省略記号...を使用する前に表示する要素数です。デフォルトは1000です。
• linewidth： 出力行の最大長です。デフォルトは80です。
• formatter： 各要素の値をどのようにフォーマットするかを指定する関数です。デフォルトはstr関数です。

以下の例は、threshold オプションと formatter オプションを使用して、出力形式をカスタマイズする例です。

# threshold オプションによる要素数の制限
arr = np.arange(100)
print(arr)

# 出力例：
# array([ 0,  1,  2, ..., 97, 98, 99])

# threshold オプションの変更
print(arr, threshold=10)

# 出力例：
# array([ 0,  1,  2, ..., 90, 91, 92, 93, 94, 95, 96, 97, 98, 99])

# formatter オプションによるフォーマット変更
print(arr.astype(float) / 10, formatter="{:.2f}")

# 出力例：
# [[0.00 0.10 0.20 ... 

NumPy ndarray.str() メソッド：サンプルコード集

基本的な出力

import numpy as np

# 1次元配列
arr1 = np.array([1, 2, 3, 4, 5])
print(arr1)

# 出力例：
# [1 2 3 4 5]

# 2次元配列
arr2 = np.array([[1, 2, 3], [4, 5, 6]])
print(arr2)

# 出力例：
# [[1 2 3]
#  [4 5 6]]

オプションによるカスタマイズ

# 省略記号の表示数変更
arr = np.arange(100)
print(arr, threshold=10)

# 出力例：
# array([ 0,  1,  2, ..., 90, 91, 92, 93, 94, 95, 96, 97, 98, 99])

# 出力行の長さ変更
print(arr, linewidth=50)

# 出力例：
# array([ 0,  1,  2, ..., 96, 97, 98, 99])

# フォーマット変更
print(arr.astype(float) / 10, formatter="{:.2f}")

# 出力例：
# [[0.00 0.10 0.20 ... 9.70 9.80 9.90]]

高度な活用

# 3次元配列のスライス表示
arr3 = np.arange(24).reshape(2, 3, 4)
print(arr3[0, :, :])

# 出力例：
# [[ 0  1  2  3]
#  [ 4  5  6  7]
#  [ 8  9 10 11]]

# 条件付き表示
print(arr3[arr3 % 2 == 0])

# 出力例：
# [ 0  2  4  6  8 10 12 14 16 18 20 22]

# 独自のフォーマット関数
def my_formatter(x):
  return f"{x:.2f}%"

print(arr3.astype(float) / 24 * 100, formatter=my_formatter)

# 出力例：
# [[ 0.00%  4.17%  8.33% ... 95.83% 99.17%100.00%]
#  [ 4.17%  8.33% 12.50% ... 87.50% 91.67% 95.83%]]

これらのサンプルコードは、ndarray.__str__() メソッドのさまざまな機能を理解し、使いこなすための出発点となります。さらに深く理解するためには、NumPy公式ドキュメントやチュートリアルを参照することをおすすめします。

• ndarray.__str__() メソッドは、print() 関数以外にも、str() 関数や repr() 関数でも呼び出すことができます。
• 出力結果をファイルに保存したい場合は、np.savetxt() 関数などを利用できます。

NumPy ndarray の内容を表示するその他の方法

np.array2string() 関数は、NumPy 配列を文字列に変換するための関数です。ndarray.__str__() メソッドと比べて、以下の点で柔軟性があります。

• 出力形式を細かくカスタマイズできる
• 特定の条件に基づいて要素を表示・非表示できる
• Unicode 文字を使用できる

例：

import numpy as np

arr = np.arange(10)

# 省略記号の表示数変更
print(np.array2string(arr, threshold=5))

# 出力例：
# '[0 1 2 3 4 ... 6 7 8 9]'

# 浮動小数点数の桁数指定
print(np.array2string(arr.astype(float) / 10, floatmode="unique"))

# 出力例：
# '[0.0 0.1 0.2 0.3 0.4 0.5 0.6 0.7 0.8 0.9]'

# 条件付き表示
print(np.array2string(arr, separator=", ", formatter="{:02d}".format,
                        filter=lambda x: x % 2 == 0))

# 出力例：
# '00, 02, 04, 06, 08'

np.savetxt() 関数は、NumPy 配列をテキストファイルに保存するための関数です。ファイル形式を指定したり、区切り文字を設定したりすることができます。

例：

arr = np.arange(10).reshape(2, 5)

# テキストファイルへの保存
np.savetxt("output.txt", arr, delimiter=", ")

# 出力例：
# (output.txt)
# 0, 1, 2, 3, 4
# 5, 6, 7, 8, 9

IPython 環境では、%pinfo や %pprint などのマジックコマンドを使って、NumPy 配列の内容をより詳細に表示することができます。

例：

# IPython 環境

%pinfo arr

# 出力例：
# Complete information about array arr

# ...

%pprint arr

# 出力例：
# Pretty printing of array arr

# ...

自作関数

上記の方法に加え、独自のフォーマットで出力したい場合は、自作関数を作成することもできます。

例：

def my_formatter(arr):
  """
  NumPy 配列を独自のフォーマットで出力する関数
  """
  # 処理内容

  return formatted_string

# 出力
print(my_formatter(arr))

NumPy 配列の内容を表示するには、ndarray.__str__() メソッド以外にも、さまざまな方法があります。それぞれの特徴を理解し、目的に合った方法を選択することで、効率的に情報を表示することができます。