| <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> |
| <html> |
| <head> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>GArrowChunkedArray: Apache Arrow GLib Reference Manual</title> |
| <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> |
| <link rel="home" href="index.html" title="Apache Arrow GLib Reference Manual"> |
| <link rel="up" href="table.html" title="Table"> |
| <link rel="prev" href="record-batch.html" title="Record batch related classes"> |
| <link rel="next" href="table-builder.html" title="Table builder"> |
| <meta name="generator" content="GTK-Doc V1.27 (XML mode)"> |
| <link rel="stylesheet" href="style.css" type="text/css"> |
| </head> |
| <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> |
| <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle"> |
| <td width="100%" align="left" class="shortcuts"> |
| <a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> |
| <a href="#GArrowChunkedArray.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> |
| <a href="#GArrowChunkedArray.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span> |
| <a href="#GArrowChunkedArray.properties" class="shortcut">Properties</a></span> |
| </td> |
| <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> |
| <td><a accesskey="u" href="table.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> |
| <td><a accesskey="p" href="record-batch.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> |
| <td><a accesskey="n" href="table-builder.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> |
| </tr></table> |
| <div class="refentry"> |
| <a name="GArrowChunkedArray"></a><div class="titlepage"></div> |
| <div class="refnamediv"><table width="100%"><tr> |
| <td valign="top"> |
| <h2><span class="refentrytitle"><a name="GArrowChunkedArray.top_of_page"></a>GArrowChunkedArray</span></h2> |
| <p>GArrowChunkedArray — Chunked array class</p> |
| </td> |
| <td class="gallery_image" valign="top" align="right"></td> |
| </tr></table></div> |
| <div class="refsect1"> |
| <a name="GArrowChunkedArray.functions"></a><h2>Functions</h2> |
| <div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| <colgroup> |
| <col width="150px" class="functions_return"> |
| <col class="functions_name"> |
| </colgroup> |
| <tbody> |
| <tr> |
| <td class="function_type"> |
| <a class="link" href="GArrowChunkedArray.html" title="GArrowChunkedArray"><span class="returnvalue">GArrowChunkedArray</span></a> * |
| </td> |
| <td class="function_name"> |
| <a class="link" href="GArrowChunkedArray.html#garrow-chunked-array-new" title="garrow_chunked_array_new ()">garrow_chunked_array_new</a> <span class="c_punctuation">()</span> |
| </td> |
| </tr> |
| <tr> |
| <td class="function_type"> |
| <span class="returnvalue">gboolean</span> |
| </td> |
| <td class="function_name"> |
| <a class="link" href="GArrowChunkedArray.html#garrow-chunked-array-equal" title="garrow_chunked_array_equal ()">garrow_chunked_array_equal</a> <span class="c_punctuation">()</span> |
| </td> |
| </tr> |
| <tr> |
| <td class="function_type"> |
| <a class="link" href="basic-data-type-classes.html#GArrowDataType"><span class="returnvalue">GArrowDataType</span></a> * |
| </td> |
| <td class="function_name"> |
| <a class="link" href="GArrowChunkedArray.html#garrow-chunked-array-get-value-data-type" title="garrow_chunked_array_get_value_data_type ()">garrow_chunked_array_get_value_data_type</a> <span class="c_punctuation">()</span> |
| </td> |
| </tr> |
| <tr> |
| <td class="function_type"> |
| <a class="link" href="arrow-glib-GArrowType.html#GArrowType" title="enum GArrowType"><span class="returnvalue">GArrowType</span></a> |
| </td> |
| <td class="function_name"> |
| <a class="link" href="GArrowChunkedArray.html#garrow-chunked-array-get-value-type" title="garrow_chunked_array_get_value_type ()">garrow_chunked_array_get_value_type</a> <span class="c_punctuation">()</span> |
| </td> |
| </tr> |
| <tr> |
| <td class="function_type"> |
| <span class="returnvalue">guint64</span> |
| </td> |
| <td class="function_name"> |
| <a class="link" href="GArrowChunkedArray.html#garrow-chunked-array-get-length" title="garrow_chunked_array_get_length ()">garrow_chunked_array_get_length</a> <span class="c_punctuation">()</span> |
| </td> |
| </tr> |
| <tr> |
| <td class="function_type"> |
| <span class="returnvalue">guint64</span> |
| </td> |
| <td class="function_name"> |
| <a class="link" href="GArrowChunkedArray.html#garrow-chunked-array-get-n-rows" title="garrow_chunked_array_get_n_rows ()">garrow_chunked_array_get_n_rows</a> <span class="c_punctuation">()</span> |
| </td> |
| </tr> |
| <tr> |
| <td class="function_type"> |
| <span class="returnvalue">guint64</span> |
| </td> |
| <td class="function_name"> |
| <a class="link" href="GArrowChunkedArray.html#garrow-chunked-array-get-n-nulls" title="garrow_chunked_array_get_n_nulls ()">garrow_chunked_array_get_n_nulls</a> <span class="c_punctuation">()</span> |
| </td> |
| </tr> |
| <tr> |
| <td class="function_type"> |
| <span class="returnvalue">guint</span> |
| </td> |
| <td class="function_name"> |
| <a class="link" href="GArrowChunkedArray.html#garrow-chunked-array-get-n-chunks" title="garrow_chunked_array_get_n_chunks ()">garrow_chunked_array_get_n_chunks</a> <span class="c_punctuation">()</span> |
| </td> |
| </tr> |
| <tr> |
| <td class="function_type"> |
| <a class="link" href="basic-array-classes.html#GArrowArray"><span class="returnvalue">GArrowArray</span></a> * |
| </td> |
| <td class="function_name"> |
| <a class="link" href="GArrowChunkedArray.html#garrow-chunked-array-get-chunk" title="garrow_chunked_array_get_chunk ()">garrow_chunked_array_get_chunk</a> <span class="c_punctuation">()</span> |
| </td> |
| </tr> |
| <tr> |
| <td class="function_type"> |
| <span class="returnvalue">GList</span> * |
| </td> |
| <td class="function_name"> |
| <a class="link" href="GArrowChunkedArray.html#garrow-chunked-array-get-chunks" title="garrow_chunked_array_get_chunks ()">garrow_chunked_array_get_chunks</a> <span class="c_punctuation">()</span> |
| </td> |
| </tr> |
| <tr> |
| <td class="function_type"> |
| <a class="link" href="GArrowChunkedArray.html" title="GArrowChunkedArray"><span class="returnvalue">GArrowChunkedArray</span></a> * |
| </td> |
| <td class="function_name"> |
| <a class="link" href="GArrowChunkedArray.html#garrow-chunked-array-slice" title="garrow_chunked_array_slice ()">garrow_chunked_array_slice</a> <span class="c_punctuation">()</span> |
| </td> |
| </tr> |
| <tr> |
| <td class="function_type"> |
| <span class="returnvalue">gchar</span> * |
| </td> |
| <td class="function_name"> |
| <a class="link" href="GArrowChunkedArray.html#garrow-chunked-array-to-string" title="garrow_chunked_array_to_string ()">garrow_chunked_array_to_string</a> <span class="c_punctuation">()</span> |
| </td> |
| </tr> |
| </tbody> |
| </table></div> |
| </div> |
| <div class="refsect1"> |
| <a name="GArrowChunkedArray.properties"></a><h2>Properties</h2> |
| <div class="informaltable"><table class="informaltable" border="0"> |
| <colgroup> |
| <col width="150px" class="properties_type"> |
| <col width="300px" class="properties_name"> |
| <col width="200px" class="properties_flags"> |
| </colgroup> |
| <tbody><tr> |
| <td class="property_type"><span class="type">gpointer</span></td> |
| <td class="property_name"><a class="link" href="GArrowChunkedArray.html#GArrowChunkedArray--chunked-array" title="The “chunked-array” property">chunked-array</a></td> |
| <td class="property_flags">Write / Construct Only</td> |
| </tr></tbody> |
| </table></div> |
| </div> |
| <div class="refsect1"> |
| <a name="GArrowChunkedArray.other"></a><h2>Types and Values</h2> |
| <div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| <colgroup> |
| <col width="150px" class="name"> |
| <col class="description"> |
| </colgroup> |
| <tbody> |
| <tr> |
| <td class="define_keyword">#define</td> |
| <td class="function_name"><a class="link" href="GArrowChunkedArray.html#GARROW-TYPE-CHUNKED-ARRAY:CAPS" title="GARROW_TYPE_CHUNKED_ARRAY">GARROW_TYPE_CHUNKED_ARRAY</a></td> |
| </tr> |
| <tr> |
| <td class="datatype_keyword">struct</td> |
| <td class="function_name"><a class="link" href="GArrowChunkedArray.html#GArrowChunkedArrayClass" title="struct GArrowChunkedArrayClass">GArrowChunkedArrayClass</a></td> |
| </tr> |
| <tr> |
| <td class="datatype_keyword"> </td> |
| <td class="function_name"><a class="link" href="GArrowChunkedArray.html#GArrowChunkedArray-struct" title="GArrowChunkedArray">GArrowChunkedArray</a></td> |
| </tr> |
| </tbody> |
| </table></div> |
| </div> |
| <div class="refsect1"> |
| <a name="GArrowChunkedArray.object-hierarchy"></a><h2>Object Hierarchy</h2> |
| <pre class="screen"> GObject |
| <span class="lineart">╰──</span> GArrowChunkedArray |
| </pre> |
| </div> |
| <div class="refsect1"> |
| <a name="GArrowChunkedArray.description"></a><h2>Description</h2> |
| <p><a class="link" href="GArrowChunkedArray.html" title="GArrowChunkedArray"><span class="type">GArrowChunkedArray</span></a> is a class for chunked array. Chunked array |
| makes a list of <a href="basic-array-classes.html#GArrowArray-struct"><span class="type">GArrowArrays</span></a> one logical large array.</p> |
| </div> |
| <div class="refsect1"> |
| <a name="GArrowChunkedArray.functions_details"></a><h2>Functions</h2> |
| <div class="refsect2"> |
| <a name="garrow-chunked-array-new"></a><h3>garrow_chunked_array_new ()</h3> |
| <pre class="programlisting"><a class="link" href="GArrowChunkedArray.html" title="GArrowChunkedArray"><span class="returnvalue">GArrowChunkedArray</span></a> * |
| garrow_chunked_array_new (<em class="parameter"><code><span class="type">GList</span> *chunks</code></em>);</pre> |
| <div class="refsect3"> |
| <a name="garrow-chunked-array-new.parameters"></a><h4>Parameters</h4> |
| <div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| <colgroup> |
| <col width="150px" class="parameters_name"> |
| <col class="parameters_description"> |
| <col width="200px" class="parameters_annotations"> |
| </colgroup> |
| <tbody><tr> |
| <td class="parameter_name"><p>chunks</p></td> |
| <td class="parameter_description"><p>The array chunks. </p></td> |
| <td class="parameter_annotations"><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> GArrowArray]</span></td> |
| </tr></tbody> |
| </table></div> |
| </div> |
| <div class="refsect3"> |
| <a name="garrow-chunked-array-new.returns"></a><h4>Returns</h4> |
| <p> A newly created <a class="link" href="GArrowChunkedArray.html" title="GArrowChunkedArray"><span class="type">GArrowChunkedArray</span></a>.</p> |
| </div> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="garrow-chunked-array-equal"></a><h3>garrow_chunked_array_equal ()</h3> |
| <pre class="programlisting"><span class="returnvalue">gboolean</span> |
| garrow_chunked_array_equal (<em class="parameter"><code><a class="link" href="GArrowChunkedArray.html" title="GArrowChunkedArray"><span class="type">GArrowChunkedArray</span></a> *chunked_array</code></em>, |
| <em class="parameter"><code><a class="link" href="GArrowChunkedArray.html" title="GArrowChunkedArray"><span class="type">GArrowChunkedArray</span></a> *other_chunked_array</code></em>);</pre> |
| <div class="refsect3"> |
| <a name="garrow-chunked-array-equal.parameters"></a><h4>Parameters</h4> |
| <div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| <colgroup> |
| <col width="150px" class="parameters_name"> |
| <col class="parameters_description"> |
| <col width="200px" class="parameters_annotations"> |
| </colgroup> |
| <tbody> |
| <tr> |
| <td class="parameter_name"><p>chunked_array</p></td> |
| <td class="parameter_description"><p>A <a class="link" href="GArrowChunkedArray.html" title="GArrowChunkedArray"><span class="type">GArrowChunkedArray</span></a>.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| <tr> |
| <td class="parameter_name"><p>other_chunked_array</p></td> |
| <td class="parameter_description"><p>A <a class="link" href="GArrowChunkedArray.html" title="GArrowChunkedArray"><span class="type">GArrowChunkedArray</span></a> to be compared.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| </tbody> |
| </table></div> |
| </div> |
| <div class="refsect3"> |
| <a name="garrow-chunked-array-equal.returns"></a><h4>Returns</h4> |
| <p> <code class="literal">TRUE</code> if both of them have the same data, <code class="literal">FALSE</code> |
| otherwise.</p> |
| </div> |
| <p class="since">Since: <a class="link" href="api-index-0-4-0.html#api-index-0.4.0">0.4.0</a></p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="garrow-chunked-array-get-value-data-type"></a><h3>garrow_chunked_array_get_value_data_type ()</h3> |
| <pre class="programlisting"><a class="link" href="basic-data-type-classes.html#GArrowDataType"><span class="returnvalue">GArrowDataType</span></a> * |
| garrow_chunked_array_get_value_data_type |
| (<em class="parameter"><code><a class="link" href="GArrowChunkedArray.html" title="GArrowChunkedArray"><span class="type">GArrowChunkedArray</span></a> *chunked_array</code></em>);</pre> |
| <div class="refsect3"> |
| <a name="garrow-chunked-array-get-value-data-type.parameters"></a><h4>Parameters</h4> |
| <div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| <colgroup> |
| <col width="150px" class="parameters_name"> |
| <col class="parameters_description"> |
| <col width="200px" class="parameters_annotations"> |
| </colgroup> |
| <tbody><tr> |
| <td class="parameter_name"><p>chunked_array</p></td> |
| <td class="parameter_description"><p>A <a class="link" href="GArrowChunkedArray.html" title="GArrowChunkedArray"><span class="type">GArrowChunkedArray</span></a>.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr></tbody> |
| </table></div> |
| </div> |
| <div class="refsect3"> |
| <a name="garrow-chunked-array-get-value-data-type.returns"></a><h4>Returns</h4> |
| <p>The <a class="link" href="basic-data-type-classes.html#GArrowDataType"><span class="type">GArrowDataType</span></a> of the value of |
| the chunked array. </p> |
| <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> |
| </div> |
| <p class="since">Since: <a class="link" href="api-index-0-9-0.html#api-index-0.9.0">0.9.0</a></p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="garrow-chunked-array-get-value-type"></a><h3>garrow_chunked_array_get_value_type ()</h3> |
| <pre class="programlisting"><a class="link" href="arrow-glib-GArrowType.html#GArrowType" title="enum GArrowType"><span class="returnvalue">GArrowType</span></a> |
| garrow_chunked_array_get_value_type (<em class="parameter"><code><a class="link" href="GArrowChunkedArray.html" title="GArrowChunkedArray"><span class="type">GArrowChunkedArray</span></a> *chunked_array</code></em>);</pre> |
| <div class="refsect3"> |
| <a name="garrow-chunked-array-get-value-type.parameters"></a><h4>Parameters</h4> |
| <div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| <colgroup> |
| <col width="150px" class="parameters_name"> |
| <col class="parameters_description"> |
| <col width="200px" class="parameters_annotations"> |
| </colgroup> |
| <tbody><tr> |
| <td class="parameter_name"><p>chunked_array</p></td> |
| <td class="parameter_description"><p>A <a class="link" href="GArrowChunkedArray.html" title="GArrowChunkedArray"><span class="type">GArrowChunkedArray</span></a>.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr></tbody> |
| </table></div> |
| </div> |
| <div class="refsect3"> |
| <a name="garrow-chunked-array-get-value-type.returns"></a><h4>Returns</h4> |
| <p> The <a class="link" href="arrow-glib-GArrowType.html#GArrowType" title="enum GArrowType"><span class="type">GArrowType</span></a> of the value of the chunked array.</p> |
| </div> |
| <p class="since">Since: <a class="link" href="api-index-0-9-0.html#api-index-0.9.0">0.9.0</a></p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="garrow-chunked-array-get-length"></a><h3>garrow_chunked_array_get_length ()</h3> |
| <pre class="programlisting"><span class="returnvalue">guint64</span> |
| garrow_chunked_array_get_length (<em class="parameter"><code><a class="link" href="GArrowChunkedArray.html" title="GArrowChunkedArray"><span class="type">GArrowChunkedArray</span></a> *chunked_array</code></em>);</pre> |
| <div class="warning"> |
| <p><code class="literal">garrow_chunked_array_get_length</code> has been deprecated since version 0.15.0 and should not be used in newly-written code.</p> |
| <p>Use <a class="link" href="GArrowChunkedArray.html#garrow-chunked-array-get-n-rows" title="garrow_chunked_array_get_n_rows ()"><code class="function">garrow_chunked_array_get_n_rows()</code></a> instead.</p> |
| </div> |
| <div class="refsect3"> |
| <a name="garrow-chunked-array-get-length.parameters"></a><h4>Parameters</h4> |
| <div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| <colgroup> |
| <col width="150px" class="parameters_name"> |
| <col class="parameters_description"> |
| <col width="200px" class="parameters_annotations"> |
| </colgroup> |
| <tbody><tr> |
| <td class="parameter_name"><p>chunked_array</p></td> |
| <td class="parameter_description"><p>A <a class="link" href="GArrowChunkedArray.html" title="GArrowChunkedArray"><span class="type">GArrowChunkedArray</span></a>.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr></tbody> |
| </table></div> |
| </div> |
| <div class="refsect3"> |
| <a name="garrow-chunked-array-get-length.returns"></a><h4>Returns</h4> |
| <p> The total number of rows in the chunked array.</p> |
| </div> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="garrow-chunked-array-get-n-rows"></a><h3>garrow_chunked_array_get_n_rows ()</h3> |
| <pre class="programlisting"><span class="returnvalue">guint64</span> |
| garrow_chunked_array_get_n_rows (<em class="parameter"><code><a class="link" href="GArrowChunkedArray.html" title="GArrowChunkedArray"><span class="type">GArrowChunkedArray</span></a> *chunked_array</code></em>);</pre> |
| <div class="refsect3"> |
| <a name="garrow-chunked-array-get-n-rows.parameters"></a><h4>Parameters</h4> |
| <div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| <colgroup> |
| <col width="150px" class="parameters_name"> |
| <col class="parameters_description"> |
| <col width="200px" class="parameters_annotations"> |
| </colgroup> |
| <tbody><tr> |
| <td class="parameter_name"><p>chunked_array</p></td> |
| <td class="parameter_description"><p>A <a class="link" href="GArrowChunkedArray.html" title="GArrowChunkedArray"><span class="type">GArrowChunkedArray</span></a>.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr></tbody> |
| </table></div> |
| </div> |
| <div class="refsect3"> |
| <a name="garrow-chunked-array-get-n-rows.returns"></a><h4>Returns</h4> |
| <p> The total number of rows in the chunked array.</p> |
| </div> |
| <p class="since">Since: <a class="link" href="api-index-0-15-0.html#api-index-0.15.0">0.15.0</a></p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="garrow-chunked-array-get-n-nulls"></a><h3>garrow_chunked_array_get_n_nulls ()</h3> |
| <pre class="programlisting"><span class="returnvalue">guint64</span> |
| garrow_chunked_array_get_n_nulls (<em class="parameter"><code><a class="link" href="GArrowChunkedArray.html" title="GArrowChunkedArray"><span class="type">GArrowChunkedArray</span></a> *chunked_array</code></em>);</pre> |
| <div class="refsect3"> |
| <a name="garrow-chunked-array-get-n-nulls.parameters"></a><h4>Parameters</h4> |
| <div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| <colgroup> |
| <col width="150px" class="parameters_name"> |
| <col class="parameters_description"> |
| <col width="200px" class="parameters_annotations"> |
| </colgroup> |
| <tbody><tr> |
| <td class="parameter_name"><p>chunked_array</p></td> |
| <td class="parameter_description"><p>A <a class="link" href="GArrowChunkedArray.html" title="GArrowChunkedArray"><span class="type">GArrowChunkedArray</span></a>.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr></tbody> |
| </table></div> |
| </div> |
| <div class="refsect3"> |
| <a name="garrow-chunked-array-get-n-nulls.returns"></a><h4>Returns</h4> |
| <p> The total number of NULL in the chunked array.</p> |
| </div> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="garrow-chunked-array-get-n-chunks"></a><h3>garrow_chunked_array_get_n_chunks ()</h3> |
| <pre class="programlisting"><span class="returnvalue">guint</span> |
| garrow_chunked_array_get_n_chunks (<em class="parameter"><code><a class="link" href="GArrowChunkedArray.html" title="GArrowChunkedArray"><span class="type">GArrowChunkedArray</span></a> *chunked_array</code></em>);</pre> |
| <div class="refsect3"> |
| <a name="garrow-chunked-array-get-n-chunks.parameters"></a><h4>Parameters</h4> |
| <div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| <colgroup> |
| <col width="150px" class="parameters_name"> |
| <col class="parameters_description"> |
| <col width="200px" class="parameters_annotations"> |
| </colgroup> |
| <tbody><tr> |
| <td class="parameter_name"><p>chunked_array</p></td> |
| <td class="parameter_description"><p>A <a class="link" href="GArrowChunkedArray.html" title="GArrowChunkedArray"><span class="type">GArrowChunkedArray</span></a>.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr></tbody> |
| </table></div> |
| </div> |
| <div class="refsect3"> |
| <a name="garrow-chunked-array-get-n-chunks.returns"></a><h4>Returns</h4> |
| <p> The total number of chunks in the chunked array.</p> |
| </div> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="garrow-chunked-array-get-chunk"></a><h3>garrow_chunked_array_get_chunk ()</h3> |
| <pre class="programlisting"><a class="link" href="basic-array-classes.html#GArrowArray"><span class="returnvalue">GArrowArray</span></a> * |
| garrow_chunked_array_get_chunk (<em class="parameter"><code><a class="link" href="GArrowChunkedArray.html" title="GArrowChunkedArray"><span class="type">GArrowChunkedArray</span></a> *chunked_array</code></em>, |
| <em class="parameter"><code><span class="type">guint</span> i</code></em>);</pre> |
| <div class="refsect3"> |
| <a name="garrow-chunked-array-get-chunk.parameters"></a><h4>Parameters</h4> |
| <div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| <colgroup> |
| <col width="150px" class="parameters_name"> |
| <col class="parameters_description"> |
| <col width="200px" class="parameters_annotations"> |
| </colgroup> |
| <tbody> |
| <tr> |
| <td class="parameter_name"><p>chunked_array</p></td> |
| <td class="parameter_description"><p>A <a class="link" href="GArrowChunkedArray.html" title="GArrowChunkedArray"><span class="type">GArrowChunkedArray</span></a>.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| <tr> |
| <td class="parameter_name"><p>i</p></td> |
| <td class="parameter_description"><p>The index of the target chunk.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| </tbody> |
| </table></div> |
| </div> |
| <div class="refsect3"> |
| <a name="garrow-chunked-array-get-chunk.returns"></a><h4>Returns</h4> |
| <p>The i-th chunk of the chunked array. </p> |
| <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> |
| </div> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="garrow-chunked-array-get-chunks"></a><h3>garrow_chunked_array_get_chunks ()</h3> |
| <pre class="programlisting"><span class="returnvalue">GList</span> * |
| garrow_chunked_array_get_chunks (<em class="parameter"><code><a class="link" href="GArrowChunkedArray.html" title="GArrowChunkedArray"><span class="type">GArrowChunkedArray</span></a> *chunked_array</code></em>);</pre> |
| <div class="refsect3"> |
| <a name="garrow-chunked-array-get-chunks.parameters"></a><h4>Parameters</h4> |
| <div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| <colgroup> |
| <col width="150px" class="parameters_name"> |
| <col class="parameters_description"> |
| <col width="200px" class="parameters_annotations"> |
| </colgroup> |
| <tbody><tr> |
| <td class="parameter_name"><p>chunked_array</p></td> |
| <td class="parameter_description"><p>A <a class="link" href="GArrowChunkedArray.html" title="GArrowChunkedArray"><span class="type">GArrowChunkedArray</span></a>.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr></tbody> |
| </table></div> |
| </div> |
| <div class="refsect3"> |
| <a name="garrow-chunked-array-get-chunks.returns"></a><h4>Returns</h4> |
| <p>The chunks in the chunked array. </p> |
| <p><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> GArrowArray][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> |
| </div> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="garrow-chunked-array-slice"></a><h3>garrow_chunked_array_slice ()</h3> |
| <pre class="programlisting"><a class="link" href="GArrowChunkedArray.html" title="GArrowChunkedArray"><span class="returnvalue">GArrowChunkedArray</span></a> * |
| garrow_chunked_array_slice (<em class="parameter"><code><a class="link" href="GArrowChunkedArray.html" title="GArrowChunkedArray"><span class="type">GArrowChunkedArray</span></a> *chunked_array</code></em>, |
| <em class="parameter"><code><span class="type">guint64</span> offset</code></em>, |
| <em class="parameter"><code><span class="type">guint64</span> length</code></em>);</pre> |
| <div class="refsect3"> |
| <a name="garrow-chunked-array-slice.parameters"></a><h4>Parameters</h4> |
| <div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| <colgroup> |
| <col width="150px" class="parameters_name"> |
| <col class="parameters_description"> |
| <col width="200px" class="parameters_annotations"> |
| </colgroup> |
| <tbody> |
| <tr> |
| <td class="parameter_name"><p>chunked_array</p></td> |
| <td class="parameter_description"><p>A <a class="link" href="GArrowChunkedArray.html" title="GArrowChunkedArray"><span class="type">GArrowChunkedArray</span></a>.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| <tr> |
| <td class="parameter_name"><p>offset</p></td> |
| <td class="parameter_description"><p>The offset of sub <a class="link" href="GArrowChunkedArray.html" title="GArrowChunkedArray"><span class="type">GArrowChunkedArray</span></a>.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| <tr> |
| <td class="parameter_name"><p>length</p></td> |
| <td class="parameter_description"><p>The length of sub <a class="link" href="GArrowChunkedArray.html" title="GArrowChunkedArray"><span class="type">GArrowChunkedArray</span></a>.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| </tbody> |
| </table></div> |
| </div> |
| <div class="refsect3"> |
| <a name="garrow-chunked-array-slice.returns"></a><h4>Returns</h4> |
| <p>The sub <a class="link" href="GArrowChunkedArray.html" title="GArrowChunkedArray"><span class="type">GArrowChunkedArray</span></a>. It covers only from |
| <code class="literal">offset</code> to <code class="literal">offset + length</code> range. The sub <a class="link" href="GArrowChunkedArray.html" title="GArrowChunkedArray"><span class="type">GArrowChunkedArray</span></a> shares |
| values with the base <a class="link" href="GArrowChunkedArray.html" title="GArrowChunkedArray"><span class="type">GArrowChunkedArray</span></a>. </p> |
| <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> |
| </div> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="garrow-chunked-array-to-string"></a><h3>garrow_chunked_array_to_string ()</h3> |
| <pre class="programlisting"><span class="returnvalue">gchar</span> * |
| garrow_chunked_array_to_string (<em class="parameter"><code><a class="link" href="GArrowChunkedArray.html" title="GArrowChunkedArray"><span class="type">GArrowChunkedArray</span></a> *chunked_array</code></em>, |
| <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre> |
| <div class="refsect3"> |
| <a name="garrow-chunked-array-to-string.parameters"></a><h4>Parameters</h4> |
| <div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| <colgroup> |
| <col width="150px" class="parameters_name"> |
| <col class="parameters_description"> |
| <col width="200px" class="parameters_annotations"> |
| </colgroup> |
| <tbody> |
| <tr> |
| <td class="parameter_name"><p>chunked_array</p></td> |
| <td class="parameter_description"><p>A <a class="link" href="GArrowChunkedArray.html" title="GArrowChunkedArray"><span class="type">GArrowChunkedArray</span></a>.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| <tr> |
| <td class="parameter_name"><p>error</p></td> |
| <td class="parameter_description"><p>Return location for a <span class="type">GError</span> or <code class="literal">NULL</code>. </p></td> |
| <td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> |
| </tr> |
| </tbody> |
| </table></div> |
| </div> |
| <div class="refsect3"> |
| <a name="garrow-chunked-array-to-string.returns"></a><h4>Returns</h4> |
| <p>The formatted chunked array content or <code class="literal">NULL</code> on error.</p> |
| <p> It should be freed with <code class="function">g_free()</code> when no longer needed. </p> |
| <p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></p> |
| </div> |
| <p class="since">Since: <a class="link" href="api-index-0-11-0.html#api-index-0.11.0">0.11.0</a></p> |
| </div> |
| </div> |
| <div class="refsect1"> |
| <a name="GArrowChunkedArray.other_details"></a><h2>Types and Values</h2> |
| <div class="refsect2"> |
| <a name="GARROW-TYPE-CHUNKED-ARRAY:CAPS"></a><h3>GARROW_TYPE_CHUNKED_ARRAY</h3> |
| <pre class="programlisting">#define GARROW_TYPE_CHUNKED_ARRAY (garrow_chunked_array_get_type()) |
| </pre> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GArrowChunkedArrayClass"></a><h3>struct GArrowChunkedArrayClass</h3> |
| <pre class="programlisting">struct GArrowChunkedArrayClass { |
| GObjectClass parent_class; |
| }; |
| </pre> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GArrowChunkedArray-struct"></a><h3>GArrowChunkedArray</h3> |
| <pre class="programlisting">typedef struct _GArrowChunkedArray GArrowChunkedArray;</pre> |
| </div> |
| </div> |
| <div class="refsect1"> |
| <a name="GArrowChunkedArray.property-details"></a><h2>Property Details</h2> |
| <div class="refsect2"> |
| <a name="GArrowChunkedArray--chunked-array"></a><h3>The <code class="literal">“chunked-array”</code> property</h3> |
| <pre class="programlisting"> “chunked-array” <span class="type">gpointer</span></pre> |
| <p>The raw std::shared<arrow::ChunkedArray> *.</p> |
| <p>Flags: Write / Construct Only</p> |
| </div> |
| </div> |
| </div> |
| <div class="footer"> |
| <hr>Generated by GTK-Doc V1.27</div> |
| <script type="text/javascript" src="/docs/_static/versionwarning.js"></script></body> |
| </html> |
