📝 docs(tsl): complete and lint codegen reference
This commit is contained in:
@@ -1,6 +1,6 @@
|
||||
# 数据仓库 / 当日
|
||||
|
||||
### `cacheStrMerge(arg1, arg2, date_value_3)`
|
||||
## `cacheStrMerge(arg1, arg2, date_value_3)`
|
||||
|
||||
当日相关函数。
|
||||
|
||||
@@ -12,7 +12,7 @@
|
||||
|
||||
返回：string
|
||||
|
||||
### `getHbCacheStr(cache_str, fname)`
|
||||
## `getHbCacheStr(cache_str, fname)`
|
||||
|
||||
横比缓存串，多用于101因子中。串中不缓存pn_StockArr，因为无法满足动态指数成分，得需要用pn_StockArrName作唯一标识。
|
||||
|
||||
@@ -23,7 +23,7 @@
|
||||
|
||||
返回：string
|
||||
|
||||
### `getParmGroupIndustryByEndt(t, endt, by_group)`
|
||||
## `GetParm_GroupIndustry_ByEndt(t, endt, by_group)`
|
||||
|
||||
得到指定日股票池行业分类。1、用于支持横比行业分类；2、目前多用于101因子的计算中的中间函数IndNeutralize中；3、目前使用申万一二三级行业来处理。
|
||||
|
||||
@@ -35,7 +35,7 @@
|
||||
|
||||
返回：array
|
||||
|
||||
### `getParmStockArrByEndt(end_t)`
|
||||
## `GetParm_StockArr_ByEndt(end_t)`
|
||||
|
||||
得到指定日股票池。1、用于支持横比动态成分；2、目前多用于101因子的计算中。
|
||||
|
||||
@@ -45,7 +45,7 @@
|
||||
|
||||
返回：array
|
||||
|
||||
### `indNeutralize4(exp, by_group, cache_str, fill_nan)`
|
||||
## `indNeutralize4(exp, by_group, cache_str, fill_nan)`
|
||||
|
||||
表达式当日中性化,与系统参数证券代码，时间，pn_StockArr()相关。
|
||||
|
||||
@@ -58,7 +58,7 @@
|
||||
|
||||
返回：float
|
||||
|
||||
#### 示例
|
||||
### 示例
|
||||
|
||||
```tsl
|
||||
endt:=20231010T;
|
||||
@@ -68,7 +68,7 @@ setsysparam(pn_StockArr(),getbkbydate("SH000300",endt));
|
||||
return IndNeutralize4(@close(),0,"",1);
|
||||
```
|
||||
|
||||
### `indNeutralizeOftheReport(exp, report_id, by_group, cache_str)`
|
||||
## `indNeutralizeOftheReport(exp, report_id, by_group, cache_str)`
|
||||
|
||||
表达式当期中性化
|
||||
|
||||
@@ -81,7 +81,7 @@ return IndNeutralize4(@close(),0,"",1);
|
||||
|
||||
返回：float
|
||||
|
||||
#### 示例
|
||||
### 示例
|
||||
|
||||
```tsl
|
||||
endt:=20221231T;
|
||||
@@ -90,7 +90,7 @@ setsysparam(pn_StockArr(),getbkbydate("SH000300",endt));
|
||||
return IndNeutralizeOftheReport(@ReportOfAll(46002,DefaultRepID()),20221231,0);
|
||||
```
|
||||
|
||||
### `percentRankOftheDay(exp, cache_str)`
|
||||
## `percentRankOftheDay(exp, cache_str)`
|
||||
|
||||
当日分位排名。与PercentRankOftheDay2最大的区别，停牌成分设为Nan。
|
||||
|
||||
@@ -101,7 +101,7 @@ return IndNeutralizeOftheReport(@ReportOfAll(46002,DefaultRepID()),20221231,0);
|
||||
|
||||
返回：float|void
|
||||
|
||||
### `percentRankOftheDay2(exp, cache_str)`
|
||||
## `percentRankOftheDay2(exp, cache_str)`
|
||||
|
||||
当日分位排名。股票横截面数据排名，x表示一组股票的截面数据，按向量x的元素大小升序排序，序号从0开始，如\[0,1,...,n\]，然后输出排名所占总位数的百分比，即将排名归一到\[0,1\]区间。注意：Nan值不参与排名，输出Nan。
|
||||
|
||||
@@ -112,7 +112,7 @@ return IndNeutralizeOftheReport(@ReportOfAll(46002,DefaultRepID()),20221231,0);
|
||||
|
||||
返回：float
|
||||
|
||||
### `percentRankOftheDay3(exp, cache_str, fill_nan)`
|
||||
## `percentRankOftheDay3(exp, cache_str, fill_nan)`
|
||||
|
||||
表达式当日分位排名,个股在pn_StockArr()成分股中的表达式值的分位排名，与系统参数证券代码，时间，pn_StockArr()相关。
|
||||
|
||||
@@ -124,7 +124,7 @@ return IndNeutralizeOftheReport(@ReportOfAll(46002,DefaultRepID()),20221231,0);
|
||||
|
||||
返回：float
|
||||
|
||||
#### 示例
|
||||
### 示例
|
||||
|
||||
```tsl
|
||||
endt:=20231010T;
|
||||
@@ -134,7 +134,7 @@ setsysparam(pn_StockArr(),getbkbydate("SH000300",endt));
|
||||
return PercentRankOftheDay3(@close(),"",1);
|
||||
```
|
||||
|
||||
### `percentRankOftheReport(exp, report_id, cache_str)`
|
||||
## `percentRankOftheReport(exp, report_id, cache_str)`
|
||||
|
||||
表达式当期分位排名,个股在pn_StockArr()成分股中的表达式值的排名，与系统参数证券代码，时间，pn_StockArr()相关。
|
||||
|
||||
@@ -146,7 +146,7 @@ return PercentRankOftheDay3(@close(),"",1);
|
||||
|
||||
返回：float
|
||||
|
||||
#### 示例
|
||||
### 示例
|
||||
|
||||
```tsl
|
||||
endt:=20221231T;
|
||||
@@ -155,19 +155,19 @@ setsysparam(pn_StockArr(),getbkbydate("SH000300",endt));
|
||||
return PercentRankOftheReport(@ReportOfAll(46002,DefaultRepID()),20221231);
|
||||
```
|
||||
|
||||
### `pnStockArrFunc()`
|
||||
## `pn_StockArrFunc()`
|
||||
|
||||
当日相关函数。
|
||||
|
||||
返回：any
|
||||
|
||||
### `pnStockArrName()`
|
||||
## `pn_StockArrName()`
|
||||
|
||||
当日相关函数。
|
||||
|
||||
返回：string
|
||||
|
||||
### `rankOftheDay(exp, sort_order, cache_str)`
|
||||
## `rankOftheDay(exp, sort_order, cache_str)`
|
||||
|
||||
当日横比排名。注意：pn_StockArr当日无交易的成分设置为Nan；EXp计算为NAN值时，不参与排名，排名为NAN。
|
||||
|
||||
@@ -179,7 +179,7 @@ return PercentRankOftheReport(@ReportOfAll(46002,DefaultRepID()),20221231);
|
||||
|
||||
返回：int
|
||||
|
||||
### `rankOftheDay2(exp, sort_order, cache_str)`
|
||||
## `rankOftheDay2(exp, sort_order, cache_str)`
|
||||
|
||||
当日最新值横比排名。与RankOftheDay的区别在于：RankOftheDay2不会将pn_StockArr当日的停牌成分设置为Nan。注意：EXp计算为NAN值时，不参与排名，排名为NAN。
|
||||
|
||||
@@ -191,7 +191,7 @@ return PercentRankOftheReport(@ReportOfAll(46002,DefaultRepID()),20221231);
|
||||
|
||||
返回：int
|
||||
|
||||
### `rankOftheDay3(exp, sort_order, cache_str, fill_nan)`
|
||||
## `rankOftheDay3(exp, sort_order, cache_str, fill_nan)`
|
||||
|
||||
表达式当日排名,个股在pn_StockArr()成分股中的表达式值的排名，与系统参数证券代码，时间，pn_StockArr()相关。
|
||||
|
||||
@@ -204,7 +204,7 @@ return PercentRankOftheReport(@ReportOfAll(46002,DefaultRepID()),20221231);
|
||||
|
||||
返回：float
|
||||
|
||||
#### 示例
|
||||
### 示例
|
||||
|
||||
```tsl
|
||||
endt:=20231010T;
|
||||
@@ -214,7 +214,7 @@ setsysparam(pn_StockArr(),getbkbydate("SH000300",endt));
|
||||
return RankOftheDay3(@close(),0,"",1);
|
||||
```
|
||||
|
||||
### `rankOftheReport(exp, report_id, sort_order, cache_str)`
|
||||
## `rankOftheReport(exp, report_id, sort_order, cache_str)`
|
||||
|
||||
表达式当期排名,个股在pn_StockArr()成分股中的表达式值的排名，与系统参数证券代码，时间，pn_StockArr()相关。
|
||||
|
||||
@@ -227,7 +227,7 @@ return RankOftheDay3(@close(),0,"",1);
|
||||
|
||||
返回：float
|
||||
|
||||
#### 示例
|
||||
### 示例
|
||||
|
||||
```tsl
|
||||
endt:=20221231T;
|
||||
@@ -236,7 +236,7 @@ setsysparam(pn_StockArr(),getbkbydate("SH000300",endt));
|
||||
return RankOftheReport(@ReportOfAll(46002,DefaultRepID()),20221231,0);
|
||||
```
|
||||
|
||||
### `scaleOfSeries(exp, a, cache_str)`
|
||||
## `scaleOfSeries(exp, a, cache_str)`
|
||||
|
||||
标准化（无交易成分设为NAN）。将x中的非NAN值进行标准化，使x的绝对值的和为a，默认a=1。注意：NAN值依然输出NAN。
|
||||
|
||||
@@ -248,7 +248,7 @@ return RankOftheReport(@ReportOfAll(46002,DefaultRepID()),20221231,0);
|
||||
|
||||
返回：float|void
|
||||
|
||||
#### 示例
|
||||
### 示例
|
||||
|
||||
```tsl
|
||||
endt:=20231010T;
|
||||
@@ -258,7 +258,7 @@ setsysparam(pn_StockArr(),getbkbydate("SH000300",endt));
|
||||
return ScaleOfSeries(@close(),1,"");
|
||||
```
|
||||
|
||||
### `scaleOfSeries2(exp, a, cache_str)`
|
||||
## `scaleOfSeries2(exp, a, cache_str)`
|
||||
|
||||
标准化。将x中的非NAN值进行标准化，使x的绝对值的和为a，默认a=1。注意：NAN值依然输出NAN。
|
||||
|
||||
@@ -270,7 +270,7 @@ return ScaleOfSeries(@close(),1,"");
|
||||
|
||||
返回：float
|
||||
|
||||
#### 示例
|
||||
### 示例
|
||||
|
||||
```tsl
|
||||
endt:=20231010T;
|
||||
@@ -280,7 +280,7 @@ setsysparam(pn_StockArr(),getbkbydate("SH000300",endt));
|
||||
return ScaleOfSeries2(@close(),1,"");
|
||||
```
|
||||
|
||||
### `scaleOfSeries3(exp, a, cache_str, fill_nan)`
|
||||
## `scaleOfSeries3(exp, a, cache_str, fill_nan)`
|
||||
|
||||
表达式当日标准化,与系统参数证券代码，时间，pn_StockArr()相关。
|
||||
|
||||
@@ -293,7 +293,7 @@ return ScaleOfSeries2(@close(),1,"");
|
||||
|
||||
返回：float
|
||||
|
||||
#### 示例
|
||||
### 示例
|
||||
|
||||
```tsl
|
||||
endt:=20231010T;
|
||||
@@ -303,7 +303,7 @@ setsysparam(pn_StockArr(),getbkbydate("SH000300",endt));
|
||||
return ScaleOfSeries3(@close(),1,"",1);
|
||||
```
|
||||
|
||||
### `scaleOfSeriesOftheReport(exp, report_id, a, cache_str)`
|
||||
## `scaleOfSeriesOftheReport(exp, report_id, a, cache_str)`
|
||||
|
||||
表达式当期标准化
|
||||
|
||||
@@ -316,7 +316,7 @@ return ScaleOfSeries3(@close(),1,"",1);
|
||||
|
||||
返回：float
|
||||
|
||||
#### 示例
|
||||
### 示例
|
||||
|
||||
```tsl
|
||||
endt:=20221231T;
|
||||
@@ -325,7 +325,7 @@ setsysparam(pn_StockArr(),getbkbydate("SH000300",endt));
|
||||
return ScaleOfSeriesOftheReport(@ReportOfAll(46002,DefaultRepID()),20221231,1);
|
||||
```
|
||||
|
||||
### `setParmStockArrFunc(func, stock_arr_name)`
|
||||
## `SetParm_StockArrFunc(func, stock_arr_name)`
|
||||
|
||||
1、用于支持横比动态成分；2、目前多用于101因子的计算中，与GetParm_StockArr_ByEndt一起使用；3、一般客户无需使用。
|
||||
|
||||
@@ -335,4 +335,3 @@ return ScaleOfSeriesOftheReport(@ReportOfAll(46002,DefaultRepID()),20221231,1);
|
||||
| `stock_arr_name` | string | 字符串。股票池名称 |
|
||||
|
||||
返回：any
|
||||
|
||||
|
||||
Reference in New Issue
Block a user