♻️ refactor(tsl-api): tighten docs and retire stale tests

This commit is contained in:
csh
2026-08-21 10:11:48 +08:00
parent 2e8c46e152
commit 5484fc7519
24 changed files with 505 additions and 2700 deletions
@@ -58,11 +58,11 @@ return ContinuedMatchOfNDay(@close(), 3);
<!-- tags: 数据仓库 向导函数 N 日 -->
| 参数 | 类型 | 说明 |
| ----------- | ------ | ------------------- |
| `exp_1` | string | 字符串。统计表达式1 |
| `exp_2` | string | 字符串。统计表达式2 |
| `n` | int | 整数。天数 |
| 参数 | 类型 | 说明 |
| ----------- | ------ | -------------------- |
| `exp_1` | string | 字符串。统计表达式1 |
| `exp_2` | string | 字符串。统计表达式2 |
| `n` | int | 整数。天数 |
| `cache_str` | string | 可选。字符串,缓存串 |
返回:float
@@ -164,10 +164,10 @@ N日线性衰减加权平均,与系统参数(股票,日期,周期,复权
<!-- tags: 数据仓库 向导函数 N 日 -->
| 参数 | 类型 | 说明 |
| ----------- | ------ | ------------------ |
| `exp` | string | 字符串。统计表达式 |
| `n` | int | 整数。天数 |
| 参数 | 类型 | 说明 |
| ----------- | ------ | -------------------- |
| `exp` | string | 字符串。统计表达式 |
| `n` | int | 整数。天数 |
| `cache_str` | string | 可选。字符串,缓存串 |
返回:float
@@ -293,10 +293,10 @@ N日最高点到当前的周期数。N日表示市场交易日,当日最低为
<!-- tags: 数据仓库 向导函数 N 日 -->
| 参数 | 类型 | 说明 |
| ----------- | ------ | ------------------ |
| `exp` | string | 字符串。统计表达式 |
| `n` | int | 整数。天数 |
| 参数 | 类型 | 说明 |
| ----------- | ------ | -------------------- |
| `exp` | string | 字符串。统计表达式 |
| `n` | int | 整数。天数 |
| `cache_str` | string | 可选。字符串,缓存串 |
返回:int
@@ -422,10 +422,10 @@ N日最低点到当前的周期数。N日表示市场交易日,当日最低为
<!-- tags: 数据仓库 向导函数 N 日 -->
| 参数 | 类型 | 说明 |
| ----------- | ------ | ------------------ |
| `exp` | string | 字符串。统计表达式 |
| `n` | int | 整数。天数 |
| 参数 | 类型 | 说明 |
| ----------- | ------ | -------------------- |
| `exp` | string | 字符串。统计表达式 |
| `n` | int | 整数。天数 |
| `cache_str` | string | 可选。字符串,缓存串 |
返回:int
@@ -524,10 +524,10 @@ return OccuredOfNDay(@close(), 10);
<!-- tags: 数据仓库 向导函数 N 日 -->
| 参数 | 类型 | 说明 |
| ----------- | ------ | ------------------ |
| `exp` | string | 字符串。统计表达式 |
| `n` | int | 整数。天数 |
| 参数 | 类型 | 说明 |
| ----------- | ------ | -------------------- |
| `exp` | string | 字符串。统计表达式 |
| `n` | int | 整数。天数 |
| `cache_str` | string | 可选。字符串,缓存串 |
返回:float
@@ -550,10 +550,10 @@ return PercentRankOfNDay(@close(), 10, "");
<!-- tags: 数据仓库 向导函数 N 日 -->
| 参数 | 类型 | 说明 |
| ----------- | ------ | ------------------ |
| `exp` | string | 字符串。统计表达式 |
| `n` | int | 整数。天数 |
| 参数 | 类型 | 说明 |
| ----------- | ------ | -------------------- |
| `exp` | string | 字符串。统计表达式 |
| `n` | int | 整数。天数 |
| `cache_str` | string | 可选。字符串,缓存串 |
返回:float
@@ -130,9 +130,9 @@ Return BondBasisPointValue(Endt, MV);
<!-- tags: 金融 债券 债券敏感性指标 返回 获取 TS -->
| 参数 | 类型 | 说明 |
| ----------------- | -------- | -------- |
| `settlement_date` | datetime | 结算日期 |
| 参数 | 类型 | 说明 |
| ----------------- | -------- | ---------------------------------- |
| `settlement_date` | datetime | 结算日期 |
| `option` | int | 可选。是否行权,默认 0(持有到期) |
返回:float
@@ -233,9 +233,9 @@ return bondMacaulayDuration(endt); // 麦考利久期,返回3.12
<!-- tags: 金融 债券 债券敏感性指标 返回 获取 TS -->
| 参数 | 类型 | 说明 |
| ---------------- | -------- | -------- |
| `settlementdate` | datetime | 结算日 |
| 参数 | 类型 | 说明 |
| ---------------- | -------- | ---------------------------------- |
| `settlementdate` | datetime | 结算日 |
| `option` | int | 可选。是否行权,默认 0(持有到期) |
返回:float
@@ -993,9 +993,9 @@ return FundZjRatio(endt);
<!-- tags: 金融 基金 基金收益率 分级基金 折价率 返回 获取 -->
| 参数 | 类型 | 说明 |
| ----------- | -------- | ------------------------------------------- |
| `end_t` | datetime | 截止日期 |
| 参数 | 类型 | 说明 |
| ----------- | -------- | ------------------------------------------ |
| `end_t` | datetime | 截止日期 |
| `fund_type` | integer | 基金类别;原始文档示例中 `2` 表示分级 B 类 |
返回:float
@@ -195,17 +195,17 @@ return op_hv("SZ000002", 20210101T, -6);
<!-- tags: 金融 期权 基本函数 隐含波动率 Greeks Delta Gamma Theta Vega Rho -->
| 参数 | 类型 | 说明 |
| --------------- | ------- | ---------------------------------------------------- |
| `option_type` | integer | 期权类型,0 为看涨期权,1 为看跌期权 |
| `s` | real | 现货价格 |
| `x` | real | 行权价 |
| `close` | real | 期权交易价格 |
| `r` | real | 无风险收益率百分比 |
| `t` | real | 剩余期限月数 |
| `option_style` | string | 可选。默认行权方式,支持 `欧式``美式` |
| `method` | integer | 可选。默认定价方式,0 为默认,1 为 B_S,2 为二叉树 |
| `contract_type` | integer | 可选。默认 0;0 股票、1 指数、2 外汇、3 期货期权 |
| 参数 | 类型 | 说明 |
| --------------- | ------- | --------------------------------------------------- |
| `option_type` | integer | 期权类型,0 为看涨期权,1 为看跌期权 |
| `s` | real | 现货价格 |
| `x` | real | 行权价 |
| `close` | real | 期权交易价格 |
| `r` | real | 无风险收益率百分比 |
| `t` | real | 剩余期限月数 |
| `option_style` | string | 可选。默认行权方式,支持 `欧式``美式` |
| `method` | integer | 可选。默认定价方式,0 为默认,1 为 B_S,2 为二叉树 |
| `contract_type` | integer | 可选。默认 0;0 股票、1 指数、2 外汇、3 期货期权 |
| `rf` | real | 可选。默认 0;标的资产年股息率或外币无风险年利率(%) |
返回:array
@@ -91,12 +91,12 @@ return bondFutureBasicindicators2(endt, -1, 1, 0);
<!-- tags: 金融 专题函数 衍生品分析 期货专项 常用国债期货基本指标 基于债券估值 返回 获取 -->
| 参数 | 类型 | 说明 |
| --------------- | ----------- | ----------------------------- |
| `end_t` | date | 日期,截止日 |
| `bond_id` | string | 字符串,债券代码 |
| `return_option` | user_define | 用户自定义, 返回结果选项 |
| `market_id` | user_define | 用户自定义, 国债市场选项 |
| 参数 | 类型 | 说明 |
| --------------- | ----------- | ---------------------------------- |
| `end_t` | date | 日期,截止日 |
| `bond_id` | string | 字符串,债券代码 |
| `return_option` | user_define | 用户自定义, 返回结果选项 |
| `market_id` | user_define | 用户自定义, 国债市场选项 |
| `dbtype` | user_define | 可选。用户自定义,国债估值数据来源 |
返回:real
@@ -8,9 +8,9 @@
<!-- tags: 数学算法 压缩估计 均值 -->
| 参数 | 类型 | 说明 |
| -------- | ------ | ------------------------------------------------------------------------------- |
| `data` | array | 二维数据表,T×N,T 期样本数量,N 个股票 |
| 参数 | 类型 | 说明 |
| -------- | ------ | -------------------------------------------------------------------------- |
| `data` | array | 二维数据表,T×N,T 期样本数量,N 个股票 |
| `b_type` | string | 目标均值向量:b0 零向量、b1 均值、b2 波动率加权均值、b3 样本均值的均方误差 |
返回:array