Array classes

Array classes

Functions

Properties

gpointer array Write / Construct Only

Types and Values

Object Hierarchy

    GObject
    ├── GArrowArray
       ├── GArrowBinaryArray
          ╰── GArrowStringArray
       ├── GArrowListArray
       ├── GArrowNullArray
       ├── GArrowPrimitiveArray
          ├── GArrowBooleanArray
          ├── GArrowDoubleArray
          ├── GArrowFloatArray
          ├── GArrowInt16Array
          ├── GArrowInt32Array
          ├── GArrowInt64Array
          ├── GArrowInt8Array
          ├── GArrowUInt16Array
          ├── GArrowUInt32Array
          ├── GArrowUInt64Array
          ╰── GArrowUInt8Array
       ╰── GArrowStructArray
    ╰── GArrowArray
        ├── GArrowBinaryArray
           ╰── GArrowStringArray
        ├── GArrowPrimitiveArray
           ├── GArrowBooleanArray
           ├── GArrowDoubleArray
           ├── GArrowFloatArray
           ├── GArrowInt16Array
           ├── GArrowInt32Array
           ├── GArrowInt64Array
           ├── GArrowInt8Array
           ├── GArrowUInt16Array
           ├── GArrowUInt32Array
           ├── GArrowUInt64Array
           ╰── GArrowUInt8Array
        ├── GArrowListArray
        ├── GArrowNullArray
        ╰── GArrowStructArray

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 array builder class such as GArrowBooleanArrayBuilder to create a new array except GArrowNullArray.

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 binary array. It can store zero or more boolean 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. 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 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.

GArrowListArray is a class for list array. It can store zero or more list data. You need to use GArrowListArrayBuilder 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 ()

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_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 indexes 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_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);

Parameters

array

A GArrowPrimitiveArray.

 

Returns

The data of the array as GArrowBuffer.

[transfer full]


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

Parameters

array

A GArrowBinaryArray.

 

Returns

The data of the array as GArrowBuffer.

[transfer full]


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_list_array_get_value_type ()

GArrowDataType *
garrow_list_array_get_value_type (GArrowListArray *array);

Parameters

array

A GArrowListArray.

 

Returns

The data type of value in each list.

[transfer full]


garrow_list_array_get_value ()

GArrowArray *
garrow_list_array_get_value (GArrowListArray *array,
                             gint64 i);

Parameters

array

A GArrowListArray.

 

i

The index of the target value.

 

Returns

The i-th list.

[transfer full]


garrow_struct_array_get_field ()

GArrowArray *
garrow_struct_array_get_field (GArrowStructArray *array,
                               gint i);

Parameters

array

A GArrowStructArray.

 

i

The index of the field in the struct.

 

Returns

The i-th field.

[transfer full]


garrow_struct_array_get_fields ()

GList *
garrow_struct_array_get_fields (GArrowStructArray *array);

Parameters

array

A GArrowStructArray.

 

Returns

The fields in the struct.

[element-type GArrowArray][transfer full]

Types and Values

struct GArrowArray

struct GArrowArray;

It wraps arrow::Array.


struct GArrowNullArray

struct GArrowNullArray;

It wraps arrow::NullArray.


struct GArrowNullArrayClass

struct GArrowNullArrayClass {
  GArrowArrayClass parent_class;
};


struct GArrowPrimitiveArray

struct GArrowPrimitiveArray;

It wraps arrow::PrimitiveArray.


struct GArrowPrimitiveArrayClass

struct GArrowPrimitiveArrayClass {
  GArrowArrayClass parent_class;
};


struct GArrowBooleanArray

struct GArrowBooleanArray;

It wraps arrow::BooleanArray.


struct GArrowBooleanArrayClass

struct GArrowBooleanArrayClass {
  GArrowPrimitiveArrayClass parent_class;
};


struct GArrowInt8Array

struct GArrowInt8Array;

It wraps arrow::Int8Array.


struct GArrowInt8ArrayClass

struct GArrowInt8ArrayClass {
  GArrowPrimitiveArrayClass parent_class;
};


struct GArrowUInt8Array

struct GArrowUInt8Array;

It wraps arrow::UInt8Array.


struct GArrowUInt8ArrayClass

struct GArrowUInt8ArrayClass {
  GArrowPrimitiveArrayClass parent_class;
};


struct GArrowInt16Array

struct GArrowInt16Array;

It wraps arrow::Int16Array.


struct GArrowInt16ArrayClass

struct GArrowInt16ArrayClass {
  GArrowPrimitiveArrayClass parent_class;
};


struct GArrowUInt16Array

struct GArrowUInt16Array;

It wraps arrow::UInt16Array.


struct GArrowUInt16ArrayClass

struct GArrowUInt16ArrayClass {
  GArrowPrimitiveArrayClass parent_class;
};


struct GArrowInt32Array

struct GArrowInt32Array;

It wraps arrow::Int32Array.


struct GArrowInt32ArrayClass

struct GArrowInt32ArrayClass {
  GArrowPrimitiveArrayClass parent_class;
};


struct GArrowUInt32Array

struct GArrowUInt32Array;

It wraps arrow::UInt32Array.


struct GArrowUInt32ArrayClass

struct GArrowUInt32ArrayClass {
  GArrowPrimitiveArrayClass parent_class;
};


struct GArrowInt64Array

struct GArrowInt64Array;

It wraps arrow::Int64Array.


struct GArrowInt64ArrayClass

struct GArrowInt64ArrayClass {
  GArrowPrimitiveArrayClass parent_class;
};


struct GArrowUInt64Array

struct GArrowUInt64Array;

It wraps arrow::UInt64Array.


struct GArrowUInt64ArrayClass

struct GArrowUInt64ArrayClass {
  GArrowPrimitiveArrayClass parent_class;
};


struct GArrowFloatArray

struct GArrowFloatArray;

It wraps arrow::FloatArray.


struct GArrowFloatArrayClass

struct GArrowFloatArrayClass {
  GArrowPrimitiveArrayClass parent_class;
};


struct GArrowDoubleArray

struct GArrowDoubleArray;

It wraps arrow::DoubleArray.


struct GArrowDoubleArrayClass

struct GArrowDoubleArrayClass {
  GArrowPrimitiveArrayClass parent_class;
};


struct GArrowBinaryArray

struct GArrowBinaryArray;

It wraps arrow::BinaryArray.


struct GArrowBinaryArrayClass

struct GArrowBinaryArrayClass {
  GArrowArrayClass parent_class;
};


struct GArrowStringArray

struct GArrowStringArray;

It wraps arrow::StringArray.


struct GArrowStringArrayClass

struct GArrowStringArrayClass {
  GArrowBinaryArrayClass parent_class;
};


struct GArrowListArray

struct GArrowListArray;

It wraps arrow::ListArray.


struct GArrowListArrayClass

struct GArrowListArrayClass {
  GArrowArrayClass parent_class;
};


struct GArrowStructArray

struct GArrowStructArray;

It wraps arrow::StructArray.


struct GArrowStructArrayClass

struct GArrowStructArrayClass {
  GArrowArrayClass parent_class;
};

Property Details

The “array” property

  “array”                    gpointer

The raw std::shared<arrow::Array> *.

Flags: Write / Construct Only