polars-ta 0.5.6__tar.gz → 0.5.7__tar.gz

{polars_ta-0.5.6 → polars_ta-0.5.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: polars_ta
-Version: 0.5.6
+Version: 0.5.7
 Summary: polars expressions
 Author-email: wukan <wu-kan@163.com>
 License: MIT License

polars_ta-0.5.7/polars_ta/_version.py

@@ -0,0 +1 @@
+__version__ = "0.5.7"

{polars_ta-0.5.6 → polars_ta-0.5.7}/polars_ta/wq/cross_sectional.py

@@ -290,7 +290,7 @@ def cs_rank(x: Expr, pct: bool = True) -> Expr:
 
 
 def cs_rank_if(condition: Expr, x: Expr, pct: bool = True) -> Expr:
-    """动态票池过滤排名
+    """横截面筛选排名。可实现动态票池
 
     Parameters
     ----------
@@ -299,17 +299,34 @@ def cs_rank_if(condition: Expr, x: Expr, pct: bool = True) -> Expr:
     x:Expr
         因子
     pct:bool
+        排名百分比。范围：[0,1]
 
     Examples
     --------
     ```python
     df = pl.DataFrame({
         'a': [None, 1, 1, 1, 2, 2, 3, 10],
-        'b': [1, 2, 3, 4, 5, 6, 7, 8],
+        'b': [1, 2, 3, 4, 5, 6, None, 8],
     }).with_columns(
-        out1=cs_rank_if(True, pl.col('a'), True), # 与cs_rank等价
+        out1=cs_rank_if(True, pl.col('a'), True),  # 与cs_rank等价
         out2=cs_rank_if(pl.col('b') > 3, -pl.col('a'), False),
     )
+
+    shape: (8, 4)
+    ┌──────┬──────┬──────────┬──────┐
+    │ a    ┆ b    ┆ out1     ┆ out2 │
+    │ ---  ┆ ---  ┆ ---      ┆ ---  │
+    │ i64  ┆ i64  ┆ f64      ┆ u32  │
+    ╞══════╪══════╪══════════╪══════╡
+    │ null ┆ 1    ┆ null     ┆ null │
+    │ 1    ┆ 2    ┆ 0.0      ┆ null │
+    │ 1    ┆ 3    ┆ 0.0      ┆ null │
+    │ 1    ┆ 4    ┆ 0.0      ┆ 3    │
+    │ 2    ┆ 5    ┆ 0.333333 ┆ 2    │
+    │ 2    ┆ 6    ┆ 0.333333 ┆ 2    │
+    │ 3    ┆ null ┆ 0.666667 ┆ null │
+    │ 10   ┆ 8    ┆ 1.0      ┆ 1    │
+    └──────┴──────┴──────────┴──────┘
     ```
 
     Notes

{polars_ta-0.5.6 → polars_ta-0.5.7}/polars_ta/wq/transformational.py

@@ -275,3 +275,8 @@ def bool_(a: Expr) -> Expr:
 def float_(a: Expr) -> Expr:
     """int转成float"""
     return a.cast(Float32)
+
+
+def nop(x: Expr) -> Expr:
+    """空操作"""
+    return x

polars_ta-0.5.6/polars_ta/_version.py

@@ -1 +0,0 @@
-__version__ = "0.5.6"