Documenting any/all as kleen when skip_null=True.

Author: rok

cpp/src/arrow/compute/api_aggregate.h

@@ -202,6 +202,8 @@ Result<Datum> MinMax(
 ///
 /// This function returns true if any of the elements in the array evaluates
 /// to true and false otherwise. Null values are ignored by default.
+/// If null values are taken into account by setting ScalarAggregateOptions
+/// parameter skip_nulls = false then kleen logic is applied.
 ///
 /// \param[in] value input datum, expecting a boolean array
 /// \param[in] options see ScalarAggregateOptions for more information
@@ -220,6 +222,8 @@ Result<Datum> Any(
 ///
 /// This function returns true if all of the elements in the array evaluate
 /// to true and false otherwise. Null values are ignored by default.
+/// If null values are taken into account by setting ScalarAggregateOptions
+/// parameter skip_nulls = false then kleen logic is applied.
 ///
 /// \param[in] value input datum, expecting a boolean array
 /// \param[in] options see ScalarAggregateOptions for more information

docs/source/cpp/compute.rst

@@ -186,25 +186,25 @@ Aggregations
 +--------------------------+------------+--------------------+-----------------------+--------------------------------------------+
 | Function name            | Arity      | Input types        | Output type           | Options class                              |
 +==========================+============+====================+=======================+============================================+
-| all                      | Unary      | Boolean            | Scalar Boolean        | :struct:`ScalarAggregateOptions`           |
+| all                      | Unary      | Boolean            | Scalar Boolean (1)    | :struct:`ScalarAggregateOptions`           |
 +--------------------------+------------+--------------------+-----------------------+--------------------------------------------+
-| any                      | Unary      | Boolean            | Scalar Boolean        | :struct:`ScalarAggregateOptions`           |
+| any                      | Unary      | Boolean            | Scalar Boolean (1)    | :struct:`ScalarAggregateOptions`           |
 +--------------------------+------------+--------------------+-----------------------+--------------------------------------------+
 | count                    | Unary      | Any                | Scalar Int64          | :struct:`ScalarAggregateOptions`           |
 +--------------------------+------------+--------------------+-----------------------+--------------------------------------------+
 | index                    | Unary      | Any                | Scalar Int64          | :struct:`IndexOptions`                     |
 +--------------------------+------------+--------------------+-----------------------+--------------------------------------------+
 | mean                     | Unary      | Numeric            | Scalar Float64        | :struct:`ScalarAggregateOptions`           |
 +--------------------------+------------+--------------------+-----------------------+--------------------------------------------+
-| min_max                  | Unary      | Numeric            | Scalar Struct  (1)    | :struct:`ScalarAggregateOptions`           |
+| min_max                  | Unary      | Numeric            | Scalar Struct  (2)    | :struct:`ScalarAggregateOptions`           |
 +--------------------------+------------+--------------------+-----------------------+--------------------------------------------+
-| mode                     | Unary      | Numeric            | Struct  (2)           | :struct:`ModeOptions`                      |
+| mode                     | Unary      | Numeric            | Struct  (3)           | :struct:`ModeOptions`                      |
 +--------------------------+------------+--------------------+-----------------------+--------------------------------------------+
-| quantile                 | Unary      | Numeric            | Scalar Numeric (3)    | :struct:`QuantileOptions`                  |
+| quantile                 | Unary      | Numeric            | Scalar Numeric (4)    | :struct:`QuantileOptions`                  |
 +--------------------------+------------+--------------------+-----------------------+--------------------------------------------+
 | stddev                   | Unary      | Numeric            | Scalar Float64        | :struct:`VarianceOptions`                  |
 +--------------------------+------------+--------------------+-----------------------+--------------------------------------------+
-| sum                      | Unary      | Numeric            | Scalar Numeric (4)    | :struct:`ScalarAggregateOptions`           |
+| sum                      | Unary      | Numeric            | Scalar Numeric (5)    | :struct:`ScalarAggregateOptions`           |
 +--------------------------+------------+--------------------+-----------------------+--------------------------------------------+
 | tdigest                  | Unary      | Numeric            | Scalar Float64        | :struct:`TDigestOptions`                   |
 +--------------------------+------------+--------------------+-----------------------+--------------------------------------------+
@@ -213,18 +213,23 @@ Aggregations
 
 Notes:
 
-* \(1) Output is a ``{"min": input type, "max": input type}`` Struct.
+* \(1) If null values are taken into account by setting ScalarAggregateOptions
+  parameter skip_nulls = false then `Kleene logic`_ logic is applied.
 
-* \(2) Output is an array of ``{"mode": input type, "count": Int64}`` Struct.
+* \(2) Output is a ``{"min": input type, "max": input type}`` Struct.
+
+* \(3) Output is an array of ``{"mode": input type, "count": Int64}`` Struct.
   It contains the *N* most common elements in the input, in descending
   order, where *N* is given in :member:`ModeOptions::n`.
   If two values have the same count, the smallest one comes first.
   Note that the output can have less than *N* elements if the input has
   less than *N* distinct values.
 
-* \(3) Output is Float64 or input type, depending on QuantileOptions.
+* \(4) Output is Float64 or input type, depending on QuantileOptions.
+
+* \(5) Output is Int64, UInt64 or Float64, depending on the input type.
 
-* \(4) Output is Int64, UInt64 or Float64, depending on the input type.
+.. _Kleene logic: https://en.wikipedia.org/wiki/Three-valued_logic#Kleene_and_Priest_logics
 
 Element-wise ("scalar") functions
 ---------------------------------