Computation on array

Computation on array

Functions

GArrowCastOptions * garrow_cast_options_new ()
GArrowCountOptions * garrow_count_options_new ()
GArrowFilterOptions * garrow_filter_options_new ()
GArrowTakeOptions * garrow_take_options_new ()
GArrowCompareOptions * garrow_compare_options_new ()
GArrowArray * garrow_array_cast ()
GArrowArray * garrow_array_unique ()
GArrowDictionaryArray * garrow_array_dictionary_encode ()
gint64 garrow_array_count ()
GArrowStructArray * garrow_array_count_values ()
GArrowBooleanArray * garrow_boolean_array_invert ()
GArrowBooleanArray * garrow_boolean_array_and ()
GArrowBooleanArray * garrow_boolean_array_or ()
GArrowBooleanArray * garrow_boolean_array_xor ()
gdouble garrow_numeric_array_mean ()
gint64 garrow_int8_array_sum ()
guint64 garrow_uint8_array_sum ()
gint64 garrow_int16_array_sum ()
guint64 garrow_uint16_array_sum ()
gint64 garrow_int32_array_sum ()
guint64 garrow_uint32_array_sum ()
gint64 garrow_int64_array_sum ()
guint64 garrow_uint64_array_sum ()
gdouble garrow_float_array_sum ()
gdouble garrow_double_array_sum ()
GArrowArray * garrow_array_take ()
GArrowChunkedArray * garrow_array_take_chunked_array ()
GArrowTable * garrow_table_take ()
GArrowTable * garrow_table_take_chunked_array ()
GArrowChunkedArray * garrow_chunked_array_take ()
GArrowChunkedArray * garrow_chunked_array_take_chunked_array ()
GArrowRecordBatch * garrow_record_batch_take ()
GArrowBooleanArray * garrow_int8_array_compare ()
GArrowBooleanArray * garrow_uint8_array_compare ()
GArrowBooleanArray * garrow_int16_array_compare ()
GArrowBooleanArray * garrow_uint16_array_compare ()
GArrowBooleanArray * garrow_int32_array_compare ()
GArrowBooleanArray * garrow_uint32_array_compare ()
GArrowBooleanArray * garrow_int64_array_compare ()
GArrowBooleanArray * garrow_uint64_array_compare ()
GArrowBooleanArray * garrow_float_array_compare ()
GArrowBooleanArray * garrow_double_array_compare ()
GArrowArray * garrow_array_filter ()
GArrowBooleanArray * garrow_array_is_in ()
GArrowBooleanArray * garrow_array_is_in_chunked_array ()
GArrowUInt64Array * garrow_array_sort_to_indices ()
GArrowTable * garrow_table_filter ()
GArrowTable * garrow_table_filter_chunked_array ()
GArrowChunkedArray * garrow_chunked_array_filter ()
GArrowChunkedArray * garrow_chunked_array_filter_chunked_array ()
GArrowRecordBatch * garrow_record_batch_filter ()

Properties

Types and Values

Object Hierarchy

    GEnum
    ├── GArrowCompareOperator
    ├── GArrowCountMode
    ╰── GArrowFilterNullSelectionBehavior
    GObject
    ├── GArrowCastOptions
    ├── GArrowCompareOptions
    ├── GArrowCountOptions
    ├── GArrowFilterOptions
    ╰── GArrowTakeOptions

Includes

#include <arrow-glib/arrow-glib.h>

Description

GArrowCastOptions is a class to customize garrow_array_cast().

GArrowCountOptions is a class to customize garrow_array_count().

There are many functions to compute data on an array.

Functions

garrow_cast_options_new ()

GArrowCastOptions *
garrow_cast_options_new (void);

Returns

A newly created GArrowCastOptions.

Since: 0.7.0

garrow_count_options_new ()

GArrowCountOptions *
garrow_count_options_new (void);

Returns

A newly created GArrowCountOptions.

Since: 0.13.0

garrow_filter_options_new ()

GArrowFilterOptions *
garrow_filter_options_new (void);

Returns

A newly created GArrowFilterOptions.

Since: 0.17.0

garrow_take_options_new ()

GArrowTakeOptions *
garrow_take_options_new (void);

Returns

A newly created GArrowTakeOptions.

Since: 0.14.0

garrow_compare_options_new ()

GArrowCompareOptions *
garrow_compare_options_new (void);

Returns

A newly created GArrowCompareOptions.

Since: 0.14.0

garrow_array_cast ()

GArrowArray *
garrow_array_cast (GArrowArray *array,
                   GArrowDataType *target_data_type,
                   GArrowCastOptions *options,
                   GError **error);

Parameters

array

A GArrowArray.

 

target_data_type

A GArrowDataType of cast target data.

 

options

A GArrowCastOptions.

[nullable]

error

Return location for a GError or NULL.

[nullable]

Returns

A newly created casted array on success, NULL on error.

[nullable][transfer full]

Since: 0.7.0

garrow_array_unique ()

GArrowArray *
garrow_array_unique (GArrowArray *array,
                     GError **error);

Parameters

array

A GArrowArray.

 

error

Return location for a GError or NULL.

[nullable]

Returns

A newly created unique elements array on success, NULL on error.

[nullable][transfer full]

Since: 0.8.0

garrow_array_dictionary_encode ()

GArrowDictionaryArray *
garrow_array_dictionary_encode (GArrowArray *array,
                                GError **error);

Parameters

array

A GArrowArray.

 

error

Return location for a GError or NULL.

[nullable]

Returns

A newly created GArrowDictionaryArray for the array on success, NULL on error.

[nullable][transfer full]

Since: 0.8.0

garrow_array_count ()

gint64
garrow_array_count (GArrowArray *array,
                    GArrowCountOptions *options,
                    GError **error);

Parameters

array

A GArrowArray.

 

options

A GArrowCountOptions.

[nullable]

error

Return location for a GError or NULL.

[nullable]

Returns

The number of target values on success. If an error is occurred, the returned value is untrustful value.

Since: 0.13.0

garrow_array_count_values ()

GArrowStructArray *
garrow_array_count_values (GArrowArray *array,
                           GError **error);

Parameters

array

A GArrowArray.

 

error

Return location for a GError or NULL.

[nullable]

Returns

A GArrowStructArray of {input type "values", int64_t "counts"} on success, NULL on error.

[nullable][transfer full]

Since: 0.13.0

garrow_boolean_array_invert ()

GArrowBooleanArray *
garrow_boolean_array_invert (GArrowBooleanArray *array,
                             GError **error);

Parameters

array

A GArrowBooleanArray.

 

error

Return location for a GError or NULL.

[nullable]

Returns

The element-wise inverted boolean array.

It should be freed with g_object_unref() when no longer needed.

[transfer full]

Since: 0.13.0

garrow_boolean_array_and ()

GArrowBooleanArray *
garrow_boolean_array_and (GArrowBooleanArray *left,
                          GArrowBooleanArray *right,
                          GError **error);

Parameters

left

A left hand side GArrowBooleanArray.

 

right

A right hand side GArrowBooleanArray.

 

error

Return location for a GError or NULL.

[nullable]

Returns

The element-wise AND operated boolean array.

It should be freed with g_object_unref() when no longer needed.

[transfer full]

Since: 0.13.0

garrow_boolean_array_or ()

GArrowBooleanArray *
garrow_boolean_array_or (GArrowBooleanArray *left,
                         GArrowBooleanArray *right,
                         GError **error);

Parameters

left

A left hand side GArrowBooleanArray.

 

right

A right hand side GArrowBooleanArray.

 

error

Return location for a GError or NULL.

[nullable]

Returns

The element-wise OR operated boolean array.

It should be freed with g_object_unref() when no longer needed.

[transfer full]

Since: 0.13.0

garrow_boolean_array_xor ()

GArrowBooleanArray *
garrow_boolean_array_xor (GArrowBooleanArray *left,
                          GArrowBooleanArray *right,
                          GError **error);

Parameters

left

A left hand side GArrowBooleanArray.

 

right

A right hand side GArrowBooleanArray.

 

error

Return location for a GError or NULL.

[nullable]

Returns

The element-wise XOR operated boolean array.

It should be freed with g_object_unref() when no longer needed.

[transfer full]

Since: 0.13.0

garrow_numeric_array_mean ()

gdouble
garrow_numeric_array_mean (GArrowNumericArray *array,
                           GError **error);

Parameters

array

A GArrowNumericArray.

 

error

Return location for a GError or NULL.

[nullable]

Returns

The value of the computed mean.

Since: 0.13.0

garrow_int8_array_sum ()

gint64
garrow_int8_array_sum (GArrowInt8Array *array,
                       GError **error);

Parameters

array

A GArrowInt8Array.

 

error

Return location for a GError or NULL.

[nullable]

Returns

The value of the computed sum on success, If an error is occurred, the returned value is untrustful value.

Since: 0.13.0

garrow_uint8_array_sum ()

guint64
garrow_uint8_array_sum (GArrowUInt8Array *array,
                        GError **error);

Parameters

array

A GArrowUInt8Array.

 

error

Return location for a GError or NULL.

[nullable]

Returns

The value of the computed sum on success, If an error is occurred, the returned value is untrustful value.

Since: 0.13.0

garrow_int16_array_sum ()

gint64
garrow_int16_array_sum (GArrowInt16Array *array,
                        GError **error);

Parameters

array

A GArrowInt16Array.

 

error

Return location for a GError or NULL.

[nullable]

Returns

The value of the computed sum on success, If an error is occurred, the returned value is untrustful value.

Since: 0.13.0

garrow_uint16_array_sum ()

guint64
garrow_uint16_array_sum (GArrowUInt16Array *array,
                         GError **error);

Parameters

array

A GArrowUInt16Array.

 

error

Return location for a GError or NULL.

[nullable]

Returns

The value of the computed sum on success, If an error is occurred, the returned value is untrustful value.

Since: 0.13.0

garrow_int32_array_sum ()

gint64
garrow_int32_array_sum (GArrowInt32Array *array,
                        GError **error);

Parameters

array

A GArrowInt32Array.

 

error

Return location for a GError or NULL.

[nullable]

Returns

The value of the computed sum on success, If an error is occurred, the returned value is untrustful value.

Since: 0.13.0

garrow_uint32_array_sum ()

guint64
garrow_uint32_array_sum (GArrowUInt32Array *array,
                         GError **error);

Parameters

array

A GArrowUInt32Array.

 

error

Return location for a GError or NULL.

[nullable]

Returns

The value of the computed sum on success, If an error is occurred, the returned value is untrustful value.

Since: 0.13.0

garrow_int64_array_sum ()

gint64
garrow_int64_array_sum (GArrowInt64Array *array,
                        GError **error);

Parameters

array

A GArrowInt64Array.

 

error

Return location for a GError or NULL.

[nullable]

Returns

The value of the computed sum on success, If an error is occurred, the returned value is untrustful value.

Since: 0.13.0

garrow_uint64_array_sum ()

guint64
garrow_uint64_array_sum (GArrowUInt64Array *array,
                         GError **error);

Parameters

array

A GArrowUInt64Array.

 

error

Return location for a GError or NULL.

[nullable]

Returns

The value of the computed sum on success, If an error is occurred, the returned value is untrustful value.

Since: 0.13.0

garrow_float_array_sum ()

gdouble
garrow_float_array_sum (GArrowFloatArray *array,
                        GError **error);

Parameters

array

A GArrowFloatArray.

 

error

Return location for a GError or NULL.

[nullable]

Returns

The value of the computed sum on success, If an error is occurred, the returned value is untrustful value.

Since: 0.13.0

garrow_double_array_sum ()

gdouble
garrow_double_array_sum (GArrowDoubleArray *array,
                         GError **error);

Parameters

array

A GArrowDoubleArray.

 

error

Return location for a GError or NULL.

[nullable]

Returns

The value of the computed sum on success, If an error is occurred, the returned value is untrustful value.

Since: 0.13.0

garrow_array_take ()

GArrowArray *
garrow_array_take (GArrowArray *array,
                   GArrowArray *indices,
                   GArrowTakeOptions *options,
                   GError **error);

Parameters

array

A GArrowArray.

 

indices

The indices of values to take.

 

options

A GArrowTakeOptions.

[nullable]

error

Return location for a GError or NULL.

[nullable]

Returns

The GArrowArray taken from an array of values at indices in input array or NULL on error.

[nullable][transfer full]

Since: 0.14.0

garrow_array_take_chunked_array ()

GArrowChunkedArray *
garrow_array_take_chunked_array (GArrowArray *array,
                                 GArrowChunkedArray *indices,
                                 GArrowTakeOptions *options,
                                 GError **error);

Parameters

array

A GArrowArray.

 

indices

The indices of values to take.

 

options

A GArrowTakeOptions.

[nullable]

error

Return location for a GError or NULL.

[nullable]

Returns

The GArrowChunkedArray taken from an array of values at indices in chunked array or NULL on error.

[nullable][transfer full]

Since: 0.16.0

garrow_table_take ()

GArrowTable *
garrow_table_take (GArrowTable *table,
                   GArrowArray *indices,
                   GArrowTakeOptions *options,
                   GError **error);

Parameters

table

A GArrowTable.

 

indices

The indices of values to take.

 

options

A GArrowTakeOptions.

[nullable]

error

Return location for a GError or NULL.

[nullable]

Returns

The GArrowTable taken from an array of values at indices in input array or NULL on error.

[nullable][transfer full]

Since: 0.16.0

garrow_table_take_chunked_array ()

GArrowTable *
garrow_table_take_chunked_array (GArrowTable *table,
                                 GArrowChunkedArray *indices,
                                 GArrowTakeOptions *options,
                                 GError **error);

Parameters

table

A GArrowTable.

 

indices

The indices of values to take.

 

options

A GArrowTakeOptions.

[nullable]

error

Return location for a GError or NULL.

[nullable]

Returns

The GArrowTable taken from an array of values at indices in chunked array or NULL on error.

[nullable][transfer full]

Since: 0.16.0

garrow_chunked_array_take ()

GArrowChunkedArray *
garrow_chunked_array_take (GArrowChunkedArray *chunked_array,
                           GArrowArray *indices,
                           GArrowTakeOptions *options,
                           GError **error);

Parameters

chunked_array

A GArrowChunkedArray.

 

indices

The indices of values to take.

 

options

A GArrowTakeOptions.

[nullable]

error

Return location for a GError or NULL.

[nullable]

Returns

The GArrowChunkedArray taken from an array of values at indices in input array or NULL on error.

[nullable][transfer full]

Since: 0.16.0

garrow_chunked_array_take_chunked_array ()

GArrowChunkedArray *
garrow_chunked_array_take_chunked_array
                               (GArrowChunkedArray *chunked_array,
                                GArrowChunkedArray *indices,
                                GArrowTakeOptions *options,
                                GError **error);

Parameters

chunked_array

A GArrowChunkedArray.

 

indices

The indices of values to take.

 

options

A GArrowTakeOptions.

[nullable]

error

Return location for a GError or NULL.

[nullable]

Returns

The GArrowChunkedArray taken from an array of values at indices in chunked array or NULL on error.

[nullable][transfer full]

Since: 0.16.0

garrow_record_batch_take ()

GArrowRecordBatch *
garrow_record_batch_take (GArrowRecordBatch *record_batch,
                          GArrowArray *indices,
                          GArrowTakeOptions *options,
                          GError **error);

Parameters

record_batch

A GArrowRecordBatch.

 

indices

The indices of values to take.

 

options

A GArrowTakeOptions.

[nullable]

error

Return location for a GError or NULL.

[nullable]

Returns

The GArrowChunkedArray taken from an array of values at indices in input array or NULL on error.

[nullable][transfer full]

Since: 0.16.0

garrow_int8_array_compare ()

GArrowBooleanArray *
garrow_int8_array_compare (GArrowInt8Array *array,
                           gint8 value,
                           GArrowCompareOptions *options,
                           GError **error);

Parameters

array

A GArrowInt8Array.

 

value

The value to compare.

 

options

A GArrowCompareOptions.

 

error

Return location for a GError or NULL.

[nullable]

Returns

The GArrowBooleanArray as the result compared a numeric array with a scalar on success, NULL on error.

[nullable][transfer full]

Since: 0.14.0

garrow_uint8_array_compare ()

GArrowBooleanArray *
garrow_uint8_array_compare (GArrowUInt8Array *array,
                            guint8 value,
                            GArrowCompareOptions *options,
                            GError **error);

Parameters

array

A GArrowUInt8Array.

 

value

The value to compare.

 

options

A GArrowCompareOptions.

 

error

Return location for a GError or NULL.

[nullable]

Returns

The GArrowBooleanArray as the result compared a numeric array with a scalar on success, NULL on error.

[nullable][transfer full]

Since: 0.14.0

garrow_int16_array_compare ()

GArrowBooleanArray *
garrow_int16_array_compare (GArrowInt16Array *array,
                            gint16 value,
                            GArrowCompareOptions *options,
                            GError **error);

Parameters

array

A GArrowInt16Array.

 

value

The value to compare.

 

options

A GArrowCompareOptions.

 

error

Return location for a GError or NULL.

[nullable]

Returns

The GArrowBooleanArray as the result compared a numeric array with a scalar on success, NULL on error.

[nullable][transfer full]

Since: 0.14.0

garrow_uint16_array_compare ()

GArrowBooleanArray *
garrow_uint16_array_compare (GArrowUInt16Array *array,
                             guint16 value,
                             GArrowCompareOptions *options,
                             GError **error);

Parameters

array

A GArrowUInt16Array.

 

value

The value to compare.

 

options

A GArrowCompareOptions.

 

error

Return location for a GError or NULL.

[nullable]

Returns

The GArrowBooleanArray as the result compared a numeric array with a scalar on success, NULL on error.

[nullable][transfer full]

Since: 0.14.0

garrow_int32_array_compare ()

GArrowBooleanArray *
garrow_int32_array_compare (GArrowInt32Array *array,
                            gint32 value,
                            GArrowCompareOptions *options,
                            GError **error);

Parameters

array

A GArrowUInt32Array.

 

value

The value to compare.

 

options

A GArrowCompareOptions.

 

error

Return location for a GError or NULL.

[nullable]

Returns

The GArrowBooleanArray as the result compared a numeric array with a scalar on success, NULL on error.

[nullable][transfer full]

Since: 0.14.0

garrow_uint32_array_compare ()

GArrowBooleanArray *
garrow_uint32_array_compare (GArrowUInt32Array *array,
                             guint32 value,
                             GArrowCompareOptions *options,
                             GError **error);

Parameters

array

A GArrowUInt32Array.

 

value

The value to compare.

 

options

A GArrowCompareOptions.

 

error

Return location for a GError or NULL.

[nullable]

Returns

The GArrowBooleanArray as the result compared a numeric array with a scalar on success, NULL on error.

[nullable][transfer full]

Since: 0.14.0

garrow_int64_array_compare ()

GArrowBooleanArray *
garrow_int64_array_compare (GArrowInt64Array *array,
                            gint64 value,
                            GArrowCompareOptions *options,
                            GError **error);

Parameters

array

A GArrowInt64Array.

 

value

The value to compare.

 

options

A GArrowCompareOptions.

 

error

Return location for a GError or NULL.

[nullable]

Returns

The GArrowBooleanArray as the result compared a numeric array with a scalar on success, NULL on error.

[nullable][transfer full]

Since: 0.14.0

garrow_uint64_array_compare ()

GArrowBooleanArray *
garrow_uint64_array_compare (GArrowUInt64Array *array,
                             guint64 value,
                             GArrowCompareOptions *options,
                             GError **error);

Parameters

array

A GArrowUInt64Array.

 

value

The value to compare.

 

options

A GArrowCompareOptions.

 

error

Return location for a GError or NULL.

[nullable]

Returns

The GArrowBooleanArray as the result compared a numeric array with a scalar on success, NULL on error.

[nullable][transfer full]

Since: 0.14.0

garrow_float_array_compare ()

GArrowBooleanArray *
garrow_float_array_compare (GArrowFloatArray *array,
                            gfloat value,
                            GArrowCompareOptions *options,
                            GError **error);

Parameters

array

A GArrowFloatArray.

 

value

The value to compare.

 

options

A GArrowCompareOptions.

 

error

Return location for a GError or NULL.

[nullable]

Returns

The GArrowBooleanArray as the result compared a numeric array with a scalar on success, NULL on error.

[nullable][transfer full]

Since: 0.14.0

garrow_double_array_compare ()

GArrowBooleanArray *
garrow_double_array_compare (GArrowDoubleArray *array,
                             gdouble value,
                             GArrowCompareOptions *options,
                             GError **error);

Parameters

array

A GArrowDoubleArray.

 

value

The value to compare.

 

options

A GArrowCompareOptions.

 

error

Return location for a GError or NULL.

[nullable]

Returns

The GArrowBooleanArray as the result compared a numeric array with a scalar on success, NULL on error.

[nullable][transfer full]

Since: 0.14.0

garrow_array_filter ()

GArrowArray *
garrow_array_filter (GArrowArray *array,
                     GArrowBooleanArray *filter,
                     GArrowFilterOptions *options,
                     GError **error);

Parameters

array

A GArrowArray.

 

filter

The values indicates which values should be filtered out.

 

options

A GArrowFilterOptions.

[nullable]

error

Return location for a GError or NULL.

[nullable]

Returns

The GArrowArray filterd with a boolean selection filter. Nulls in the filter will result in nulls in the output.

[nullable][transfer full]

Since: 0.15.0

garrow_array_is_in ()

GArrowBooleanArray *
garrow_array_is_in (GArrowArray *left,
                    GArrowArray *right,
                    GError **error);

Parameters

left

A left hand side GArrowArray.

 

right

A right hand side GArrowArray.

 

error

Return location for a GError or NULL.

[nullable]

Returns

The GArrowBooleanArray showing whether each element in the left array is contained in right array.

[nullable][transfer full]

Since: 0.15.0

garrow_array_is_in_chunked_array ()

GArrowBooleanArray *
garrow_array_is_in_chunked_array (GArrowArray *left,
                                  GArrowChunkedArray *right,
                                  GError **error);

Parameters

left

A left hand side GArrowArray.

 

right

A right hand side GArrowChunkedArray.

 

error

Return location for a GError or NULL.

[nullable]

Returns

The GArrowBooleanArray showing whether each element in the left array is contained in right chunked array.

[nullable][transfer full]

Since: 0.15.0

garrow_array_sort_to_indices ()

GArrowUInt64Array *
garrow_array_sort_to_indices (GArrowArray *array,
                              GError **error);

Parameters

array

A GArrowArray.

 

error

Return location for a GError or NULL.

[nullable]

Returns

The indices that would sort an array on success, NULL on error.

[nullable][transfer full]

Since: 0.15.0

garrow_table_filter ()

GArrowTable *
garrow_table_filter (GArrowTable *table,
                     GArrowBooleanArray *filter,
                     GArrowFilterOptions *options,
                     GError **error);

Parameters

table

A GArrowTable.

 

filter

The values indicates which values should be filtered out.

 

options

A GArrowFilterOptions.

[nullable]

error

Return location for a GError or NULL.

[nullable]

Returns

The GArrowTable filterd with a boolean selection filter. Nulls in the filter will result in nulls in the output.

[nullable][transfer full]

Since: 0.15.0

garrow_table_filter_chunked_array ()

GArrowTable *
garrow_table_filter_chunked_array (GArrowTable *table,
                                   GArrowChunkedArray *filter,
                                   GArrowFilterOptions *options,
                                   GError **error);

Parameters

table

A GArrowTable.

 

filter

The values indicates which values should be filtered out.

 

options

A GArrowFilterOptions.

[nullable]

error

Return location for a GError or NULL.

[nullable]

Returns

The GArrowTable filterd with a chunked array filter. Nulls in the filter will result in nulls in the output.

[nullable][transfer full]

Since: 0.15.0

garrow_chunked_array_filter ()

GArrowChunkedArray *
garrow_chunked_array_filter (GArrowChunkedArray *chunked_array,
                             GArrowBooleanArray *filter,
                             GArrowFilterOptions *options,
                             GError **error);

Parameters

chunked_array

A GArrowChunkedArray.

 

filter

The values indicates which values should be filtered out.

 

options

A GArrowFilterOptions.

[nullable]

error

Return location for a GError or NULL.

[nullable]

Returns

The GArrowChunkedArray filterd with a boolean selection filter. Nulls in the filter will result in nulls in the output.

[nullable][transfer full]

Since: 0.15.0

garrow_chunked_array_filter_chunked_array ()

GArrowChunkedArray *
garrow_chunked_array_filter_chunked_array
                               (GArrowChunkedArray *chunked_array,
                                GArrowChunkedArray *filter,
                                GArrowFilterOptions *options,
                                GError **error);

Parameters

chunked_array

A GArrowChunkedArray.

 

filter

The values indicates which values should be filtered out.

 

options

A GArrowFilterOptions.

[nullable]

error

Return location for a GError or NULL.

[nullable]

Returns

The GArrowChunkedArray filterd with a chunked array filter. Nulls in the filter will result in nulls in the output.

[nullable][transfer full]

Since: 0.15.0

garrow_record_batch_filter ()

GArrowRecordBatch *
garrow_record_batch_filter (GArrowRecordBatch *record_batch,
                            GArrowBooleanArray *filter,
                            GArrowFilterOptions *options,
                            GError **error);

Parameters

record_batch

A GArrowRecordBatch.

 

filter

The values indicates which values should be filtered out.

 

options

A GArrowFilterOptions.

[nullable]

error

Return location for a GError or NULL.

[nullable]

Returns

The GArrowRecordBatch filterd with a boolean selection filter. Nulls in the filter will result in nulls in the output.

[nullable][transfer full]

Since: 0.15.0

Types and Values

GARROW_TYPE_CAST_OPTIONS

#define GARROW_TYPE_CAST_OPTIONS (garrow_cast_options_get_type())

struct GArrowCastOptionsClass

struct GArrowCastOptionsClass {
  GObjectClass parent_class;
};

enum GArrowCountMode

They are corresponding to arrow::compute::CountOptions::mode values.

Members

GARROW_COUNT_ALL

Count all non-null values.

 

GARROW_COUNT_NULL

Count all null values.

 

GARROW_TYPE_COUNT_OPTIONS

#define GARROW_TYPE_COUNT_OPTIONS (garrow_count_options_get_type())

struct GArrowCountOptionsClass

struct GArrowCountOptionsClass {
  GObjectClass parent_class;
};

enum GArrowFilterNullSelectionBehavior

They are corresponding to arrow::compute::FilterOptions::NullSelectionBehavior values.

Members

GARROW_FILTER_NULL_SELECTION_DROP

Filtered value will be removed in the output.

 

GARROW_FILTER_NULL_SELECTION_EMIT_NULL

Filtered value will be null in the output.

 

GARROW_TYPE_FILTER_OPTIONS

#define GARROW_TYPE_FILTER_OPTIONS (garrow_filter_options_get_type())

struct GArrowFilterOptionsClass

struct GArrowFilterOptionsClass {
  GObjectClass parent_class;
};

GARROW_TYPE_TAKE_OPTIONS

#define GARROW_TYPE_TAKE_OPTIONS (garrow_take_options_get_type())

struct GArrowTakeOptionsClass

struct GArrowTakeOptionsClass {
  GObjectClass parent_class;
};

enum GArrowCompareOperator

They are corresponding to arrow::compute::CompareOperator values.

Members

GARROW_COMPARE_EQUAL

Equal operator.

 

GARROW_COMPARE_NOT_EQUAL

Not equal operator.

 

GARROW_COMPARE_GREATER

Greater operator.

 

GARROW_COMPARE_GREATER_EQUAL

Greater equal operator.

 

GARROW_COMPARE_LESS

Less operator.

 

GARROW_COMPARE_LESS_EQUAL

Less equal operator.

 

GARROW_TYPE_COMPARE_OPTIONS

#define GARROW_TYPE_COMPARE_OPTIONS (garrow_compare_options_get_type())

struct GArrowCompareOptionsClass

struct GArrowCompareOptionsClass {
  GObjectClass parent_class;
};

GArrowCastOptions

typedef struct _GArrowCastOptions GArrowCastOptions;

GArrowCompareOptions

typedef struct _GArrowCompareOptions GArrowCompareOptions;

GArrowCountOptions

typedef struct _GArrowCountOptions GArrowCountOptions;

GArrowFilterOptions

typedef struct _GArrowFilterOptions GArrowFilterOptions;

GArrowTakeOptions

typedef struct _GArrowTakeOptions GArrowTakeOptions;

Property Details

The “allow-float-truncate” property

  “allow-float-truncate”     gboolean

Whether truncating float value is allowed or not.

Owner: GArrowCastOptions

Flags: Read / Write

Default value: FALSE

Since: 0.12.0

The “allow-int-overflow” property

  “allow-int-overflow”       gboolean

Whether integer overflow is allowed or not.

Owner: GArrowCastOptions

Flags: Read / Write

Default value: FALSE

Since: 0.7.0

The “allow-invalid-utf8” property

  “allow-invalid-utf8”       gboolean

Whether invalid UTF-8 string value is allowed or not.

Owner: GArrowCastOptions

Flags: Read / Write

Default value: FALSE

Since: 0.13.0

The “allow-time-truncate” property

  “allow-time-truncate”      gboolean

Whether truncating time value is allowed or not.

Owner: GArrowCastOptions

Flags: Read / Write

Default value: FALSE

Since: 0.8.0

The “operator” property

  “operator”                 GArrowCompareOperator

How to compare the value.

Owner: GArrowCompareOptions

Flags: Read / Write

Default value: GARROW_COMPARE_EQUAL

Since: 0.14.0

The “mode” property

  “mode”                     GArrowCountMode

How to count values.

Owner: GArrowCountOptions

Flags: Read / Write

Default value: GARROW_COUNT_ALL

Since: 0.13.0

The “null-selection-behavior” property

  “null-selection-behavior”  GArrowFilterNullSelectionBehavior

How to handle filtered values.

Owner: GArrowFilterOptions

Flags: Read / Write

Default value: GARROW_FILTER_NULL_SELECTION_DROP