You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@iotdb.apache.org by ja...@apache.org on 2023/04/06 11:04:31 UTC

[iotdb] branch master updated: [IOTDB-5742][UserGuide]Modify the output type of the mode function in userguide

This is an automated email from the ASF dual-hosted git repository.

jackietien pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/iotdb.git


The following commit(s) were added to refs/heads/master by this push:
     new 33843b6e2a [IOTDB-5742][UserGuide]Modify the output type of the mode function in userguide
33843b6e2a is described below

commit 33843b6e2a1610e179a557ddc85d721549261219
Author: Weihao Li <60...@users.noreply.github.com>
AuthorDate: Thu Apr 6 19:04:22 2023 +0800

    [IOTDB-5742][UserGuide]Modify the output type of the mode function in userguide
---
 docs/UserGuide/Operators-Functions/Aggregation.md  | 30 +++++++++++-----------
 .../UserGuide/Operators-Functions/Aggregation.md   | 30 +++++++++++-----------
 2 files changed, 30 insertions(+), 30 deletions(-)

diff --git a/docs/UserGuide/Operators-Functions/Aggregation.md b/docs/UserGuide/Operators-Functions/Aggregation.md
index 2ca60f6932..a07d05feb1 100644
--- a/docs/UserGuide/Operators-Functions/Aggregation.md
+++ b/docs/UserGuide/Operators-Functions/Aggregation.md
@@ -27,21 +27,21 @@ All aggregate functions except `COUNT()`, `COUNT_IF()` ignore null values and re
 
 The aggregate functions supported by IoTDB are as follows:
 
-| Function Name | Function Description                                                                                                                                                                                                                                                                                 | Allowed Input Data Types | required attributes                                                                                                                                      [...]
-|---------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| ------------------------ |--------------------------------------------------------------------------------------------------------------------------------------------------------- [...]
-| SUM           | Summation.                                                                                                                                                                                                                                                                                           | INT32 INT64 FLOAT DOUBLE | No                                                                                                                                                       [...]
-| COUNT         | Counts the number of data points.                                                                                                                                                                                                                                                                    | All types                | No                                                                                                                                                       [...]
-| AVG           | Average.                                                                                                                                                                                                                                                                                             | INT32 INT64 FLOAT DOUBLE | No                                                                                                                                                       [...]
-| EXTREME       | Finds the value with the largest absolute value. Returns a positive value if the maximum absolute value of positive and negative values is equal.                                                                                                                                                    | INT32 INT64 FLOAT DOUBLE | No                                                                                                                                                       [...]
-| MAX_VALUE     | Find the maximum value.                                                                                                                                                                                                                                                                              | INT32 INT64 FLOAT DOUBLE | No                                                                                                                                                       [...]
-| MIN_VALUE     | Find the minimum value.                                                                                                                                                                                                                                                                              | INT32 INT64 FLOAT DOUBLE | No                                                                                                                                                       [...]
-| FIRST_VALUE   | Find the value with the smallest timestamp.                                                                                                                                                                                                                                                          | All data types           | No                                                                                                                                                       [...]
-| LAST_VALUE    | Find the value with the largest timestamp.                                                                                                                                                                                                                                                           | All data types           | No                                                                                                                                                       [...]
-| MAX_TIME      | Find the maximum timestamp.                                                                                                                                                                                                                                                                          | All data Types           | No                                                                                                                                                       [...]
-| MIN_TIME      | Find the minimum timestamp.                                                                                                                                                                                                                                                                          | All data Types           | No                                                                                                                                                       [...]
-| COUNT_IF      | Find the number of data points that continuously meet a given condition and the number of data points that meet the condition (represented by keep) meet the specified threshold.                                                                                                                    | BOOLEAN                  | `[keep >=/>/=/!=/</<=]threshold`:The specified threshold or threshold condition, it is equivalent to `keep >= threshold` if `threshold` is used alone, t [...]
-| TIME_DURATION | Find the difference between the timestamp of the largest non-null value and the timestamp of the smallest non-null value in a column                                                                                                                                                                 |  All data Types   | No                                                                                                                                                              [...]
-| MODE          | Find the mode. Note: <br>1. Having too many different values in the input series risks a memory exception; <br>2. If all the elements have the same number of occurrences, that is no Mode, return the value with earliest time; <br> 3.If there are many Modes, return the Mode with earliest time. | All data Types                     | No                                                                                                                                             [...]
+| Function Name | Function Description                                                                                                                                                                                                                                                                              | Allowed Input Data Types | required attributes                                                                                                                                         [...]
+|---------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| ------------------------ |------------------------------------------------------------------------------------------------------------------------------------------------------------ [...]
+| SUM           | Summation.                                                                                                                                                                                                                                                                                        | INT32 INT64 FLOAT DOUBLE | No                                                                                                                                                          [...]
+| COUNT         | Counts the number of data points.                                                                                                                                                                                                                                                                 | All types                | No                                                                                                                                                          [...]
+| AVG           | Average.                                                                                                                                                                                                                                                                                          | INT32 INT64 FLOAT DOUBLE | No                                                                                                                                                          [...]
+| EXTREME       | Finds the value with the largest absolute value. Returns a positive value if the maximum absolute value of positive and negative values is equal.                                                                                                                                                 | INT32 INT64 FLOAT DOUBLE | No                                                                                                                                                          [...]
+| MAX_VALUE     | Find the maximum value.                                                                                                                                                                                                                                                                           | INT32 INT64 FLOAT DOUBLE | No                                                                                                                                                          [...]
+| MIN_VALUE     | Find the minimum value.                                                                                                                                                                                                                                                                           | INT32 INT64 FLOAT DOUBLE | No                                                                                                                                                          [...]
+| FIRST_VALUE   | Find the value with the smallest timestamp.                                                                                                                                                                                                                                                       | All data types           | No                                                                                                                                                          [...]
+| LAST_VALUE    | Find the value with the largest timestamp.                                                                                                                                                                                                                                                        | All data types           | No                                                                                                                                                          [...]
+| MAX_TIME      | Find the maximum timestamp.                                                                                                                                                                                                                                                                       | All data Types           | No                                                                                                                                                          [...]
+| MIN_TIME      | Find the minimum timestamp.                                                                                                                                                                                                                                                                       | All data Types           | No                                                                                                                                                          [...]
+| COUNT_IF      | Find the number of data points that continuously meet a given condition and the number of data points that meet the condition (represented by keep) meet the specified threshold.                                                                                                                 | BOOLEAN                  | `[keep >=/>/=/!=/</<=]threshold`:The specified threshold or threshold condition, it is equivalent to `keep >= threshold` if `threshold` is used alone, type [...]
+| TIME_DURATION | Find the difference between the timestamp of the largest non-null value and the timestamp of the smallest non-null value in a column                                                                                                                                                              |  All data Types   | No                                                                                                                                                                 [...]
+|  MODE         | Find the mode. Note: <br>1.Having too many different values in the input series risks a memory exception; <br>2.If all the elements have the same number of occurrences, that is no Mode, return the value with earliest time; <br>3.If there are many Modes, return the Mode with earliest time. | All data Types                     | No                                                                                                                                                [...]
 ## COUNT
 
 ### example
diff --git a/docs/zh/UserGuide/Operators-Functions/Aggregation.md b/docs/zh/UserGuide/Operators-Functions/Aggregation.md
index 7e8336add9..81d4c7eec6 100644
--- a/docs/zh/UserGuide/Operators-Functions/Aggregation.md
+++ b/docs/zh/UserGuide/Operators-Functions/Aggregation.md
@@ -27,21 +27,21 @@
 
 IoTDB 支持的聚合函数如下:
 
-| 函数名           | 功能描述                                                                                                        | 允许的输入类型                  | 必要的属性参数                                                                                                                                                                                                                    | 输出类型      |
-|---------------|-------------------------------------------------------------------------------------------------------------|--------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|
-| SUM           | 求和。                                                                                                         | INT32 INT64 FLOAT DOUBLE | 无                                                                                                                                                                                                                          | DOUBLE    |
-| COUNT         | 计算数据点数。                                                                                                     | 所有类型                     | 无                                                                                                                                                                                                                          | INT64     |
-| AVG           | 求平均值。                                                                                                       | INT32 INT64 FLOAT DOUBLE | 无                                                                                                                                                                                                                          | DOUBLE    |
-| EXTREME       | 求具有最大绝对值的值。如果正值和负值的最大绝对值相等,则返回正值。                                                                           | INT32 INT64 FLOAT DOUBLE | 无                                                                                                                                                                                                                          | 与输入类型一致   |
-| MAX_VALUE     | 求最大值。                                                                                                       | INT32 INT64 FLOAT DOUBLE | 无                                                                                                                                                                                                                          | 与输入类型一致   |
-| MIN_VALUE     | 求最小值。                                                                                                       | INT32 INT64 FLOAT DOUBLE | 无                                                                                                                                                                                                                          | 与输入类型一致   |
-| FIRST_VALUE   | 求时间戳最小的值。                                                                                                   | 所有类型                     | 无                                                                                                                                                                                                                          | 与输入类型一致   |
-| LAST_VALUE    | 求时间戳最大的值。                                                                                                   | 所有类型                     | 无                                                                                                                                                                                                                          | 与输入类型一致   |
-| MAX_TIME      | 求最大时间戳。                                                                                                     | 所有类型                     | 无                                                                                                                                                                                                                          | Timestamp |
-| MIN_TIME      | 求最小时间戳。                                                                                                     | 所有类型                     | 无                                                                                                                                                                                                                          | Timestamp |
-| COUNT_IF      | 求数据点连续满足某一给定条件,且满足条件的数据点个数(用keep表示)满足指定阈值的次数。                                                               | BOOLEAN                  | `[keep >=/>/=/!=/</<=]threshold`:被指定的阈值或阈值条件,若只使用`threshold`则等价于`keep >= threshold`,`threshold`类型为`INT64` <br> `ignoreNull`:可选,默认为`true`;为`true`表示忽略null值,即如果中间出现null值,直接忽略,不会打断连续性;为`false`表示不忽略null值,即如果中间出现null值,会打断连续性 | INT64     |
-| TIME_DURATION | 求某一列最大一个不为NULL的值所在时间戳与最小一个不为NULL的值所在时间戳的时间戳差                                                                | 所有类型                     | 无                                                                                                                                                                                                                          |   INT64        |
-| MODE          | 求众数。注意:<br>1. 输入序列的不同值个数过多时会有内存异常风险; <br>2. 如果所有元素出现的频次相同,即没有众数,则返回对应时间戳最小的值; <br> 3.如果有多个众数,则返回对应时间戳最小的众数。 | 所有类型                     | 无                                                                                                                                                                                                                          | INT64     |
+| 函数名           | 功能描述                                                                                                     | 允许的输入类型                  | 必要的属性参数                                                                                                                                                                                                                    | 输出类型      |
+|---------------|----------------------------------------------------------------------------------------------------------|--------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|
+| SUM           | 求和。                                                                                                      | INT32 INT64 FLOAT DOUBLE | 无                                                                                                                                                                                                                          | DOUBLE    |
+| COUNT         | 计算数据点数。                                                                                                  | 所有类型                     | 无                                                                                                                                                                                                                          | INT64     |
+| AVG           | 求平均值。                                                                                                    | INT32 INT64 FLOAT DOUBLE | 无                                                                                                                                                                                                                          | DOUBLE    |
+| EXTREME       | 求具有最大绝对值的值。如果正值和负值的最大绝对值相等,则返回正值。                                                                        | INT32 INT64 FLOAT DOUBLE | 无                                                                                                                                                                                                                          | 与输入类型一致   |
+| MAX_VALUE     | 求最大值。                                                                                                    | INT32 INT64 FLOAT DOUBLE | 无                                                                                                                                                                                                                          | 与输入类型一致   |
+| MIN_VALUE     | 求最小值。                                                                                                    | INT32 INT64 FLOAT DOUBLE | 无                                                                                                                                                                                                                          | 与输入类型一致   |
+| FIRST_VALUE   | 求时间戳最小的值。                                                                                                | 所有类型                     | 无                                                                                                                                                                                                                          | 与输入类型一致   |
+| LAST_VALUE    | 求时间戳最大的值。                                                                                                | 所有类型                     | 无                                                                                                                                                                                                                          | 与输入类型一致   |
+| MAX_TIME      | 求最大时间戳。                                                                                                  | 所有类型                     | 无                                                                                                                                                                                                                          | Timestamp |
+| MIN_TIME      | 求最小时间戳。                                                                                                  | 所有类型                     | 无                                                                                                                                                                                                                          | Timestamp |
+| COUNT_IF      | 求数据点连续满足某一给定条件,且满足条件的数据点个数(用keep表示)满足指定阈值的次数。                                                            | BOOLEAN                  | `[keep >=/>/=/!=/</<=]threshold`:被指定的阈值或阈值条件,若只使用`threshold`则等价于`keep >= threshold`,`threshold`类型为`INT64` <br> `ignoreNull`:可选,默认为`true`;为`true`表示忽略null值,即如果中间出现null值,直接忽略,不会打断连续性;为`false`表示不忽略null值,即如果中间出现null值,会打断连续性 | INT64     |
+| TIME_DURATION | 求某一列最大一个不为NULL的值所在时间戳与最小一个不为NULL的值所在时间戳的时间戳差                                                             | 所有类型                     | 无                                                                                                                                                                                                                          |   INT64        |
+| MODE          | 求众数。注意:<br>1.输入序列的不同值个数过多时会有内存异常风险; <br>2.如果所有元素出现的频次相同,即没有众数,则返回对应时间戳最小的值; <br>3.如果有多个众数,则返回对应时间戳最小的众数。 | 所有类型                     | 无                                                                                                                                                                                                                          | 与输入类型一致     |
 ### COUNT_IF
 
 #### 语法