blob: ed415b289cbbb759e9d44d036ecad25091f24bb4 [file] [log] [blame]
<!--
SPDX-FileCopyrightText: The Apache Software Foundation
SPDX-License-Identifier: Apache-2.0
-->
<!DOCTYPE html>
<html lang="en">
<head>
<title>Arrow.Array</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta charset="utf-8" />
<meta property="og:type" content="website"/>
<meta property="og:title" content="Arrow.Array"/>
<meta property="og:description" content="Reference for Arrow.Array"/>
<meta name="twitter:title" content="Arrow.Array"/>
<meta name="twitter:description" content="Reference for Arrow.Array"/>
<meta name="twitter:card" content="summary"/>
<link rel="stylesheet" href="style.css" type="text/css" />
<script src="urlmap.js"></script>
<script src="fzy.js"></script>
<script src="search.js"></script>
<script src="main.js"></script>
</head>
<body>
<div id="body-wrapper" tabindex="-1">
<nav class="sidebar devhelp-hidden">
<div class="search section">
<form id="search-form" autocomplete="off">
<input id="search-input" type="text" name="do-not-autocomplete" placeholder="Click, or press 's' to search" autocomplete="off"/>
</form>
</div>
<div class="section namespace">
<h3><a href="index.html">Arrow</a></h3>
<p>API Version: 1.0</p>
<p>Library Version: 23.0.0.dev</p>
</div>
<div class="section">
<h5>Type</h5>
<div class="links">
<a class="current" href="class.Array.html#description">Array</a>
</div>
</div>
<div class="section">
<h5>Functions</h5>
<div class="links">
<a class="func" href="type_func.Array.import.html">import</a>
</div>
</div>
<div class="section">
<h5>Instance methods</h5>
<div class="links">
<a class="method" href="method.Array.cast.html">cast</a>
<a class="method" href="method.Array.concatenate.html">concatenate</a>
<a class="method" href="method.Array.count.html">count</a>
<a class="method" href="method.Array.count_values.html">count_values</a>
<a class="method" href="method.Array.dictionary_encode.html">dictionary_encode</a>
<a class="method" href="method.Array.diff_unified.html">diff_unified</a>
<a class="method" href="method.Array.equal.html">equal</a>
<a class="method" href="method.Array.equal_approx.html">equal_approx</a>
<a class="method" href="method.Array.equal_options.html">equal_options</a>
<a class="method" href="method.Array.equal_range.html">equal_range</a>
<a class="method" href="method.Array.export.html">export</a>
<a class="method" href="method.Array.filter.html">filter</a>
<a class="method" href="method.Array.get_length.html">get_length</a>
<a class="method" href="method.Array.get_n_nulls.html">get_n_nulls</a>
<a class="method" href="method.Array.get_null_bitmap.html">get_null_bitmap</a>
<a class="method" href="method.Array.get_offset.html">get_offset</a>
<a class="method" href="method.Array.get_statistics.html">get_statistics</a>
<a class="method" href="method.Array.get_value_data_type.html">get_value_data_type</a>
<a class="method" href="method.Array.get_value_type.html">get_value_type</a>
<a class="method" href="method.Array.is_in.html">is_in</a>
<a class="method" href="method.Array.is_in_chunked_array.html">is_in_chunked_array</a>
<a class="method" href="method.Array.is_null.html">is_null</a>
<a class="method" href="method.Array.is_valid.html">is_valid</a>
<a class="method" href="method.Array.run_end_encode.html">run_end_encode</a>
<a class="method" href="method.Array.slice.html">slice</a>
<a class="method" href="method.Array.sort_indices.html">sort_indices</a>
<a class="method" href="method.Array.sort_to_indices.html">sort_to_indices</a>
<a class="method" href="method.Array.take.html">take</a>
<a class="method" href="method.Array.take_chunked_array.html">take_chunked_array</a>
<a class="method" href="method.Array.to_string.html">to_string</a>
<a class="method" href="method.Array.unique.html">unique</a>
<a class="method" href="method.Array.validate.html">validate</a>
<a class="method" href="method.Array.validate_full.html">validate_full</a>
<a class="method" href="method.Array.view.html">view</a>
</div>
</div>
<div class="section">
<h5>Properties</h5>
<div class="links">
<a class="property" href="property.Array.array.html">array</a>
<a class="property" href="property.Array.buffer1.html">buffer1</a>
<a class="property" href="property.Array.buffer2.html">buffer2</a>
<a class="property" href="property.Array.null-bitmap.html">null-bitmap</a>
<a class="property" href="property.Array.parent.html">parent</a>
<a class="property" href="property.Array.value-data-type.html">value-data-type</a>
</div>
</div>
<div class="section generator">
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.1</p>
</div>
</nav>
<button id="btn-to-top" class="hidden"><span class="up-arrow"></span></button>
<section id="main" class="content">
<header>
<h3>Class</h3>
<h1 aria-label="Name"><a href="index.html">Arrow</a><span class="sep" role="presentation"></span>Array</h1>
</header>
<section>
<summary>
<div class="docblock">
<p></p>
</div>
<div class="toggle-wrapper">
<h4 id="description" style="display:flex;">
Description
<a href="#description" class="anchor"></a>
</h4>
<pre><code>abstract class Arrow.Array : GObject.Object {
parent_instance: GObject
}</pre></code>
<div class="docblock">
No description available.
</div>
<div class="docblock">
</div>
</div>
</summary>
<div class="toggle-wrapper ancestors">
<h4 id="ancestors">
Ancestors
<a href="#ancestors" class="anchor"></a>
</h4>
<div class="docblock">
<ul>
<li class="class"><a class="external" href="javascript:void(0)" data-link="class.Object.html" data-namespace="GObject">GObject</a></li>
</ul>
</div>
</div>
<div class="descendants toggle-wrapper default-hide">
<h4 id="descendants">Descendants <a href="#descendants" class="anchor"></a></h4>
<div class="docblock">
<ul>
<li class="class"><a href="class.BinaryArray.html" title="BinaryArray">GArrowBinaryArray</a></li>
<li class="class"><a href="class.BinaryViewArray.html" title="BinaryViewArray">GArrowBinaryViewArray</a></li>
<li class="class"><a href="class.DictionaryArray.html" title="DictionaryArray">GArrowDictionaryArray</a></li>
<li class="class"><a href="class.ExtensionArray.html" title="ExtensionArray">GArrowExtensionArray</a></li>
<li class="class"><a href="class.LargeBinaryArray.html" title="LargeBinaryArray">GArrowLargeBinaryArray</a></li>
<li class="class"><a href="class.LargeListArray.html" title="LargeListArray">GArrowLargeListArray</a></li>
<li class="class"><a href="class.ListArray.html" title="ListArray">GArrowListArray</a></li>
<li class="class"><a href="class.NullArray.html" title="NullArray">GArrowNullArray</a></li>
<li class="class"><a href="class.PrimitiveArray.html" title="PrimitiveArray">GArrowPrimitiveArray</a></li>
<li class="class"><a href="class.RunEndEncodedArray.html" title="RunEndEncodedArray">GArrowRunEndEncodedArray</a></li>
<li class="class"><a href="class.StructArray.html" title="StructArray">GArrowStructArray</a></li>
<li class="class"><a href="class.UnionArray.html" title="UnionArray">GArrowUnionArray</a></li>
</ul>
</div>
</div>
<div class="toggle-wrapper methods">
<h4 id="type-functions">
Functions
<a href="#type-functions" class="anchor"></a>
</h4>
<div class="docblock">
<div class="">
<h6><a href="type_func.Array.import.html">garrow_array_import</a></h6>
<div class="docblock">
No description available.
</div>
<div class="docblock">
<p><span class="emblem available">since: 6.0.0</span></p>
</div>
</div>
</div>
</div>
<div class="toggle-wrapper methods">
<h4 id="methods">
Instance methods
<a href="#methods" class="anchor"></a>
</h4>
<div class="docblock">
<div class="">
<h6><a href="method.Array.cast.html">garrow_array_cast</a></h6>
<div class="docblock">
No description available.
</div>
<div class="docblock">
<p><span class="emblem available">since: 0.7.0</span></p>
</div>
</div>
<div class="">
<h6><a href="method.Array.concatenate.html">garrow_array_concatenate</a></h6>
<div class="docblock">
No description available.
</div>
<div class="docblock">
<p><span class="emblem available">since: 4.0.0</span></p>
</div>
</div>
<div class="">
<h6><a href="method.Array.count.html">garrow_array_count</a></h6>
<div class="docblock">
No description available.
</div>
<div class="docblock">
<p><span class="emblem available">since: 0.13.0</span></p>
</div>
</div>
<div class="">
<h6><a href="method.Array.count_values.html">garrow_array_count_values</a></h6>
<div class="docblock">
No description available.
</div>
<div class="docblock">
<p><span class="emblem available">since: 0.13.0</span></p>
</div>
</div>
<div class="">
<h6><a href="method.Array.dictionary_encode.html">garrow_array_dictionary_encode</a></h6>
<div class="docblock">
No description available.
</div>
<div class="docblock">
<p><span class="emblem available">since: 0.8.0</span></p>
</div>
</div>
<div class="">
<h6><a href="method.Array.diff_unified.html">garrow_array_diff_unified</a></h6>
<div class="docblock">
No description available.
</div>
<div class="docblock">
<p><span class="emblem available">since: 0.15.0</span></p>
</div>
</div>
<div class="">
<h6><a href="method.Array.equal.html">garrow_array_equal</a></h6>
<div class="docblock">
No description available.
</div>
<div class="docblock">
<p><span class="emblem available">since: 0.4.0</span></p>
</div>
</div>
<div class="">
<h6><a href="method.Array.equal_approx.html">garrow_array_equal_approx</a></h6>
<div class="docblock">
No description available.
</div>
<div class="docblock">
<p><span class="emblem available">since: 0.4.0</span></p>
</div>
</div>
<div class="">
<h6><a href="method.Array.equal_options.html">garrow_array_equal_options</a></h6>
<div class="docblock">
No description available.
</div>
<div class="docblock">
<p><span class="emblem available">since: 5.0.0</span></p>
</div>
</div>
<div class="">
<h6><a href="method.Array.equal_range.html">garrow_array_equal_range</a></h6>
<div class="docblock">
No description available.
</div>
<div class="docblock">
<p><span class="emblem available">since: 0.4.0</span></p>
</div>
</div>
<div class="">
<h6><a href="method.Array.export.html">garrow_array_export</a></h6>
<div class="docblock">
No description available.
</div>
<div class="docblock">
<p><span class="emblem available">since: 6.0.0</span></p>
</div>
</div>
<div class="">
<h6><a href="method.Array.filter.html">garrow_array_filter</a></h6>
<div class="docblock">
No description available.
</div>
<div class="docblock">
<p><span class="emblem available">since: 0.15.0</span></p>
</div>
</div>
<div class="">
<h6><a href="method.Array.get_length.html">garrow_array_get_length</a></h6>
<div class="docblock">
No description available.
</div>
<div class="docblock">
<p></p>
</div>
</div>
<div class="">
<h6><a href="method.Array.get_n_nulls.html">garrow_array_get_n_nulls</a></h6>
<div class="docblock">
No description available.
</div>
<div class="docblock">
<p></p>
</div>
</div>
<div class="">
<h6><a href="method.Array.get_null_bitmap.html">garrow_array_get_null_bitmap</a></h6>
<div class="docblock">
No description available.
</div>
<div class="docblock">
<p><span class="emblem available">since: 0.3.0</span></p>
</div>
</div>
<div class="">
<h6><a href="method.Array.get_offset.html">garrow_array_get_offset</a></h6>
<div class="docblock">
No description available.
</div>
<div class="docblock">
<p></p>
</div>
</div>
<div class="">
<h6><a href="method.Array.get_statistics.html">garrow_array_get_statistics</a></h6>
<div class="docblock">
No description available.
</div>
<div class="docblock">
<p><span class="emblem available">since: 20.0.0</span></p>
</div>
</div>
<div class="">
<h6><a href="method.Array.get_value_data_type.html">garrow_array_get_value_data_type</a></h6>
<div class="docblock">
No description available.
</div>
<div class="docblock">
<p><span class="emblem available">since: 0.3.0</span></p>
</div>
</div>
<div class="">
<h6><a href="method.Array.get_value_type.html">garrow_array_get_value_type</a></h6>
<div class="docblock">
No description available.
</div>
<div class="docblock">
<p><span class="emblem available">since: 0.3.0</span></p>
</div>
</div>
<div class="">
<h6><a href="method.Array.is_in.html">garrow_array_is_in</a></h6>
<div class="docblock">
No description available.
</div>
<div class="docblock">
<p><span class="emblem available">since: 0.15.0</span></p>
</div>
</div>
<div class="">
<h6><a href="method.Array.is_in_chunked_array.html">garrow_array_is_in_chunked_array</a></h6>
<div class="docblock">
No description available.
</div>
<div class="docblock">
<p><span class="emblem available">since: 0.15.0</span></p>
</div>
</div>
<div class="">
<h6><a href="method.Array.is_null.html">garrow_array_is_null</a></h6>
<div class="docblock">
No description available.
</div>
<div class="docblock">
<p><span class="emblem available">since: 0.3.0</span></p>
</div>
</div>
<div class="">
<h6><a href="method.Array.is_valid.html">garrow_array_is_valid</a></h6>
<div class="docblock">
No description available.
</div>
<div class="docblock">
<p><span class="emblem available">since: 0.8.0</span></p>
</div>
</div>
<div class="">
<h6><a href="method.Array.run_end_encode.html">garrow_array_run_end_encode</a></h6>
<div class="docblock">
No description available.
</div>
<div class="docblock">
<p><span class="emblem available">since: 13.0.0</span></p>
</div>
</div>
<div class="">
<h6><a href="method.Array.slice.html">garrow_array_slice</a></h6>
<div class="docblock">
No description available.
</div>
<div class="docblock">
<p></p>
</div>
</div>
<div class="">
<h6><a href="method.Array.sort_indices.html">garrow_array_sort_indices</a></h6>
<div class="docblock">
No description available.
</div>
<div class="docblock">
<p><span class="emblem available">since: 3.0.0</span></p>
</div>
</div>
<div class="deprecated">
<h6><a href="method.Array.sort_to_indices.html">garrow_array_sort_to_indices</a></h6>
<div class="docblock">
No description available.
</div>
<div class="docblock">
<p><span class="emblem deprecated">deprecated: 3.0.0</span>&nbsp;<span class="emblem available">since: 0.15.0</span></p>
</div>
</div>
<div class="">
<h6><a href="method.Array.take.html">garrow_array_take</a></h6>
<div class="docblock">
No description available.
</div>
<div class="docblock">
<p><span class="emblem available">since: 0.14.0</span></p>
</div>
</div>
<div class="">
<h6><a href="method.Array.take_chunked_array.html">garrow_array_take_chunked_array</a></h6>
<div class="docblock">
No description available.
</div>
<div class="docblock">
<p><span class="emblem available">since: 0.16.0</span></p>
</div>
</div>
<div class="">
<h6><a href="method.Array.to_string.html">garrow_array_to_string</a></h6>
<div class="docblock">
No description available.
</div>
<div class="docblock">
<p><span class="emblem available">since: 0.4.0</span></p>
</div>
</div>
<div class="">
<h6><a href="method.Array.unique.html">garrow_array_unique</a></h6>
<div class="docblock">
No description available.
</div>
<div class="docblock">
<p><span class="emblem available">since: 0.8.0</span></p>
</div>
</div>
<div class="">
<h6><a href="method.Array.validate.html">garrow_array_validate</a></h6>
<div class="docblock">
No description available.
</div>
<div class="docblock">
<p><span class="emblem available">since: 20.0.0</span></p>
</div>
</div>
<div class="">
<h6><a href="method.Array.validate_full.html">garrow_array_validate_full</a></h6>
<div class="docblock">
No description available.
</div>
<div class="docblock">
<p><span class="emblem available">since: 20.0.0</span></p>
</div>
</div>
<div class="">
<h6><a href="method.Array.view.html">garrow_array_view</a></h6>
<div class="docblock">
No description available.
</div>
<div class="docblock">
<p><span class="emblem available">since: 0.15.0</span></p>
</div>
</div>
</div>
<div class="toggle-wrapper default-hide ancestor-methods"><h5 style="display:block;">Methods inherited from <a class="external" href="javascript:void(0)" data-link="class.Object.html" data-namespace="GObject">GObject</a> (43)</h5>
<div class="docblock">
<div class="docblock">
<p>Please see&nbsp;<a class="external" href="javascript:void(0)" data-link="class.Object.html#methods" data-namespace="GObject">GObject</a>&nbsp;for a full list of methods.</em></p>
</div>
</div>
</div>
</div>
<div class="toggle-wrapper properties">
<h4 id="properties">
Properties
<a href="#properties" class="anchor"></a>
</h4>
<div class="docblock">
<div class="">
<h6><a href="property.Array.array.html">Arrow.Array:array</a></h6>
<div class="docblock">
No description available.
</div>
<div class="docblock">
<p></p>
</div>
</div>
<div class="">
<h6><a href="property.Array.buffer1.html">Arrow.Array:buffer1</a></h6>
<div class="docblock">
No description available.
</div>
<div class="docblock">
<p></p>
</div>
</div>
<div class="">
<h6><a href="property.Array.buffer2.html">Arrow.Array:buffer2</a></h6>
<div class="docblock">
No description available.
</div>
<div class="docblock">
<p></p>
</div>
</div>
<div class="">
<h6><a href="property.Array.null-bitmap.html">Arrow.Array:null-bitmap</a></h6>
<div class="docblock">
No description available.
</div>
<div class="docblock">
<p></p>
</div>
</div>
<div class="">
<h6><a href="property.Array.parent.html">Arrow.Array:parent</a></h6>
<div class="docblock">
No description available.
</div>
<div class="docblock">
<p></p>
</div>
</div>
<div class="">
<h6><a href="property.Array.value-data-type.html">Arrow.Array:value-data-type</a></h6>
<div class="docblock">
No description available.
</div>
<div class="docblock">
<p></p>
</div>
</div>
</div>
</div>
<div class="signals toggle-wrapper">
<h4 id="signals">
Signals
<a href="#signals" class="anchor"></a>
</h4>
<div class="toggle-wrapper default-hide ancestor-signals"><h5 style="display:block;">Signals inherited from <a class="external" href="javascript:void(0)" data-link="class.Object.html" data-namespace="GObject">GObject</a> (1)</h5>
<div class="docblock">
<h6><a class="external" href="javascript:void(0)" data-namespace="GObject" data-link="signal.Object.notify.html">GObject::notify</a></h6>
<div class="docblock">
<p>The notify signal is emitted on an object when one of its properties has
its value set through g_object_set_property(), g_object_set(), et&nbsp;al.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
</div>
</div>
<div class="class toggle-wrapper default-hide">
<h4 id="class-struct">
Class structure
<a href="#class-struct" class="anchor"></a>
</h4>
<div class="docblock">
<pre><code>struct ArrowArrayClass {
GObjectClass parent_class;
}</code></pre>
</div>
<div class="docblock">
No description available.
</div>
<div class="docblock">
<h6>Class members</h6>
<dl class="members">
<dt><code>parent_class: GObjectClass</code></dt>
<dd>No description available.</dd>
</dd>
</div>
</div>
</section>
</section>
<div id="toc" class="toc">
<nav aria-labelledby="toc-title">
<p id="toc-title">Content</p>
<ul class="toc-list">
<li class="toc-list-item"><a href="#description"><span class="link-text">Description</span></a></li>
<li class="toc-list-item"><a href="#ancestors"><span class="link-text">Ancestors</span></a></li>
<li class="toc-list-item"><a href="#type-functions"><span class="link-text">Functions</span></a></li>
<li class="toc-list-item"><a href="#methods"><span class="link-text">Methods</span></a></li>
<li class="toc-list-item"><a href="#properties"><span class="link-text">Properties</span></a></li>
</ul>
</nav>
</div>
<section id="search" class="content hidden"></section>
<footer>
</footer>
</div>
</body>
</html>