Computation on array: arrow-glib Reference Manual

Computation on array

Functions

GArrowCastOptions *	garrow_cast_options_new ()
GArrowCountOptions *	garrow_count_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 ()

Properties

gboolean	allow-float-truncate	Read / Write
gboolean	allow-int-overflow	Read / Write
gboolean	allow-invalid-utf8	Read / Write
gboolean	allow-time-truncate	Read / Write
GArrowCountMode	mode	Read / Write

Types and Values

#define	GARROW_TYPE_CAST_OPTIONS
struct	GArrowCastOptionsClass
enum	GArrowCountMode
#define	GARROW_TYPE_COUNT_OPTIONS
struct	GArrowCountOptionsClass
	GArrowCastOptions
	GArrowCountOptions

Object Hierarchy

    GEnum
    ╰── GArrowCountMode
    GObject
    ├── GArrowCastOptions
    ╰── GArrowCountOptions

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_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

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;
};

GArrowCastOptions

typedef struct _GArrowCastOptions GArrowCastOptions;

GArrowCountOptions

typedef struct _GArrowCountOptions GArrowCountOptions;

Property Details

The `“allow-float-truncate”` property

  “allow-float-truncate”     gboolean

Whether truncating float value is allowed or not.

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.

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.

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.

Flags: Read / Write

Default value: FALSE

Since: 0.8.0

The `“mode”` property

  “mode”                     GArrowCountMode

How to count values.

Flags: Read / Write

Default value: GARROW_COUNT_ALL

Since: 0.13.0