http://git-wip-us.apache.org/repos/asf/arrow-site/blob/3cd84682/build/docs/c_glib/GArrowTable.html ---------------------------------------------------------------------- diff --git a/build/docs/c_glib/GArrowTable.html b/build/docs/c_glib/GArrowTable.html new file mode 100644 index 0000000..a730171 --- /dev/null +++ b/build/docs/c_glib/GArrowTable.html @@ -0,0 +1,441 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>GArrowTable: arrow-glib Reference Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> +<link rel="home" href="index.html" title="arrow-glib Reference Manual"> +<link rel="up" href="table.html" title="Table"> +<link rel="prev" href="table.html" title="Table"> +<link rel="next" href="GArrowRecordBatch.html" title="GArrowRecordBatch"> +<meta name="generator" content="GTK-Doc V1.25 (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="#GArrowTable.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> + <a href="#GArrowTable.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties">  <span class="dim">|</span> + <a href="#GArrowTable.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="table.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="GArrowRecordBatch.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="GArrowTable"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="GArrowTable.top_of_page"></a>GArrowTable</span></h2> +<p>GArrowTable â Table class</p> +</td> +<td class="gallery_image" valign="top" align="right"></td> +</tr></table></div> +<div class="refsect1"> +<a name="GArrowTable.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="GArrowTable.html" title="GArrowTable"><span class="returnvalue">GArrowTable</span></a> * +</td> +<td class="function_name"> +<a class="link" href="GArrowTable.html#garrow-table-new" title="garrow_table_new ()">garrow_table_new</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<GTKDOCLINK HREF="gboolean"><span class="returnvalue">gboolean</span></GTKDOCLINK> +</td> +<td class="function_name"> +<a class="link" href="GArrowTable.html#garrow-table-equal" title="garrow_table_equal ()">garrow_table_equal</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a class="link" href="GArrowSchema.html" title="GArrowSchema"><span class="returnvalue">GArrowSchema</span></a> * +</td> +<td class="function_name"> +<a class="link" href="GArrowTable.html#garrow-table-get-schema" title="garrow_table_get_schema ()">garrow_table_get_schema</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a class="link" href="GArrowColumn.html" title="GArrowColumn"><span class="returnvalue">GArrowColumn</span></a> * +</td> +<td class="function_name"> +<a class="link" href="GArrowTable.html#garrow-table-get-column" title="garrow_table_get_column ()">garrow_table_get_column</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<GTKDOCLINK HREF="guint"><span class="returnvalue">guint</span></GTKDOCLINK> +</td> +<td class="function_name"> +<a class="link" href="GArrowTable.html#garrow-table-get-n-columns" title="garrow_table_get_n_columns ()">garrow_table_get_n_columns</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<GTKDOCLINK HREF="guint64"><span class="returnvalue">guint64</span></GTKDOCLINK> +</td> +<td class="function_name"> +<a class="link" href="GArrowTable.html#garrow-table-get-n-rows" title="garrow_table_get_n_rows ()">garrow_table_get_n_rows</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a class="link" href="GArrowTable.html" title="GArrowTable"><span class="returnvalue">GArrowTable</span></a> * +</td> +<td class="function_name"> +<a class="link" href="GArrowTable.html#garrow-table-add-column" title="garrow_table_add_column ()">garrow_table_add_column</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a class="link" href="GArrowTable.html" title="GArrowTable"><span class="returnvalue">GArrowTable</span></a> * +</td> +<td class="function_name"> +<a class="link" href="GArrowTable.html#garrow-table-remove-column" title="garrow_table_remove_column ()">garrow_table_remove_column</a> <span class="c_punctuation">()</span> +</td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="GArrowTable.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"><GTKDOCLINK HREF="gpointer"><span class="type">gpointer</span></GTKDOCLINK></td> +<td class="property_name"><a class="link" href="GArrowTable.html#GArrowTable--table" title="The âtableâ property">table</a></td> +<td class="property_flags">Write / Construct Only</td> +</tr></tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="GArrowTable.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="datatype_keyword">struct</td> +<td class="function_name"><a class="link" href="GArrowTable.html#GArrowTable-struct" title="struct GArrowTable">GArrowTable</a></td> +</tr></tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="GArrowTable.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="screen"> <GTKDOCLINK HREF="GObject">GObject</GTKDOCLINK> + <span class="lineart">â°ââ</span> GArrowTable +</pre> +</div> +<div class="refsect1"> +<a name="GArrowTable.description"></a><h2>Description</h2> +<p><a class="link" href="GArrowTable.html" title="GArrowTable"><span class="type">GArrowTable</span></a> is a class for table. Table has zero or more +<GTKDOCLINK HREF="GArrowColumns"><span class="type">GArrowColumns</span></GTKDOCLINK> and zero or more records.</p> +</div> +<div class="refsect1"> +<a name="GArrowTable.functions_details"></a><h2>Functions</h2> +<div class="refsect2"> +<a name="garrow-table-new"></a><h3>garrow_table_new ()</h3> +<pre class="programlisting"><a class="link" href="GArrowTable.html" title="GArrowTable"><span class="returnvalue">GArrowTable</span></a> * +garrow_table_new (<em class="parameter"><code><a class="link" href="GArrowSchema.html" title="GArrowSchema"><span class="type">GArrowSchema</span></a> *schema</code></em>, + <em class="parameter"><code><GTKDOCLINK HREF="GList"><span class="type">GList</span></GTKDOCLINK> *columns</code></em>);</pre> +<div class="refsect3"> +<a name="garrow-table-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>schema</p></td> +<td class="parameter_description"><p>The schema of the table.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>columns</p></td> +<td class="parameter_description"><p> The columns of the table. </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> GArrowColumn]</span></td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="garrow-table-new.returns"></a><h4>Returns</h4> +<p> A newly created <a class="link" href="GArrowTable.html" title="GArrowTable"><span class="type">GArrowTable</span></a>.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="garrow-table-equal"></a><h3>garrow_table_equal ()</h3> +<pre class="programlisting"><GTKDOCLINK HREF="gboolean"><span class="returnvalue">gboolean</span></GTKDOCLINK> +garrow_table_equal (<em class="parameter"><code><a class="link" href="GArrowTable.html" title="GArrowTable"><span class="type">GArrowTable</span></a> *table</code></em>, + <em class="parameter"><code><a class="link" href="GArrowTable.html" title="GArrowTable"><span class="type">GArrowTable</span></a> *other_table</code></em>);</pre> +<div class="refsect3"> +<a name="garrow-table-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>table</p></td> +<td class="parameter_description"><p>A <a class="link" href="GArrowTable.html" title="GArrowTable"><span class="type">GArrowTable</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>other_table</p></td> +<td class="parameter_description"><p>A <a class="link" href="GArrowTable.html" title="GArrowTable"><span class="type">GArrowTable</span></a> to be compared.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="garrow-table-equal.returns"></a><h4>Returns</h4> +<p> <GTKDOCLINK HREF="TRUE:CAPS"><code class="literal">TRUE</code></GTKDOCLINK> if both of them have the same data, <GTKDOCLINK HREF="FALSE:CAPS"><code class="literal">FALSE</code></GTKDOCLINK> +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-table-get-schema"></a><h3>garrow_table_get_schema ()</h3> +<pre class="programlisting"><a class="link" href="GArrowSchema.html" title="GArrowSchema"><span class="returnvalue">GArrowSchema</span></a> * +garrow_table_get_schema (<em class="parameter"><code><a class="link" href="GArrowTable.html" title="GArrowTable"><span class="type">GArrowTable</span></a> *table</code></em>);</pre> +<div class="refsect3"> +<a name="garrow-table-get-schema.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>table</p></td> +<td class="parameter_description"><p>A <a class="link" href="GArrowTable.html" title="GArrowTable"><span class="type">GArrowTable</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="garrow-table-get-schema.returns"></a><h4>Returns</h4> +<p> The schema of the table. </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-table-get-column"></a><h3>garrow_table_get_column ()</h3> +<pre class="programlisting"><a class="link" href="GArrowColumn.html" title="GArrowColumn"><span class="returnvalue">GArrowColumn</span></a> * +garrow_table_get_column (<em class="parameter"><code><a class="link" href="GArrowTable.html" title="GArrowTable"><span class="type">GArrowTable</span></a> *table</code></em>, + <em class="parameter"><code><GTKDOCLINK HREF="guint"><span class="type">guint</span></GTKDOCLINK> i</code></em>);</pre> +<div class="refsect3"> +<a name="garrow-table-get-column.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>table</p></td> +<td class="parameter_description"><p>A <a class="link" href="GArrowTable.html" title="GArrowTable"><span class="type">GArrowTable</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 column.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="garrow-table-get-column.returns"></a><h4>Returns</h4> +<p> The i-th column in the table. </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-table-get-n-columns"></a><h3>garrow_table_get_n_columns ()</h3> +<pre class="programlisting"><GTKDOCLINK HREF="guint"><span class="returnvalue">guint</span></GTKDOCLINK> +garrow_table_get_n_columns (<em class="parameter"><code><a class="link" href="GArrowTable.html" title="GArrowTable"><span class="type">GArrowTable</span></a> *table</code></em>);</pre> +<div class="refsect3"> +<a name="garrow-table-get-n-columns.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>table</p></td> +<td class="parameter_description"><p>A <a class="link" href="GArrowTable.html" title="GArrowTable"><span class="type">GArrowTable</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="garrow-table-get-n-columns.returns"></a><h4>Returns</h4> +<p> The number of columns in the table.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="garrow-table-get-n-rows"></a><h3>garrow_table_get_n_rows ()</h3> +<pre class="programlisting"><GTKDOCLINK HREF="guint64"><span class="returnvalue">guint64</span></GTKDOCLINK> +garrow_table_get_n_rows (<em class="parameter"><code><a class="link" href="GArrowTable.html" title="GArrowTable"><span class="type">GArrowTable</span></a> *table</code></em>);</pre> +<div class="refsect3"> +<a name="garrow-table-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>table</p></td> +<td class="parameter_description"><p>A <a class="link" href="GArrowTable.html" title="GArrowTable"><span class="type">GArrowTable</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="garrow-table-get-n-rows.returns"></a><h4>Returns</h4> +<p> The number of rows in the table.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="garrow-table-add-column"></a><h3>garrow_table_add_column ()</h3> +<pre class="programlisting"><a class="link" href="GArrowTable.html" title="GArrowTable"><span class="returnvalue">GArrowTable</span></a> * +garrow_table_add_column (<em class="parameter"><code><a class="link" href="GArrowTable.html" title="GArrowTable"><span class="type">GArrowTable</span></a> *table</code></em>, + <em class="parameter"><code><GTKDOCLINK HREF="guint"><span class="type">guint</span></GTKDOCLINK> i</code></em>, + <em class="parameter"><code><a class="link" href="GArrowColumn.html" title="GArrowColumn"><span class="type">GArrowColumn</span></a> *column</code></em>, + <em class="parameter"><code><GTKDOCLINK HREF="GError"><span class="type">GError</span></GTKDOCLINK> **error</code></em>);</pre> +<div class="refsect3"> +<a name="garrow-table-add-column.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>table</p></td> +<td class="parameter_description"><p>A <a class="link" href="GArrowTable.html" title="GArrowTable"><span class="type">GArrowTable</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 new column.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>column</p></td> +<td class="parameter_description"><p>The column to be added.</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 <GTKDOCLINK HREF="GError"><span class="type">GError</span></GTKDOCLINK> or <GTKDOCLINK HREF="NULL:CAPS"><code class="literal">NULL</code></GTKDOCLINK>. </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-table-add-column.returns"></a><h4>Returns</h4> +<p> The newly allocated +<a class="link" href="GArrowTable.html" title="GArrowTable"><span class="type">GArrowTable</span></a> that has a new column or <GTKDOCLINK HREF="NULL:CAPS"><code class="literal">NULL</code></GTKDOCLINK> on error. </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>][<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-3-0.html#api-index-0.3.0">0.3.0</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="garrow-table-remove-column"></a><h3>garrow_table_remove_column ()</h3> +<pre class="programlisting"><a class="link" href="GArrowTable.html" title="GArrowTable"><span class="returnvalue">GArrowTable</span></a> * +garrow_table_remove_column (<em class="parameter"><code><a class="link" href="GArrowTable.html" title="GArrowTable"><span class="type">GArrowTable</span></a> *table</code></em>, + <em class="parameter"><code><GTKDOCLINK HREF="guint"><span class="type">guint</span></GTKDOCLINK> i</code></em>, + <em class="parameter"><code><GTKDOCLINK HREF="GError"><span class="type">GError</span></GTKDOCLINK> **error</code></em>);</pre> +<div class="refsect3"> +<a name="garrow-table-remove-column.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>table</p></td> +<td class="parameter_description"><p>A <a class="link" href="GArrowTable.html" title="GArrowTable"><span class="type">GArrowTable</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 column to be removed.</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 <GTKDOCLINK HREF="GError"><span class="type">GError</span></GTKDOCLINK> or <GTKDOCLINK HREF="NULL:CAPS"><code class="literal">NULL</code></GTKDOCLINK>. </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-table-remove-column.returns"></a><h4>Returns</h4> +<p> The newly allocated +<a class="link" href="GArrowTable.html" title="GArrowTable"><span class="type">GArrowTable</span></a> that doesn't have the column or <GTKDOCLINK HREF="NULL:CAPS"><code class="literal">NULL</code></GTKDOCLINK> on error. </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>][<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-3-0.html#api-index-0.3.0">0.3.0</a></p> +</div> +</div> +<div class="refsect1"> +<a name="GArrowTable.other_details"></a><h2>Types and Values</h2> +<div class="refsect2"> +<a name="GArrowTable-struct"></a><h3>struct GArrowTable</h3> +<pre class="programlisting">struct GArrowTable;</pre> +<p>It wraps <code class="literal">arrow::Table</code>.</p> +</div> +</div> +<div class="refsect1"> +<a name="GArrowTable.property-details"></a><h2>Property Details</h2> +<div class="refsect2"> +<a name="GArrowTable--table"></a><h3>The <code class="literal">âtableâ</code> property</h3> +<pre class="programlisting"> âtableâ <GTKDOCLINK HREF="gpointer"><span class="type">gpointer</span></GTKDOCLINK></pre> +<p>The raw std::shared<arrow::Table> *.</p> +<p>Flags: Write / Construct Only</p> +</div> +</div> +</div> +<div class="footer"> +<hr>Generated by GTK-Doc V1.25</div> +</body> +</html>
http://git-wip-us.apache.org/repos/asf/arrow-site/blob/3cd84682/build/docs/c_glib/GArrowTensor.html ---------------------------------------------------------------------- diff --git a/build/docs/c_glib/GArrowTensor.html b/build/docs/c_glib/GArrowTensor.html new file mode 100644 index 0000000..3a699d5 --- /dev/null +++ b/build/docs/c_glib/GArrowTensor.html @@ -0,0 +1,691 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>GArrowTensor: arrow-glib Reference Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> +<link rel="home" href="index.html" title="arrow-glib Reference Manual"> +<link rel="up" href="tensor.html" title="Tensor"> +<link rel="prev" href="tensor.html" title="Tensor"> +<link rel="next" href="type.html" title="Type"> +<meta name="generator" content="GTK-Doc V1.25 (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="#GArrowTensor.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> + <a href="#GArrowTensor.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties">  <span class="dim">|</span> + <a href="#GArrowTensor.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="tensor.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="tensor.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="type.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="GArrowTensor"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="GArrowTensor.top_of_page"></a>GArrowTensor</span></h2> +<p>GArrowTensor â Tensor class</p> +</td> +<td class="gallery_image" valign="top" align="right"></td> +</tr></table></div> +<div class="refsect1"> +<a name="GArrowTensor.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="GArrowTensor.html" title="GArrowTensor"><span class="returnvalue">GArrowTensor</span></a> * +</td> +<td class="function_name"> +<a class="link" href="GArrowTensor.html#garrow-tensor-new" title="garrow_tensor_new ()">garrow_tensor_new</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<GTKDOCLINK HREF="gboolean"><span class="returnvalue">gboolean</span></GTKDOCLINK> +</td> +<td class="function_name"> +<a class="link" href="GArrowTensor.html#garrow-tensor-equal" title="garrow_tensor_equal ()">garrow_tensor_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="GArrowTensor.html#garrow-tensor-get-value-data-type" title="garrow_tensor_get_value_data_type ()">garrow_tensor_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="GArrowTensor.html#garrow-tensor-get-value-type" title="garrow_tensor_get_value_type ()">garrow_tensor_get_value_type</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a class="link" href="buffer-classes.html#GArrowBuffer"><span class="returnvalue">GArrowBuffer</span></a> * +</td> +<td class="function_name"> +<a class="link" href="GArrowTensor.html#garrow-tensor-get-buffer" title="garrow_tensor_get_buffer ()">garrow_tensor_get_buffer</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<GTKDOCLINK HREF="gint64"><span class="returnvalue">gint64</span></GTKDOCLINK> * +</td> +<td class="function_name"> +<a class="link" href="GArrowTensor.html#garrow-tensor-get-shape" title="garrow_tensor_get_shape ()">garrow_tensor_get_shape</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<GTKDOCLINK HREF="gint64"><span class="returnvalue">gint64</span></GTKDOCLINK> * +</td> +<td class="function_name"> +<a class="link" href="GArrowTensor.html#garrow-tensor-get-strides" title="garrow_tensor_get_strides ()">garrow_tensor_get_strides</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<GTKDOCLINK HREF="gint"><span class="returnvalue">gint</span></GTKDOCLINK> +</td> +<td class="function_name"> +<a class="link" href="GArrowTensor.html#garrow-tensor-get-n-dimensions" title="garrow_tensor_get_n_dimensions ()">garrow_tensor_get_n_dimensions</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type">const <GTKDOCLINK HREF="gchar"><span class="returnvalue">gchar</span></GTKDOCLINK> * +</td> +<td class="function_name"> +<a class="link" href="GArrowTensor.html#garrow-tensor-get-dimension-name" title="garrow_tensor_get_dimension_name ()">garrow_tensor_get_dimension_name</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<GTKDOCLINK HREF="gint64"><span class="returnvalue">gint64</span></GTKDOCLINK> +</td> +<td class="function_name"> +<a class="link" href="GArrowTensor.html#garrow-tensor-get-size" title="garrow_tensor_get_size ()">garrow_tensor_get_size</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<GTKDOCLINK HREF="gboolean"><span class="returnvalue">gboolean</span></GTKDOCLINK> +</td> +<td class="function_name"> +<a class="link" href="GArrowTensor.html#garrow-tensor-is-mutable" title="garrow_tensor_is_mutable ()">garrow_tensor_is_mutable</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<GTKDOCLINK HREF="gboolean"><span class="returnvalue">gboolean</span></GTKDOCLINK> +</td> +<td class="function_name"> +<a class="link" href="GArrowTensor.html#garrow-tensor-is-contiguous" title="garrow_tensor_is_contiguous ()">garrow_tensor_is_contiguous</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<GTKDOCLINK HREF="gboolean"><span class="returnvalue">gboolean</span></GTKDOCLINK> +</td> +<td class="function_name"> +<a class="link" href="GArrowTensor.html#garrow-tensor-is-row-major" title="garrow_tensor_is_row_major ()">garrow_tensor_is_row_major</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<GTKDOCLINK HREF="gboolean"><span class="returnvalue">gboolean</span></GTKDOCLINK> +</td> +<td class="function_name"> +<a class="link" href="GArrowTensor.html#garrow-tensor-is-column-major" title="garrow_tensor_is_column_major ()">garrow_tensor_is_column_major</a> <span class="c_punctuation">()</span> +</td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="GArrowTensor.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"> +<a class="link" href="buffer-classes.html#GArrowBuffer"><span class="type">GArrowBuffer</span></a> *</td> +<td class="property_name"><a class="link" href="GArrowTensor.html#GArrowTensor--buffer" title="The âbufferâ property">buffer</a></td> +<td class="property_flags">Read / Write / Construct Only</td> +</tr> +<tr> +<td class="property_type"><GTKDOCLINK HREF="gpointer"><span class="type">gpointer</span></GTKDOCLINK></td> +<td class="property_name"><a class="link" href="GArrowTensor.html#GArrowTensor--tensor" title="The âtensorâ property">tensor</a></td> +<td class="property_flags">Write / Construct Only</td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="GArrowTensor.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="datatype_keyword">struct</td> +<td class="function_name"><a class="link" href="GArrowTensor.html#GArrowTensor-struct" title="struct GArrowTensor">GArrowTensor</a></td> +</tr></tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="GArrowTensor.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="screen"> <GTKDOCLINK HREF="GObject">GObject</GTKDOCLINK> + <span class="lineart">â°ââ</span> GArrowTensor +</pre> +</div> +<div class="refsect1"> +<a name="GArrowTensor.includes"></a><h2>Includes</h2> +<pre class="synopsis">#include <arrow-glib/arrow-glib.h> +</pre> +</div> +<div class="refsect1"> +<a name="GArrowTensor.description"></a><h2>Description</h2> +<p><a class="link" href="GArrowTensor.html" title="GArrowTensor"><span class="type">GArrowTensor</span></a> is a tensor class.</p> +</div> +<div class="refsect1"> +<a name="GArrowTensor.functions_details"></a><h2>Functions</h2> +<div class="refsect2"> +<a name="garrow-tensor-new"></a><h3>garrow_tensor_new ()</h3> +<pre class="programlisting"><a class="link" href="GArrowTensor.html" title="GArrowTensor"><span class="returnvalue">GArrowTensor</span></a> * +garrow_tensor_new (<em class="parameter"><code><a class="link" href="basic-data-type-classes.html#GArrowDataType"><span class="type">GArrowDataType</span></a> *data_type</code></em>, + <em class="parameter"><code><a class="link" href="buffer-classes.html#GArrowBuffer"><span class="type">GArrowBuffer</span></a> *data</code></em>, + <em class="parameter"><code><GTKDOCLINK HREF="gint64"><span class="type">gint64</span></GTKDOCLINK> *shape</code></em>, + <em class="parameter"><code><GTKDOCLINK HREF="gsize"><span class="type">gsize</span></GTKDOCLINK> n_dimensions</code></em>, + <em class="parameter"><code><GTKDOCLINK HREF="gint64"><span class="type">gint64</span></GTKDOCLINK> *strides</code></em>, + <em class="parameter"><code><GTKDOCLINK HREF="gsize"><span class="type">gsize</span></GTKDOCLINK> n_strides</code></em>, + <em class="parameter"><code><GTKDOCLINK HREF="gchar"><span class="type">gchar</span></GTKDOCLINK> **dimention_names</code></em>, + <em class="parameter"><code><GTKDOCLINK HREF="gsize"><span class="type">gsize</span></GTKDOCLINK> n_dimention_names</code></em>);</pre> +<div class="refsect3"> +<a name="garrow-tensor-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>data_type</p></td> +<td class="parameter_description"><p>A <a class="link" href="basic-data-type-classes.html#GArrowDataType"><span class="type">GArrowDataType</span></a> that indicates each element type +in the tensor.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>data</p></td> +<td class="parameter_description"><p>A <a class="link" href="buffer-classes.html#GArrowBuffer"><span class="type">GArrowBuffer</span></a> that contains tensor data.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>shape</p></td> +<td class="parameter_description"><p> A list of dimension sizes. </p></td> +<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=n_dimensions]</span></td> +</tr> +<tr> +<td class="parameter_name"><p>n_dimensions</p></td> +<td class="parameter_description"><p>The number of dimensions.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>strides</p></td> +<td class="parameter_description"><p> A list of the number of +bytes in each dimension. </p></td> +<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=n_strides][<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> +<tr> +<td class="parameter_name"><p>n_strides</p></td> +<td class="parameter_description"><p>The number of strides.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>dimention_names</p></td> +<td class="parameter_description"><p> A list of +dimension names. </p></td> +<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=n_dimention_names][<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> +<tr> +<td class="parameter_name"><p>n_dimention_names</p></td> +<td class="parameter_description"><p>The number of dimension names</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="garrow-tensor-new.returns"></a><h4>Returns</h4> +<p> The newly created <a class="link" href="GArrowTensor.html" title="GArrowTensor"><span class="type">GArrowTensor</span></a>.</p> +</div> +<p class="since">Since: <a class="link" href="api-index-0-3-0.html#api-index-0.3.0">0.3.0</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="garrow-tensor-equal"></a><h3>garrow_tensor_equal ()</h3> +<pre class="programlisting"><GTKDOCLINK HREF="gboolean"><span class="returnvalue">gboolean</span></GTKDOCLINK> +garrow_tensor_equal (<em class="parameter"><code><a class="link" href="GArrowTensor.html" title="GArrowTensor"><span class="type">GArrowTensor</span></a> *tensor</code></em>, + <em class="parameter"><code><a class="link" href="GArrowTensor.html" title="GArrowTensor"><span class="type">GArrowTensor</span></a> *other_tensor</code></em>);</pre> +<div class="refsect3"> +<a name="garrow-tensor-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>tensor</p></td> +<td class="parameter_description"><p>A <a class="link" href="GArrowTensor.html" title="GArrowTensor"><span class="type">GArrowTensor</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>other_tensor</p></td> +<td class="parameter_description"><p>A <a class="link" href="GArrowTensor.html" title="GArrowTensor"><span class="type">GArrowTensor</span></a> to be compared.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="garrow-tensor-equal.returns"></a><h4>Returns</h4> +<p> <GTKDOCLINK HREF="TRUE:CAPS"><code class="literal">TRUE</code></GTKDOCLINK> if both of them have the same data, <GTKDOCLINK HREF="FALSE:CAPS"><code class="literal">FALSE</code></GTKDOCLINK> +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-tensor-get-value-data-type"></a><h3>garrow_tensor_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_tensor_get_value_data_type (<em class="parameter"><code><a class="link" href="GArrowTensor.html" title="GArrowTensor"><span class="type">GArrowTensor</span></a> *tensor</code></em>);</pre> +<div class="refsect3"> +<a name="garrow-tensor-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>tensor</p></td> +<td class="parameter_description"><p>A <a class="link" href="GArrowTensor.html" title="GArrowTensor"><span class="type">GArrowTensor</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="garrow-tensor-get-value-data-type.returns"></a><h4>Returns</h4> +<p> The data type of each value in the tensor. </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-3-0.html#api-index-0.3.0">0.3.0</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="garrow-tensor-get-value-type"></a><h3>garrow_tensor_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_tensor_get_value_type (<em class="parameter"><code><a class="link" href="GArrowTensor.html" title="GArrowTensor"><span class="type">GArrowTensor</span></a> *tensor</code></em>);</pre> +<div class="refsect3"> +<a name="garrow-tensor-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>tensor</p></td> +<td class="parameter_description"><p>A <a class="link" href="GArrowTensor.html" title="GArrowTensor"><span class="type">GArrowTensor</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="garrow-tensor-get-value-type.returns"></a><h4>Returns</h4> +<p> The type of each value in the tensor.</p> +</div> +<p class="since">Since: <a class="link" href="api-index-0-3-0.html#api-index-0.3.0">0.3.0</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="garrow-tensor-get-buffer"></a><h3>garrow_tensor_get_buffer ()</h3> +<pre class="programlisting"><a class="link" href="buffer-classes.html#GArrowBuffer"><span class="returnvalue">GArrowBuffer</span></a> * +garrow_tensor_get_buffer (<em class="parameter"><code><a class="link" href="GArrowTensor.html" title="GArrowTensor"><span class="type">GArrowTensor</span></a> *tensor</code></em>);</pre> +<div class="refsect3"> +<a name="garrow-tensor-get-buffer.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>tensor</p></td> +<td class="parameter_description"><p>A <a class="link" href="GArrowTensor.html" title="GArrowTensor"><span class="type">GArrowTensor</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="garrow-tensor-get-buffer.returns"></a><h4>Returns</h4> +<p> The data of the tensor. </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-3-0.html#api-index-0.3.0">0.3.0</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="garrow-tensor-get-shape"></a><h3>garrow_tensor_get_shape ()</h3> +<pre class="programlisting"><GTKDOCLINK HREF="gint64"><span class="returnvalue">gint64</span></GTKDOCLINK> * +garrow_tensor_get_shape (<em class="parameter"><code><a class="link" href="GArrowTensor.html" title="GArrowTensor"><span class="type">GArrowTensor</span></a> *tensor</code></em>, + <em class="parameter"><code><GTKDOCLINK HREF="gint"><span class="type">gint</span></GTKDOCLINK> *n_dimensions</code></em>);</pre> +<div class="refsect3"> +<a name="garrow-tensor-get-shape.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>tensor</p></td> +<td class="parameter_description"><p>A <a class="link" href="GArrowTensor.html" title="GArrowTensor"><span class="type">GArrowTensor</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>n_dimensions</p></td> +<td class="parameter_description"><p> The number of dimensions. </p></td> +<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="garrow-tensor-get-shape.returns"></a><h4>Returns</h4> +<p> The shape of the tensor. +It should be freed with <GTKDOCLINK HREF="g-free"><code class="function">g_free()</code></GTKDOCLINK> when no longer needed. </p> +<p><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=n_dimensions]</span></p> +</div> +<p class="since">Since: <a class="link" href="api-index-0-3-0.html#api-index-0.3.0">0.3.0</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="garrow-tensor-get-strides"></a><h3>garrow_tensor_get_strides ()</h3> +<pre class="programlisting"><GTKDOCLINK HREF="gint64"><span class="returnvalue">gint64</span></GTKDOCLINK> * +garrow_tensor_get_strides (<em class="parameter"><code><a class="link" href="GArrowTensor.html" title="GArrowTensor"><span class="type">GArrowTensor</span></a> *tensor</code></em>, + <em class="parameter"><code><GTKDOCLINK HREF="gint"><span class="type">gint</span></GTKDOCLINK> *n_strides</code></em>);</pre> +<div class="refsect3"> +<a name="garrow-tensor-get-strides.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>tensor</p></td> +<td class="parameter_description"><p>A <a class="link" href="GArrowTensor.html" title="GArrowTensor"><span class="type">GArrowTensor</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>n_strides</p></td> +<td class="parameter_description"><p> The number of strides. </p></td> +<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="garrow-tensor-get-strides.returns"></a><h4>Returns</h4> +<p> The strides of the tensor. +It should be freed with <GTKDOCLINK HREF="g-free"><code class="function">g_free()</code></GTKDOCLINK> when no longer needed. </p> +<p><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=n_strides]</span></p> +</div> +<p class="since">Since: <a class="link" href="api-index-0-3-0.html#api-index-0.3.0">0.3.0</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="garrow-tensor-get-n-dimensions"></a><h3>garrow_tensor_get_n_dimensions ()</h3> +<pre class="programlisting"><GTKDOCLINK HREF="gint"><span class="returnvalue">gint</span></GTKDOCLINK> +garrow_tensor_get_n_dimensions (<em class="parameter"><code><a class="link" href="GArrowTensor.html" title="GArrowTensor"><span class="type">GArrowTensor</span></a> *tensor</code></em>);</pre> +<div class="refsect3"> +<a name="garrow-tensor-get-n-dimensions.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>tensor</p></td> +<td class="parameter_description"><p>A <a class="link" href="GArrowTensor.html" title="GArrowTensor"><span class="type">GArrowTensor</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="garrow-tensor-get-n-dimensions.returns"></a><h4>Returns</h4> +<p> The number of dimensions of the tensor.</p> +</div> +<p class="since">Since: <a class="link" href="api-index-0-3-0.html#api-index-0.3.0">0.3.0</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="garrow-tensor-get-dimension-name"></a><h3>garrow_tensor_get_dimension_name ()</h3> +<pre class="programlisting">const <GTKDOCLINK HREF="gchar"><span class="returnvalue">gchar</span></GTKDOCLINK> * +garrow_tensor_get_dimension_name (<em class="parameter"><code><a class="link" href="GArrowTensor.html" title="GArrowTensor"><span class="type">GArrowTensor</span></a> *tensor</code></em>, + <em class="parameter"><code><GTKDOCLINK HREF="gint"><span class="type">gint</span></GTKDOCLINK> i</code></em>);</pre> +<div class="refsect3"> +<a name="garrow-tensor-get-dimension-name.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>tensor</p></td> +<td class="parameter_description"><p>A <a class="link" href="GArrowTensor.html" title="GArrowTensor"><span class="type">GArrowTensor</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 dimension.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="garrow-tensor-get-dimension-name.returns"></a><h4>Returns</h4> +<p> The i-th dimension name of the tensor.</p> +</div> +<p class="since">Since: <a class="link" href="api-index-0-3-0.html#api-index-0.3.0">0.3.0</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="garrow-tensor-get-size"></a><h3>garrow_tensor_get_size ()</h3> +<pre class="programlisting"><GTKDOCLINK HREF="gint64"><span class="returnvalue">gint64</span></GTKDOCLINK> +garrow_tensor_get_size (<em class="parameter"><code><a class="link" href="GArrowTensor.html" title="GArrowTensor"><span class="type">GArrowTensor</span></a> *tensor</code></em>);</pre> +<div class="refsect3"> +<a name="garrow-tensor-get-size.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>tensor</p></td> +<td class="parameter_description"><p>A <a class="link" href="GArrowTensor.html" title="GArrowTensor"><span class="type">GArrowTensor</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="garrow-tensor-get-size.returns"></a><h4>Returns</h4> +<p> The number of value cells in the tensor.</p> +</div> +<p class="since">Since: <a class="link" href="api-index-0-3-0.html#api-index-0.3.0">0.3.0</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="garrow-tensor-is-mutable"></a><h3>garrow_tensor_is_mutable ()</h3> +<pre class="programlisting"><GTKDOCLINK HREF="gboolean"><span class="returnvalue">gboolean</span></GTKDOCLINK> +garrow_tensor_is_mutable (<em class="parameter"><code><a class="link" href="GArrowTensor.html" title="GArrowTensor"><span class="type">GArrowTensor</span></a> *tensor</code></em>);</pre> +<div class="refsect3"> +<a name="garrow-tensor-is-mutable.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>tensor</p></td> +<td class="parameter_description"><p>A <a class="link" href="GArrowTensor.html" title="GArrowTensor"><span class="type">GArrowTensor</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="garrow-tensor-is-mutable.returns"></a><h4>Returns</h4> +<p> <GTKDOCLINK HREF="TRUE:CAPS"><code class="literal">TRUE</code></GTKDOCLINK> if the tensor is mutable, <GTKDOCLINK HREF="FALSE:CAPS"><code class="literal">FALSE</code></GTKDOCLINK> otherwise.</p> +</div> +<p class="since">Since: <a class="link" href="api-index-0-3-0.html#api-index-0.3.0">0.3.0</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="garrow-tensor-is-contiguous"></a><h3>garrow_tensor_is_contiguous ()</h3> +<pre class="programlisting"><GTKDOCLINK HREF="gboolean"><span class="returnvalue">gboolean</span></GTKDOCLINK> +garrow_tensor_is_contiguous (<em class="parameter"><code><a class="link" href="GArrowTensor.html" title="GArrowTensor"><span class="type">GArrowTensor</span></a> *tensor</code></em>);</pre> +<div class="refsect3"> +<a name="garrow-tensor-is-contiguous.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>tensor</p></td> +<td class="parameter_description"><p>A <a class="link" href="GArrowTensor.html" title="GArrowTensor"><span class="type">GArrowTensor</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="garrow-tensor-is-contiguous.returns"></a><h4>Returns</h4> +<p> <GTKDOCLINK HREF="TRUE:CAPS"><code class="literal">TRUE</code></GTKDOCLINK> if the tensor is contiguous, <GTKDOCLINK HREF="FALSE:CAPS"><code class="literal">FALSE</code></GTKDOCLINK> otherwise.</p> +</div> +<p class="since">Since: <a class="link" href="api-index-0-3-0.html#api-index-0.3.0">0.3.0</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="garrow-tensor-is-row-major"></a><h3>garrow_tensor_is_row_major ()</h3> +<pre class="programlisting"><GTKDOCLINK HREF="gboolean"><span class="returnvalue">gboolean</span></GTKDOCLINK> +garrow_tensor_is_row_major (<em class="parameter"><code><a class="link" href="GArrowTensor.html" title="GArrowTensor"><span class="type">GArrowTensor</span></a> *tensor</code></em>);</pre> +<div class="refsect3"> +<a name="garrow-tensor-is-row-major.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>tensor</p></td> +<td class="parameter_description"><p>A <a class="link" href="GArrowTensor.html" title="GArrowTensor"><span class="type">GArrowTensor</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="garrow-tensor-is-row-major.returns"></a><h4>Returns</h4> +<p> <GTKDOCLINK HREF="TRUE:CAPS"><code class="literal">TRUE</code></GTKDOCLINK> if the tensor is row major a.k.a. C order, +<GTKDOCLINK HREF="FALSE:CAPS"><code class="literal">FALSE</code></GTKDOCLINK> otherwise.</p> +</div> +<p class="since">Since: <a class="link" href="api-index-0-3-0.html#api-index-0.3.0">0.3.0</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="garrow-tensor-is-column-major"></a><h3>garrow_tensor_is_column_major ()</h3> +<pre class="programlisting"><GTKDOCLINK HREF="gboolean"><span class="returnvalue">gboolean</span></GTKDOCLINK> +garrow_tensor_is_column_major (<em class="parameter"><code><a class="link" href="GArrowTensor.html" title="GArrowTensor"><span class="type">GArrowTensor</span></a> *tensor</code></em>);</pre> +<div class="refsect3"> +<a name="garrow-tensor-is-column-major.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>tensor</p></td> +<td class="parameter_description"><p>A <a class="link" href="GArrowTensor.html" title="GArrowTensor"><span class="type">GArrowTensor</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="garrow-tensor-is-column-major.returns"></a><h4>Returns</h4> +<p> <GTKDOCLINK HREF="TRUE:CAPS"><code class="literal">TRUE</code></GTKDOCLINK> if the tensor is column major a.k.a. Fortran order, +<GTKDOCLINK HREF="FALSE:CAPS"><code class="literal">FALSE</code></GTKDOCLINK> otherwise.</p> +</div> +<p class="since">Since: <a class="link" href="api-index-0-3-0.html#api-index-0.3.0">0.3.0</a></p> +</div> +</div> +<div class="refsect1"> +<a name="GArrowTensor.other_details"></a><h2>Types and Values</h2> +<div class="refsect2"> +<a name="GArrowTensor-struct"></a><h3>struct GArrowTensor</h3> +<pre class="programlisting">struct GArrowTensor;</pre> +<p>It wraps <code class="literal">arrow::Tensor</code>.</p> +</div> +</div> +<div class="refsect1"> +<a name="GArrowTensor.property-details"></a><h2>Property Details</h2> +<div class="refsect2"> +<a name="GArrowTensor--buffer"></a><h3>The <code class="literal">âbufferâ</code> property</h3> +<pre class="programlisting"> âbufferâ <a class="link" href="buffer-classes.html#GArrowBuffer"><span class="type">GArrowBuffer</span></a> *</pre> +<p>The data.</p> +<p>Flags: Read / Write / Construct Only</p> +</div> +<hr> +<div class="refsect2"> +<a name="GArrowTensor--tensor"></a><h3>The <code class="literal">âtensorâ</code> property</h3> +<pre class="programlisting"> âtensorâ <GTKDOCLINK HREF="gpointer"><span class="type">gpointer</span></GTKDOCLINK></pre> +<p>The raw std::shared<arrow::Tensor> *.</p> +<p>Flags: Write / Construct Only</p> +</div> +</div> +</div> +<div class="footer"> +<hr>Generated by GTK-Doc V1.25</div> +</body> +</html> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/3cd84682/build/docs/c_glib/GArrowWriteable.html ---------------------------------------------------------------------- diff --git a/build/docs/c_glib/GArrowWriteable.html b/build/docs/c_glib/GArrowWriteable.html new file mode 100644 index 0000000..8c5e7dd --- /dev/null +++ b/build/docs/c_glib/GArrowWriteable.html @@ -0,0 +1,178 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>GArrowWriteable: arrow-glib Reference Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> +<link rel="home" href="index.html" title="arrow-glib Reference Manual"> +<link rel="up" href="output.html" title="Output"> +<link rel="prev" href="output.html" title="Output"> +<link rel="next" href="GArrowWriteableFile.html" title="GArrowWriteableFile"> +<meta name="generator" content="GTK-Doc V1.25 (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="#GArrowWriteable.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> + <a href="#GArrowWriteable.object-hierarchy" class="shortcut">Object Hierarchy</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="output.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="output.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="GArrowWriteableFile.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="GArrowWriteable"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="GArrowWriteable.top_of_page"></a>GArrowWriteable</span></h2> +<p>GArrowWriteable â Output interface</p> +</td> +<td class="gallery_image" valign="top" align="right"></td> +</tr></table></div> +<div class="refsect1"> +<a name="GArrowWriteable.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"> +<GTKDOCLINK HREF="gboolean"><span class="returnvalue">gboolean</span></GTKDOCLINK> +</td> +<td class="function_name"> +<a class="link" href="GArrowWriteable.html#garrow-writeable-write" title="garrow_writeable_write ()">garrow_writeable_write</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<GTKDOCLINK HREF="gboolean"><span class="returnvalue">gboolean</span></GTKDOCLINK> +</td> +<td class="function_name"> +<a class="link" href="GArrowWriteable.html#garrow-writeable-flush" title="garrow_writeable_flush ()">garrow_writeable_flush</a> <span class="c_punctuation">()</span> +</td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="GArrowWriteable.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="datatype_keyword"> </td> +<td class="function_name"><a class="link" href="GArrowWriteable.html#GArrowWriteableInterface" title="GArrowWriteableInterface">GArrowWriteableInterface</a></td> +</tr></tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="GArrowWriteable.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="screen"> <GTKDOCLINK HREF="GInterface">GInterface</GTKDOCLINK> + <span class="lineart">â°ââ</span> GArrowWriteable +</pre> +</div> +<div class="refsect1"> +<a name="GArrowWriteable.description"></a><h2>Description</h2> +<p><a class="link" href="GArrowWriteable.html" title="GArrowWriteable"><span class="type">GArrowWriteable</span></a> is an interface for output. Output must be +writeable.</p> +</div> +<div class="refsect1"> +<a name="GArrowWriteable.functions_details"></a><h2>Functions</h2> +<div class="refsect2"> +<a name="garrow-writeable-write"></a><h3>garrow_writeable_write ()</h3> +<pre class="programlisting"><GTKDOCLINK HREF="gboolean"><span class="returnvalue">gboolean</span></GTKDOCLINK> +garrow_writeable_write (<em class="parameter"><code><a class="link" href="GArrowWriteable.html" title="GArrowWriteable"><span class="type">GArrowWriteable</span></a> *writeable</code></em>, + <em class="parameter"><code>const <GTKDOCLINK HREF="guint8"><span class="type">guint8</span></GTKDOCLINK> *data</code></em>, + <em class="parameter"><code><GTKDOCLINK HREF="gint64"><span class="type">gint64</span></GTKDOCLINK> n_bytes</code></em>, + <em class="parameter"><code><GTKDOCLINK HREF="GError"><span class="type">GError</span></GTKDOCLINK> **error</code></em>);</pre> +<div class="refsect3"> +<a name="garrow-writeable-write.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>writeable</p></td> +<td class="parameter_description"><p>A <a class="link" href="GArrowWriteable.html" title="GArrowWriteable"><span class="type">GArrowWriteable</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>data</p></td> +<td class="parameter_description"><p> The data to be written. </p></td> +<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=n_bytes]</span></td> +</tr> +<tr> +<td class="parameter_name"><p>n_bytes</p></td> +<td class="parameter_description"><p>The number of bytes to be written.</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 <GTKDOCLINK HREF="GError"><span class="type">GError</span></GTKDOCLINK> or <GTKDOCLINK HREF="NULL:CAPS"><code class="literal">NULL</code></GTKDOCLINK>. </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-writeable-write.returns"></a><h4>Returns</h4> +<p> <GTKDOCLINK HREF="TRUE:CAPS"><code class="literal">TRUE</code></GTKDOCLINK> on success, <GTKDOCLINK HREF="FALSE:CAPS"><code class="literal">FALSE</code></GTKDOCLINK> if there was an error.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="garrow-writeable-flush"></a><h3>garrow_writeable_flush ()</h3> +<pre class="programlisting"><GTKDOCLINK HREF="gboolean"><span class="returnvalue">gboolean</span></GTKDOCLINK> +garrow_writeable_flush (<em class="parameter"><code><a class="link" href="GArrowWriteable.html" title="GArrowWriteable"><span class="type">GArrowWriteable</span></a> *writeable</code></em>, + <em class="parameter"><code><GTKDOCLINK HREF="GError"><span class="type">GError</span></GTKDOCLINK> **error</code></em>);</pre> +<p>It ensures writing all data on memory to storage.</p> +<div class="refsect3"> +<a name="garrow-writeable-flush.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>writeable</p></td> +<td class="parameter_description"><p>A <a class="link" href="GArrowWriteable.html" title="GArrowWriteable"><span class="type">GArrowWriteable</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 <GTKDOCLINK HREF="GError"><span class="type">GError</span></GTKDOCLINK> or <GTKDOCLINK HREF="NULL:CAPS"><code class="literal">NULL</code></GTKDOCLINK>. </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-writeable-flush.returns"></a><h4>Returns</h4> +<p> <GTKDOCLINK HREF="TRUE:CAPS"><code class="literal">TRUE</code></GTKDOCLINK> on success, <GTKDOCLINK HREF="FALSE:CAPS"><code class="literal">FALSE</code></GTKDOCLINK> if there was an error.</p> +</div> +</div> +</div> +<div class="refsect1"> +<a name="GArrowWriteable.other_details"></a><h2>Types and Values</h2> +<div class="refsect2"> +<a name="GArrowWriteableInterface"></a><h3>GArrowWriteableInterface</h3> +<pre class="programlisting">typedef struct _GArrowWriteableInterface GArrowWriteableInterface;</pre> +</div> +</div> +</div> +<div class="footer"> +<hr>Generated by GTK-Doc V1.25</div> +</body> +</html> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/3cd84682/build/docs/c_glib/GArrowWriteableFile.html ---------------------------------------------------------------------- diff --git a/build/docs/c_glib/GArrowWriteableFile.html b/build/docs/c_glib/GArrowWriteableFile.html new file mode 100644 index 0000000..50cbcae --- /dev/null +++ b/build/docs/c_glib/GArrowWriteableFile.html @@ -0,0 +1,139 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>GArrowWriteableFile: arrow-glib Reference Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> +<link rel="home" href="index.html" title="arrow-glib Reference Manual"> +<link rel="up" href="output.html" title="Output"> +<link rel="prev" href="GArrowWriteable.html" title="GArrowWriteable"> +<link rel="next" href="output-stream-classes.html" title="Output stream classes"> +<meta name="generator" content="GTK-Doc V1.25 (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="#GArrowWriteableFile.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> + <a href="#GArrowWriteableFile.object-hierarchy" class="shortcut">Object Hierarchy</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="output.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="GArrowWriteable.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="output-stream-classes.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="GArrowWriteableFile"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="GArrowWriteableFile.top_of_page"></a>GArrowWriteableFile</span></h2> +<p>GArrowWriteableFile â File output interface</p> +</td> +<td class="gallery_image" valign="top" align="right"></td> +</tr></table></div> +<div class="refsect1"> +<a name="GArrowWriteableFile.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"> +<GTKDOCLINK HREF="gboolean"><span class="returnvalue">gboolean</span></GTKDOCLINK> +</td> +<td class="function_name"> +<a class="link" href="GArrowWriteableFile.html#garrow-writeable-file-write-at" title="garrow_writeable_file_write_at ()">garrow_writeable_file_write_at</a> <span class="c_punctuation">()</span> +</td> +</tr></tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="GArrowWriteableFile.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="datatype_keyword"> </td> +<td class="function_name"><a class="link" href="GArrowWriteableFile.html#GArrowWriteableFileInterface" title="GArrowWriteableFileInterface">GArrowWriteableFileInterface</a></td> +</tr></tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="GArrowWriteableFile.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="screen"> <GTKDOCLINK HREF="GInterface">GInterface</GTKDOCLINK> + <span class="lineart">â°ââ</span> GArrowWriteableFile +</pre> +</div> +<div class="refsect1"> +<a name="GArrowWriteableFile.description"></a><h2>Description</h2> +<p><a class="link" href="GArrowWriteableFile.html" title="GArrowWriteableFile"><span class="type">GArrowWriteableFile</span></a> is an interface for file output.</p> +</div> +<div class="refsect1"> +<a name="GArrowWriteableFile.functions_details"></a><h2>Functions</h2> +<div class="refsect2"> +<a name="garrow-writeable-file-write-at"></a><h3>garrow_writeable_file_write_at ()</h3> +<pre class="programlisting"><GTKDOCLINK HREF="gboolean"><span class="returnvalue">gboolean</span></GTKDOCLINK> +garrow_writeable_file_write_at (<em class="parameter"><code><a class="link" href="GArrowWriteableFile.html" title="GArrowWriteableFile"><span class="type">GArrowWriteableFile</span></a> *writeable_file</code></em>, + <em class="parameter"><code><GTKDOCLINK HREF="gint64"><span class="type">gint64</span></GTKDOCLINK> position</code></em>, + <em class="parameter"><code>const <GTKDOCLINK HREF="guint8"><span class="type">guint8</span></GTKDOCLINK> *data</code></em>, + <em class="parameter"><code><GTKDOCLINK HREF="gint64"><span class="type">gint64</span></GTKDOCLINK> n_bytes</code></em>, + <em class="parameter"><code><GTKDOCLINK HREF="GError"><span class="type">GError</span></GTKDOCLINK> **error</code></em>);</pre> +<div class="refsect3"> +<a name="garrow-writeable-file-write-at.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>writeable_file</p></td> +<td class="parameter_description"><p>A <a class="link" href="GArrowWriteableFile.html" title="GArrowWriteableFile"><span class="type">GArrowWriteableFile</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>position</p></td> +<td class="parameter_description"><p>The write start position.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>data</p></td> +<td class="parameter_description"><p> The data to be written. </p></td> +<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=n_bytes]</span></td> +</tr> +<tr> +<td class="parameter_name"><p>n_bytes</p></td> +<td class="parameter_description"><p>The number of bytes to be written.</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 <GTKDOCLINK HREF="GError"><span class="type">GError</span></GTKDOCLINK> or <GTKDOCLINK HREF="NULL:CAPS"><code class="literal">NULL</code></GTKDOCLINK>. </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-writeable-file-write-at.returns"></a><h4>Returns</h4> +<p> <GTKDOCLINK HREF="TRUE:CAPS"><code class="literal">TRUE</code></GTKDOCLINK> on success, <GTKDOCLINK HREF="FALSE:CAPS"><code class="literal">FALSE</code></GTKDOCLINK> if there was an error.</p> +</div> +</div> +</div> +<div class="refsect1"> +<a name="GArrowWriteableFile.other_details"></a><h2>Types and Values</h2> +<div class="refsect2"> +<a name="GArrowWriteableFileInterface"></a><h3>GArrowWriteableFileInterface</h3> +<pre class="programlisting">typedef struct _GArrowWriteableFileInterface GArrowWriteableFileInterface;</pre> +</div> +</div> +</div> +<div class="footer"> +<hr>Generated by GTK-Doc V1.25</div> +</body> +</html> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/3cd84682/build/docs/c_glib/annotation-glossary.html ---------------------------------------------------------------------- diff --git a/build/docs/c_glib/annotation-glossary.html b/build/docs/c_glib/annotation-glossary.html new file mode 100644 index 0000000..64ff862 --- /dev/null +++ b/build/docs/c_glib/annotation-glossary.html @@ -0,0 +1,58 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Annotation Glossary: arrow-glib Reference Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> +<link rel="home" href="index.html" title="arrow-glib Reference Manual"> +<link rel="up" href="index.html" title="arrow-glib Reference Manual"> +<link rel="prev" href="api-index-0-3-0.html" title="Index of new symbols in 0.3.0"> +<meta name="generator" content="GTK-Doc V1.25 (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"><span id="nav_glossary"><a class="shortcut" href="#glsA">A</a> +  <span class="dim">|</span> + <a class="shortcut" href="#glsE">E</a> +  <span class="dim">|</span> + <a class="shortcut" href="#glsN">N</a> +  <span class="dim">|</span> + <a class="shortcut" href="#glsO">O</a> +  <span class="dim">|</span> + <a class="shortcut" href="#glsS">S</a> +  <span class="dim">|</span> + <a class="shortcut" href="#glsT">T</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><img src="up-insensitive.png" width="16" height="16" border="0"></td> +<td><a accesskey="p" href="api-index-0-3-0.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><img src="right-insensitive.png" width="16" height="16" border="0"></td> +</tr></table> +<div class="glossary"> +<div class="titlepage"><div><div><h1 class="title"> +<a name="annotation-glossary"></a>Annotation Glossary</h1></div></div></div> +<a name="glsA"></a><h3 class="title">A</h3> +<dt><span class="glossterm"><a name="annotation-glossterm-array"></a>array</span></dt> +<dd class="glossdef"><p>Parameter points to an array of items.</p></dd> +<a name="glsE"></a><h3 class="title">E</h3> +<dt><span class="glossterm"><a name="annotation-glossterm-element-type"></a>element-type</span></dt> +<dd class="glossdef"><p>Generics and defining elements of containers and arrays.</p></dd> +<a name="glsN"></a><h3 class="title">N</h3> +<dt><span class="glossterm"><a name="annotation-glossterm-nullable"></a>nullable</span></dt> +<dd class="glossdef"><p>NULL may be passed as the value in, out, in-out; or as a return value.</p></dd> +<a name="glsO"></a><h3 class="title">O</h3> +<dt><span class="glossterm"><a name="annotation-glossterm-out"></a>out</span></dt> +<dd class="glossdef"><p>Parameter for returning results. Default is <acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>.</p></dd> +<a name="glsS"></a><h3 class="title">S</h3> +<dt><span class="glossterm"><a name="annotation-glossterm-skip"></a>skip</span></dt> +<dd class="glossdef"><p>Exposed in C code, not necessarily available in other languages.</p></dd> +<a name="glsT"></a><h3 class="title">T</h3> +<dt><span class="glossterm"><a name="annotation-glossterm-transfer%20full"></a>transfer full</span></dt> +<dd class="glossdef"><p>Free data after the code is done.</p></dd> +<dt><span class="glossterm"><a name="annotation-glossterm-transfer%20none"></a>transfer none</span></dt> +<dd class="glossdef"><p>Don't free data after the code is done.</p></dd> +</div> +<div class="footer"> +<hr>Generated by GTK-Doc V1.25</div> +</body> +</html>
