Top |
GArrowInt32Array * | value-offsets | Read / Write / Construct Only |
GArrowArray * | dictionary | Read / Write / Construct Only |
GArrowArray * | indices | Read / Write / Construct Only |
GArrowArray * | raw-values | Read / Write / Construct Only |
GArrowArray * | raw-values | Read / Write / Construct Only |
GArrowArray * | items | Read / Write / Construct Only |
GArrowArray * | keys | Read / Write / Construct Only |
GArrowArray * | offsets | Read / Write / Construct Only |
GArrowArray * | run-ends | Read / Write / Construct Only |
GArrowArray * | values | Read / Write / Construct Only |
GArrowInt8Array * | type-ids | Read / Write / Construct Only |
#define | GARROW_TYPE_LIST_ARRAY |
struct | GArrowListArrayClass |
#define | GARROW_TYPE_LARGE_LIST_ARRAY |
struct | GArrowLargeListArrayClass |
#define | GARROW_TYPE_STRUCT_ARRAY |
struct | GArrowStructArrayClass |
#define | GARROW_TYPE_MAP_ARRAY |
struct | GArrowMapArrayClass |
#define | GARROW_TYPE_UNION_ARRAY |
struct | GArrowUnionArrayClass |
#define | GARROW_TYPE_SPARSE_UNION_ARRAY |
struct | GArrowSparseUnionArrayClass |
#define | GARROW_TYPE_DENSE_UNION_ARRAY |
struct | GArrowDenseUnionArrayClass |
#define | GARROW_TYPE_DICTIONARY_ARRAY |
struct | GArrowDictionaryArrayClass |
#define | GARROW_TYPE_RUN_END_ENCODED_ARRAY |
struct | GArrowRunEndEncodedArrayClass |
GArrowDenseUnionArray | |
GArrowDictionaryArray | |
GArrowLargeListArray | |
GArrowListArray | |
GArrowMapArray | |
GArrowRunEndEncodedArray | |
GArrowSparseUnionArray | |
GArrowStructArray | |
GArrowUnionArray |
GObject ╰── GArrowArray ├── GArrowDictionaryArray ├── GArrowLargeListArray ├── GArrowListArray │ ╰── GArrowMapArray ├── GArrowRunEndEncodedArray ├── GArrowStructArray ╰── GArrowUnionArray ├── GArrowDenseUnionArray ├── GArrowSparseUnionArray ├── GArrowDenseUnionArray ╰── GArrowSparseUnionArray
GArrowListArray is a class for list array. It can store zero or more list data. If you don't have Arrow format data, you need to use GArrowListArrayBuilder to create a new array.
GArrowLargeListArray is a class for 64-bit offsets list array. It can store zero or more list data. If you don't have Arrow format data, you need to use GArrowLargeListArrayBuilder to create a new array.
GArrowStructArray is a class for struct array. It can store zero or more structs. One struct has one or more fields. If you don't have Arrow format data, you need to use GArrowStructArrayBuilder to create a new array.
GArrowMapArray is a class for map array. It can store data with keys and items.
GArrowUnionArray is a base class for union array. It can store zero or more unions. One union has one or more fields but one union can store only one field value.
GArrowDenseUnionArray is a class for dense union array.
GArrowSparseUnionArray is a class for sparse union array.
GArrowDictionaryArray is a class for dictionary array. It can
store data with dictionary and indices. It's more space effective
than normal array when the array has many same values. You can
convert a normal array to a dictionary array by
garrow_array_dictionary_encode()
.
GArrowRunEndEncodedArray is a class for run-end encoded array. It
can store data with run-ends and values. It's more space effective
than normal array when the array has many continuous same
values. You can convert a normal array to a run-end encoded array
by garrow_array_run_end_encode()
. You can convert a run-end encoded
array to a normal array by garrow_run_end_encoded_array_decode()
.
GArrowListArray * garrow_list_array_new (GArrowDataType *data_type
,gint64 length
,GArrowBuffer *value_offsets
,GArrowArray *values
,GArrowBuffer *null_bitmap
,gint64 n_nulls
);
data_type |
The data type of the list. |
|
length |
The number of elements. |
|
value_offsets |
The offsets of |
|
values |
The values as GArrowArray. |
|
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 |
[nullable] |
n_nulls |
The number of null elements. If -1 is specified, the
number of nulls are computed from |
Since: 0.4.0
GArrowDataType *
garrow_list_array_get_value_type (GArrowListArray *array
);
GArrowArray * garrow_list_array_get_value (GArrowListArray *array
,gint64 i
);
GArrowArray *
garrow_list_array_get_values (GArrowListArray *array
);
Since: 2.0.0
gint32 garrow_list_array_get_value_offset (GArrowListArray *array
,gint64 i
);
gint32 garrow_list_array_get_value_length (GArrowListArray *array
,gint64 i
);
Since: 2.0.0
const gint32 * garrow_list_array_get_value_offsets (GArrowListArray *array
,gint64 *n_offsets
);
Since: 2.0.0
GArrowLargeListArray * garrow_large_list_array_new (GArrowDataType *data_type
,gint64 length
,GArrowBuffer *value_offsets
,GArrowArray *values
,GArrowBuffer *null_bitmap
,gint64 n_nulls
);
data_type |
The data type of the list. |
|
length |
The number of elements. |
|
value_offsets |
The offsets of |
|
values |
The values as GArrowArray. |
|
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 |
[nullable] |
n_nulls |
The number of null elements. If -1 is specified, the
number of nulls are computed from |
Since: 0.16.0
GArrowDataType *
garrow_large_list_array_get_value_type
(GArrowLargeListArray *array
);
Since: 0.16.0
GArrowArray * garrow_large_list_array_get_value (GArrowLargeListArray *array
,gint64 i
);
Since: 0.16.0
GArrowArray *
garrow_large_list_array_get_values (GArrowLargeListArray *array
);
Since: 2.0.0
gint64 garrow_large_list_array_get_value_offset (GArrowLargeListArray *array
,gint64 i
);
Since: 2.0.0
gint64 garrow_large_list_array_get_value_length (GArrowLargeListArray *array
,gint64 i
);
const gint64 * garrow_large_list_array_get_value_offsets (GArrowLargeListArray *array
,gint64 *n_offsets
);
Since: 2.0.0
GArrowStructArray * garrow_struct_array_new (GArrowDataType *data_type
,gint64 length
,GList *fields
,GArrowBuffer *null_bitmap
,gint64 n_nulls
);
data_type |
The data type of the struct. |
|
length |
The number of elements. |
|
fields |
The arrays for each field as GList of GArrowArray. |
[element-type GArrowArray] |
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 |
[nullable] |
n_nulls |
The number of null elements. If -1 is specified, the
number of nulls are computed from |
Since: 0.4.0
GArrowArray * garrow_struct_array_get_field (GArrowStructArray *array
,gint i
);
GList *
garrow_struct_array_get_fields (GArrowStructArray *array
);
GList * garrow_struct_array_flatten (GArrowStructArray *array
,GError **error
);
Since: 0.10.0
GArrowMapArray * garrow_map_array_new (GArrowArray *offsets
,GArrowArray *keys
,GArrowArray *items
,GError **error
);
Since: 0.17.0
GArrowArray *
garrow_map_array_get_keys (GArrowMapArray *array
);
Since: 0.17.0
GArrowArray *
garrow_map_array_get_items (GArrowMapArray *array
);
Since: 0.17.0
gint8 garrow_union_array_get_type_code (GArrowUnionArray *array
,gint64 i
);
Since: 12.0.0
gint garrow_union_array_get_child_id (GArrowUnionArray *array
,gint64 i
);
Since: 12.0.0
GArrowArray * garrow_union_array_get_field (GArrowUnionArray *array
,gint i
);
GArrowSparseUnionArray * garrow_sparse_union_array_new (GArrowInt8Array *type_ids
,GList *fields
,GError **error
);
type_ids |
The field type IDs for each value as GArrowInt8Array. |
|
fields |
The arrays for each field as GList of GArrowArray. |
[element-type GArrowArray] |
error |
[nullable] |
Since: 0.12.0
GArrowSparseUnionArray * garrow_sparse_union_array_new_data_type (GArrowSparseUnionDataType *data_type
,GArrowInt8Array *type_ids
,GList *fields
,GError **error
);
data_type |
The data type for the sparse array. |
|
type_ids |
The field type IDs for each value as GArrowInt8Array. |
|
fields |
The arrays for each field as GList of GArrowArray. |
[element-type GArrowArray] |
error |
[nullable] |
Since: 0.14.0
GArrowDenseUnionArray * garrow_dense_union_array_new (GArrowInt8Array *type_ids
,GArrowInt32Array *value_offsets
,GList *fields
,GError **error
);
type_ids |
The field type IDs for each value as GArrowInt8Array. |
|
value_offsets |
The value offsets for each value as GArrowInt32Array. Each offset is counted for each type. |
|
fields |
The arrays for each field as GList of GArrowArray. |
[element-type GArrowArray] |
error |
[nullable] |
Since: 0.12.0
GArrowDenseUnionArray * garrow_dense_union_array_new_data_type (GArrowDenseUnionDataType *data_type
,GArrowInt8Array *type_ids
,GArrowInt32Array *value_offsets
,GList *fields
,GError **error
);
data_type |
The data type for the dense array. |
|
type_ids |
The field type IDs for each value as GArrowInt8Array. |
|
value_offsets |
The value offsets for each value as GArrowInt32Array. Each offset is counted for each type. |
|
fields |
The arrays for each field as GList of GArrowArray. |
[element-type GArrowArray] |
error |
[nullable] |
Since: 0.14.0
gint32 garrow_dense_union_array_get_value_offset (GArrowDenseUnionArray *array
,gint64 i
);
Since: 12.0.0
GArrowDictionaryArray * garrow_dictionary_array_new (GArrowDataType *data_type
,GArrowArray *indices
,GArrowArray *dictionary
,GError **error
);
Since: 0.8.0
GArrowArray *
garrow_dictionary_array_get_indices (GArrowDictionaryArray *array
);
Since: 0.8.0
GArrowArray *
garrow_dictionary_array_get_dictionary
(GArrowDictionaryArray *array
);
Since: 0.8.0
GArrowDictionaryDataType *
garrow_dictionary_array_get_dictionary_data_type
(GArrowDictionaryArray *array
);
garrow_dictionary_array_get_dictionary_data_type
has been deprecated since version 1.0.0 and should not be used in newly-written code.
Use garrow_array_get_value_data_type()
instead.
Since: 0.8.0
GArrowRunEndEncodedArray * garrow_run_end_encoded_array_new (GArrowDataType *data_type
,gint64 logical_length
,GArrowArray *run_ends
,GArrowArray *values
,gint64 logical_offset
,GError **error
);
data_type |
The data type of the run-end encoded array. |
|
logical_length |
The logical length of the run-end encoded array. |
|
run_ends |
The run-ends of the run-end encoded array. |
|
values |
The values of the run-end encoded array. |
|
logical_offset |
The offset of the run-end encoded array. |
|
error |
[nullable] |
Since: 13.0.0
GArrowArray *
garrow_run_end_encoded_array_get_run_ends
(GArrowRunEndEncodedArray *array
);
Since: 13.0.0
GArrowArray *
garrow_run_end_encoded_array_get_values
(GArrowRunEndEncodedArray *array
);
Since: 13.0.0
GArrowArray * garrow_run_end_encoded_array_get_logical_run_ends (GArrowRunEndEncodedArray *array
,GError **error
);
The logical indexes of each run-end or
NULL
on error.
If a non-zero logical offset is set, this function allocates a new array and rewrites all the run end values to be relative to the logical offset and cuts the end of the array to the logical length.
[transfer full]
Since: 13.0.0
GArrowArray *
garrow_run_end_encoded_array_get_logical_values
(GArrowRunEndEncodedArray *array
);
The logical values of each run.
If a non-zero logical offset is set, this function allocates a new array containing only the values within the logical range.
[transfer full]
Since: 13.0.0
gint64
garrow_run_end_encoded_array_find_physical_offset
(GArrowRunEndEncodedArray *array
);
Find the physical offset of this array.
This function uses binary-search, so it has a O(log N) cost.
Since: 13.0.0
gint64
garrow_run_end_encoded_array_find_physical_length
(GArrowRunEndEncodedArray *array
);
Find the physical length of this array.
The physical length of an run-end encoded array is the number of physical values (and run-ends) necessary to represent the logical range of values from offset to length.
Avoid calling this function if the physical length can be estabilished in some other way (e.g. when iterating over the runs sequentially until the end). This function uses binary-search, so it has a O(log N) cost.
Since: 13.0.0
#define GARROW_TYPE_LARGE_LIST_ARRAY (garrow_large_list_array_get_type())
struct GArrowLargeListArrayClass { GArrowArrayClass parent_class; };
#define GARROW_TYPE_SPARSE_UNION_ARRAY (garrow_sparse_union_array_get_type())
struct GArrowSparseUnionArrayClass { GArrowUnionArrayClass parent_class; };
#define GARROW_TYPE_DENSE_UNION_ARRAY (garrow_dense_union_array_get_type())
struct GArrowDenseUnionArrayClass { GArrowUnionArrayClass parent_class; };
#define GARROW_TYPE_DICTIONARY_ARRAY (garrow_dictionary_array_get_type())
struct GArrowDictionaryArrayClass { GArrowArrayClass parent_class; };
struct GArrowRunEndEncodedArrayClass { GArrowArrayClass parent_class; };
“value-offsets”
property“value-offsets” GArrowInt32Array *
The GArrowInt32Array for value offsets.
Owner: GArrowDenseUnionArray
Flags: Read / Write / Construct Only
“dictionary”
property “dictionary” GArrowArray *
The GArrowArray for dictionary.
Owner: GArrowDictionaryArray
Flags: Read / Write / Construct Only
“indices”
property “indices” GArrowArray *
The GArrowArray for indices.
Owner: GArrowDictionaryArray
Flags: Read / Write / Construct Only
“raw-values”
property “raw-values” GArrowArray *
The raw values.
Owner: GArrowLargeListArray
Flags: Read / Write / Construct Only
“raw-values”
property “raw-values” GArrowArray *
The raw values.
Owner: GArrowListArray
Flags: Read / Write / Construct Only
“items”
property “items” GArrowArray *
The GArrowArray for items.
Owner: GArrowMapArray
Flags: Read / Write / Construct Only
“keys”
property “keys” GArrowArray *
The GArrowArray for keys.
Owner: GArrowMapArray
Flags: Read / Write / Construct Only
“offsets”
property “offsets” GArrowArray *
The GArrowArray for offsets.
Owner: GArrowMapArray
Flags: Read / Write / Construct Only
“run-ends”
property “run-ends” GArrowArray *
The GArrowArray for run-ends.
Owner: GArrowRunEndEncodedArray
Flags: Read / Write / Construct Only
“values”
property “values” GArrowArray *
The GArrowArray for values.
Owner: GArrowRunEndEncodedArray
Flags: Read / Write / Construct Only
“type-ids”
property“type-ids” GArrowInt8Array *
The GArrowInt8Array for type IDs.
Owner: GArrowUnionArray
Flags: Read / Write / Construct Only