"""
概要:
    tkfermi_integralの関数群をテストしベンチマークを実行するスクリプトです。

詳細説明:
    fermi_dirac_e_npvector、fermi_dirac_e_if、fermi_dirac_eをtkfermi_integralから読み込みます。
    指定されたxの値について基準値からの相対誤差を計算し、tol=1e-20を基準としてテストを行いFAILかPASSかを出力します。
    出力には各関数の値とdiff値を含みます。また、各関数の実行速度を比較するためのベンチマークも行います。
"""

import numpy as np
import time
from tkfermi_integral import (
    fermi_dirac_e_npvector,
    fermi_dirac_e_if,
    fermi_dirac_e
)

# ------------------------------------------------------------
# Test points
# ------------------------------------------------------------
x_values = np.array([
    -1000,
    -100, -50, -40, -20, -10, -5, -2, -1, -0.5, -0.1,
     0.0, 0.1, 0.5, 1.0, 2, 5, 10, 20, 40, 50, 100,
     300, 500, 600, 700, 800, 900, 1000
], dtype=float)

eta = 0.0
g = 1.0
tol = 1e-20

# ------------------------------------------------------------
# Helper: relative error
# ------------------------------------------------------------
def relerr(a, b):
    """
    概要:
        2つの値の相対誤差を計算します。
    
    引数:
        :param a: 比較対象の値
        :type a: float または numpy.ndarray
        :param b: 基準となる値
        :type b: float または numpy.ndarray
    
    戻り値:
        :returns: 計算された相対誤差
        :rtype: float または numpy.ndarray
    """
    return np.abs(a - b) / np.maximum(np.abs(b), 1e-300)

# ------------------------------------------------------------
# Wrappers to unify interface
# ------------------------------------------------------------
def fd_high_precision_scalar(x, eta, g):
    """
    概要:
        fermi_dirac_e_npvectorのスカララッパー関数です。
    
    引数:
        :param x: 評価するxの値
        :type x: float
        :param eta: etaパラメータ
        :type eta: float
        :param g: gパラメータ
        :type g: float
    
    戻り値:
        :returns: 計算された関数の値
        :rtype: float
    """
    return fermi_dirac_e_npvector(np.array([x]))[0]

def fd_if_scalar(x, eta, g):
    """
    概要:
        fermi_dirac_e_ifのスカララッパー関数です。
    
    引数:
        :param x: 評価するxの値
        :type x: float
        :param eta: etaパラメータ
        :type eta: float
        :param g: gパラメータ
        :type g: float
    
    戻り値:
        :returns: 計算された関数の値
        :rtype: float
    """
    return fermi_dirac_e_if(x, eta, g)

def fd_expit_scalar(x, eta, g):
    """
    概要:
        fermi_dirac_eのスカララッパー関数です。
    
    引数:
        :param x: 評価するxの値
        :type x: float
        :param eta: etaパラメータ
        :type eta: float
        :param g: gパラメータ
        :type g: float
    
    戻り値:
        :returns: 計算された関数の値
        :rtype: float
    """
    return fermi_dirac_e(x, eta, g)

# ------------------------------------------------------------
# Test each function
# ------------------------------------------------------------
def test_function(name, func, x_values, ref_values):
    """
    概要:
        対象関数をテストし基準値との差異を判定して結果を出力します。
    
    詳細説明:
        許容誤差 tol と比較し、誤差が許容範囲内であれば PASS を、そうでなければ FAIL を標準出力に出力します。
    
    引数:
        :param name: テストする関数の名前
        :type name: str
        :param func: テスト対象の関数
        :type func: callable
        :param x_values: テストで使用する入力値の配列
        :type x_values: numpy.ndarray
        :param ref_values: 基準となる計算値の配列
        :type ref_values: numpy.ndarray
    
    戻り値:
        :returns: 戻り値はありません。
        :rtype: None
    """
    print(f"\n=== Testing {name} ===")
    for x, ref in zip(x_values, ref_values):
        val = func(x, eta, g)
        diff = relerr(val, ref)
        status = "PASS" if diff < tol else "FAIL"
        print(f"x={x:8.2f}  val={val:.8e}  ref={ref:.8e}  diff={diff:.3e}  {status}")

# ------------------------------------------------------------
# Compute reference (high precision)
# ------------------------------------------------------------
ref_values = fermi_dirac_e_npvector(x_values)

# ------------------------------------------------------------
# Run tests
# ------------------------------------------------------------
#test_function("high_precision", fd_high_precision_scalar, x_values, ref_values)
test_function("scalar_if", fd_if_scalar, x_values, ref_values)
test_function("expit", fd_expit_scalar, x_values, ref_values)

# ------------------------------------------------------------
# Benchmark
# ------------------------------------------------------------
def benchmark(name, func, x_values, repeat=20000):
    """
    概要:
        対象関数の実行時間を計測するベンチマーク関数です。
    
    詳細説明:
        nameで指定された文字列に基づいて実行する関数を切り替え、指定回数だけ処理を繰り返して実行時間を計測します。
    
    引数:
        :param name: ベンチマーク処理を分岐するための名前
        :type name: str
        :param func: 比較対象となる関数
        :type func: callable
        :param x_values: 計算に使用する入力値の配列
        :type x_values: numpy.ndarray
        :param repeat: 繰り返し実行する回数
        :type repeat: int
    
    戻り値:
        :returns: 処理にかかった合計秒数
        :rtype: float
    """
    t0 = time.time()
    for _ in range(repeat):
        # vectorized version for speed test
        if name == "npvector":
            fermi_dirac_e_npvector(x_values)
        elif name == "scalar_if":
            np.array([fermi_dirac_e_if(x, eta, g) for x in x_values])
        else:
            fermi_dirac_e(x_values, eta, g)
    t1 = time.time()
    return t1 - t0

print("\n=== Benchmark (lower is faster) ===")
t_np = benchmark("npvector", fd_high_precision_scalar, x_values)
t_if = benchmark("scalar_if", fd_if_scalar, x_values)
t_ex = benchmark("expit", fd_expit_scalar, x_values)

print(f"npvector : {t_np:.4f} sec")
print(f"scalar_if: {t_if:.4f} sec")
print(f"expit    : {t_ex:.4f} sec")