csh/playbook
1
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

✨ feat(tsl-api-reference): index class and unit APIs

Browse Source 
Migrate reference pages to declaration-line storage and rebuild the
13-column index.

Add qualified member lookup plus regression and end-to-end coverage.
This commit is contained in:
csh
2026-07-29 15:47:46 +08:00
parent 9edc8fc868
commit 13be5ea0aa
239 changed files with 39157 additions and 12846 deletions
Download Patch File Download Diff File Expand all files Collapse all files
skills/tsl-api-reference/references/codegen/dotnet/runtime/general.md
+95 -5
View File
@@ -2,6 +2,8 @@
## `call(func_name, p1, pn)`
声明：function
根据名称或者函数指针调用指定的函数，后面带的参数将自动送入该函数。
| 参数 | 类型 | 说明 |
@@ -14,6 +16,8 @@
## `checkGlobalCacheExpired(value)`
声明：function
判断全局缓存引用是否已经过期。
| 参数 | 类型 | 说明 |
@@ -24,6 +28,8 @@
## `dbglocalcancel(id, return_value)`
声明：function
注销任务。该功能可以用来终止运行的WEB任务。 其任务ID为dbglocalrunning中返回信息中的id字段以十六进制模式转换为64位整数。
| 参数 | 类型 | 说明 |
@@ -35,6 +41,8 @@
## `divMod(dividend, divisor, remainder)`
声明：function
计算整数除法的整数商和余数。也就是用参数Dividend除以参数Divisor，得到的整数商存到参数Result中，把余数存到参数Remainder中
| 参数 | 类型 | 说明 |
@@ -47,6 +55,8 @@
## `eastrq(b, c, q)`
声明：function
Eastrq 相关函数。
| 参数 | 类型 | 说明 |
@@ -59,6 +69,8 @@ Eastrq 相关函数。
## `ensureRange(amin, amax)`
声明：function
这个函数可以保证返回某个区间之内的数，参数Amin和参数Amax是这个区间的上限和下限。 如果参数Avalue大于等于参数Amin并且小于等于参数Amax，则返回Avalue 如果参数Avalue大于参数Amax，则返回Amax的值 如果参数Avalue小于参数Amin，则返回Amin的值
| 参数 | 类型 | 说明 |
@@ -70,6 +82,8 @@ Eastrq 相关函数。
## `exportJsonStringMbcs(data, n, return_value)`
声明：function
将TSL结构数据转换为json串。和ExportJSONString不同的是，该函数不会对中文进行转码处理，保留中文原码。
| 参数 | 类型 | 说明 |
@@ -82,6 +96,8 @@ Eastrq 相关函数。
## `frameconcat(arrdic, _type)`
声明：function
数据表-拼接
| 参数 | 类型 | 说明 |
@@ -101,6 +117,8 @@ frameconcat(array(a,b));
## `getEigenValue(a, eigen_value)`
声明：function
通过赋值得到EigenValue
| 参数 | 类型 | 说明 |
@@ -112,6 +130,8 @@ frameconcat(array(a,b));
## `H_J_Method_Pgm(call_back)`
声明：function
H_J算法测试
| 参数 | 类型 | 说明 |
@@ -122,6 +142,8 @@ H_J算法测试
## `inRange(amin, amax)`
声明：function
判断Avalue是否在\[Amin, Amax\]范围内
| 参数 | 类型 | 说明 |
@@ -133,6 +155,8 @@ H_J算法测试
## `interestRate(nperiods, payment, present_value, future_value, payment_time)`
声明：function
返回要求收益率，使得这项投资从现值PresentValue实现终值FutureValue，在共NPeriods个周期后实现。如果周期定义为一年，那么结果就是要求的年收益率。
| 参数 | 类型 | 说明 |
@@ -147,6 +171,8 @@ H_J算法测试
## `invoke(obj, member_name, member_value, p1, pn)`
声明：function
调用类的成员方法或对类的成员变量进行赋值操作。支持对重载方法的调用。
| 参数 | 类型 | 说明 |
@@ -163,18 +189,24 @@ H_J算法测试
## `logined()`
声明：function
判定是否已经登录成功。只读属性。
返回：any
## `milliSecondSpan()`
声明：function
范围生成函数相关函数。
返回：float
## `mswap(value, dim1, dim2)`
声明：function
交换多维 FMArray 的两个维度。
| 参数 | 类型 | 说明 |
@@ -189,6 +221,8 @@ H_J算法测试
## `nils(length)`
声明：function
生成元素为 `nil` 的一维结果。
| 参数 | 类型 | 说明 |
@@ -199,12 +233,16 @@ H_J算法测试
## `noTechCacheDo()`
声明：function
和TechCacheDo相反的是，在NoTechCacheDo语句段中调用的所有相关计算，将均取消缓存。
返回：any
## `ones(length)`
声明：function
生成元素为 `1` 的一维结果。
| 参数 | 类型 | 说明 |
@@ -215,6 +253,8 @@ H_J算法测试
## `outPutGrowRatio(v1, v2)`
声明：function
增长率(%)
| 参数 | 类型 | 说明 |
@@ -234,6 +274,8 @@ outPutGrowRatio(14,13);
## `outPutGrowRatio2(v1, v2)`
声明：function
增长率(%)
| 参数 | 类型 | 说明 |
@@ -253,6 +295,8 @@ outPutGrowRatio2(14,13);
## `outPutGrowValue2(v1, v2)`
声明：function
增长
| 参数 | 类型 | 说明 |
@@ -272,6 +316,8 @@ outPutGrowValue2(13,14);
## `raiseError(func_name, err_str)`
声明：function
显示调试出错信息
| 参数 | 类型 | 说明 |
@@ -283,6 +329,8 @@ outPutGrowValue2(13,14);
## `reIndexCopy(data, index_info1, index_info1_2, index_info_n)`
声明：function
ReIndexCopy和Reindex的差异：ReIndex修改原有的结果集，而ReIndexCopy不修改原结果集返回一个新结果集。
| 参数 | 类型 | 说明 |
@@ -308,6 +356,8 @@ return reindexcopy(t,t[:,"time"]);
## `reportSeriesSplit(table_name)`
声明：function
报告期数据处理。注意，该函数主要用于客户端结果处理，不提供给用户程序编辑。
| 参数 | 类型 | 说明 |
@@ -318,6 +368,8 @@ return reindexcopy(t,t[:,"time"]);
## `rotatedComponentMatrix(cm, eigen_value, eigen_vector)`
声明：function
该函数已废弃
| 参数 | 类型 | 说明 |
@@ -348,6 +400,8 @@ rotatedComponentMatrix(cm);
## `sendRunningData(data, nwdow)`
声明：function
直接函数相关函数。
| 参数 | 类型 | 说明 |
@@ -361,6 +415,8 @@ rotatedComponentMatrix(cm);
## `setUid(uid)`
声明：function
设置当前的用户为指定的用户，需要有特殊权限，如果成功则返回真。
| 参数 | 类型 | 说明 |
@@ -371,12 +427,16 @@ rotatedComponentMatrix(cm);
## `techCacheDo()`
声明：function
TechCacheDo打开技术类缓存 相关函数。
返回：any
## `user(name)`
声明：function
执行指定用户的函数，只有当你已经得到该用户的授权才可以 例如：如果已经被用户user1授权，且user1拥有函数sample,那么我们可以用user('user1').sample来执行user1的sample函数。
| 参数 | 类型 | 说明 |
@@ -387,6 +447,8 @@ TechCacheDo打开技术类缓存 相关函数。
## `Logger_debug(msg)`
声明：function
打印带执行节点的调试信息
| 参数 | 类型 | 说明 |
@@ -397,6 +459,8 @@ TechCacheDo打开技术类缓存 相关函数。
## `logger_info(msg)`
声明：function
打印带执行节点的提示信息
| 参数 | 类型 | 说明 |
@@ -407,6 +471,8 @@ TechCacheDo打开技术类缓存 相关函数。
## `logger_warning(msg)`
声明：function
打印带执行节点的调试信息
| 参数 | 类型 | 说明 |
@@ -417,6 +483,8 @@ TechCacheDo打开技术类缓存 相关函数。
## `logger_info2(p1, p2, p3, pn)`
声明：function
打印带执行节点的提示信息
| 参数 | 类型 | 说明 |
@@ -430,12 +498,16 @@ TechCacheDo打开技术类缓存 相关函数。
## `sp_UserSysParam2()`
声明：function
用户自定义函数教学范例，获得当前系统参数
返回：string
## `ifThen3(left, right, r1, r2, r3)`
声明：function
比较left与Right大小，若Left大，则返回r1;若相等，返回r2;若Right大，返回r3。
| 参数 | 类型 | 说明 |
@@ -448,7 +520,7 @@ TechCacheDo打开技术类缓存 相关函数。
返回：expr
#### 示例
### 示例
```tsl
return ifThen3(1, 2, '左大', '相等', '右大');
@@ -457,6 +529,8 @@ return ifThen3(1, 2, '左大', '相等', '右大');
## `safeEval(exp)`
声明：function
表达式求值
| 参数 | 类型 | 说明 |
@@ -467,6 +541,8 @@ return ifThen3(1, 2, '左大', '相等', '右大');
## `exportCsvne(data, csv_str, include_index, include_header)`
声明：function
将指定数组Data转换为csv格式字符串并存储在csvStr参数中。仅支持一维及二维数组的转换。和ExportCsv的区别：在处理浮点数据时，ExportCsvne的结果不会输出为1E15等格式。
| 参数 | 类型 | 说明 |
@@ -478,7 +554,7 @@ return ifThen3(1, 2, '左大', '相等', '右大');
返回：bool
#### 示例
### 示例
范例01：一维数组转换成csv格式字符串（含大数量级数据）
@@ -526,6 +602,8 @@ else return ret;
## `doubleVariableExecute(arr, sys_name, time_arr, exp)`
声明：function
计算指定系统参数，指定时间序列下的指标表达式的值
| 参数 | 类型 | 说明 |
@@ -537,7 +615,7 @@ else return ret;
返回：array
#### 示例
### 示例
```tsl
stocks := array(getBk('上证50'));
@@ -548,6 +626,8 @@ return doubleVariableExecute(stocks, pn_Stock(), timer, @close());
## `multipleExecute(exp)`
声明：function
表达式求值
| 参数 | 类型 | 说明 |
@@ -558,6 +638,8 @@ return doubleVariableExecute(stocks, pn_Stock(), timer, @close());
## `singleVariableExecute(arr, sys_name, exp)`
声明：function
设置系统变量SysName的值为Arr中的元素，执行表达式exp，将表达式的值放到数组Arr中。
| 参数 | 类型 | 说明 |
@@ -568,7 +650,7 @@ return doubleVariableExecute(stocks, pn_Stock(), timer, @close());
返回：array
#### 示例
### 示例
```tsl
// Arr中存储的是代码，获取2019年3月1日，Arr中所有代码的收盘价
@@ -578,6 +660,8 @@ return singleVariableExecute(arr, pn_stock(), @close());
## `safeSetSysParam(systype, value)`
声明：function
设置系统参数。主要是将value的值转化为正确的对应于systype数据类型，再通过setsysparam进行设置setysparam(systype,value)，保证系统参数设置成功。
| 参数 | 类型 | 说明 |
@@ -589,6 +673,8 @@ return singleVariableExecute(arr, pn_stock(), @close());
## `assert(error)`
声明：function
断言。若Check为假，返回出错信息
| 参数 | 类型 | 说明 |
@@ -597,7 +683,7 @@ return singleVariableExecute(arr, pn_stock(), @close());
返回：string
#### 示例
### 示例
```tsl
return assert(0, '无效的语段');
@@ -607,12 +693,16 @@ return assert(0, '无效的语段');
## `sp_SetSysParam1()`
声明：function
设置系统参数教学范例，使用缺省系统参数,返回股票.基本信息
返回：any
## `sp_SetSysParam2()`
声明：function
设置系统参数教学范例，指定系统参数(当前为SH600718),返回股票.基本信息
返回：any