You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@arrow.apache.org by ia...@apache.org on 2022/06/02 20:09:00 UTC
[arrow] branch master updated: ARROW-16742: [C++][Docs] Fix output type of hash_distinct in docs (#13303)
This is an automated email from the ASF dual-hosted git repository.
ianmcook pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/arrow.git
The following commit(s) were added to refs/heads/master by this push:
new df0af8164a ARROW-16742: [C++][Docs] Fix output type of hash_distinct in docs (#13303)
df0af8164a is described below
commit df0af8164a46e306e7d224b103859843863529a3
Author: Ian Cook <ia...@gmail.com>
AuthorDate: Thu Jun 2 16:08:54 2022 -0400
ARROW-16742: [C++][Docs] Fix output type of hash_distinct in docs (#13303)
This corrects the output type of `hash_distinct` in the compute docs.
Authored-by: Ian Cook <ia...@gmail.com>
Signed-off-by: Ian Cook <ia...@gmail.com>
---
docs/source/cpp/compute.rst | 77 +++++++++++++++++++++++----------------------
1 file changed, 39 insertions(+), 38 deletions(-)
diff --git a/docs/source/cpp/compute.rst b/docs/source/cpp/compute.rst
index 80aea63dfa..a354f42a4b 100644
--- a/docs/source/cpp/compute.rst
+++ b/docs/source/cpp/compute.rst
@@ -319,43 +319,43 @@ The supported aggregation functions are as follows. All function names are
prefixed with ``hash_``, which differentiates them from their scalar
equivalents above and reflects how they are implemented internally.
-+-------------------------+-------+------------------------------------+------------------------+----------------------------------+-------+
-| Function name | Arity | Input types | Output type | Options class | Notes |
-+=========================+=======+====================================+========================+==================================+=======+
-| hash_all | Unary | Boolean | Boolean | :struct:`ScalarAggregateOptions` | \(1) |
-+-------------------------+-------+------------------------------------+------------------------+----------------------------------+-------+
-| hash_any | Unary | Boolean | Boolean | :struct:`ScalarAggregateOptions` | \(1) |
-+-------------------------+-------+------------------------------------+------------------------+----------------------------------+-------+
-| hash_approximate_median | Unary | Numeric | Float64 | :struct:`ScalarAggregateOptions` | |
-+-------------------------+-------+------------------------------------+------------------------+----------------------------------+-------+
-| hash_count | Unary | Any | Int64 | :struct:`CountOptions` | \(2) |
-+-------------------------+-------+------------------------------------+------------------------+----------------------------------+-------+
-| hash_count_distinct | Unary | Any | Int64 | :struct:`CountOptions` | \(2) |
-+-------------------------+-------+------------------------------------+------------------------+----------------------------------+-------+
-| hash_distinct | Unary | Any | Input type | :struct:`CountOptions` | \(2) |
-+-------------------------+-------+------------------------------------+------------------------+----------------------------------+-------+
-| hash_list | Unary | Any | List of input type | | \(3) |
-+-------------------------+-------+------------------------------------+------------------------+----------------------------------+-------+
-| hash_max | Unary | Non-nested, non-binary/string-like | Input type | :struct:`ScalarAggregateOptions` | |
-+-------------------------+-------+------------------------------------+------------------------+----------------------------------+-------+
-| hash_mean | Unary | Numeric | Decimal/Float64 | :struct:`ScalarAggregateOptions` | \(4) |
-+-------------------------+-------+------------------------------------+------------------------+----------------------------------+-------+
-| hash_min | Unary | Non-nested, non-binary/string-like | Input type | :struct:`ScalarAggregateOptions` | |
-+-------------------------+-------+------------------------------------+------------------------+----------------------------------+-------+
-| hash_min_max | Unary | Non-nested types | Struct | :struct:`ScalarAggregateOptions` | \(5) |
-+-------------------------+-------+------------------------------------+------------------------+----------------------------------+-------+
-| hash_one | Unary | Any | Input type | | \(6) |
-+-------------------------+-------+------------------------------------+------------------------+----------------------------------+-------+
-| hash_product | Unary | Numeric | Numeric | :struct:`ScalarAggregateOptions` | \(7) |
-+-------------------------+-------+------------------------------------+------------------------+----------------------------------+-------+
-| hash_stddev | Unary | Numeric | Float64 | :struct:`VarianceOptions` | \(8) |
-+-------------------------+-------+------------------------------------+------------------------+----------------------------------+-------+
-| hash_sum | Unary | Numeric | Numeric | :struct:`ScalarAggregateOptions` | \(7) |
-+-------------------------+-------+------------------------------------+------------------------+----------------------------------+-------+
-| hash_tdigest | Unary | Numeric | FixedSizeList[Float64] | :struct:`TDigestOptions` | \(9) |
-+-------------------------+-------+------------------------------------+------------------------+----------------------------------+-------+
-| hash_variance | Unary | Numeric | Float64 | :struct:`VarianceOptions` | \(8) |
-+-------------------------+-------+------------------------------------+------------------------+----------------------------------+-------+
++-------------------------+-------+------------------------------------+------------------------+----------------------------------+-----------+
+| Function name | Arity | Input types | Output type | Options class | Notes |
++=========================+=======+====================================+========================+==================================+===========+
+| hash_all | Unary | Boolean | Boolean | :struct:`ScalarAggregateOptions` | \(1) |
++-------------------------+-------+------------------------------------+------------------------+----------------------------------+-----------+
+| hash_any | Unary | Boolean | Boolean | :struct:`ScalarAggregateOptions` | \(1) |
++-------------------------+-------+------------------------------------+------------------------+----------------------------------+-----------+
+| hash_approximate_median | Unary | Numeric | Float64 | :struct:`ScalarAggregateOptions` | |
++-------------------------+-------+------------------------------------+------------------------+----------------------------------+-----------+
+| hash_count | Unary | Any | Int64 | :struct:`CountOptions` | \(2) |
++-------------------------+-------+------------------------------------+------------------------+----------------------------------+-----------+
+| hash_count_distinct | Unary | Any | Int64 | :struct:`CountOptions` | \(2) |
++-------------------------+-------+------------------------------------+------------------------+----------------------------------+-----------+
+| hash_distinct | Unary | Any | List of input type | :struct:`CountOptions` | \(2) \(3) |
++-------------------------+-------+------------------------------------+------------------------+----------------------------------+-----------+
+| hash_list | Unary | Any | List of input type | | \(3) |
++-------------------------+-------+------------------------------------+------------------------+----------------------------------+-----------+
+| hash_max | Unary | Non-nested, non-binary/string-like | Input type | :struct:`ScalarAggregateOptions` | |
++-------------------------+-------+------------------------------------+------------------------+----------------------------------+-----------+
+| hash_mean | Unary | Numeric | Decimal/Float64 | :struct:`ScalarAggregateOptions` | \(4) |
++-------------------------+-------+------------------------------------+------------------------+----------------------------------+-----------+
+| hash_min | Unary | Non-nested, non-binary/string-like | Input type | :struct:`ScalarAggregateOptions` | |
++-------------------------+-------+------------------------------------+------------------------+----------------------------------+-----------+
+| hash_min_max | Unary | Non-nested types | Struct | :struct:`ScalarAggregateOptions` | \(5) |
++-------------------------+-------+------------------------------------+------------------------+----------------------------------+-----------+
+| hash_one | Unary | Any | Input type | | \(6) |
++-------------------------+-------+------------------------------------+------------------------+----------------------------------+-----------+
+| hash_product | Unary | Numeric | Numeric | :struct:`ScalarAggregateOptions` | \(7) |
++-------------------------+-------+------------------------------------+------------------------+----------------------------------+-----------+
+| hash_stddev | Unary | Numeric | Float64 | :struct:`VarianceOptions` | \(8) |
++-------------------------+-------+------------------------------------+------------------------+----------------------------------+-----------+
+| hash_sum | Unary | Numeric | Numeric | :struct:`ScalarAggregateOptions` | \(7) |
++-------------------------+-------+------------------------------------+------------------------+----------------------------------+-----------+
+| hash_tdigest | Unary | Numeric | FixedSizeList[Float64] | :struct:`TDigestOptions` | \(9) |
++-------------------------+-------+------------------------------------+------------------------+----------------------------------+-----------+
+| hash_variance | Unary | Numeric | Float64 | :struct:`VarianceOptions` | \(8) |
++-------------------------+-------+------------------------------------+------------------------+----------------------------------+-----------+
* \(1) If null values are taken into account, by setting the
:member:`ScalarAggregateOptions::skip_nulls` to false, then `Kleene logic`_
@@ -367,7 +367,8 @@ equivalents above and reflects how they are implemented internally.
are emitted. This never affects the grouping keys, only group values
(i.e. you may get a group where the key is null).
-* \(3) ``hash_list`` gathers the grouped values into a list array.
+* \(3) ``hash_distinct`` and ``hash_list`` gather the grouped values
+ into a list array.
* \(4) For decimal inputs, the resulting decimal will have the same
precision and scale. The result is rounded away from zero.