You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@arrow.apache.org by li...@apache.org on 2022/07/05 11:48:07 UTC

[arrow] branch master updated: MINOR: [C++] Aggregate doc fix (#13496)

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

lidavidm 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 3e8839ef4d MINOR: [C++] Aggregate doc fix (#13496)
3e8839ef4d is described below

commit 3e8839ef4d57e051cf465914a7e73960297d0c34
Author: Vibhatha Lakmal Abeykoon <vi...@users.noreply.github.com>
AuthorDate: Tue Jul 5 17:18:02 2022 +0530

    MINOR: [C++] Aggregate doc fix (#13496)
    
    The `Aggregate` was exposed to the user, but the docs weren't properly fixed to reflect that. Adding that minor change in this PR.
    
    Authored-by: Vibhatha Abeykoon <vi...@gmail.com>
    Signed-off-by: David Li <li...@gmail.com>
---
 cpp/src/arrow/compute/api_aggregate.h | 30 +++++++++++++++---------------
 1 file changed, 15 insertions(+), 15 deletions(-)

diff --git a/cpp/src/arrow/compute/api_aggregate.h b/cpp/src/arrow/compute/api_aggregate.h
index 55f434c665..c9a84d2018 100644
--- a/cpp/src/arrow/compute/api_aggregate.h
+++ b/cpp/src/arrow/compute/api_aggregate.h
@@ -184,6 +184,21 @@ class ARROW_EXPORT IndexOptions : public FunctionOptions {
   std::shared_ptr<Scalar> value;
 };
 
+/// \brief Configure a grouped aggregation
+struct ARROW_EXPORT Aggregate {
+  /// the name of the aggregation function
+  std::string function;
+
+  /// options for the aggregation function
+  std::shared_ptr<FunctionOptions> options;
+
+  // fields to which aggregations will be applied
+  FieldRef target;
+
+  // output field name for aggregations
+  std::string name;
+};
+
 /// @}
 
 /// \brief Count values in an array.
@@ -393,20 +408,5 @@ ARROW_EXPORT
 Result<Datum> Index(const Datum& value, const IndexOptions& options,
                     ExecContext* ctx = NULLPTR);
 
-/// \brief Configure a grouped aggregation
-struct ARROW_EXPORT Aggregate {
-  /// the name of the aggregation function
-  std::string function;
-
-  /// options for the aggregation function
-  std::shared_ptr<FunctionOptions> options;
-
-  // fields to which aggregations will be applied
-  FieldRef target;
-
-  // output field name for aggregations
-  std::string name;
-};
-
 }  // namespace compute
 }  // namespace arrow