#!/usr/bin/env python3
"""
概要:
    外部からのランダムな増減を受ける資産モデルのシミュレーションを行います。
詳細説明:
    各個人の資産が独立して外部からのランダムな変動を受ける様子を計算し、可視化します。
    シミュレーション結果は画面表示のほか、PNG画像やGIFアニメーションとして保存できます。
関連リンク:
    randommoney2_usage
"""

import argparse
import random
from math import log
from pathlib import Path

import matplotlib as mpl
from matplotlib import pyplot as plt
from matplotlib.animation import FuncAnimation, PillowWriter


mpl.rcParams.update({
    "font.family": ["Yu Mincho", "MS Mincho", "serif"],
    "axes.unicode_minus": False,
    "text.usetex": False,
})


def parse_args():
    """
    概要:
        比較用プログラムと共通のコマンドライン引数を解析します。
    詳細説明:
        argparseを使用して、人数や初期資産、外部変動の最大値、スイープ数などのパラメータを設定します。
    戻り値:
        :returns: 解析されたコマンドライン引数を格納した名前空間オブジェクト。
        :rtype: argparse.Namespace
    """
    parser = argparse.ArgumentParser(description="外部ランダム変動を受ける資産分布を可視化します。")
    parser.add_argument("--npersons", type=int, default=200, help="人数（既定値: 200）")
    parser.add_argument("--value", type=float, default=100, help="一人当たりの初期資産（既定値: 10）")
    parser.add_argument(
        "--vtrade", type=float, default=1,
        help="一回の外部変動の最大絶対値。Δm は [-vtrade, +vtrade]（既定値: 1）",
    )
    parser.add_argument("--niter", type=int, default=100000, help="スイープ数（既定値: 100000）")
    parser.add_argument("--record-every", type=int, default=100, help="状態を記録する間隔（既定値: 100）")
    parser.add_argument("--nbins", type=int, default=21, help="資産分布のビン数（既定値: 21）")
    parser.add_argument("--interval", type=int, default=200, help="GIF のフレーム間隔 [ms]（既定値: 200）")
    parser.add_argument("--gif-fps", type=int, default=5, help="GIF の毎秒フレーム数（既定値: 5）")
    parser.add_argument("--seed", type=int, default=None, help="乱数シード")
    parser.add_argument("--save-png", type=Path, metavar="FILE", help="最終状態を PNG 保存")
    parser.add_argument("--save-gif", type=Path, metavar="FILE", help="時間発展を GIF 保存")
    parser.add_argument("--dpi", type=int, default=150, help="保存画像の dpi（既定値: 150）")
    parser.add_argument("--no-show", action="store_true", help="画面にグラフを表示しない")
    args = parser.parse_args()
    if args.npersons <= 0 or args.value < 0 or args.vtrade <= 0:
        parser.error("--npersons は正、--value は非負、--vtrade は正にしてください。")
    if args.niter < 0 or args.record_every <= 0 or args.nbins < 2:
        parser.error("--niter は非負、--record-every は正、--nbins は 2 以上にしてください。")
    return args


def fluctuate_one_sweep(money, amplitude, rng):
    """
    概要:
        全員の資産へ独立な一様乱数の増減を加えます。
    詳細説明:
        各個人の資産に対して、指定された振幅の範囲内でランダムな増減を行います。
        資産は負にならないように0.0で下限が設定されます。
    引数:
        :param money: 各個人の資産を格納したリスト。
        :type money: list
        :param amplitude: 一回の変動の最大絶対値。
        :type amplitude: float
        :param rng: 乱数生成器オブジェクト。
        :type rng: random.Random
    戻り値:
        :returns: 戻り値はありません。
        :rtype: None
    """
    for index in range(len(money)):
        money[index] = max(0.0, money[index] + rng.uniform(-amplitude, amplitude))


def shannon_entropy(money, nbins, hist_max):
    """
    概要:
        固定ビンの資産分布からシャノンエントロピーを計算します。
    詳細説明:
        ヒストグラムの最大値とビン数からビン幅を求め、各ビンに含まれる資産の割合を確率として計算します。
        H = -Σp log(p) の式を用いてエントロピーを算出します。
    引数:
        :param money: 各個人の資産を格納したリスト。
        :type money: list
        :param nbins: ヒストグラムのビン数。
        :type nbins: int
        :param hist_max: ヒストグラムの最大値。
        :type hist_max: float
    戻り値:
        :returns: 計算されたシャノンエントロピーの値。
        :rtype: float
    """
    counts = [0] * nbins
    bin_width = hist_max / nbins
    for amount in money:
        index = min(int(amount / bin_width), nbins - 1)
        counts[index] += 1
    probabilities = [count / len(money) for count in counts if count > 0]
    return -sum(p * log(p) for p in probabilities)


def draw_state(axes, frame_index, frames, entropy_history, args, hist_max):
    """
    概要:
        指定されたフレームのシミュレーション状態をグラフに描画します。
    詳細説明:
        4つのサブプロットに対し、現在の資産分布、昇順に並べた資産、ヒストグラム、およびシャノンエントロピーの時間発展を描画します。
    引数:
        :param axes: 描画先のAxesオブジェクトのリスト。
        :type axes: list
        :param frame_index: 描画対象のフレームインデックス。
        :type frame_index: int
        :param frames: 記録されたスイープ数と資産リストのタプルを格納したリスト。
        :type frames: list
        :param entropy_history: 各フレームにおけるエントロピーの履歴リスト。
        :type entropy_history: list
        :param args: コマンドライン引数を格納した名前空間オブジェクト。
        :type args: argparse.Namespace
        :param hist_max: ヒストグラムの最大値。
        :type hist_max: float
    戻り値:
        :returns: 戻り値はありません。
        :rtype: None
    """
    ax1, ax2, ax3, ax4 = axes
    for ax in axes:
        ax.clear()

    sweep, money = frames[frame_index]
    n = args.npersons
    sorted_money = sorted(money)
    average = sum(money) / n

    ax1.bar(range(n), money, width=1.0)
    ax1.axhline(average, linestyle="--", color="red", linewidth=0.8, label="現在の平均")
    ax1.set_title(f"外部ランダム変動（sweep = {sweep}/{args.niter}, N = {n}）")
    ax1.set_xlabel("個人 i")
    ax1.set_ylabel("資産")
    ax1.set_xlim(-0.5, n - 0.5)
    ax1.legend(loc="upper right")

    ax2.bar(range(n), sorted_money, width=1.0)
    ax2.axhline(average, linestyle="--", color="red", linewidth=0.8, label="現在の平均")
    ax2.set_xlabel("順位 i")
    ax2.set_ylabel("資産（昇順）")
    ax2.set_xlim(-0.5, n - 0.5)
    ax2.legend(loc="upper right")

    counts, _, _ = ax3.hist(money, bins=args.nbins, range=(0, hist_max), density=True,
                             histtype="stepfilled", alpha=0.45, label="シミュレーション")
    ax3.set_xlabel("一人あたりの資産 m")
    ax3.set_ylabel("確率密度")
    ax3.set_xlim(0, hist_max)
    ymax = max(max(counts, default=0), 1e-12)
    ax3.set_ylim(0, 1.15 * ymax)
    ax3.legend(loc="upper right")

    sweeps = [item[0] for item in frames[:frame_index + 1]]
    ax4.plot(sweeps, entropy_history[:frame_index + 1], color="green")
    ax4.set_title(r"資産分布の Shannon エントロピー  $H=-\sum_j p_j\log p_j$")
    ax4.set_xlabel("スイープ数")
    ax4.set_ylabel("H")
    ax4.set_xlim(0, max(args.niter, 1))
    ax4.set_ylim(0, max(log(args.nbins) * 1.05, max(entropy_history, default=0) * 1.05, 1))


def prepare_output(path):
    """
    概要:
        出力先ファイルの親ディレクトリを作成します。
    詳細説明:
        指定されたパスの親ディレクトリが存在しない場合は新しく作成します。
    引数:
        :param path: 出力先ファイルのパスオブジェクト。
        :type path: pathlib.Path
    戻り値:
        :returns: 戻り値はありません。
        :rtype: None
    """
    path.parent.mkdir(parents=True, exist_ok=True)


def main():
    """
    概要:
        プログラムのメイン処理を実行します。
    詳細説明:
        引数の解析、シミュレーションの実行、データの記録を行い、最終的にグラフの描画やファイル保存を処理します。
    戻り値:
        :returns: 戻り値はありません。
        :rtype: None
    例外:
        :raises RuntimeError: GIF保存時にPillowがインストールされていない場合に発生します。
    """
    args = parse_args()
    rng = random.Random(args.seed)
    money = [args.value] * args.npersons
    frames = [(0, money.copy())]

    for sweep in range(1, args.niter + 1):
        fluctuate_one_sweep(money, args.vtrade, rng)
        if sweep % args.record_every == 0 or sweep == args.niter:
            frames.append((sweep, money.copy()))

    # 全記録時刻の最大資産を共通上限にするので、ビン範囲は全フレームで固定される。
    hist_max = max(max(values) for _, values in frames)
    hist_max = max(float(hist_max), 1.0)
    entropy_history = [shannon_entropy(values, args.nbins, hist_max) for _, values in frames]

    fig, axes = plt.subplots(4, 1, figsize=(6, 8), constrained_layout=True)
    draw_state(axes, len(frames) - 1, frames, entropy_history, args, hist_max)

    if args.save_png:
        prepare_output(args.save_png)
        fig.savefig(args.save_png, dpi=args.dpi, bbox_inches="tight")
        print(f"PNG を保存しました: {args.save_png}")

    if args.save_gif:
        prepare_output(args.save_gif)

        def update(frame_index):
            draw_state(axes, frame_index, frames, entropy_history, args, hist_max)
            return axes

        animation = FuncAnimation(fig, update, frames=len(frames), interval=args.interval, repeat=True)
        try:
            animation.save(args.save_gif, writer=PillowWriter(fps=args.gif_fps), dpi=args.dpi)
        except (ImportError, ModuleNotFoundError) as exc:
            raise RuntimeError("GIF 保存には Pillow が必要です: python -m pip install pillow") from exc
        print(f"GIF を保存しました: {args.save_gif}")

    if not args.no_show:
        plt.show()


if __name__ == "__main__":
    main()