Basic array classes

Basic array classes

Functions

GArrowEqualOptions * garrow_equal_options_new ()
gboolean garrow_equal_options_is_approx ()
GArrowArray * garrow_array_import ()
gboolean garrow_array_export ()
gboolean garrow_array_equal ()
gboolean garrow_array_equal_options ()
gboolean garrow_array_equal_approx ()
gboolean garrow_array_equal_range ()
gboolean garrow_array_is_null ()
gboolean garrow_array_is_valid ()
gint64 garrow_array_get_length ()
gint64 garrow_array_get_offset ()
gint64 garrow_array_get_n_nulls ()
GArrowBuffer * garrow_array_get_null_bitmap ()
GArrowDataType * garrow_array_get_value_data_type ()
GArrowType garrow_array_get_value_type ()
GArrowArray * garrow_array_slice ()
gchar * garrow_array_to_string ()
GArrowArray * garrow_array_view ()
gchar * garrow_array_diff_unified ()
GArrowArray * garrow_array_concatenate ()
GArrowNullArray * garrow_null_array_new ()
GArrowBuffer * garrow_primitive_array_get_buffer ()
GArrowBuffer * garrow_primitive_array_get_data_buffer ()
GArrowBooleanArray * garrow_boolean_array_new ()
gboolean garrow_boolean_array_get_value ()
gboolean * garrow_boolean_array_get_values ()
GArrowInt8Array * garrow_int8_array_new ()
gint8 garrow_int8_array_get_value ()
const gint8 * garrow_int8_array_get_values ()
GArrowUInt8Array * garrow_uint8_array_new ()
guint8 garrow_uint8_array_get_value ()
const guint8 * garrow_uint8_array_get_values ()
GArrowInt16Array * garrow_int16_array_new ()
gint16 garrow_int16_array_get_value ()
const gint16 * garrow_int16_array_get_values ()
GArrowUInt16Array * garrow_uint16_array_new ()
guint16 garrow_uint16_array_get_value ()
const guint16 * garrow_uint16_array_get_values ()
GArrowInt32Array * garrow_int32_array_new ()
gint32 garrow_int32_array_get_value ()
const gint32 * garrow_int32_array_get_values ()
GArrowUInt32Array * garrow_uint32_array_new ()
guint32 garrow_uint32_array_get_value ()
const guint32 * garrow_uint32_array_get_values ()
GArrowInt64Array * garrow_int64_array_new ()
gint64 garrow_int64_array_get_value ()
const gint64 * garrow_int64_array_get_values ()
GArrowUInt64Array * garrow_uint64_array_new ()
guint64 garrow_uint64_array_get_value ()
const guint64 * garrow_uint64_array_get_values ()
GArrowFloatArray * garrow_float_array_new ()
gfloat garrow_float_array_get_value ()
const gfloat * garrow_float_array_get_values ()
GArrowDoubleArray * garrow_double_array_new ()
gdouble garrow_double_array_get_value ()
const gdouble * garrow_double_array_get_values ()
GArrowBinaryArray * garrow_binary_array_new ()
GBytes * garrow_binary_array_get_value ()
GArrowBuffer * garrow_binary_array_get_buffer ()
GArrowBuffer * garrow_binary_array_get_data_buffer ()
GArrowBuffer * garrow_binary_array_get_offsets_buffer ()
GArrowLargeBinaryArray * garrow_large_binary_array_new ()
GBytes * garrow_large_binary_array_get_value ()
GArrowBuffer * garrow_large_binary_array_get_buffer ()
GArrowBuffer * garrow_large_binary_array_get_data_buffer ()
GArrowBuffer * garrow_large_binary_array_get_offsets_buffer ()
GArrowStringArray * garrow_string_array_new ()
gchar * garrow_string_array_get_string ()
GArrowLargeStringArray * garrow_large_string_array_new ()
gchar * garrow_large_string_array_get_string ()
GArrowDate32Array * garrow_date32_array_new ()
gint32 garrow_date32_array_get_value ()
const gint32 * garrow_date32_array_get_values ()
GArrowDate64Array * garrow_date64_array_new ()
gint64 garrow_date64_array_get_value ()
const gint64 * garrow_date64_array_get_values ()
GArrowTimestampArray * garrow_timestamp_array_new ()
gint64 garrow_timestamp_array_get_value ()
const gint64 * garrow_timestamp_array_get_values ()
GArrowTime32Array * garrow_time32_array_new ()
gint32 garrow_time32_array_get_value ()
const gint32 * garrow_time32_array_get_values ()
GArrowTime64Array * garrow_time64_array_new ()
gint64 garrow_time64_array_get_value ()
const gint64 * garrow_time64_array_get_values ()
GArrowMonthIntervalArray * garrow_month_interval_array_new ()
gint32 garrow_month_interval_array_get_value ()
const gint32 * garrow_month_interval_array_get_values ()
GArrowDayTimeIntervalArray * garrow_day_time_interval_array_new ()
GArrowDayMillisecond * garrow_day_time_interval_array_get_value ()
GList * garrow_day_time_interval_array_get_values ()
GArrowMonthDayNanoIntervalArray * garrow_month_day_nano_interval_array_new ()
GArrowMonthDayNano * garrow_month_day_nano_interval_array_get_value ()
GList * garrow_month_day_nano_interval_array_get_values ()
GArrowFixedSizeBinaryArray * garrow_fixed_size_binary_array_new ()
gint32 garrow_fixed_size_binary_array_get_byte_width ()
GBytes * garrow_fixed_size_binary_array_get_value ()
GBytes * garrow_fixed_size_binary_array_get_values_bytes ()
gchar * garrow_decimal128_array_format_value ()
GArrowDecimal128 * garrow_decimal128_array_get_value ()
gchar * garrow_decimal256_array_format_value ()
GArrowDecimal256 * garrow_decimal256_array_get_value ()
GArrowArray * garrow_extension_array_get_storage ()

Properties

gdouble absolute-tolerance Read / Write
gboolean approx Read / Write
gboolean nans-equal Read / Write

Types and Values

#define GARROW_TYPE_EQUAL_OPTIONS
struct GArrowEqualOptionsClass
#define GARROW_TYPE_NULL_ARRAY
struct GArrowNullArrayClass
#define GARROW_TYPE_PRIMITIVE_ARRAY
struct GArrowPrimitiveArrayClass
#define GARROW_TYPE_BOOLEAN_ARRAY
struct GArrowBooleanArrayClass
#define GARROW_TYPE_NUMERIC_ARRAY
struct GArrowNumericArrayClass
#define GARROW_TYPE_INT8_ARRAY
struct GArrowInt8ArrayClass
#define GARROW_TYPE_UINT8_ARRAY
struct GArrowUInt8ArrayClass
#define GARROW_TYPE_INT16_ARRAY
struct GArrowInt16ArrayClass
#define GARROW_TYPE_UINT16_ARRAY
struct GArrowUInt16ArrayClass
#define GARROW_TYPE_INT32_ARRAY
struct GArrowInt32ArrayClass
#define GARROW_TYPE_UINT32_ARRAY
struct GArrowUInt32ArrayClass
#define GARROW_TYPE_INT64_ARRAY
struct GArrowInt64ArrayClass
#define GARROW_TYPE_UINT64_ARRAY
struct GArrowUInt64ArrayClass
#define GARROW_TYPE_FLOAT_ARRAY
struct GArrowFloatArrayClass
#define GARROW_TYPE_DOUBLE_ARRAY
struct GArrowDoubleArrayClass
#define GARROW_TYPE_BINARY_ARRAY
struct GArrowBinaryArrayClass
#define GARROW_TYPE_LARGE_BINARY_ARRAY
struct GArrowLargeBinaryArrayClass
#define GARROW_TYPE_STRING_ARRAY
struct GArrowStringArrayClass
#define GARROW_TYPE_LARGE_STRING_ARRAY
struct GArrowLargeStringArrayClass
#define GARROW_TYPE_DATE32_ARRAY
struct GArrowDate32ArrayClass
#define GARROW_TYPE_DATE64_ARRAY
struct GArrowDate64ArrayClass
#define GARROW_TYPE_TIMESTAMP_ARRAY
struct GArrowTimestampArrayClass
#define GARROW_TYPE_TIME32_ARRAY
struct GArrowTime32ArrayClass
#define GARROW_TYPE_TIME64_ARRAY
struct GArrowTime64ArrayClass
#define GARROW_TYPE_MONTH_INTERVAL_ARRAY
struct GArrowMonthIntervalArrayClass
#define GARROW_TYPE_DAY_TIME_INTERVAL_ARRAY
struct GArrowDayTimeIntervalArrayClass
#define GARROW_TYPE_MONTH_DAY_NANO_INTERVAL_ARRAY
struct GArrowMonthDayNanoIntervalArrayClass
#define GARROW_TYPE_FIXED_SIZE_BINARY_ARRAY
struct GArrowFixedSizeBinaryArrayClass
#define GARROW_TYPE_DECIMAL128_ARRAY
struct GArrowDecimal128ArrayClass
#define GARROW_TYPE_DECIMAL256_ARRAY
struct GArrowDecimal256ArrayClass
  GArrowBinaryArray
  GArrowBooleanArray
  GArrowDate32Array
  GArrowDate64Array
  GArrowDayTimeIntervalArray
  GArrowDecimal128Array
  GArrowDecimal256Array
  GArrowDoubleArray
  GArrowEqualOptions
  GArrowFixedSizeBinaryArray
  GArrowFloatArray
  GArrowInt16Array
  GArrowInt32Array
  GArrowInt64Array
  GArrowInt8Array
  GArrowLargeBinaryArray
  GArrowLargeStringArray
  GArrowMonthDayNanoIntervalArray
  GArrowMonthIntervalArray
  GArrowNullArray
  GArrowNumericArray
  GArrowPrimitiveArray
  GArrowStringArray
  GArrowTime32Array
  GArrowTime64Array
  GArrowTimestampArray
  GArrowUInt16Array
  GArrowUInt32Array
  GArrowUInt64Array
  GArrowUInt8Array

Object Hierarchy

    GObject
    ├── GArrowArray
       ├── GArrowLargeBinaryArray
          ╰── GArrowLargeStringArray
       ├── GArrowNullArray
       ├── GArrowPrimitiveArray
          ├── GArrowBooleanArray
          ├── GArrowNumericArray
          ├── GArrowDayTimeIntervalArray
          ├── GArrowFixedSizeBinaryArray
          ├── GArrowMonthDayNanoIntervalArray
          ├── GArrowFixedSizeBinaryArray
             ├── GArrowDecimal128Array
             ├── GArrowDecimal256Array
             ├── GArrowDecimal128Array
             ╰── GArrowDecimal256Array
          ├── GArrowDayTimeIntervalArray
          ├── GArrowMonthDayNanoIntervalArray
          ├── GArrowNumericArray
             ├── GArrowDate32Array
             ├── GArrowDate64Array
             ├── GArrowDoubleArray
             ├── GArrowFloatArray
             ├── GArrowInt16Array
             ├── GArrowInt32Array
             ├── GArrowInt64Array
             ├── GArrowInt8Array
             ├── GArrowMonthIntervalArray
             ├── GArrowTime32Array
             ├── GArrowTime64Array
             ├── GArrowTimestampArray
             ├── GArrowUInt16Array
             ├── GArrowUInt32Array
             ├── GArrowUInt64Array
             ├── GArrowUInt8Array
             ├── GArrowDate32Array
             ├── GArrowDate64Array
             ├── GArrowDoubleArray
             ├── GArrowFloatArray
             ├── GArrowInt16Array
             ├── GArrowInt32Array
             ├── GArrowInt64Array
             ├── GArrowInt8Array
             ╰── GArrowMonthIntervalArray
          ╰── GArrowBooleanArray
       ╰── GArrowBinaryArray
           ╰── GArrowStringArray
    ╰── GArrowEqualOptions

Includes

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

Description

GArrowArray is a base class for all array classes such as GArrowBooleanArray.

All array classes are immutable. You need to use binary data or array builder to create a new array except GArrowNullArray. If you have binary data that uses Arrow format data, you can create a new array with the binary data as GArrowBuffer object. If you don't have binary data, you can use array builder class such as GArrowBooleanArrayBuilder that creates Arrow format data internally and a new array from the data.

GArrowNullArray is a class for null array. It can store zero or more null values. You need to specify an array length to create a new array.

GArrowBooleanArray is a class for boolean array. It can store zero or more boolean data. If you don't have Arrow format data, you need to use GArrowBooleanArrayBuilder to create a new array.

GArrowInt8Array is a class for 8-bit integer array. It can store zero or more 8-bit integer data. If you don't have Arrow format data, you need to use GArrowInt8ArrayBuilder to create a new array.

GArrowUInt8Array is a class for 8-bit unsigned integer array. It can store zero or more 8-bit unsigned integer data. If you don't have Arrow format data, you need to use GArrowUInt8ArrayBuilder to create a new array.

GArrowInt16Array is a class for 16-bit integer array. It can store zero or more 16-bit integer data. If you don't have Arrow format data, you need to use GArrowInt16ArrayBuilder to create a new array.

GArrowUInt16Array is a class for 16-bit unsigned integer array. It can store zero or more 16-bit unsigned integer data. If you don't have Arrow format data, you need to use GArrowUInt16ArrayBuilder to create a new array.

GArrowInt32Array is a class for 32-bit integer array. It can store zero or more 32-bit integer data. If you don't have Arrow format data, you need to use GArrowInt32ArrayBuilder to create a new array.

GArrowUInt32Array is a class for 32-bit unsigned integer array. It can store zero or more 32-bit unsigned integer data. If you don't have Arrow format data, you need to use GArrowUInt32ArrayBuilder to create a new array.

GArrowInt64Array is a class for 64-bit integer array. It can store zero or more 64-bit integer data. If you don't have Arrow format data, you need to use GArrowInt64ArrayBuilder to create a new array.

GArrowUInt64Array is a class for 64-bit unsigned integer array. It can store zero or more 64-bit unsigned integer data. If you don't have Arrow format data, you need to use GArrowUInt64ArrayBuilder to create a new array.

GArrowFloatArray is a class for 32-bit floating point array. It can store zero or more 32-bit floating data. If you don't have Arrow format data, you need to use GArrowFloatArrayBuilder to create a new array.

GArrowDoubleArray is a class for 64-bit floating point array. It can store zero or more 64-bit floating data. If you don't have Arrow format data, you need to use GArrowDoubleArrayBuilder to create a new array.

GArrowBinaryArray is a class for binary array. It can store zero or more binary data. If you don't have Arrow format data, you need to use GArrowBinaryArrayBuilder to create a new array.

GArrowLargeBinaryArray is a class for 64-bit offsets binary array. It can store zero or more binary data. If you don't have Arrow format data, you need to use GArrowLargeBinaryArrayBuilder to create a new array.

GArrowStringArray is a class for UTF-8 encoded string array. It can store zero or more UTF-8 encoded string data. If you don't have Arrow format data, you need to use GArrowStringArrayBuilder to create a new array.

GArrowLargeStringArray is a class for 64-bit offsets UTF-8 encoded string array. It can store zero or more UTF-8 encoded string data. If you don't have Arrow format data, you need to use GArrowLargeStringArrayBuilder to create a new array.

GArrowFixedSizeBinaryArray is a class for fixed size binary array. It can store zero or more fixed size binary data. If you don't have Arrow format data, you need to use GArrowFixedSizeBinaryArrayBuilder to create a new array.

GArrowDate32Array is a class for the number of days since UNIX epoch in 32-bit signed integer array. It can store zero or more date data. If you don't have Arrow format data, you need to use GArrowDate32ArrayBuilder to create a new array.

GArrowDate64Array is a class for the number of milliseconds since UNIX epoch in 64-bit signed integer array. It can store zero or more date data. If you don't have Arrow format data, you need to use GArrowDate64ArrayBuilder to create a new array.

GArrowTimestampArray is a class for the number of seconds/milliseconds/microseconds/nanoseconds since UNIX epoch in 64-bit signed integer array. It can store zero or more timestamp data. If you don't have Arrow format data, you need to use GArrowTimestampArrayBuilder to create a new array.

GArrowTime32Array is a class for the number of seconds or milliseconds since midnight in 32-bit signed integer array. It can store zero or more time data. If you don't have Arrow format data, you need to use GArrowTime32ArrayBuilder to create a new array.

GArrowTime64Array is a class for the number of microseconds or nanoseconds since midnight in 64-bit signed integer array. It can store zero or more time data. If you don't have Arrow format data, you need to use GArrowTime64ArrayBuilder to create a new array.

GArrowMonthIntervalArray is a class for the month intarval array. It can store zero or more date data. If you don't have Arrow format data, you need to use GArrowMonthIntervalArrayBuilder to create a new array.

GArrowDayTimeIntervalArray is a class for the day time intarval array. It can store zero or more date data. If you don't have Arrow format data, you need to use GArrowDayTimeIntervalArrayBuilder to create a new array.

GArrowMonthDayNanoIntervalArray is a class for the month day nano intarval array. It can store zero or more date data. If you don't have Arrow format data, you need to use GArrowMonthDayNanoIntervalArray to create a new array.

GArrowDecimal128Array is a class for 128-bit decimal array. It can store zero or more 128-bit decimal data. If you don't have Arrow format data, you need to use GArrowDecimal128ArrayBuilder to create a new array.

GArrowDecimal256Array is a class for 256-bit decimal array. It can store zero or more 256-bit decimal data. If you don't have Arrow format data, you need to use GArrowDecimal256ArrayBuilder to create a new array.

GArrowExtensionArray is a base class for array of user-defined extension types.

Functions

garrow_equal_options_new ()

GArrowEqualOptions *
garrow_equal_options_new (void);

Returns

A newly created GArrowEqualOptions.

Since: 5.0.0


garrow_equal_options_is_approx ()

gboolean
garrow_equal_options_is_approx (GArrowEqualOptions *options);

Parameters

options

A GArrowEqualOptions.

 

Returns

TRUE if approximate comparison is used, FALSE otherwise.

Since: 5.0.0


garrow_array_import ()

GArrowArray *
garrow_array_import (gpointer c_abi_array,
                     GArrowDataType *data_type,
                     GError **error);

Parameters

c_abi_array

A struct ArrowArray *.

[not nullable]

data_type

A GArrowDataType of the C ABI array.

 

error

Return location for a GError or NULL.

[nullable]

Returns

An imported GArrowArray on success, NULL on error.

You don't need to release the passed struct ArrowArray *, even if this function reports an error.

[transfer full][nullable]

Since: 6.0.0


garrow_array_export ()

gboolean
garrow_array_export (GArrowArray *array,
                     gpointer *c_abi_array,
                     gpointer *c_abi_schema,
                     GError **error);

Parameters

array

A GArrowArray.

 

c_abi_array

Return location for a struct ArrowArray *. It should be freed with the ArrowArray::release callback then g_free() when no longer needed.

[out]

c_abi_schema

Return location for a struct ArrowSchema * or NULL. It should be freed with the ArrowSchema::release callback then g_free() when no longer needed.

[out][nullable]

error

Return location for a GError or NULL.

[nullable]

Returns

TRUE on success, FALSE on error.

Since: 6.0.0


garrow_array_equal ()

gboolean
garrow_array_equal (GArrowArray *array,
                    GArrowArray *other_array);

Parameters

array

A GArrowArray.

 

other_array

A GArrowArray to be compared.

 

Returns

TRUE if both of them have the same data, FALSE otherwise.

Since: 0.4.0


garrow_array_equal_options ()

gboolean
garrow_array_equal_options (GArrowArray *array,
                            GArrowArray *other_array,
                            GArrowEqualOptions *options);

Parameters

array

A GArrowArray.

 

other_array

A GArrowArray to be compared.

 

options

A GArrowEqualOptions to custom how to compare.

[nullable]

Returns

TRUE if both of them have the same data, FALSE otherwise.

Since: 5.0.0


garrow_array_equal_approx ()

gboolean
garrow_array_equal_approx (GArrowArray *array,
                           GArrowArray *other_array);

Parameters

array

A GArrowArray.

 

other_array

A GArrowArray to be compared.

 

Returns

TRUE if both of them have the approx same data, FALSE otherwise.

Since: 0.4.0


garrow_array_equal_range ()

gboolean
garrow_array_equal_range (GArrowArray *array,
                          gint64 start_index,
                          GArrowArray *other_array,
                          gint64 other_start_index,
                          gint64 end_index,
                          GArrowEqualOptions *options);

Parameters

array

A GArrowArray.

 

start_index

The start index of array to be used.

 

other_array

A GArrowArray to be compared.

 

other_start_index

The start index of other_array to be used.

 

end_index

The end index of array to be used. The end index of other_array is "other_start_index + (end_index - start_index )".

 

options

A GArrowEqualOptions to custom how to compare.

[nullable]

Returns

TRUE if both of them have the same data in the range, FALSE otherwise.

Since: 0.4.0


garrow_array_is_null ()

gboolean
garrow_array_is_null (GArrowArray *array,
                      gint64 i);

Parameters

array

A GArrowArray.

 

i

The index of the target value.

 

Returns

Whether the i -th value is null or not.

Since: 0.3.0


garrow_array_is_valid ()

gboolean
garrow_array_is_valid (GArrowArray *array,
                       gint64 i);

Parameters

array

A GArrowArray.

 

i

The index of the target value.

 

Returns

Whether the i -th value is valid (not null) or not.

Since: 0.8.0


garrow_array_get_length ()

gint64
garrow_array_get_length (GArrowArray *array);

Parameters

array

A GArrowArray.

 

Returns

The number of rows in the array.


garrow_array_get_offset ()

gint64
garrow_array_get_offset (GArrowArray *array);

Parameters

array

A GArrowArray.

 

Returns

The number of values in the array.


garrow_array_get_n_nulls ()

gint64
garrow_array_get_n_nulls (GArrowArray *array);

Parameters

array

A GArrowArray.

 

Returns

The number of NULLs in the array.


garrow_array_get_null_bitmap ()

GArrowBuffer *
garrow_array_get_null_bitmap (GArrowArray *array);

Parameters

array

A GArrowArray.

 

Returns

The bitmap that indicates null value indices for the array as GArrowBuffer or NULL when garrow_array_get_n_nulls() returns 0.

[transfer full][nullable]

Since: 0.3.0


garrow_array_get_value_data_type ()

GArrowDataType *
garrow_array_get_value_data_type (GArrowArray *array);

Parameters

array

A GArrowArray.

 

Returns

The GArrowDataType for each value of the array.

[transfer full]

Since: 0.3.0


garrow_array_get_value_type ()

GArrowType
garrow_array_get_value_type (GArrowArray *array);

Parameters

array

A GArrowArray.

 

Returns

The GArrowType for each value of the array.

Since: 0.3.0


garrow_array_slice ()

GArrowArray *
garrow_array_slice (GArrowArray *array,
                    gint64 offset,
                    gint64 length);

Parameters

array

A GArrowArray.

 

offset

The offset of sub GArrowArray.

 

length

The length of sub GArrowArray.

 

Returns

The sub GArrowArray. It covers only from offset to offset + length range. The sub GArrowArray shares values with the base GArrowArray.

[transfer full]


garrow_array_to_string ()

gchar *
garrow_array_to_string (GArrowArray *array,
                        GError **error);

Parameters

array

A GArrowArray.

 

error

Return location for a GError or NULL.

[nullable]

Returns

The formatted array content or NULL on error.

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

[nullable]

Since: 0.4.0


garrow_array_view ()

GArrowArray *
garrow_array_view (GArrowArray *array,
                   GArrowDataType *return_type,
                   GError **error);

Parameters

array

A GArrowArray.

 

return_type

A GArrowDataType of the returned view.

 

error

Return location for a GError or NULL.

[nullable]

Returns

A zero-copy view of this array with the given type. This method checks if the return_type are layout-compatible.

[nullable][transfer full]

Since: 0.15.0


garrow_array_diff_unified ()

gchar *
garrow_array_diff_unified (GArrowArray *array,
                           GArrowArray *other_array);

Parameters

array

A GArrowArray.

 

other_array

A GArrowArray to be compared.

 

Returns

The string representation of the difference between two arrays as unified format. If there is no difference, the return value is NULL.

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

[nullable][transfer full]

Since: 0.15.0


garrow_array_concatenate ()

GArrowArray *
garrow_array_concatenate (GArrowArray *array,
                          GList *other_arrays,
                          GError **error);

Parameters

array

A GArrowArray.

 

other_arrays

A GArrowArray to be concatenated.

[element-type GArrowArray]

error

Return location for a GError or NULL.

[nullable]

Returns

The concatenated array.

[nullable][transfer full]

Since: 4.0.0


garrow_null_array_new ()

GArrowNullArray *
garrow_null_array_new (gint64 length);

Parameters

length

An array length.

 

Returns

A newly created GArrowNullArray.


garrow_primitive_array_get_buffer ()

GArrowBuffer *
garrow_primitive_array_get_buffer (GArrowPrimitiveArray *array);

garrow_primitive_array_get_buffer has been deprecated since version 1.0.0 and should not be used in newly-written code.

Use garrow_primitive_array_get_data_buffer() instead.

Parameters

array

A GArrowPrimitiveArray.

 

Returns

The data of the array as GArrowBuffer.

[transfer full]


garrow_primitive_array_get_data_buffer ()

GArrowBuffer *
garrow_primitive_array_get_data_buffer
                               (GArrowPrimitiveArray *array);

Parameters

array

A GArrowPrimitiveArray.

 

Returns

The data of the array as GArrowBuffer.

[transfer full]

Since: 1.0.0


garrow_boolean_array_new ()

GArrowBooleanArray *
garrow_boolean_array_new (gint64 length,
                          GArrowBuffer *data,
                          GArrowBuffer *null_bitmap,
                          gint64 n_nulls);

Parameters

length

The number of elements.

 

data

The binary data in Arrow format of the array.

 

null_bitmap

The bitmap that shows null elements. The N-th element is null when the N-th bit is 0, not null otherwise. If the array has no null elements, the bitmap must be NULL and n_nulls is 0.

[nullable]

n_nulls

The number of null elements. If -1 is specified, the number of nulls are computed from null_bitmap .

 

Returns

A newly created GArrowBooleanArray.

Since: 0.4.0


garrow_boolean_array_get_value ()

gboolean
garrow_boolean_array_get_value (GArrowBooleanArray *array,
                                gint64 i);

Parameters

array

A GArrowBooleanArray.

 

i

The index of the target value.

 

Returns

The i -th value.


garrow_boolean_array_get_values ()

gboolean *
garrow_boolean_array_get_values (GArrowBooleanArray *array,
                                 gint64 *length);

Parameters

array

A GArrowBooleanArray.

 

length

The number of values.

[out]

Returns

The raw boolean values.

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

[array length=length][transfer full]


garrow_int8_array_new ()

GArrowInt8Array *
garrow_int8_array_new (gint64 length,
                       GArrowBuffer *data,
                       GArrowBuffer *null_bitmap,
                       gint64 n_nulls);

Parameters

length

The number of elements.

 

data

The binary data in Arrow format of the array.

 

null_bitmap

The bitmap that shows null elements. The N-th element is null when the N-th bit is 0, not null otherwise. If the array has no null elements, the bitmap must be NULL and n_nulls is 0.

[nullable]

n_nulls

The number of null elements. If -1 is specified, the number of nulls are computed from null_bitmap .

 

Returns

A newly created GArrowInt8Array.

Since: 0.4.0


garrow_int8_array_get_value ()

gint8
garrow_int8_array_get_value (GArrowInt8Array *array,
                             gint64 i);

Parameters

array

A GArrowInt8Array.

 

i

The index of the target value.

 

Returns

The i -th value.


garrow_int8_array_get_values ()

const gint8 *
garrow_int8_array_get_values (GArrowInt8Array *array,
                              gint64 *length);

Parameters

array

A GArrowInt8Array.

 

length

The number of values.

[out]

Returns

The raw values.

[array length=length]


garrow_uint8_array_new ()

GArrowUInt8Array *
garrow_uint8_array_new (gint64 length,
                        GArrowBuffer *data,
                        GArrowBuffer *null_bitmap,
                        gint64 n_nulls);

Parameters

length

The number of elements.

 

data

The binary data in Arrow format of the array.

 

null_bitmap

The bitmap that shows null elements. The N-th element is null when the N-th bit is 0, not null otherwise. If the array has no null elements, the bitmap must be NULL and n_nulls is 0.

[nullable]

n_nulls

The number of null elements. If -1 is specified, the number of nulls are computed from null_bitmap .

 

Returns

A newly created GArrowUInt8Array.

Since: 0.4.0


garrow_uint8_array_get_value ()

guint8
garrow_uint8_array_get_value (GArrowUInt8Array *array,
                              gint64 i);

Parameters

array

A GArrowUInt8Array.

 

i

The index of the target value.

 

Returns

The i -th value.


garrow_uint8_array_get_values ()

const guint8 *
garrow_uint8_array_get_values (GArrowUInt8Array *array,
                               gint64 *length);

Parameters

array

A GArrowUInt8Array.

 

length

The number of values.

[out]

Returns

The raw values.

[array length=length]


garrow_int16_array_new ()

GArrowInt16Array *
garrow_int16_array_new (gint64 length,
                        GArrowBuffer *data,
                        GArrowBuffer *null_bitmap,
                        gint64 n_nulls);

Parameters

length

The number of elements.

 

data

The binary data in Arrow format of the array.

 

null_bitmap

The bitmap that shows null elements. The N-th element is null when the N-th bit is 0, not null otherwise. If the array has no null elements, the bitmap must be NULL and n_nulls is 0.

[nullable]

n_nulls

The number of null elements. If -1 is specified, the number of nulls are computed from null_bitmap .

 

Returns

A newly created GArrowInt16Array.

Since: 0.4.0


garrow_int16_array_get_value ()

gint16
garrow_int16_array_get_value (GArrowInt16Array *array,
                              gint64 i);

Parameters

array

A GArrowInt16Array.

 

i

The index of the target value.

 

Returns

The i -th value.


garrow_int16_array_get_values ()

const gint16 *
garrow_int16_array_get_values (GArrowInt16Array *array,
                               gint64 *length);

Parameters

array

A GArrowInt16Array.

 

length

The number of values.

[out]

Returns

The raw values.

[array length=length]


garrow_uint16_array_new ()

GArrowUInt16Array *
garrow_uint16_array_new (gint64 length,
                         GArrowBuffer *data,
                         GArrowBuffer *null_bitmap,
                         gint64 n_nulls);

Parameters

length

The number of elements.

 

data

The binary data in Arrow format of the array.

 

null_bitmap

The bitmap that shows null elements. The N-th element is null when the N-th bit is 0, not null otherwise. If the array has no null elements, the bitmap must be NULL and n_nulls is 0.

[nullable]

n_nulls

The number of null elements. If -1 is specified, the number of nulls are computed from null_bitmap .

 

Returns

A newly created GArrowUInt16Array.

Since: 0.4.0


garrow_uint16_array_get_value ()

guint16
garrow_uint16_array_get_value (GArrowUInt16Array *array,
                               gint64 i);

Parameters

array

A GArrowUInt16Array.

 

i

The index of the target value.

 

Returns

The i -th value.


garrow_uint16_array_get_values ()

const guint16 *
garrow_uint16_array_get_values (GArrowUInt16Array *array,
                                gint64 *length);

Parameters

array

A GArrowUInt16Array.

 

length

The number of values.

[out]

Returns

The raw values.

[array length=length]


garrow_int32_array_new ()

GArrowInt32Array *
garrow_int32_array_new (gint64 length,
                        GArrowBuffer *data,
                        GArrowBuffer *null_bitmap,
                        gint64 n_nulls);

Parameters

length

The number of elements.

 

data

The binary data in Arrow format of the array.

 

null_bitmap

The bitmap that shows null elements. The N-th element is null when the N-th bit is 0, not null otherwise. If the array has no null elements, the bitmap must be NULL and n_nulls is 0.

[nullable]

n_nulls

The number of null elements. If -1 is specified, the number of nulls are computed from null_bitmap .

 

Returns

A newly created GArrowInt32Array.

Since: 0.4.0


garrow_int32_array_get_value ()

gint32
garrow_int32_array_get_value (GArrowInt32Array *array,
                              gint64 i);

Parameters

array

A GArrowInt32Array.

 

i

The index of the target value.

 

Returns

The i -th value.


garrow_int32_array_get_values ()

const gint32 *
garrow_int32_array_get_values (GArrowInt32Array *array,
                               gint64 *length);

Parameters

array

A GArrowInt32Array.

 

length

The number of values.

[out]

Returns

The raw values.

[array length=length]


garrow_uint32_array_new ()

GArrowUInt32Array *
garrow_uint32_array_new (gint64 length,
                         GArrowBuffer *data,
                         GArrowBuffer *null_bitmap,
                         gint64 n_nulls);

Parameters

length

The number of elements.

 

data

The binary data in Arrow format of the array.

 

null_bitmap

The bitmap that shows null elements. The N-th element is null when the N-th bit is 0, not null otherwise. If the array has no null elements, the bitmap must be NULL and n_nulls is 0.

[nullable]

n_nulls

The number of null elements. If -1 is specified, the number of nulls are computed from null_bitmap .

 

Returns

A newly created GArrowUInt32Array.

Since: 0.4.0


garrow_uint32_array_get_value ()

guint32
garrow_uint32_array_get_value (GArrowUInt32Array *array,
                               gint64 i);

Parameters

array

A GArrowUInt32Array.

 

i

The index of the target value.

 

Returns

The i -th value.


garrow_uint32_array_get_values ()

const guint32 *
garrow_uint32_array_get_values (GArrowUInt32Array *array,
                                gint64 *length);

Parameters

array

A GArrowUInt32Array.

 

length

The number of values.

[out]

Returns

The raw values.

[array length=length]


garrow_int64_array_new ()

GArrowInt64Array *
garrow_int64_array_new (gint64 length,
                        GArrowBuffer *data,
                        GArrowBuffer *null_bitmap,
                        gint64 n_nulls);

Parameters

length

The number of elements.

 

data

The binary data in Arrow format of the array.

 

null_bitmap

The bitmap that shows null elements. The N-th element is null when the N-th bit is 0, not null otherwise. If the array has no null elements, the bitmap must be NULL and n_nulls is 0.

[nullable]

n_nulls

The number of null elements. If -1 is specified, the number of nulls are computed from null_bitmap .

 

Returns

A newly created GArrowInt64Array.

Since: 0.4.0


garrow_int64_array_get_value ()

gint64
garrow_int64_array_get_value (GArrowInt64Array *array,
                              gint64 i);

Parameters

array

A GArrowInt64Array.

 

i

The index of the target value.

 

Returns

The i -th value.


garrow_int64_array_get_values ()

const gint64 *
garrow_int64_array_get_values (GArrowInt64Array *array,
                               gint64 *length);

Parameters

array

A GArrowInt64Array.

 

length

The number of values.

[out]

Returns

The raw values.

[array length=length]


garrow_uint64_array_new ()

GArrowUInt64Array *
garrow_uint64_array_new (gint64 length,
                         GArrowBuffer *data,
                         GArrowBuffer *null_bitmap,
                         gint64 n_nulls);

Parameters

length

The number of elements.

 

data

The binary data in Arrow format of the array.

 

null_bitmap

The bitmap that shows null elements. The N-th element is null when the N-th bit is 0, not null otherwise. If the array has no null elements, the bitmap must be NULL and n_nulls is 0.

[nullable]

n_nulls

The number of null elements. If -1 is specified, the number of nulls are computed from null_bitmap .

 

Returns

A newly created GArrowUInt64Array.

Since: 0.4.0


garrow_uint64_array_get_value ()

guint64
garrow_uint64_array_get_value (GArrowUInt64Array *array,
                               gint64 i);

Parameters

array

A GArrowUInt64Array.

 

i

The index of the target value.

 

Returns

The i -th value.


garrow_uint64_array_get_values ()

const guint64 *
garrow_uint64_array_get_values (GArrowUInt64Array *array,
                                gint64 *length);

Parameters

array

A GArrowUInt64Array.

 

length

The number of values.

[out]

Returns

The raw values.

[array length=length]


garrow_float_array_new ()

GArrowFloatArray *
garrow_float_array_new (gint64 length,
                        GArrowBuffer *data,
                        GArrowBuffer *null_bitmap,
                        gint64 n_nulls);

Parameters

length

The number of elements.

 

data

The binary data in Arrow format of the array.

 

null_bitmap

The bitmap that shows null elements. The N-th element is null when the N-th bit is 0, not null otherwise. If the array has no null elements, the bitmap must be NULL and n_nulls is 0.

[nullable]

n_nulls

The number of null elements. If -1 is specified, the number of nulls are computed from null_bitmap .

 

Returns

A newly created GArrowFloatArray.

Since: 0.4.0


garrow_float_array_get_value ()

gfloat
garrow_float_array_get_value (GArrowFloatArray *array,
                              gint64 i);

Parameters

array

A GArrowFloatArray.

 

i

The index of the target value.

 

Returns

The i -th value.


garrow_float_array_get_values ()

const gfloat *
garrow_float_array_get_values (GArrowFloatArray *array,
                               gint64 *length);

Parameters

array

A GArrowFloatArray.

 

length

The number of values.

[out]

Returns

The raw values.

[array length=length]


garrow_double_array_new ()

GArrowDoubleArray *
garrow_double_array_new (gint64 length,
                         GArrowBuffer *data,
                         GArrowBuffer *null_bitmap,
                         gint64 n_nulls);

Parameters

length

The number of elements.

 

data

The binary data in Arrow format of the array.

 

null_bitmap

The bitmap that shows null elements. The N-th element is null when the N-th bit is 0, not null otherwise. If the array has no null elements, the bitmap must be NULL and n_nulls is 0.

[nullable]

n_nulls

The number of null elements. If -1 is specified, the number of nulls are computed from null_bitmap .

 

Returns

A newly created GArrowDoubleArray.

Since: 0.4.0


garrow_double_array_get_value ()

gdouble
garrow_double_array_get_value (GArrowDoubleArray *array,
                               gint64 i);

Parameters

array

A GArrowDoubleArray.

 

i

The index of the target value.

 

Returns

The i -th value.


garrow_double_array_get_values ()

const gdouble *
garrow_double_array_get_values (GArrowDoubleArray *array,
                                gint64 *length);

Parameters

array

A GArrowDoubleArray.

 

length

The number of values.

[out]

Returns

The raw values.

[array length=length]


garrow_binary_array_new ()

GArrowBinaryArray *
garrow_binary_array_new (gint64 length,
                         GArrowBuffer *value_offsets,
                         GArrowBuffer *value_data,
                         GArrowBuffer *null_bitmap,
                         gint64 n_nulls);

Parameters

length

The number of elements.

 

value_offsets

The value offsets of data in Arrow format.

 

value_data

The binary data in Arrow format of the array.

 

null_bitmap

The bitmap that shows null elements. The N-th element is null when the N-th bit is 0, not null otherwise. If the array has no null elements, the bitmap must be NULL and n_nulls is 0.

[nullable]

n_nulls

The number of null elements. If -1 is specified, the number of nulls are computed from null_bitmap .

 

Returns

A newly created GArrowBinaryArray.

Since: 0.4.0


garrow_binary_array_get_value ()

GBytes *
garrow_binary_array_get_value (GArrowBinaryArray *array,
                               gint64 i);

Parameters

array

A GArrowBinaryArray.

 

i

The index of the target value.

 

Returns

The i -th value.

[transfer full]


garrow_binary_array_get_buffer ()

GArrowBuffer *
garrow_binary_array_get_buffer (GArrowBinaryArray *array);

garrow_binary_array_get_buffer has been deprecated since version 1.0.0 and should not be used in newly-written code.

Use garrow_binary_array_get_data_buffer() instead.

Parameters

array

A GArrowBinaryArray.

 

Returns

The data of the array as GArrowBuffer.

[transfer full]


garrow_binary_array_get_data_buffer ()

GArrowBuffer *
garrow_binary_array_get_data_buffer (GArrowBinaryArray *array);

Parameters

array

A GArrowBinaryArray.

 

Returns

The data of the array as GArrowBuffer.

[transfer full]

Since: 1.0.0


garrow_binary_array_get_offsets_buffer ()

GArrowBuffer *
garrow_binary_array_get_offsets_buffer
                               (GArrowBinaryArray *array);

Parameters

array

A GArrowBinaryArray.

 

Returns

The offsets of the array as GArrowBuffer.

[transfer full]


garrow_large_binary_array_new ()

GArrowLargeBinaryArray *
garrow_large_binary_array_new (gint64 length,
                               GArrowBuffer *value_offsets,
                               GArrowBuffer *value_data,
                               GArrowBuffer *null_bitmap,
                               gint64 n_nulls);

Parameters

length

The number of elements.

 

value_offsets

The value offsets of data in Arrow format.

 

value_data

The binary data in Arrow format of the array.

 

null_bitmap

The bitmap that shows null elements. The N-th element is null when the N-th bit is 0, not null otherwise. If the array has no null elements, the bitmap must be NULL and n_nulls is 0.

[nullable]

n_nulls

The number of null elements. If -1 is specified, the number of nulls are computed from null_bitmap .

 

Returns

A newly created GArrowLargeBinaryArray.

Since: 0.16.0


garrow_large_binary_array_get_value ()

GBytes *
garrow_large_binary_array_get_value (GArrowLargeBinaryArray *array,
                                     gint64 i);

Parameters

array

A GArrowLargeBinaryArray.

 

i

The index of the target value.

 

Returns

The i -th value.

[transfer full]

Since: 0.16.0


garrow_large_binary_array_get_buffer ()

GArrowBuffer *
garrow_large_binary_array_get_buffer (GArrowLargeBinaryArray *array);

garrow_large_binary_array_get_buffer has been deprecated since version 1.0.0 and should not be used in newly-written code.

Use garrow_large_binary_array_get_data_buffer() instead.

Parameters

Returns

The data of the array as GArrowBuffer.

[transfer full]

Since: 0.16.0


garrow_large_binary_array_get_data_buffer ()

GArrowBuffer *
garrow_large_binary_array_get_data_buffer
                               (GArrowLargeBinaryArray *array);

Parameters

Returns

The data of the array as GArrowBuffer.

[transfer full]

Since: 1.0.0


garrow_large_binary_array_get_offsets_buffer ()

GArrowBuffer *
garrow_large_binary_array_get_offsets_buffer
                               (GArrowLargeBinaryArray *array);

Parameters

Returns

The offsets of the array as GArrowBuffer.

[transfer full]

Since: 0.16.0


garrow_string_array_new ()

GArrowStringArray *
garrow_string_array_new (gint64 length,
                         GArrowBuffer *value_offsets,
                         GArrowBuffer *value_data,
                         GArrowBuffer *null_bitmap,
                         gint64 n_nulls);

Parameters

length

The number of elements.

 

value_offsets

The value offsets of data in Arrow format.

 

value_data

The binary data in Arrow format of the array.

 

null_bitmap

The bitmap that shows null elements. The N-th element is null when the N-th bit is 0, not null otherwise. If the array has no null elements, the bitmap must be NULL and n_nulls is 0.

[nullable]

n_nulls

The number of null elements. If -1 is specified, the number of nulls are computed from null_bitmap .

 

Returns

A newly created GArrowStringArray.

Since: 0.4.0


garrow_string_array_get_string ()

gchar *
garrow_string_array_get_string (GArrowStringArray *array,
                                gint64 i);

Parameters

array

A GArrowStringArray.

 

i

The index of the target value.

 

Returns

The i -th UTF-8 encoded string.


garrow_large_string_array_new ()

GArrowLargeStringArray *
garrow_large_string_array_new (gint64 length,
                               GArrowBuffer *value_offsets,
                               GArrowBuffer *value_data,
                               GArrowBuffer *null_bitmap,
                               gint64 n_nulls);

Parameters

length

The number of elements.

 

value_offsets

The value offsets of data in Arrow format.

 

value_data

The binary data in Arrow format of the array.

 

null_bitmap

The bitmap that shows null elements. The N-th element is null when the N-th bit is 0, not null otherwise. If the array has no null elements, the bitmap must be NULL and n_nulls is 0.

[nullable]

n_nulls

The number of null elements. If -1 is specified, the number of nulls are computed from null_bitmap .

 

Returns

A newly created GArrowLargeStringArray.

Since: 0.16.0


garrow_large_string_array_get_string ()

gchar *
garrow_large_string_array_get_string (GArrowLargeStringArray *array,
                                      gint64 i);

Parameters

array

A GArrowLargeStringArray.

 

i

The index of the target value.

 

Returns

The i -th UTF-8 encoded string.

Since: 0.16.0


garrow_date32_array_new ()

GArrowDate32Array *
garrow_date32_array_new (gint64 length,
                         GArrowBuffer *data,
                         GArrowBuffer *null_bitmap,
                         gint64 n_nulls);

Parameters

length

The number of elements.

 

data

The binary data in Arrow format of the array.

 

null_bitmap

The bitmap that shows null elements. The N-th element is null when the N-th bit is 0, not null otherwise. If the array has no null elements, the bitmap must be NULL and n_nulls is 0.

[nullable]

n_nulls

The number of null elements. If -1 is specified, the number of nulls are computed from null_bitmap .

 

Returns

A newly created GArrowDate32Array.

Since: 0.7.0


garrow_date32_array_get_value ()

gint32
garrow_date32_array_get_value (GArrowDate32Array *array,
                               gint64 i);

Parameters

array

A GArrowDate32Array.

 

i

The index of the target value.

 

Returns

The i -th value.

Since: 0.7.0


garrow_date32_array_get_values ()

const gint32 *
garrow_date32_array_get_values (GArrowDate32Array *array,
                                gint64 *length);

Parameters

array

A GArrowDate32Array.

 

length

The number of values.

[out]

Returns

The raw values.

[array length=length]

Since: 0.7.0


garrow_date64_array_new ()

GArrowDate64Array *
garrow_date64_array_new (gint64 length,
                         GArrowBuffer *data,
                         GArrowBuffer *null_bitmap,
                         gint64 n_nulls);

Parameters

length

The number of elements.

 

data

The binary data in Arrow format of the array.

 

null_bitmap

The bitmap that shows null elements. The N-th element is null when the N-th bit is 0, not null otherwise. If the array has no null elements, the bitmap must be NULL and n_nulls is 0.

[nullable]

n_nulls

The number of null elements. If -1 is specified, the number of nulls are computed from null_bitmap .

 

Returns

A newly created GArrowDate64Array.

Since: 0.7.0


garrow_date64_array_get_value ()

gint64
garrow_date64_array_get_value (GArrowDate64Array *array,
                               gint64 i);

Parameters

array

A GArrowDate64Array.

 

i

The index of the target value.

 

Returns

The i -th value.

Since: 0.7.0


garrow_date64_array_get_values ()

const gint64 *
garrow_date64_array_get_values (GArrowDate64Array *array,
                                gint64 *length);

Parameters

array

A GArrowDate64Array.

 

length

The number of values.

[out]

Returns

The raw values.

[array length=length]

Since: 0.7.0


garrow_timestamp_array_new ()

GArrowTimestampArray *
garrow_timestamp_array_new (GArrowTimestampDataType *data_type,
                            gint64 length,
                            GArrowBuffer *data,
                            GArrowBuffer *null_bitmap,
                            gint64 n_nulls);

Parameters

data_type

The GArrowTimestampDataType.

 

length

The number of elements.

 

data

The binary data in Arrow format of the array.

 

null_bitmap

The bitmap that shows null elements. The N-th element is null when the N-th bit is 0, not null otherwise. If the array has no null elements, the bitmap must be NULL and n_nulls is 0.

[nullable]

n_nulls

The number of null elements. If -1 is specified, the number of nulls are computed from null_bitmap .

 

Returns

A newly created GArrowTimestampArray.

Since: 0.7.0


garrow_timestamp_array_get_value ()

gint64
garrow_timestamp_array_get_value (GArrowTimestampArray *array,
                                  gint64 i);

Parameters

array

A GArrowTimestampArray.

 

i

The index of the target value.

 

Returns

The i -th value.

Since: 0.7.0


garrow_timestamp_array_get_values ()

const gint64 *
garrow_timestamp_array_get_values (GArrowTimestampArray *array,
                                   gint64 *length);

Parameters

array

A GArrowTimestampArray.

 

length

The number of values.

[out]

Returns

The raw values.

[array length=length]

Since: 0.7.0


garrow_time32_array_new ()

GArrowTime32Array *
garrow_time32_array_new (GArrowTime32DataType *data_type,
                         gint64 length,
                         GArrowBuffer *data,
                         GArrowBuffer *null_bitmap,
                         gint64 n_nulls);

Parameters

data_type

The GArrowTime32DataType.

 

length

The number of elements.

 

data

The binary data in Arrow format of the array.

 

null_bitmap

The bitmap that shows null elements. The N-th element is null when the N-th bit is 0, not null otherwise. If the array has no null elements, the bitmap must be NULL and n_nulls is 0.

[nullable]

n_nulls

The number of null elements. If -1 is specified, the number of nulls are computed from null_bitmap .

 

Returns

A newly created GArrowTime32Array.

Since: 0.7.0


garrow_time32_array_get_value ()

gint32
garrow_time32_array_get_value (GArrowTime32Array *array,
                               gint64 i);

Parameters

array

A GArrowTime32Array.

 

i

The index of the target value.

 

Returns

The i -th value.

Since: 0.7.0


garrow_time32_array_get_values ()

const gint32 *
garrow_time32_array_get_values (GArrowTime32Array *array,
                                gint64 *length);

Parameters

array

A GArrowTime32Array.

 

length

The number of values.

[out]

Returns

The raw values.

[array length=length]

Since: 0.7.0


garrow_time64_array_new ()

GArrowTime64Array *
garrow_time64_array_new (GArrowTime64DataType *data_type,
                         gint64 length,
                         GArrowBuffer *data,
                         GArrowBuffer *null_bitmap,
                         gint64 n_nulls);

Parameters

data_type

The GArrowTime64DataType.

 

length

The number of elements.

 

data

The binary data in Arrow format of the array.

 

null_bitmap

The bitmap that shows null elements. The N-th element is null when the N-th bit is 0, not null otherwise. If the array has no null elements, the bitmap must be NULL and n_nulls is 0.

[nullable]

n_nulls

The number of null elements. If -1 is specified, the number of nulls are computed from null_bitmap .

 

Returns

A newly created GArrowTime64Array.

Since: 0.7.0


garrow_time64_array_get_value ()

gint64
garrow_time64_array_get_value (GArrowTime64Array *array,
                               gint64 i);

Parameters

array

A GArrowTime64Array.

 

i

The index of the target value.

 

Returns

The i -th value.

Since: 0.7.0


garrow_time64_array_get_values ()

const gint64 *
garrow_time64_array_get_values (GArrowTime64Array *array,
                                gint64 *length);

Parameters

array

A GArrowTime64Array.

 

length

The number of values.

[out]

Returns

The raw values.

[array length=length]

Since: 0.7.0


garrow_month_interval_array_new ()

GArrowMonthIntervalArray *
garrow_month_interval_array_new (gint64 length,
                                 GArrowBuffer *data,
                                 GArrowBuffer *null_bitmap,
                                 gint64 n_nulls);

Parameters

length

The number of elements.

 

data

The binary data in Arrow format of the array.

 

null_bitmap

The bitmap that shows null elements. The N-th element is null when the N-th bit is 0, not null otherwise. If the array has no null elements, the bitmap must be NULL and n_nulls is 0.

[nullable]

n_nulls

The number of null elements. If -1 is specified, the number of nulls are computed from null_bitmap .

 

Returns

A newly created GArrowMonthIntervalArray.

Since: 8.0.0


garrow_month_interval_array_get_value ()

gint32
garrow_month_interval_array_get_value (GArrowMonthIntervalArray *array,
                                       gint64 i);

Parameters

array

A GArrowMonthIntervalArray.

 

i

The index of the target value.

 

Returns

The i -th value.

Since: 8.0.0


garrow_month_interval_array_get_values ()

const gint32 *
garrow_month_interval_array_get_values
                               (GArrowMonthIntervalArray *array,
                                gint64 *length);

Parameters

array

A GArrowMonthIntervalArray.

 

length

The number of values.

[out]

Returns

The raw values.

[array length=length]

Since: 8.0.0


garrow_day_time_interval_array_new ()

GArrowDayTimeIntervalArray *
garrow_day_time_interval_array_new (gint64 length,
                                    GArrowBuffer *data,
                                    GArrowBuffer *null_bitmap,
                                    gint64 n_nulls);

Parameters

length

The number of elements.

 

data

The binary data in Arrow format of the array.

 

null_bitmap

The bitmap that shows null elements. The N-th element is null when the N-th bit is 0, not null otherwise. If the array has no null elements, the bitmap must be NULL and n_nulls is 0.

[nullable]

n_nulls

The number of null elements. If -1 is specified, the number of nulls are computed from null_bitmap .

 

Returns

A newly created GArrowDayTimeIntervalArray.

Since: 8.0.0


garrow_day_time_interval_array_get_value ()

GArrowDayMillisecond *
garrow_day_time_interval_array_get_value
                               (GArrowDayTimeIntervalArray *array,
                                gint64 i);

Parameters

array

A GArrowDayTimeIntervalArray.

 

i

The index of the target value.

 

Returns

The i -th value.

[transfer full]

Since: 8.0.0


garrow_day_time_interval_array_get_values ()

GList *
garrow_day_time_interval_array_get_values
                               (GArrowDayTimeIntervalArray *array);

Parameters

Returns

The list of GArrowDayMillisecond.

[nullable][element-type GArrowDayMillisecond][transfer full]

Since: 8.0.0


garrow_month_day_nano_interval_array_new ()

GArrowMonthDayNanoIntervalArray *
garrow_month_day_nano_interval_array_new
                               (gint64 length,
                                GArrowBuffer *data,
                                GArrowBuffer *null_bitmap,
                                gint64 n_nulls);

Parameters

length

The number of elements.

 

data

The binary data in Arrow format of the array.

 

null_bitmap

The bitmap that shows null elements. The N-th element is null when the N-th bit is 0, not null otherwise. If the array has no null elements, the bitmap must be NULL and n_nulls is 0.

[nullable]

n_nulls

The number of null elements. If -1 is specified, the number of nulls are computed from null_bitmap .

 

Returns

A newly created GArrowMonthDayNanoIntervalArray.

Since: 8.0.0


garrow_month_day_nano_interval_array_get_value ()

GArrowMonthDayNano *
garrow_month_day_nano_interval_array_get_value
                               (GArrowMonthDayNanoIntervalArray *array,
                                gint64 i);

Parameters

array

A GArrowMonthDayNanoIntervalArray.

 

i

The index of the target value.

 

Returns

The i -th value.

[transfer full]

Since: 8.0.0


garrow_month_day_nano_interval_array_get_values ()

GList *
garrow_month_day_nano_interval_array_get_values
                               (GArrowMonthDayNanoIntervalArray *array);

Parameters

Returns

The list of GArrowMonthDayNano.

[nullable][element-type GArrowMonthDayNano][transfer full]

Since: 8.0.0


garrow_fixed_size_binary_array_new ()

GArrowFixedSizeBinaryArray *
garrow_fixed_size_binary_array_new (GArrowFixedSizeBinaryDataType *data_type,
                                    gint64 length,
                                    GArrowBuffer *data,
                                    GArrowBuffer *null_bitmap,
                                    gint64 n_nulls);

Parameters

data_type

A GArrowFixedSizeBinaryDataType for the array.

 

length

The number of elements.

 

data

The binary data in Arrow format of the array.

 

null_bitmap

The bitmap that shows null elements. The N-th element is null when the N-th bit is 0, not null otherwise. If the array has no null elements, the bitmap must be NULL and n_nulls is 0.

[nullable]

n_nulls

The number of null elements. If -1 is specified, the number of nulls are computed from null_bitmap .

 

Returns

A newly created GArrowFixedSizeBinaryArray.

Since: 3.0.0


garrow_fixed_size_binary_array_get_byte_width ()

gint32
garrow_fixed_size_binary_array_get_byte_width
                               (GArrowFixedSizeBinaryArray *array);

Parameters

Returns

The number of bytes of each value.

Since: 3.0.0


garrow_fixed_size_binary_array_get_value ()

GBytes *
garrow_fixed_size_binary_array_get_value
                               (GArrowFixedSizeBinaryArray *array,
                                gint64 i);

Parameters

array

A GArrowFixedSizeBinaryArray.

 

i

The index of the target value.

 

Returns

The i -th value.

[transfer full]

Since: 3.0.0


garrow_fixed_size_binary_array_get_values_bytes ()

GBytes *
garrow_fixed_size_binary_array_get_values_bytes
                               (GArrowFixedSizeBinaryArray *array);

Parameters

Returns

All values as a GBytes.

[transfer full]

Since: 3.0.0


garrow_decimal128_array_format_value ()

gchar *
garrow_decimal128_array_format_value (GArrowDecimal128Array *array,
                                      gint64 i);

Parameters

array

A GArrowDecimal128Array.

 

i

The index of the target value.

 

Returns

The formatted i -th value.

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

[transfer full]

Since: 0.10.0


garrow_decimal128_array_get_value ()

GArrowDecimal128 *
garrow_decimal128_array_get_value (GArrowDecimal128Array *array,
                                   gint64 i);

Parameters

array

A GArrowDecimal128Array.

 

i

The index of the target value.

 

Returns

The i -th value.

[transfer full]

Since: 0.10.0


garrow_decimal256_array_format_value ()

gchar *
garrow_decimal256_array_format_value (GArrowDecimal256Array *array,
                                      gint64 i);

Parameters

array

A GArrowDecimal256Array.

 

i

The index of the target value.

 

Returns

The formatted i -th value.

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

[transfer full]

Since: 3.0.0


garrow_decimal256_array_get_value ()

GArrowDecimal256 *
garrow_decimal256_array_get_value (GArrowDecimal256Array *array,
                                   gint64 i);

Parameters

array

A GArrowDecimal256Array.

 

i

The index of the target value.

 

Returns

The i -th value.

[transfer full]

Since: 3.0.0


garrow_extension_array_get_storage ()

GArrowArray *
garrow_extension_array_get_storage (GArrowExtensionArray *array);

Parameters

array

A GArrowExtensionArray.

 

Returns

The underlying storage of the array.

[transfer full]

Since: 3.0.0

Types and Values

GARROW_TYPE_EQUAL_OPTIONS

#define GARROW_TYPE_EQUAL_OPTIONS (garrow_equal_options_get_type())

struct GArrowEqualOptionsClass

struct GArrowEqualOptionsClass {
  GObjectClass parent_class;
};

GARROW_TYPE_NULL_ARRAY

#define GARROW_TYPE_NULL_ARRAY (garrow_null_array_get_type())

struct GArrowNullArrayClass

struct GArrowNullArrayClass {
  GArrowArrayClass parent_class;
};

GARROW_TYPE_PRIMITIVE_ARRAY

#define GARROW_TYPE_PRIMITIVE_ARRAY (garrow_primitive_array_get_type())

struct GArrowPrimitiveArrayClass

struct GArrowPrimitiveArrayClass {
  GArrowArrayClass parent_class;
};

GARROW_TYPE_BOOLEAN_ARRAY

#define GARROW_TYPE_BOOLEAN_ARRAY (garrow_boolean_array_get_type())

struct GArrowBooleanArrayClass

struct GArrowBooleanArrayClass {
  GArrowPrimitiveArrayClass parent_class;
};

GARROW_TYPE_NUMERIC_ARRAY

#define GARROW_TYPE_NUMERIC_ARRAY (garrow_numeric_array_get_type())

struct GArrowNumericArrayClass

struct GArrowNumericArrayClass {
  GArrowPrimitiveArrayClass parent_class;
};

GARROW_TYPE_INT8_ARRAY

#define GARROW_TYPE_INT8_ARRAY (garrow_int8_array_get_type())

struct GArrowInt8ArrayClass

struct GArrowInt8ArrayClass {
  GArrowNumericArrayClass parent_class;
};

GARROW_TYPE_UINT8_ARRAY

#define GARROW_TYPE_UINT8_ARRAY (garrow_uint8_array_get_type())

struct GArrowUInt8ArrayClass

struct GArrowUInt8ArrayClass {
  GArrowNumericArrayClass parent_class;
};

GARROW_TYPE_INT16_ARRAY

#define GARROW_TYPE_INT16_ARRAY (garrow_int16_array_get_type())

struct GArrowInt16ArrayClass

struct GArrowInt16ArrayClass {
  GArrowNumericArrayClass parent_class;
};

GARROW_TYPE_UINT16_ARRAY

#define GARROW_TYPE_UINT16_ARRAY (garrow_uint16_array_get_type())

struct GArrowUInt16ArrayClass

struct GArrowUInt16ArrayClass {
  GArrowNumericArrayClass parent_class;
};

GARROW_TYPE_INT32_ARRAY

#define GARROW_TYPE_INT32_ARRAY (garrow_int32_array_get_type())

struct GArrowInt32ArrayClass

struct GArrowInt32ArrayClass {
  GArrowNumericArrayClass parent_class;
};

GARROW_TYPE_UINT32_ARRAY

#define GARROW_TYPE_UINT32_ARRAY (garrow_uint32_array_get_type())

struct GArrowUInt32ArrayClass

struct GArrowUInt32ArrayClass {
  GArrowNumericArrayClass parent_class;
};

GARROW_TYPE_INT64_ARRAY

#define GARROW_TYPE_INT64_ARRAY (garrow_int64_array_get_type())

struct GArrowInt64ArrayClass

struct GArrowInt64ArrayClass {
  GArrowNumericArrayClass parent_class;
};

GARROW_TYPE_UINT64_ARRAY

#define GARROW_TYPE_UINT64_ARRAY (garrow_uint64_array_get_type())

struct GArrowUInt64ArrayClass

struct GArrowUInt64ArrayClass {
  GArrowNumericArrayClass parent_class;
};

GARROW_TYPE_FLOAT_ARRAY

#define GARROW_TYPE_FLOAT_ARRAY (garrow_float_array_get_type())

struct GArrowFloatArrayClass

struct GArrowFloatArrayClass {
  GArrowNumericArrayClass parent_class;
};

GARROW_TYPE_DOUBLE_ARRAY

#define GARROW_TYPE_DOUBLE_ARRAY (garrow_double_array_get_type())

struct GArrowDoubleArrayClass

struct GArrowDoubleArrayClass {
  GArrowNumericArrayClass parent_class;
};

GARROW_TYPE_BINARY_ARRAY

#define GARROW_TYPE_BINARY_ARRAY (garrow_binary_array_get_type())

struct GArrowBinaryArrayClass

struct GArrowBinaryArrayClass {
  GArrowArrayClass parent_class;
};

GARROW_TYPE_LARGE_BINARY_ARRAY

#define GARROW_TYPE_LARGE_BINARY_ARRAY (garrow_large_binary_array_get_type())

struct GArrowLargeBinaryArrayClass

struct GArrowLargeBinaryArrayClass {
  GArrowArrayClass parent_class;
};

GARROW_TYPE_STRING_ARRAY

#define GARROW_TYPE_STRING_ARRAY (garrow_string_array_get_type())

struct GArrowStringArrayClass

struct GArrowStringArrayClass {
  GArrowBinaryArrayClass parent_class;
};

GARROW_TYPE_LARGE_STRING_ARRAY

#define GARROW_TYPE_LARGE_STRING_ARRAY (garrow_large_string_array_get_type())

struct GArrowLargeStringArrayClass

struct GArrowLargeStringArrayClass {
  GArrowLargeBinaryArrayClass parent_class;
};

GARROW_TYPE_DATE32_ARRAY

#define GARROW_TYPE_DATE32_ARRAY (garrow_date32_array_get_type())

struct GArrowDate32ArrayClass

struct GArrowDate32ArrayClass {
  GArrowNumericArrayClass parent_class;
};

GARROW_TYPE_DATE64_ARRAY

#define GARROW_TYPE_DATE64_ARRAY (garrow_date64_array_get_type())

struct GArrowDate64ArrayClass

struct GArrowDate64ArrayClass {
  GArrowNumericArrayClass parent_class;
};

GARROW_TYPE_TIMESTAMP_ARRAY

#define GARROW_TYPE_TIMESTAMP_ARRAY (garrow_timestamp_array_get_type())

struct GArrowTimestampArrayClass

struct GArrowTimestampArrayClass {
  GArrowNumericArrayClass parent_class;
};

GARROW_TYPE_TIME32_ARRAY

#define GARROW_TYPE_TIME32_ARRAY (garrow_time32_array_get_type())

struct GArrowTime32ArrayClass

struct GArrowTime32ArrayClass {
  GArrowNumericArrayClass parent_class;
};

GARROW_TYPE_TIME64_ARRAY

#define GARROW_TYPE_TIME64_ARRAY (garrow_time64_array_get_type())

struct GArrowTime64ArrayClass

struct GArrowTime64ArrayClass {
  GArrowNumericArrayClass parent_class;
};

GARROW_TYPE_MONTH_INTERVAL_ARRAY

#define             GARROW_TYPE_MONTH_INTERVAL_ARRAY

struct GArrowMonthIntervalArrayClass

struct GArrowMonthIntervalArrayClass {
  GArrowNumericArrayClass parent_class;
};

GARROW_TYPE_DAY_TIME_INTERVAL_ARRAY

#define             GARROW_TYPE_DAY_TIME_INTERVAL_ARRAY

struct GArrowDayTimeIntervalArrayClass

struct GArrowDayTimeIntervalArrayClass {
  GArrowPrimitiveArrayClass parent_class;
};

GARROW_TYPE_MONTH_DAY_NANO_INTERVAL_ARRAY

#define             GARROW_TYPE_MONTH_DAY_NANO_INTERVAL_ARRAY

struct GArrowMonthDayNanoIntervalArrayClass

struct GArrowMonthDayNanoIntervalArrayClass {
  GArrowPrimitiveArrayClass parent_class;
};

GARROW_TYPE_FIXED_SIZE_BINARY_ARRAY

#define GARROW_TYPE_FIXED_SIZE_BINARY_ARRAY (garrow_fixed_size_binary_array_get_type())

struct GArrowFixedSizeBinaryArrayClass

struct GArrowFixedSizeBinaryArrayClass {
  GArrowPrimitiveArrayClass parent_class;
};

GARROW_TYPE_DECIMAL128_ARRAY

#define GARROW_TYPE_DECIMAL128_ARRAY (garrow_decimal128_array_get_type())

struct GArrowDecimal128ArrayClass

struct GArrowDecimal128ArrayClass {
  GArrowFixedSizeBinaryArrayClass parent_class;
};

GARROW_TYPE_DECIMAL256_ARRAY

#define GARROW_TYPE_DECIMAL256_ARRAY (garrow_decimal256_array_get_type())

struct GArrowDecimal256ArrayClass

struct GArrowDecimal256ArrayClass {
  GArrowFixedSizeBinaryArrayClass parent_class;
};

GArrowBinaryArray

typedef struct _GArrowBinaryArray GArrowBinaryArray;

GArrowBooleanArray

typedef struct _GArrowBooleanArray GArrowBooleanArray;

GArrowDate32Array

typedef struct _GArrowDate32Array GArrowDate32Array;

GArrowDate64Array

typedef struct _GArrowDate64Array GArrowDate64Array;

GArrowDayTimeIntervalArray

typedef struct _GArrowDayTimeIntervalArray GArrowDayTimeIntervalArray;

GArrowDecimal128Array

typedef struct _GArrowDecimal128Array GArrowDecimal128Array;

GArrowDecimal256Array

typedef struct _GArrowDecimal256Array GArrowDecimal256Array;

GArrowDoubleArray

typedef struct _GArrowDoubleArray GArrowDoubleArray;

GArrowEqualOptions

typedef struct _GArrowEqualOptions GArrowEqualOptions;

GArrowFixedSizeBinaryArray

typedef struct _GArrowFixedSizeBinaryArray GArrowFixedSizeBinaryArray;

GArrowFloatArray

typedef struct _GArrowFloatArray GArrowFloatArray;

GArrowInt16Array

typedef struct _GArrowInt16Array GArrowInt16Array;

GArrowInt32Array

typedef struct _GArrowInt32Array GArrowInt32Array;

GArrowInt64Array

typedef struct _GArrowInt64Array GArrowInt64Array;

GArrowInt8Array

typedef struct _GArrowInt8Array GArrowInt8Array;

GArrowLargeBinaryArray

typedef struct _GArrowLargeBinaryArray GArrowLargeBinaryArray;

GArrowLargeStringArray

typedef struct _GArrowLargeStringArray GArrowLargeStringArray;

GArrowMonthDayNanoIntervalArray

typedef struct _GArrowMonthDayNanoIntervalArray GArrowMonthDayNanoIntervalArray;

GArrowMonthIntervalArray

typedef struct _GArrowMonthIntervalArray GArrowMonthIntervalArray;

GArrowNullArray

typedef struct _GArrowNullArray GArrowNullArray;

GArrowNumericArray

typedef struct _GArrowNumericArray GArrowNumericArray;

GArrowPrimitiveArray

typedef struct _GArrowPrimitiveArray GArrowPrimitiveArray;

GArrowStringArray

typedef struct _GArrowStringArray GArrowStringArray;

GArrowTime32Array

typedef struct _GArrowTime32Array GArrowTime32Array;

GArrowTime64Array

typedef struct _GArrowTime64Array GArrowTime64Array;

GArrowTimestampArray

typedef struct _GArrowTimestampArray GArrowTimestampArray;

GArrowUInt16Array

typedef struct _GArrowUInt16Array GArrowUInt16Array;

GArrowUInt32Array

typedef struct _GArrowUInt32Array GArrowUInt32Array;

GArrowUInt64Array

typedef struct _GArrowUInt64Array GArrowUInt64Array;

GArrowUInt8Array

typedef struct _GArrowUInt8Array GArrowUInt8Array;

Property Details

The “absolute-tolerance” property

  “absolute-tolerance”       gdouble

The absolute tolerance for approximate comparison of floating-point values.

Owner: GArrowEqualOptions

Flags: Read / Write

Default value: 1e-05

Since: 5.0.0


The “approx” property

  “approx”                   gboolean

Whether or not approximate comparison is used.

Owner: GArrowEqualOptions

Flags: Read / Write

Default value: FALSE

Since: 5.0.0


The “nans-equal” property

  “nans-equal”               gboolean

Whether or not NaNs are considered equal.

Owner: GArrowEqualOptions

Flags: Read / Write

Default value: FALSE

Since: 5.0.0