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

randomtrade_canonical_entropy_save.py をダウンロード

randomtrade_canonical_entropy_save.py
randomtrade_canonical_entropy_save.py
  1"""
  2概要:
  3    閉じた資産交換模型のシミュレーションを実行します。
  4詳細説明:
  5    全体系を A(小さい部分系)と B(大きい熱浴)に分け、各人がもつ資産を
  6    1 単位ずつランダムに交換します。資産は負にならず、全資産は保存されます。
  7
  8    下段の H は一人を無作為に選んだときの資産値の経験分布の Shannon エントロピー
  9    H = - sum_m p(m) log p(m) です。整数の資産値をそのまま数えているため、
 10    時刻ごとにヒストグラムのビンを取り直すことによる見かけの変化はありません。
 11    これは熱力学的エントロピー k_B log W そのものではない点に注意します。
 12
 13    第3段は、この離散模型の状態数 Omega_N(M) = (M+N-1)! / [M! (N-1)!] から
 14    計算する小正準エントロピー S/k_B = log Omega です。
 15"""
 16
 17from collections import Counter
 18import argparse
 19import math
 20import random
 21from pathlib import Path
 22
 23import matplotlib as mpl
 24import numpy as np
 25
 26# 日本語フォントは、環境内で実際に認識された名前を使う。
 27mpl.rcdefaults()
 28mpl.rcParams.update(
 29    {
 30        "font.family": "Yu Mincho",
 31        "font.size": 14,
 32        "axes.unicode_minus": False,
 33        "text.usetex": False,
 34    }
 35)
 36
 37import matplotlib.pyplot as plt
 38from matplotlib.animation import FuncAnimation
 39
 40
 41# ----- パラメータ -----
 42NA = 50          # グループ A の人数(小さい部分系)
 43NB = 500         # グループ B の人数(大きい熱浴)
 44MA0 = 100          # 各人の初期資産
 45MB0 = 50          # 各人の初期資産
 46VTRADE = 1       # 1 回の交換額(整数にする)
 47NITER = 10_000   # スイープ回数
 48RECORD_EVERY = 1 # 何スイープごとに記録するか
 49ANIMATION_EVERY = 100  # 分布アニメーションの記録間隔(スイープ数)
 50ANIMATION_INTERVAL_MS = 150
 51DISPLAY_BIN_WIDTH = 5  # アニメーション表示用の資産ビン幅
 52SEED = None      # 再現したいときは、例えば 1234 を指定する
 53
 54
 55def parse_args():
 56    """
 57    概要:
 58        コマンドライン引数をパースします。
 59    戻り値:
 60        :returns: コマンドライン引数を格納したNamespace。
 61        :rtype: argparse.Namespace
 62    """
 63    parser = argparse.ArgumentParser(
 64        description="小系 A と有限熱浴 B のランダム資産交換模型"
 65    )
 66    parser.add_argument("--na", type=int, default=NA, help=f"系 A の人数(既定値: {NA})")
 67    parser.add_argument("--nb", type=int, default=NB, help=f"系 B の人数(既定値: {NB})")
 68    parser.add_argument("--ma0", type=int, default=MA0, help=f"A の一人あたり初期資産(既定値: {MA0})")
 69    parser.add_argument("--mb0", type=int, default=MB0, help=f"B の一人あたり初期資産(既定値: {MB0})")
 70    parser.add_argument("--vtrade", type=int, default=VTRADE, help=f"1 回の交換額(既定値: {VTRADE})")
 71    parser.add_argument("--niter", type=int, default=NITER, help=f"スイープ回数(既定値: {NITER})")
 72    parser.add_argument("--record-every", type=int, default=RECORD_EVERY, help="記録間隔(スイープ数)")
 73    parser.add_argument("--animation-every", type=int, default=ANIMATION_EVERY, help="アニメーションの記録間隔")
 74    parser.add_argument("--animation-interval", type=int, default=ANIMATION_INTERVAL_MS, help="アニメーションのフレーム間隔 [ms]")
 75    parser.add_argument("--bin-width", type=int, default=DISPLAY_BIN_WIDTH, help="分布表示用ビン幅")
 76    parser.add_argument("--seed", type=int, default=SEED, help="乱数種")
 77    parser.add_argument("--save-png", metavar="PATH", help="時系列グラフを PNG へ保存")
 78    parser.add_argument("--save-gif", metavar="PATH", help="資産分布アニメーションを GIF へ保存(Pillow が必要)")
 79    parser.add_argument("--gif-fps", type=float, default=None, help="GIF のフレームレート [fps]")
 80    parser.add_argument("--dpi", type=int, default=150, help="PNG/GIF 保存時の解像度")
 81    parser.add_argument("--no-show", action="store_true", help="描画ウィンドウを開かない")
 82    args = parser.parse_args()
 83
 84    for name in ("na", "nb", "vtrade", "niter", "record_every", "animation_every", "animation_interval", "bin_width", "dpi"):
 85        if getattr(args, name) <= 0:
 86            parser.error(f"--{name.replace('_', '-')} は正の値にしてください。")
 87    if args.ma0 < 0 or args.mb0 < 0:
 88        parser.error("--ma0 と --mb0 は 0 以上にしてください。")
 89    if args.gif_fps is not None and args.gif_fps <= 0:
 90        parser.error("--gif-fps は正の値にしてください。")
 91    return args
 92
 93
 94def output_path(path_text):
 95    """
 96    概要:
 97        保存先の親ディレクトリを作成して Path を返します。
 98    引数:
 99        :param path_text: 保存先を示すパス文字列。
100        :type path_text: str
101    戻り値:
102        :returns: 作成されたディレクトリを含むパスオブジェクト。
103        :rtype: pathlib.Path
104    """
105    path = Path(path_text)
106    path.parent.mkdir(parents=True, exist_ok=True)
107    return path
108
109
110def shannon_entropy(values):
111    """
112    概要:
113        資産値の経験分布の Shannon エントロピーを返します。
114    詳細説明:
115        自然対数を使用してエントロピーを計算します。
116    引数:
117        :param values: 資産値のリストなどのイテラブル。
118        :type values: list
119    戻り値:
120        :returns: 計算された Shannon エントロピー。
121        :rtype: float
122    """
123    n = len(values)
124    counts = Counter(values).values()
125    return -sum((count / n) * math.log(count / n) for count in counts)
126
127
128def log_omega(n_people, total_money):
129    """
130    概要:
131        非負整数の総資産を複数人へ配る状態数の自然対数を計算します。
132    詳細説明:
133        状態数の対数 log(n!) は Stirling 近似ではなく math.lgamma を用いて計算します。
134    引数:
135        :param n_people: 対象の人数。
136        :type n_people: int
137        :param total_money: 割り当てる総資産。
138        :type total_money: int
139    戻り値:
140        :returns: 状態数の自然対数。
141        :rtype: float
142    例外:
143        :raises ValueError: 総資産が負の場合に発生します。
144    """
145    if total_money < 0:
146        raise ValueError("総資産は非負でなければなりません。")
147    return (
148        math.lgamma(total_money + n_people)
149        - math.lgamma(total_money + 1)
150        - math.lgamma(n_people)
151    )
152
153
154def main(args):
155    """
156    概要:
157        資産交換シミュレーションのメイン処理を実行します。
158    詳細説明:
159        系AとBの間で資産をランダムに交換し、平均資産、エントロピー、および
160        資産分布の推移を計算します。結果はプロットされ、必要に応じて
161        画像やアニメーションとして保存されます。
162    引数:
163        :param args: コマンドライン引数を格納したNamespace。
164        :type args: argparse.Namespace
165    """
166    NA = args.na
167    NB = args.nb
168    MA0 = args.ma0
169    MB0 = args.mb0
170    VTRADE = args.vtrade
171    NITER = args.niter
172    RECORD_EVERY = args.record_every
173    ANIMATION_EVERY = args.animation_every
174    ANIMATION_INTERVAL_MS = args.animation_interval
175    DISPLAY_BIN_WIDTH = args.bin_width
176
177    rng = random.Random(args.seed)
178    n_total = NA + NB
179    money = [MA0] * n_total
180    money[NA:n_total] = [MB0] * NB
181    total_money = sum(money)
182
183    steps = []
184    mean_a_history = []
185    mean_b_history = []
186    entropy_a_history = []
187    entropy_b_history = []
188    entropy_all_history = []
189    micro_entropy_a_history = []
190    micro_entropy_b_history = []
191    micro_entropy_total_history = []
192    distribution_frames = []
193
194    def record(step):
195        money_a = money[:NA]
196        money_b = money[NA:]
197
198        steps.append(step)
199        mean_a_history.append(sum(money_a) / NA)
200        mean_b_history.append(sum(money_b) / NB)
201        entropy_a_history.append(shannon_entropy(money_a))
202        entropy_b_history.append(shannon_entropy(money_b))
203        entropy_all_history.append(shannon_entropy(money))
204
205        # これは資産ヒストグラムの Shannon エントロピーとは別物である。
206        # A の全資産 M_A に対し、Omega_A(M_A) 個の微視的資産配置を数える。
207        total_money_a = sum(money_a)
208        total_money_b = total_money - total_money_a
209        s_a = log_omega(NA, total_money_a)
210        s_b = log_omega(NB, total_money_b)
211        micro_entropy_a_history.append(s_a)
212        micro_entropy_b_history.append(s_b)
213        micro_entropy_total_history.append(s_a + s_b)
214
215        if step % ANIMATION_EVERY == 0:
216            # 後から状態が変わってもよいように、ここでコピーを保存する。
217            distribution_frames.append((step, money_a.copy(), money_b.copy()))
218
219    # t = 0 も記録する。全員が M0 なので、ここで H = 0 になる。
220    record(0)
221
222    # 1 スイープ = 全人数と同じ回数だけ交換相手を選ぶ。
223    for step in range(1, NITER + 1):
224        for _ in range(n_total):
225            giver = rng.randrange(n_total)
226            receiver = rng.randrange(n_total)
227
228            if giver == receiver or money[giver] < VTRADE:
229                continue
230
231            money[giver] -= VTRADE
232            money[receiver] += VTRADE
233
234        if step % RECORD_EVERY == 0:
235            record(step)
236
237    assert sum(money) == total_money, "全資産が保存されていません。"
238
239    fig, (ax_mean, ax_entropy, ax_micro) = plt.subplots(
240        3, 1, figsize=(6, 8), sharex=True, constrained_layout=True
241    )
242
243    ax_mean.plot(steps, mean_a_history, label=r"$\langle M \rangle_A$")
244    ax_mean.plot(steps, mean_b_history, label=r"$\langle M \rangle_B$")
245    ax_mean.axhline(MA0, color="0.5", linestyle=":", linewidth=1.5, label="A初期平均")
246    ax_mean.axhline(MB0, color="0.5", linestyle="--", linewidth=1.5, label="B初期平均")
247    ax_mean.set_title("平均資産の推移")
248    ax_mean.set_ylabel("平均資産")
249    ax_mean.legend()
250    ax_mean.grid(alpha=0.25)
251
252    ax_entropy.plot(steps, entropy_all_history, color="0.25", label="全体系")
253    ax_entropy.plot(steps, entropy_a_history, label=r"$H_A$")
254    ax_entropy.plot(steps, entropy_b_history, label=r"$H_B$")
255    ax_entropy.set_title("資産分布の Shannon エントロピー")
256    ax_entropy.set_ylabel(r"$H=-\sum_m p(m)\log p(m)$")
257    ax_entropy.legend()
258    ax_entropy.grid(alpha=0.25)
259
260    ax_micro.plot(steps, micro_entropy_a_history, label=r"$S_A/k_{\rm B}$")
261    ax_micro.plot(steps, micro_entropy_b_history, label=r"$S_B/k_{\rm B}$")
262    ax_micro.plot(
263        steps,
264        micro_entropy_total_history,
265        color="0.2",
266        linewidth=2,
267        label=r"$(S_A+S_B)/k_{\rm B}$",
268    )
269    ax_micro.set_title("状態数から求めた小正準エントロピー")
270    ax_micro.set_xlabel("スイープ数")
271    ax_micro.set_ylabel(r"$S/k_{\rm B}=\log\Omega$")
272    ax_micro.legend()
273    ax_micro.grid(alpha=0.25)
274
275    # ----- A, B の資産分布のアニメーション -----
276    # 全フレームで同じ粗いビンを使う。縦軸は各フレームで A・B 共通に
277    # 自動調整し、初期状態の高さ 1 によって平衡後の分布が潰れないようにする。
278    largest_money = max(
279        max(max(money_a), max(money_b))
280        for _, money_a, money_b in distribution_frames
281    )
282    bins = list(range(0, largest_money + DISPLAY_BIN_WIDTH + 1, DISPLAY_BIN_WIDTH))
283    if bins[-1] <= largest_money:
284        bins.append(bins[-1] + DISPLAY_BIN_WIDTH)
285
286    fig_dist, (ax_a, ax_b) = plt.subplots(
287        2, 1, figsize=(8, 6), sharex=True, sharey=True, constrained_layout=True
288    )
289
290    def draw_distribution(frame_index):
291        step, money_a, money_b = distribution_frames[frame_index]
292        count_a, _ = np.histogram(money_a, bins=bins)
293        count_b, _ = np.histogram(money_b, bins=bins)
294        y_max = 1.10 * max(count_a.max() / NA, count_b.max() / NB, 0.02)
295
296        ax_a.clear()
297        ax_b.clear()
298        ax_a.hist(
299            money_a,
300            bins=bins,
301            weights=[1 / NA] * NA,
302            color="tab:blue",
303            edgecolor="white",
304        )
305        ax_b.hist(
306            money_b,
307            bins=bins,
308            weights=[1 / NB] * NB,
309            color="tab:orange",
310            edgecolor="white",
311        )
312
313        ax_a.set_title(f"系 A の資産分布(sweep = {step})")
314        ax_b.set_title(f"系 B の資産分布(sweep = {step})")
315        ax_a.set_ylabel("確率")
316        ax_b.set_ylabel("確率")
317        ax_b.set_xlabel("一人あたりの資産 $m$")
318        for ax in (ax_a, ax_b):
319            ax.set_xlim(0, bins[-1])
320            ax.set_ylim(0, y_max)
321            ax.grid(alpha=0.25)
322
323    animation = FuncAnimation(
324        fig_dist,
325        draw_distribution,
326        frames=len(distribution_frames),
327        interval=ANIMATION_INTERVAL_MS,
328        repeat=True,
329        blit=False,
330    )
331    # 参照を figure にも保持し、アニメーションが破棄されないようにする。
332    fig_dist._distribution_animation = animation
333
334    if args.save_png:
335        png_path = output_path(args.save_png)
336        fig.savefig(png_path, dpi=args.dpi)
337        print(f"時系列グラフを保存しました: {png_path}")
338
339    if args.save_gif:
340        gif_path = output_path(args.save_gif)
341        gif_fps = args.gif_fps or 1000 / ANIMATION_INTERVAL_MS
342        try:
343            animation.save(gif_path, writer="pillow", fps=gif_fps, dpi=args.dpi)
344        except (ImportError, ValueError) as exc:
345            raise RuntimeError(
346                "GIF 保存には Pillow が必要です。"
347                " 例: python -m pip install pillow"
348            ) from exc
349        print(f"分布アニメーションを保存しました: {gif_path}")
350
351    print(f"初期値: H_A = {entropy_a_history[0]:.6f}, "
352          f"H_B = {entropy_b_history[0]:.6f}, "
353          f"H_all = {entropy_all_history[0]:.6f}")
354    print(f"最終値: H_A = {entropy_a_history[-1]:.6f}, "
355          f"H_B = {entropy_b_history[-1]:.6f}, "
356          f"H_all = {entropy_all_history[-1]:.6f}")
357    print(
358        f"分布アニメーション: 0 から {NITER} sweep まで、"
359        f"{ANIMATION_EVERY} sweep 間隔で表示します。"
360    )
361
362    if not args.no_show:
363        plt.show()
364    else:
365        plt.close("all")
366
367
368if __name__ == "__main__":
369    main(parse_args())