feat(tsl-api-reference): add class and framework API lookup

This commit is contained in:
csh
2026-08-20 13:49:55 +08:00
parent 7233646398
commit 651c1f68d2
637 changed files with 25498 additions and 36673 deletions
@@ -0,0 +1,233 @@
# 应用专题 / 基金研究 / 基金定投
## `ts_AIPBackTesting`
声明:class
在通用回测框架上封装定期定额、均线、价值平均和估值策略的基金定投流程
<!-- tags: 基金 定投 回测框架 定期定额 估值策略 -->
父类:`tsBackTesting`
### `FAIPFund`
声明:field
定投基金代码
可见性:`public`
类型:string
### `FAIPType`
声明:field
定投方法;0 为定期定额,1 为均线策略,2 为价值平均,3 为估值策略
可见性:`public`
类型:integer
### `FOriginalAmount`
声明:field
每期投入金额、基础金额或初始金额,单位为元
可见性:`public`
类型:real
### `FPurchaseRatio`
声明:field
申购费率,单位为百分比
可见性:`public`
类型:real
### `FDeductDay`
声明:field
自然周期内的扣款日;默认 -1 表示周期最后一个交易日
可见性:`public`
类型:integer
### `FStrategyType`
声明:field
均线策略或估值策略的执行方式
可见性:`public`
类型:integer
### `FLparamP`
声明:field
价格或估值高于基准时使用的正杠杆倍数
可见性:`public`
类型:real
### `FLParamN`
声明:field
价格或估值不高于基准时使用的负杠杆倍数
可见性:`public`
类型:real
### `FGearArr`
声明:field
均线偏离度或估值偏离与投资份数之间的分级靠档数据
可见性:`public`
类型:array
### `FMADays`
声明:field
均线策略使用的均线天数,默认 250
可见性:`public`
类型:integer
### `FValType`
声明:field
估值指标类型;0 市盈率、1 市净率、2 市销率、3 市现率
可见性:`public`
类型:integer
### `FValBenchmark`
声明:field
估值策略使用的估值基准,默认 15
可见性:`public`
类型:real
### `FIFTranPCT`
声明:field
是否将估值转换为历史百分位,默认 `False`
可见性:`public`
类型:boolean
### `FValOptArr`
声明:field
估值加权、股票样本、报告期和历史百分位计算参数
可见性:`public`
类型:array
### `BackTest()`
声明:function
执行基金定投回测主流程
可见性:`public`
### `GetTimeSeries()`
声明:function
返回定投周期时间序列;可重写以提供自定义扣款日期
可见性:`public`
返回:array
### `GetTradeOrder(v_end_t)`
声明:function
返回指定日期的基金申购赎回明细;使用框架时必须重写
可见性:`public`
| 参数 | 类型 | 说明 |
| --------- | -------- | ------------ |
| `v_end_t` | datetime | 当前回测日期 |
返回:array
### `GetTA(v_end_t)`
声明:function
返回指定日期的申购赎回资金;可重写
可见性:`public`
| 参数 | 类型 | 说明 |
| --------- | -------- | ------------ |
| `v_end_t` | datetime | 当前回测日期 |
返回:array
### `CumReturn(beg_t, end_t, rtype, annual)`
声明:function
计算区间定投收益率
<!-- tags: 回报率 投资收益 基金 回测 -->
可见性:`public`
| 参数 | 类型 | 说明 |
| -------- | -------- | -------------------------------------------------------- |
| `beg_t` | datetime | 区间开始日 |
| `end_t` | datetime | 区间截止日 |
| `rtype` | integer | 收益率类型:0 时间加权、1 简单、2 资本加权、3 内部收益率 |
| `annual` | boolean | 是否年化,默认不年化 |
返回:real
### `IntervalReturn(begt, endt)`
声明:function
返回区间定投累计收益率走势
<!-- tags: 查询 基金 回测 -->
可见性:`public`
| 参数 | 类型 | 说明 |
| ------ | -------- | ---------- |
| `begt` | datetime | 区间开始日 |
| `endt` | datetime | 区间截止日 |
返回:array
@@ -0,0 +1,596 @@
# 应用专题 / 基金研究 / 风格分析
## `fund_style_index_cfg(type)`
声明:function
基金仓位基准配置函数,用户可自定义
<!-- tags: 持仓 基金产品 比较基准 业绩基准 基金 仓位分析 -->
| 参数 | 类型 | 说明 |
| ------ | ------- | -------------------------------------- |
| `type` | integer | 控制计算方法、数据口径或返回格式的选项 |
返回:array
## `fund_styleQKData(begt, endt, index_id, type)`
声明:function
计算单只基金在指定区间内相对给定基准的风格仓位
<!-- tags: 持仓 基金产品 风格因子 投资风格 基金 仓位分析 -->
| 参数 | 类型 | 说明 |
| ---------- | -------- | -------------------- |
| `begt` | datetime | 区间开始日 |
| `endt` | datetime | 区间截止日 |
| `index_id` | string | 市场基准指数代码 |
| `type` | integer | 用户自定义的基准类型 |
返回:array
## `tsPositionMeasure`
声明:class
复用行情数据、缓存和优化约束,对指定基金与日期执行仓位测算的求解基类
<!-- tags: 基金 仓位测算 数学优化 求解基类 -->
### `FDataNum`
声明:field
回归使用的交易日数,默认 20
可见性:`public`
类型:integer
### `FEndT`
声明:field
仓位测算截止日,默认 `Today()`
可见性:`public`
类型:datetime
### `FCycle`
声明:field
行情数据周期,默认 `日线`
可见性:`public`
类型:string
### `FBaseFund`
声明:field
目标测算基金代码,必须设置
可见性:`public`
类型:string
### `FIndexArr`
声明:field
权益基准代码列表
可见性:`public`
类型:array
### `FBondId`
声明:field
固收基准代码;为空时不配置债券仓位
可见性:`public`
类型:string
### `FifConstant`
声明:field
回归模型是否包含常数项,默认 `True`
可见性:`public`
类型:boolean
### `FObjType`
声明:field
优化目标函数类型;设为 -1 时由 `GetObj` 提供自定义目标
可见性:`public`
类型:integer
### `FConType`
声明:field
约束类型;设为 -1 时由 `GetCon` 提供自定义约束
可见性:`public`
类型:integer
### `FThresholdLower`
声明:field
`FConType` 配合使用的约束下界
可见性:`public`
类型:real
### `FThresholdUpper`
声明:field
`FConType` 配合使用的约束上界
可见性:`public`
类型:real
### `FYdata`
声明:field
目标基金净值收益率序列
可见性:`public`
类型:array
### `FXdata`
声明:field
权益基准收益率矩阵,列顺序与 `FIndexArr` 对应
可见性:`public`
类型:array
### `FOtherX`
声明:field
固收基准收益率序列
可见性:`public`
类型:array
### `Fiffastgetdata`
声明:field
是否优先使用数据仓库中的预计算基金收益率,默认 `True`
可见性:`public`
类型:boolean
### `FifUseCase`
声明:field
是否使用缓存减少重复取数,默认 `True`
可见性:`public`
类型:boolean
### `PortfolioOptimize()`
声明:function
按照优化目标和约束求解仓位配置比例
可见性:`public`
返回:boolean
### `Upm_Endt(EndT)`
声明:function
更新测算截止日并复用约束执行仓位测算
可见性:`public`
| 参数 | 类型 | 说明 |
| ------ | -------- | -------------- |
| `EndT` | datetime | 新的测算截止日 |
返回:boolean
### `Upm_Fund(baseFund)`
声明:function
更新目标基金并复用基准数据和约束执行仓位测算
可见性:`public`
| 参数 | 类型 | 说明 |
| ---------- | ------ | ------------ |
| `baseFund` | string | 新的目标基金 |
返回:boolean
### `GetXData()`
声明:function
设置基金净值收益率数据 `FYdata`;可重写以接入自有数据
可见性:`public`
### `SetXdata()`
声明:function
设置权益基准收益率矩阵 `FXdata`;可重写以接入自有数据
可见性:`public`
### `SetOtherX()`
声明:function
设置固收基准收益率序列 `FOtherX`;可重写以接入自有数据
可见性:`public`
### `GetObj(wa, WEquity_, Wbond)`
声明:function
`FObjType=-1` 时提供自定义优化目标
可见性:`public`
| 参数 | 类型 | 说明 |
| ---------- | ----- | ---------------- |
| `wa` | real | 常数项收益 |
| `WEquity_` | array | 权益资产配置比例 |
| `Wbond` | real | 债券配置比例 |
返回:real
### `GetCon(wa, WEquity_, Wbond)`
声明:function
`FConType=-1` 时提供自定义等式与不等式约束
可见性:`public`
| 参数 | 类型 | 说明 |
| ---------- | ----- | ---------------- |
| `wa` | real | 常数项收益 |
| `WEquity_` | array | 权益资产配置比例 |
| `Wbond` | real | 债券配置比例 |
返回:array
### `GetRealDataNum()`
声明:function
返回对齐市场交易日后基金实际公布的净值点数
可见性:`public`
返回:integer
### `GetPmedParams(wa, WEquity, Wbond)`
声明:function
通过输出参数批量取得优化后的常数项、权益配置和债券配置
可见性:`public`
| 参数 | 类型 | 说明 |
| --------- | ----- | ---------------- |
| `wa` | real | 输出常数项收益 |
| `WEquity` | array | 输出权益配置比例 |
| `Wbond` | real | 输出债券配置比例 |
返回:nil
## `ts_SameTypeFundEquityPercent`
声明:class
在历史回溯场景中批量测算同类基金仓位,并提供缓存、汇总和误差分析接口
<!-- tags: 基金 仓位测算 同类基金 历史回溯 分析框架 -->
### `FEndT`
声明:field
测算截止日,默认 `Today()`
可见性:`public`
类型:datetime
### `FBegT`
声明:field
测算开始日,默认从当前日期向前推一年
可见性:`public`
类型:datetime
### `FCycle`
声明:field
测算周期,默认 `日线`
可见性:`public`
类型:string
### `FIndexArr`
声明:field
默认求解器使用的权益基准代码列表
可见性:`public`
类型:array
### `FBondId`
声明:field
默认求解器使用的固收基准代码
可见性:`public`
类型:string
### `FDataNum`
声明:field
默认求解器使用的回归天数,默认 20
可见性:`public`
类型:integer
### `FPMOBJ`
声明:field
仓位测算求解器;为空时按 `FIndexArr``FBondId``FDataNum` 创建默认 `tsPositionMeasure`
可见性:`public`
类型:object
### `FMinDataNum`
声明:field
约束回归使用的最小基金净值点数,默认 -1 表示不计算点数
可见性:`public`
类型:integer
### `FRDateType`
声明:field
真实仓位报告期序列类型;-1 不输出,0 输出季报仓位
可见性:`public`
类型:integer
### `FVersionId`
声明:field
结果缓存模式,默认 -1 表示不缓存
可见性:`public`
类型:integer
### `FDestDir`
声明:field
缓存结果输出目录
可见性:`public`
类型:string
### `FAnyTimeout`
声明:field
是否实时缓存计算结果,默认 `True`
可见性:`public`
类型:boolean
### `FifNoLog`
声明:field
是否启用静默模式,默认 `False`
可见性:`public`
类型:boolean
### `BackMeasure()`
声明:function
执行同类基金历史仓位测算主流程
可见性:`public`
### `GetTimeSeries()`
声明:function
返回仓位测算时间序列;可重写以提供自定义回溯日期
可见性:`public`
返回:array
### `GetFundArr(vEndT)`
声明:function
返回指定日需要求解仓位的基金列表;可重写以自定义基金筛选
可见性:`public`
| 参数 | 类型 | 说明 |
| ------- | -------- | -------- |
| `vEndT` | datetime | 当前时点 |
返回:array
### `GetStatfundData(regmxarrday, day)`
声明:function
从指定日已完成的基金仓位结果中筛选进入统计分析的数据;可重写
可见性:`public`
| 参数 | 类型 | 说明 |
| ------------- | -------- | ---------------------- |
| `regmxarrday` | array | 当日各基金仓位测算结果 |
| `day` | datetime | 当前统计日期 |
返回:array
### `GetPMOBJ(vEndT, fund)`
声明:function
返回指定日期、指定基金的仓位求解器参数;可重写以增加个别约束
可见性:`public`
| 参数 | 类型 | 说明 |
| ------- | -------- | -------- |
| `vEndT` | datetime | 截止日 |
| `fund` | string | 基金代码 |
返回:any
### `GetPMdetail(vBegT, vEndT)`
声明:function
返回区间基金仓位汇总使用的原始测算明细
可见性:`public`
| 参数 | 类型 | 说明 |
| ------- | -------- | ---------- |
| `vBegT` | datetime | 区间开始日 |
| `vEndT` | datetime | 区间截止日 |
返回:array
### `GetPMdistribution(vBegT, vEndT)`
声明:function
返回不同日期下的基金仓位分布统计
可见性:`public`
| 参数 | 类型 | 说明 |
| ------- | -------- | ---------- |
| `vBegT` | datetime | 区间开始日 |
| `vEndT` | datetime | 区间截止日 |
返回:array
### `GetOverAllPM(vBegT, vEndT, type_)`
声明:function
返回不同日期和加权方式下的基金整体仓位
可见性:`public`
| 参数 | 类型 | 说明 |
| ------- | -------- | ---------------- |
| `vBegT` | datetime | 区间开始日 |
| `vEndT` | datetime | 区间截止日 |
| `type_` | integer | 整体仓位加权方式 |
返回:array
### `GetErrorDistribution(vBegT, vEndT)`
声明:function
返回不同日期下基金测算仓位与真实仓位的误差分布
可见性:`public`
| 参数 | 类型 | 说明 |
| ------- | -------- | ---------- |
| `vBegT` | datetime | 区间开始日 |
| `vEndT` | datetime | 区间截止日 |
返回:array
### `GetOverAllErrorAnalysis(vBegT, vEndT)`
声明:function
返回基金整体仓位误差分析结果
可见性:`public`
| 参数 | 类型 | 说明 |
| ------- | -------- | ---------- |
| `vBegT` | datetime | 区间开始日 |
| `vEndT` | datetime | 区间截止日 |
返回:array
@@ -0,0 +1,85 @@
# 应用专题 / 基金研究 / 基金定投
## `aipstartMonitor_user(v_end_t)`
声明:function
执行 `aipstartMonitor_user` 对应的模块功能
<!-- tags: 调用 基金 回测 -->
| 参数 | 类型 | 说明 |
| --------- | -------- | ------------------------ |
| `v_end_t` | datetime | 计算或查询区间的结束日期 |
返回:nil
## `fundAccountReturn(beg_t, end_t, rtype, annual)`
声明:function
计算基金帐户区间收益率,由区间申购赎回基金的现金流与期初期末基金市值计算得出,与
<!-- tags: 回报率 投资收益 基金产品 基金 回测 -->
| 参数 | 类型 | 说明 |
| -------- | -------- | --------------------------------------------------------------- |
| `beg_t` | datetime | 计算或查询区间的开始日期 |
| `end_t` | datetime | 计算或查询区间的结束日期 |
| `rtype` | any | 收益率类型, 1:简单收益率;2:资本加权;3:内部收益率(xirr);默认为1 |
| `annual` | boolean | 是否年化,0:收益率不年化,1:收益率年化,默认不年化 |
返回:real
## `fundAccountSummary(begt, endt)`
声明:function
统计汇总基金帐户区间申赎情况
<!-- tags: 基金产品 基金 回测 -->
| 参数 | 类型 | 说明 |
| ------ | -------- | ------ |
| `begt` | datetime | 开始日 |
| `endt` | datetime | 截止日 |
返回:array
## `getAIPPROrder_user(v_end_t)`
声明:function
用户自定义在定投方法
<!-- tags: 查询 基金 回测 -->
| 参数 | 类型 | 说明 |
| --------- | -------- | ------------------------ |
| `v_end_t` | datetime | 计算或查询区间的结束日期 |
返回:array
## `intervalreturnByTimes()`
声明:function
统计各阶段定投收益(止盈全部卖出为一次)
<!-- tags: 汇总 基金 回测 -->
返回:array
## `tpslMonitor_user(v_end_t)`
声明:function
执行 `tpslMonitor_user` 对应的模块功能
<!-- tags: 调用 基金 回测 -->
| 参数 | 类型 | 说明 |
| --------- | -------- | ------------------------ |
| `v_end_t` | datetime | 计算或查询区间的结束日期 |
返回:array
@@ -0,0 +1,11 @@
# 应用专题 / 基金研究 / 基金定投
## `getstockVal()`
声明:function
获取估值法基金定投的回测所需的数据或计算结果
<!-- tags: 查询 历史模拟 策略验证 基金产品 基金 回测 -->
返回:any
@@ -0,0 +1,20 @@
# 应用专题 / 基金研究 / 基金定投
## `vafv(r, g, nper, c, pv, types)`
声明:function
第 t次投资时,增长调整后的目标市值
<!-- tags: 基金 回测 -->
| 参数 | 类型 | 说明 |
| ------- | ------- | -------------------------------------- |
| `r` | any | 每期预期增长率 |
| `g` | any | 每期投资增长率 |
| `nper` | any | 第 t次投资 |
| `c` | any | 初始投资金额,默认为 1 |
| `pv` | any | 第 0次投资时资产净值,默认为 0 |
| `types` | boolean | 是否转为第 t次投资后预期的期末资产净值 |
返回:real