test_vdPauw_compare.py ダウンロード/コピー
test_vdPauw_compare.py をダウンロード
test_vdPauw_compare.py
test_vdPauw_compare.py
1"""
2概要:
3 refactored版を基準に、指定プログラムの計算結果を比較する。
4詳細説明:
5 実行例として python test_vdPauw_compare.py vdPauw_verbose.py や、
6 python test_vdPauw_compare.py vdPauw_verbose.py --rtol 1e-8 などがある。
7 基準ファイル vdPauw_refactored.py は、このテストと同じフォルダーに置く。
8 対象の仕様として vdp_factor(r) および calculate_factors(r_values) を実装している必要がある。
9 対象をimportして実行するので、信頼できるプログラムだけを指定すること。
10"""
11
12import argparse
13import importlib.util
14from pathlib import Path
15import sys
16
17import numpy as np
18
19
20def load_module(path, name):
21 """
22 概要:
23 パスを指定してモジュールを読み込む。
24 詳細説明:
25 実行ガード内のmainは動かない。
26 引数:
27 :param path: モジュールのファイルパス。
28 :type path: str または pathlib.Path
29 :param name: インポート時に割り当てるモジュール名。
30 :type name: str
31 戻り値:
32 :returns: 読み込まれたモジュールオブジェクト。
33 :rtype: module
34 例外:
35 :raises ImportError: モジュールを読み込めない場合に発生する。
36 """
37 path = Path(path).resolve()
38 spec = importlib.util.spec_from_file_location(name, path)
39 if spec is None or spec.loader is None:
40 raise ImportError(f"モジュールを読み込めません: {path}")
41 module = importlib.util.module_from_spec(spec)
42 sys.modules[name] = module
43 spec.loader.exec_module(module)
44 return module
45
46
47def compare_results(reference, target, r_values, *, rtol, atol):
48 """
49 概要:
50 スカラー関数と配列関数を比較し、不一致ならAssertionErrorを送出する。
51 引数:
52 :param reference: 基準となるモジュール。
53 :type reference: module
54 :param target: 比較対象のモジュール。
55 :type target: module
56 :param r_values: テストに用いるR値の配列。
57 :type r_values: numpy.ndarray
58 :param rtol: 相対許容誤差。
59 :type rtol: float
60 :param atol: 絶対許容誤差。
61 :type atol: float
62 例外:
63 :raises AssertionError: 対象に必要な関数がない場合、結果の配列形状が不一致の場合、NaNまたは無限大を検出した場合、許容誤差範囲内で一致しなかった場合に発生する。
64 """
65 for name in ("vdp_factor", "calculate_factors"):
66 if not callable(getattr(target, name, None)):
67 raise AssertionError(f"対象に必要な関数がありません: {name}")
68
69 for name in ("vdp_factor", "calculate_factors"):
70 if name == "vdp_factor":
71 expected = np.array([reference.vdp_factor(r) for r in r_values])
72 actual = np.array([target.vdp_factor(r) for r in r_values])
73 else:
74 # 一方の関数が入力を書き換えても、他方の入力に影響させない。
75 expected = np.asarray(reference.calculate_factors(r_values.copy()))
76 actual = np.asarray(target.calculate_factors(r_values.copy()))
77 if actual.shape != expected.shape:
78 raise AssertionError(f"{name}: 配列形状が不一致 "
79 f"{actual.shape} != {expected.shape}")
80 if not (np.isfinite(expected).all() and np.isfinite(actual).all()):
81 raise AssertionError(f"{name}: NaNまたは無限大を検出しました")
82 abs_diff = np.abs(actual - expected)
83 relative_diff = abs_diff / np.maximum(np.abs(expected), np.finfo(float).tiny)
84 worst = int(np.argmax(relative_diff))
85 print(f"{name}: 最大絶対差={np.max(abs_diff):.3e}, "
86 f"最大相対差={relative_diff[worst]:.3e} (R={r_values[worst]:.6g})",
87 flush=True)
88 np.testing.assert_allclose(actual, expected, rtol=rtol, atol=atol,
89 equal_nan=False, err_msg=f"{name}: 基準と不一致")
90 print(f" PASS: {len(r_values)}点が許容誤差内で一致", flush=True)
91
92
93def initialize(argv=None):
94 """
95 概要:
96 コマンドライン引数を解析して初期設定を行う。
97 引数:
98 :param argv: コマンドライン引数のリスト。デフォルトはNone。
99 :type argv: list または None
100 戻り値:
101 :returns: 解析された引数を含むNamespaceオブジェクト。
102 :rtype: argparse.Namespace
103 """
104 parser = argparse.ArgumentParser(description=__doc__,
105 formatter_class=argparse.RawDescriptionHelpFormatter)
106 parser.add_argument("program", type=Path, help="比較対象のPythonプログラム")
107 parser.add_argument("--min_R", type=float, default=1e-8)
108 parser.add_argument("--max_R", type=float, default=1e8)
109 parser.add_argument("--npoints", type=int, default=161)
110 parser.add_argument("--rtol", type=float, default=1e-8)
111 parser.add_argument("--atol", type=float, default=1e-12)
112 args = parser.parse_args(argv)
113 if not (np.isfinite(args.min_R) and np.isfinite(args.max_R)
114 and 0 < args.min_R < args.max_R and args.npoints >= 2):
115 parser.error("有限の0 < min_R < max_R、npoints >= 2が必要です")
116 if not (np.isfinite(args.rtol) and np.isfinite(args.atol)
117 and args.rtol >= 0 and args.atol >= 0):
118 parser.error("rtolとatolは有限の非負値にしてください")
119 return args
120
121
122def main(argv=None):
123 """
124 概要:
125 テストスクリプトのメイン処理を実行する。
126 詳細説明:
127 コマンドライン引数に基づいて基準と対象のモジュールを読み込み、計算結果を比較する。
128 引数:
129 :param argv: コマンドライン引数のリスト。デフォルトはNone。
130 :type argv: list または None
131 """
132 args = initialize(argv)
133 reference_path = Path(__file__).resolve().with_name("vdPauw_refactored.py")
134 print(f"基準: {reference_path}", flush=True)
135 print(f"対象: {args.program.resolve()}", flush=True)
136 print(f"設定: min_R={args.min_R:g}, max_R={args.max_R:g}, "
137 f"npoints={args.npoints}, rtol={args.rtol:g}, atol={args.atol:g}", flush=True)
138 reference = load_module(reference_path, "_vdp_reference")
139 target = load_module(args.program, "_vdp_target")
140 r_values = np.geomspace(args.min_R, args.max_R, args.npoints)
141 compare_results(reference, target, r_values, rtol=args.rtol, atol=args.atol)
142 print("全比較に合格しました。")
143
144
145if __name__ == "__main__":
146 main()