
# ============================================================
# 中文名称: GTJA Alpha #173
# 简要说明: 国泰君安191短周期交易型alpha因子第173号，详见公式定义。
# 典型用途: 在A股市场经中性化处理后用于选股或股指期货日内交易。
# ============================================================
"""GTJA Alpha 173 (国泰君安 191 短周期交易型 alpha 因子, 2014).

Formula (verbatim from the report):
    3*SMA(CLOSE,13,2)-2*SMA(SMA(CLOSE,13,2),13,2)+SMA(SMA(SMA(LOG(CLOSE),13,2),13,2),13,2)

Notes: 
"""
from __future__ import annotations

import numpy as np
import pandas as pd

from src.factors.base import (
    decay_linear,
    delta,
    rank,
    safe_div,
    scale,
    signed_power,
    ts_argmax,
    ts_argmin,
    ts_corr,
    ts_cov,
    ts_max,
    ts_mean,
    ts_min,
    ts_rank,
    ts_std,
)

ALPHA_ID = "gtja191_173"

__alpha_meta__ = {
    'id': 'gtja191_173',
    'theme': ['momentum'],
    'formula_latex': '3*sma(c,13,2)-2*sma(sma(c,13,2),13,2)+sma(sma(sma(log(c),13,2),13,2),13,2)',
    'columns_required': ['close'],
    'extras_required': [],
    'universe': ['equity_cn'],
    'frequency': ['1d'],
    'decay_horizon': 13,
    'min_warmup_bars': 40,
    'notes': '',
}


def compute(panel):
    """Compute gtja191_173.

    Args:
        panel: dict[str, pd.DataFrame] with at least the required columns.

    Returns:
        pd.DataFrame with index = panel["close"].index, columns = panel["close"].columns.
    """
    def _sma(x, n, m):
        """SMA(x, n, m) per GTJA convention -> ewm with alpha = m/n."""
        return x.ewm(alpha=m / n, adjust=False).mean()
    c = panel["close"]
    s1 = _sma(c, 13, 2)
    s2 = _sma(s1, 13, 2)
    s3 = _sma(_sma(_sma(np.log(c), 13, 2), 13, 2), 13, 2)
    out = 3.0 * s1 - 2.0 * s2 + s3
    return out
