Add GArrowElementWiseAggregateOptions

Author: stenlarsson

c_glib/arrow-glib/compute.cpp

@@ -251,6 +251,9 @@ G_BEGIN_DECLS
  * #GArrowStructFieldOptions is a class to customize the `struct_field`
  * function.
  *
+ * #GArrowElementWiseAggregateOptions is a class to customize element-wise
+ * aggregate functions such as `min_element_wise` and `max_element_wise`.
+ *
  * There are many functions to compute data on an array.
  */
 
@@ -6338,6 +6341,105 @@ garrow_struct_field_options_new(void)
   return GARROW_STRUCT_FIELD_OPTIONS(options);
 }
 
+enum {
+  PROP_ELEMENT_WISE_AGGREGATE_OPTIONS_SKIP_NULLS = 1,
+};
+
+G_DEFINE_TYPE(GArrowElementWiseAggregateOptions,
+              garrow_element_wise_aggregate_options,
+              GARROW_TYPE_FUNCTION_OPTIONS)
+
+static void
+garrow_element_wise_aggregate_options_set_property(GObject *object,
+                                                   guint prop_id,
+                                                   const GValue *value,
+                                                   GParamSpec *pspec)
+{
+  auto options = garrow_element_wise_aggregate_options_get_raw(
+    GARROW_ELEMENT_WISE_AGGREGATE_OPTIONS(object));
+
+  switch (prop_id) {
+  case PROP_ELEMENT_WISE_AGGREGATE_OPTIONS_SKIP_NULLS:
+    options->skip_nulls = g_value_get_boolean(value);
+    break;
+  default:
+    G_OBJECT_WARN_INVALID_PROPERTY_ID(object, prop_id, pspec);
+    break;
+  }
+}
+
+static void
+garrow_element_wise_aggregate_options_get_property(GObject *object,
+                                                   guint prop_id,
+                                                   GValue *value,
+                                                   GParamSpec *pspec)
+{
+  auto options = garrow_element_wise_aggregate_options_get_raw(
+    GARROW_ELEMENT_WISE_AGGREGATE_OPTIONS(object));
+
+  switch (prop_id) {
+  case PROP_ELEMENT_WISE_AGGREGATE_OPTIONS_SKIP_NULLS:
+    g_value_set_boolean(value, options->skip_nulls);
+    break;
+  default:
+    G_OBJECT_WARN_INVALID_PROPERTY_ID(object, prop_id, pspec);
+    break;
+  }
+}
+
+static void
+garrow_element_wise_aggregate_options_init(GArrowElementWiseAggregateOptions *object)
+{
+  auto priv = GARROW_FUNCTION_OPTIONS_GET_PRIVATE(object);
+  priv->options = static_cast<arrow::compute::FunctionOptions *>(
+    new arrow::compute::ElementWiseAggregateOptions());
+}
+
+static void
+garrow_element_wise_aggregate_options_class_init(
+  GArrowElementWiseAggregateOptionsClass *klass)
+{
+  auto gobject_class = G_OBJECT_CLASS(klass);
+
+  gobject_class->set_property = garrow_element_wise_aggregate_options_set_property;
+  gobject_class->get_property = garrow_element_wise_aggregate_options_get_property;
+
+  arrow::compute::ElementWiseAggregateOptions options;
+
+  GParamSpec *spec;
+  /**
+   * GArrowElementWiseAggregateOptions:skip-nulls:
+   *
+   * Whether to skip (ignore) nulls in the input.
+   * If false, any null in the input forces the output to null.
+   *
+   * Since: 23.0.0
+   */
+  spec = g_param_spec_boolean("skip-nulls",
+                              "Skip nulls",
+                              "Whether to skip (ignore) nulls in the input. If false, "
+                              "any null in the input forces the output to null",
+                              options.skip_nulls,
+                              static_cast<GParamFlags>(G_PARAM_READWRITE));
+  g_object_class_install_property(gobject_class,
+                                  PROP_ELEMENT_WISE_AGGREGATE_OPTIONS_SKIP_NULLS,
+                                  spec);
+}
+
+/**
+ * garrow_element_wise_aggregate_options_new:
+ *
+ * Returns: A newly created #GArrowElementWiseAggregateOptions.
+ *
+ * Since: 23.0.0
+ */
+GArrowElementWiseAggregateOptions *
+garrow_element_wise_aggregate_options_new(void)
+{
+  auto options = g_object_new(GARROW_TYPE_ELEMENT_WISE_AGGREGATE_OPTIONS, NULL);
+  return GARROW_ELEMENT_WISE_AGGREGATE_OPTIONS(options);
+}
+
 G_END_DECLS
 
 arrow::Result<arrow::FieldRef>
@@ -6469,6 +6571,12 @@ garrow_function_options_new_raw(const arrow::compute::FunctionOptions *arrow_opt
       static_cast<const arrow::compute::StructFieldOptions *>(arrow_options);
     auto options = garrow_struct_field_options_new_raw(arrow_struct_field_options);
     return GARROW_FUNCTION_OPTIONS(options);
+  } else if (arrow_type_name == "ElementWiseAggregateOptions") {
+    const auto arrow_element_wise_aggregate_options =
+      static_cast<const arrow::compute::ElementWiseAggregateOptions *>(arrow_options);
+    auto options =
+      garrow_element_wise_aggregate_options_new_raw(arrow_element_wise_aggregate_options);
+    return GARROW_FUNCTION_OPTIONS(options);
   } else {
     auto options = g_object_new(GARROW_TYPE_FUNCTION_OPTIONS, NULL);
     return GARROW_FUNCTION_OPTIONS(options);
@@ -6987,3 +7095,21 @@ garrow_struct_field_options_get_raw(GArrowStructFieldOptions *options)
   return static_cast<arrow::compute::StructFieldOptions *>(
     garrow_function_options_get_raw(GARROW_FUNCTION_OPTIONS(options)));
 }
+
+GArrowElementWiseAggregateOptions *
+garrow_element_wise_aggregate_options_new_raw(
+  const arrow::compute::ElementWiseAggregateOptions *arrow_options)
+{
+  return GARROW_ELEMENT_WISE_AGGREGATE_OPTIONS(
+    g_object_new(GARROW_TYPE_ELEMENT_WISE_AGGREGATE_OPTIONS,
+                 "skip-nulls",
+                 arrow_options->skip_nulls,
+                 NULL));
+}
+
+arrow::compute::ElementWiseAggregateOptions *
+garrow_element_wise_aggregate_options_get_raw(GArrowElementWiseAggregateOptions *options)
+{
+  return static_cast<arrow::compute::ElementWiseAggregateOptions *>(
+    garrow_function_options_get_raw(GARROW_FUNCTION_OPTIONS(options)));
+}

c_glib/arrow-glib/compute.h

@@ -1122,4 +1122,21 @@ GARROW_AVAILABLE_IN_16_0
 GArrowStructFieldOptions *
 garrow_struct_field_options_new(void);
 
+#define GARROW_TYPE_ELEMENT_WISE_AGGREGATE_OPTIONS                                       \
+  (garrow_element_wise_aggregate_options_get_type())
+GARROW_AVAILABLE_IN_23_0
+G_DECLARE_DERIVABLE_TYPE(GArrowElementWiseAggregateOptions,
+                         garrow_element_wise_aggregate_options,
+                         GARROW,
+                         ELEMENT_WISE_AGGREGATE_OPTIONS,
+                         GArrowFunctionOptions)
+struct _GArrowElementWiseAggregateOptionsClass
+{
+  GArrowFunctionOptionsClass parent_class;
+};
+
+GARROW_AVAILABLE_IN_23_0
+GArrowElementWiseAggregateOptions *
+garrow_element_wise_aggregate_options_new(void);
+
 G_END_DECLS

c_glib/arrow-glib/compute.hpp

@@ -175,3 +175,9 @@ garrow_struct_field_options_new_raw(
   const arrow::compute::StructFieldOptions *arrow_options);
 arrow::compute::StructFieldOptions *
 garrow_struct_field_options_get_raw(GArrowStructFieldOptions *options);
+
+GArrowElementWiseAggregateOptions *
+garrow_element_wise_aggregate_options_new_raw(
+  const arrow::compute::ElementWiseAggregateOptions *arrow_options);
+arrow::compute::ElementWiseAggregateOptions *
+garrow_element_wise_aggregate_options_get_raw(GArrowElementWiseAggregateOptions *options);

c_glib/test/test-element-wise-aggregate-options.rb

@@ -0,0 +1,46 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+class TestElementWiseAggregateOptions < Test::Unit::TestCase
+  include Helper::Buildable
+
+  def setup
+    @options = Arrow::ElementWiseAggregateOptions.new
+  end
+
+  def test_skip_nulls_property
+    assert do
+      @options.skip_nulls?
+    end
+    @options.skip_nulls = false
+    assert do
+      !@options.skip_nulls?
+    end
+  end
+
+  def test_min_element_wise_function_with_skip_nulls_false
+    args = [
+      Arrow::ArrayDatum.new(build_int64_array([1, nil, 3])),
+      Arrow::ArrayDatum.new(build_int64_array([4, 1, 5])),
+    ]
+    @options.skip_nulls = false
+    min_element_wise_function = Arrow::Function.find("min_element_wise")
+    assert_equal(build_int64_array([1, nil, 3]),
+                 min_element_wise_function.execute(args, @options).value)
+  end
+end
+