fe_test.py ダウンロード/コピー

fe_test.py をダウンロード

fe_test.py
fe_test.py
  1"""
  2概要:
  3    tkfermi_integralの関数群をテストしベンチマークを実行するスクリプトです。
  4
  5詳細説明:
  6    fermi_dirac_e_npvector、fermi_dirac_e_if、fermi_dirac_eをtkfermi_integralから読み込みます。
  7    指定されたxの値について基準値からの相対誤差を計算し、tol=1e-20を基準としてテストを行いFAILかPASSかを出力します。
  8    出力には各関数の値とdiff値を含みます。また、各関数の実行速度を比較するためのベンチマークも行います。
  9"""
 10
 11import numpy as np
 12import time
 13from tkfermi_integral import (
 14    fermi_dirac_e_npvector,
 15    fermi_dirac_e_if,
 16    fermi_dirac_e
 17)
 18
 19# ------------------------------------------------------------
 20# Test points
 21# ------------------------------------------------------------
 22x_values = np.array([
 23    -1000,
 24    -100, -50, -40, -20, -10, -5, -2, -1, -0.5, -0.1,
 25     0.0, 0.1, 0.5, 1.0, 2, 5, 10, 20, 40, 50, 100,
 26     300, 500, 600, 700, 800, 900, 1000
 27], dtype=float)
 28
 29eta = 0.0
 30g = 1.0
 31tol = 1e-20
 32
 33# ------------------------------------------------------------
 34# Helper: relative error
 35# ------------------------------------------------------------
 36def relerr(a, b):
 37    """
 38    概要:
 39        2つの値の相対誤差を計算します。
 40    
 41    引数:
 42        :param a: 比較対象の値
 43        :type a: float または numpy.ndarray
 44        :param b: 基準となる値
 45        :type b: float または numpy.ndarray
 46    
 47    戻り値:
 48        :returns: 計算された相対誤差
 49        :rtype: float または numpy.ndarray
 50    """
 51    return np.abs(a - b) / np.maximum(np.abs(b), 1e-300)
 52
 53# ------------------------------------------------------------
 54# Wrappers to unify interface
 55# ------------------------------------------------------------
 56def fd_high_precision_scalar(x, eta, g):
 57    """
 58    概要:
 59        fermi_dirac_e_npvectorのスカララッパー関数です。
 60    
 61    引数:
 62        :param x: 評価するxの値
 63        :type x: float
 64        :param eta: etaパラメータ
 65        :type eta: float
 66        :param g: gパラメータ
 67        :type g: float
 68    
 69    戻り値:
 70        :returns: 計算された関数の値
 71        :rtype: float
 72    """
 73    return fermi_dirac_e_npvector(np.array([x]))[0]
 74
 75def fd_if_scalar(x, eta, g):
 76    """
 77    概要:
 78        fermi_dirac_e_ifのスカララッパー関数です。
 79    
 80    引数:
 81        :param x: 評価するxの値
 82        :type x: float
 83        :param eta: etaパラメータ
 84        :type eta: float
 85        :param g: gパラメータ
 86        :type g: float
 87    
 88    戻り値:
 89        :returns: 計算された関数の値
 90        :rtype: float
 91    """
 92    return fermi_dirac_e_if(x, eta, g)
 93
 94def fd_expit_scalar(x, eta, g):
 95    """
 96    概要:
 97        fermi_dirac_eのスカララッパー関数です。
 98    
 99    引数:
100        :param x: 評価するxの値
101        :type x: float
102        :param eta: etaパラメータ
103        :type eta: float
104        :param g: gパラメータ
105        :type g: float
106    
107    戻り値:
108        :returns: 計算された関数の値
109        :rtype: float
110    """
111    return fermi_dirac_e(x, eta, g)
112
113# ------------------------------------------------------------
114# Test each function
115# ------------------------------------------------------------
116def test_function(name, func, x_values, ref_values):
117    """
118    概要:
119        対象関数をテストし基準値との差異を判定して結果を出力します。
120    
121    詳細説明:
122        許容誤差 tol と比較し、誤差が許容範囲内であれば PASS を、そうでなければ FAIL を標準出力に出力します。
123    
124    引数:
125        :param name: テストする関数の名前
126        :type name: str
127        :param func: テスト対象の関数
128        :type func: callable
129        :param x_values: テストで使用する入力値の配列
130        :type x_values: numpy.ndarray
131        :param ref_values: 基準となる計算値の配列
132        :type ref_values: numpy.ndarray
133    
134    戻り値:
135        :returns: 戻り値はありません。
136        :rtype: None
137    """
138    print(f"\n=== Testing {name} ===")
139    for x, ref in zip(x_values, ref_values):
140        val = func(x, eta, g)
141        diff = relerr(val, ref)
142        status = "PASS" if diff < tol else "FAIL"
143        print(f"x={x:8.2f}  val={val:.8e}  ref={ref:.8e}  diff={diff:.3e}  {status}")
144
145# ------------------------------------------------------------
146# Compute reference (high precision)
147# ------------------------------------------------------------
148ref_values = fermi_dirac_e_npvector(x_values)
149
150# ------------------------------------------------------------
151# Run tests
152# ------------------------------------------------------------
153#test_function("high_precision", fd_high_precision_scalar, x_values, ref_values)
154test_function("scalar_if", fd_if_scalar, x_values, ref_values)
155test_function("expit", fd_expit_scalar, x_values, ref_values)
156
157# ------------------------------------------------------------
158# Benchmark
159# ------------------------------------------------------------
160def benchmark(name, func, x_values, repeat=20000):
161    """
162    概要:
163        対象関数の実行時間を計測するベンチマーク関数です。
164    
165    詳細説明:
166        nameで指定された文字列に基づいて実行する関数を切り替え、指定回数だけ処理を繰り返して実行時間を計測します。
167    
168    引数:
169        :param name: ベンチマーク処理を分岐するための名前
170        :type name: str
171        :param func: 比較対象となる関数
172        :type func: callable
173        :param x_values: 計算に使用する入力値の配列
174        :type x_values: numpy.ndarray
175        :param repeat: 繰り返し実行する回数
176        :type repeat: int
177    
178    戻り値:
179        :returns: 処理にかかった合計秒数
180        :rtype: float
181    """
182    t0 = time.time()
183    for _ in range(repeat):
184        # vectorized version for speed test
185        if name == "npvector":
186            fermi_dirac_e_npvector(x_values)
187        elif name == "scalar_if":
188            np.array([fermi_dirac_e_if(x, eta, g) for x in x_values])
189        else:
190            fermi_dirac_e(x_values, eta, g)
191    t1 = time.time()
192    return t1 - t0
193
194print("\n=== Benchmark (lower is faster) ===")
195t_np = benchmark("npvector", fd_high_precision_scalar, x_values)
196t_if = benchmark("scalar_if", fd_if_scalar, x_values)
197t_ex = benchmark("expit", fd_expit_scalar, x_values)
198
199print(f"npvector : {t_np:.4f} sec")
200print(f"scalar_if: {t_if:.4f} sec")
201print(f"expit    : {t_ex:.4f} sec")