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.

GArrowInt8Array is a class for 8-bit integer array. It can store -zero or more 8-bit integer 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. 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. 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. 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. 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. 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. 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. 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. 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. 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. You need to use GArrowBinaryArrayBuilder to +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.

GArrowStringArray is a class for UTF-8 encoded string array. It -can store zero or more UTF-8 encoded string data. You need to use -GArrowStringArrayBuilder to create a new array.

GArrowStructArray is a class for struct array. It can store zero -or more structs. One struct has zero or more fields. You need to -use GArrowStructArrayBuilder to create a new array.

Functions

garrow_array_is_null ()

garrow_array_equal ()

gboolean
-garrow_array_is_null (GArrowArray *array,
-                      gint64 i);

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

Parameters

@@ -558,8 +812,8 @@ garrow_array_is_null ( --++@@ -567,16 +821,18 @@ garrow_array_is_null ( Returns - Whether the i-th value is null or not. + TRUE if both of them have the same data, FALSE +otherwise. -Since 0.3.0 +Since 0.4.0 -garrow_array_get_length () -gint64 -garrow_array_get_length (GArrowArray *array); +garrow_array_equal_approx () +gboolean +garrow_array_equal_approx (GArrowArray *array, + GArrowArray *other_array); Parameters

The index of the target value.

other_array

A GArrowArray to be compared.

@@ -585,24 +841,37 @@ garrow_array_get_length (-++-+ ++++++

array	A GArrowArray.
other_array	A GArrowArray to be compared.

Returns - The number of rows in the array. + TRUE if both of them have the approx same data, FALSE +otherwise. +Since 0.4.0

-garrow_array_get_offset () -gint64 -garrow_array_get_offset (GArrowArray *array); +garrow_array_equal_range () +gboolean +garrow_array_equal_range (GArrowArray *array, + gint64 start_index, + GArrowArray *other_array, + gint64 other_start_index, + gint64 end_index); Parameters @@ -611,24 +880,58 @@ garrow_array_get_offset ( - + + - + + + + + + + + + + + + + + + + + + + + + + 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 +)". Returns - The number of values in the array. + TRUE if both of them have the same data in the range, +FALSE otherwise. +Since 0.4.0 -garrow_array_get_n_nulls () -gint64 -garrow_array_get_n_nulls (GArrowArray *array); +garrow_array_is_null () +gboolean +garrow_array_is_null (GArrowArray *array, + gint64 i); Parameters @@ -637,24 +940,32 @@ garrow_array_get_n_nulls ( - + + - + + + + + + + array A GArrowArray. i The index of the target value. Returns - The number of NULLs in the array. + Whether the i-th value is null or not. +Since 0.3.0 -garrow_array_get_null_bitmap () -GArrowBuffer * -garrow_array_get_null_bitmap (GArrowArray *array); +garrow_array_get_length () +gint64 +garrow_array_get_length (GArrowArray *array); Parameters @@ -672,6 +983,84 @@ garrow_array_get_null_bitmap ( 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 indexes for the array as GArrowBuffer or NULL when garrow_array_get_n_nulls() returns 0. @@ -685,7 +1074,7 @@ value indexes for the array as GArrowDataType * garrow_array_get_value_data_type (GArrowArray *array); -Parameters +Parameters @@ -700,7 +1089,7 @@ garrow_array_get_value_data_type ( -Returns +Returns The GArrowDataType for each value of the array. [transfer full] @@ -713,7 +1102,7 @@ array. GArrowType garrow_array_get_value_type (GArrowArray *array); -Parameters +Parameters @@ -728,7 +1117,7 @@ garrow_array_get_value_type ( -Returns +Returns The GArrowType for each value of the array. @@ -742,7 +1131,7 @@ garrow_array_slice (gint64 offset, gint64 length); -Parameters +Parameters @@ -769,7 +1158,7 @@ garrow_array_slice ( -Returns +Returns The sub GArrowArray. It covers only from offset to offset + length range. The sub GArrowArray shares values with the base GArrowArray. @@ -778,11 +1167,48 @@ values with the base +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. + The returned string should be freed when with g_free() when no +longer needed. +[nullable] + +Since 0.4.0 + + + garrow_null_array_new () GArrowNullArray * garrow_null_array_new (gint64 length); -Parameters +Parameters @@ -797,7 +1223,7 @@ garrow_null_array_new ( -Returns +Returns A newly created GArrowNullArray. @@ -808,7 +1234,7 @@ garrow_null_array_new (GArrowBuffer * garrow_primitive_array_get_buffer (GArrowPrimitiveArray *array); -Parameters +Parameters @@ -823,19 +1249,72 @@ garrow_primitive_array_get_buffer ( -Returns +Returns The data of the array as GArrowBuffer. [transfer full] +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 +Parameters @@ -857,19 +1336,107 @@ garrow_boolean_array_get_value ( -Returns +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] + + + + +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 +Parameters @@ -891,19 +1458,832 @@ garrow_int8_array_get_value ( -Returns +Returns The i-th value. -garrow_uint8_array_get_value () -guint8 -garrow_uint8_array_get_value (GArrowUInt8Array *array, - gint64 i); +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

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` +)".

array	A GArrowArray.
error	Return location for a GError or `NULL`.	[nullable]

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` +.

Description

Functions

garrow_array_is_null ()

garrow_array_equal ()

Parameters

Returns

garrow_array_get_length ()

garrow_array_equal_approx ()

Parameters

Returns

garrow_array_get_offset ()

garrow_array_equal_range ()

Parameters

Returns

garrow_array_get_n_nulls ()

garrow_array_is_null ()

Parameters

Returns

garrow_array_get_null_bitmap ()

garrow_array_get_length ()

Parameters

Returns

garrow_array_get_offset ()

Parameters

Returns

garrow_array_get_n_nulls ()

Parameters

Returns

garrow_array_get_null_bitmap ()

Parameters

Returns

Parameters

Parameters

Returns

Returns

Parameters

Parameters

Returns

Returns

Parameters

Parameters

Returns

Returns

garrow_array_to_string ()

Parameters

Returns

garrow_null_array_new ()

Parameters

Parameters

Returns

Returns

Parameters

Parameters

Returns

Returns

garrow_boolean_array_new ()

Parameters

Returns

garrow_boolean_array_get_value ()

Parameters

Parameters

Returns

Returns

garrow_boolean_array_get_values ()

Parameters

Returns

garrow_int8_array_new ()

Parameters

Returns

garrow_int8_array_get_value ()

Parameters

Parameters

Returns

Returns

garrow_uint8_array_get_value ()

garrow_int8_array_get_values ()

Parameters

Returns

garrow_uint8_array_new ()

Parameters