http://git-wip-us.apache.org/repos/asf/arrow-site/blob/cf45c51a/docs/c_glib/GArrowTensor.html ---------------------------------------------------------------------- diff --git a/docs/c_glib/GArrowTensor.html b/docs/c_glib/GArrowTensor.html new file mode 100644 index 0000000..fc4bc3e --- /dev/null +++ b/docs/c_glib/GArrowTensor.html @@ -0,0 +1,643 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title> Reference Manual: GArrowTensor</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> +<link rel="home" href="index.html" title="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.20 (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="10"><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 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"> +<a class="link" href="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 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="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 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="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="id-1.2.4.2.9.2.4"></a><h4>Parameters</h4> +<div class="informaltable"><table 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="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][nullable]</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][nullable]</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="id-1.2.4.2.9.2.5"></a><h4>Returns</h4> +<p> The newly created <a class="link" href="GArrowTensor.html" title="GArrowTensor"><span class="type">GArrowTensor</span></a>.</p> +<p></p> +</div> +<p class="since">Since 0.3.0</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="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="id-1.2.4.2.9.3.4"></a><h4>Parameters</h4> +<div class="informaltable"><table 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="id-1.2.4.2.9.3.5"></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 0.3.0</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="id-1.2.4.2.9.4.4"></a><h4>Parameters</h4> +<div class="informaltable"><table 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="id-1.2.4.2.9.4.5"></a><h4>Returns</h4> +<p> The type of each value in the tensor.</p> +<p></p> +</div> +<p class="since">Since 0.3.0</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="id-1.2.4.2.9.5.4"></a><h4>Parameters</h4> +<div class="informaltable"><table 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="id-1.2.4.2.9.5.5"></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 0.3.0</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="id-1.2.4.2.9.6.4"></a><h4>Parameters</h4> +<div class="informaltable"><table 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="id-1.2.4.2.9.6.5"></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 0.3.0</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="id-1.2.4.2.9.7.4"></a><h4>Parameters</h4> +<div class="informaltable"><table 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="id-1.2.4.2.9.7.5"></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 0.3.0</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="id-1.2.4.2.9.8.4"></a><h4>Parameters</h4> +<div class="informaltable"><table 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="id-1.2.4.2.9.8.5"></a><h4>Returns</h4> +<p> The number of dimensions of the tensor.</p> +<p></p> +</div> +<p class="since">Since 0.3.0</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="id-1.2.4.2.9.9.4"></a><h4>Parameters</h4> +<div class="informaltable"><table 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="id-1.2.4.2.9.9.5"></a><h4>Returns</h4> +<p> The i-th dimension name of the tensor.</p> +<p></p> +</div> +<p class="since">Since 0.3.0</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="id-1.2.4.2.9.10.4"></a><h4>Parameters</h4> +<div class="informaltable"><table 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="id-1.2.4.2.9.10.5"></a><h4>Returns</h4> +<p> The number of value cells in the tensor.</p> +<p></p> +</div> +<p class="since">Since 0.3.0</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="id-1.2.4.2.9.11.4"></a><h4>Parameters</h4> +<div class="informaltable"><table 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="id-1.2.4.2.9.11.5"></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> +<p></p> +</div> +<p class="since">Since 0.3.0</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="id-1.2.4.2.9.12.4"></a><h4>Parameters</h4> +<div class="informaltable"><table 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="id-1.2.4.2.9.12.5"></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> +<p></p> +</div> +<p class="since">Since 0.3.0</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="id-1.2.4.2.9.13.4"></a><h4>Parameters</h4> +<div class="informaltable"><table 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="id-1.2.4.2.9.13.5"></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> +<p></p> +</div> +<p class="since">Since 0.3.0</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="id-1.2.4.2.9.14.4"></a><h4>Parameters</h4> +<div class="informaltable"><table 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="id-1.2.4.2.9.14.5"></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> +<p></p> +</div> +<p class="since">Since 0.3.0</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--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.20</div> +</body> +</html>
http://git-wip-us.apache.org/repos/asf/arrow-site/blob/cf45c51a/docs/c_glib/GArrowWriteable.html ---------------------------------------------------------------------- diff --git a/docs/c_glib/GArrowWriteable.html b/docs/c_glib/GArrowWriteable.html new file mode 100644 index 0000000..295aa9b --- /dev/null +++ b/docs/c_glib/GArrowWriteable.html @@ -0,0 +1,183 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title> Reference Manual: GArrowWriteable</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> +<link rel="home" href="index.html" title="Reference Manual"> +<link rel="up" href="output.html" title="Output"> +<link rel="prev" href="output.html" title="Output"> +<link rel="next" href="GArrowOutputStream.html" title="GArrowOutputStream"> +<meta name="generator" content="GTK-Doc V1.20 (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="10"><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="GArrowOutputStream.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 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 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="id-1.3.4.2.7.2.4"></a><h4>Parameters</h4> +<div class="informaltable"><table 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">[nullable]</span></td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.3.4.2.7.2.5"></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> +<p></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="id-1.3.4.2.7.3.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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">[nullable]</span></td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.3.4.2.7.3.6"></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> +<p></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> +<p> +</p> +</div> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.20</div> +</body> +</html> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/cf45c51a/docs/c_glib/GArrowWriteableFile.html ---------------------------------------------------------------------- diff --git a/docs/c_glib/GArrowWriteableFile.html b/docs/c_glib/GArrowWriteableFile.html new file mode 100644 index 0000000..354f4f5 --- /dev/null +++ b/docs/c_glib/GArrowWriteableFile.html @@ -0,0 +1,143 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title> Reference Manual: GArrowWriteableFile</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> +<link rel="home" href="index.html" title="Reference Manual"> +<link rel="up" href="output.html" title="Output"> +<link rel="prev" href="GArrowOutputStream.html" title="GArrowOutputStream"> +<link rel="next" href="GArrowFileOutputStream.html" title="GArrowFileOutputStream"> +<meta name="generator" content="GTK-Doc V1.20 (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="10"><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="GArrowOutputStream.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="GArrowFileOutputStream.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 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 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="id-1.3.4.4.7.2.4"></a><h4>Parameters</h4> +<div class="informaltable"><table 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">[nullable]</span></td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.3.4.4.7.2.5"></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> +<p></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> +<p> +</p> +</div> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.20</div> +</body> +</html> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/cf45c51a/docs/c_glib/annotation-glossary.html ---------------------------------------------------------------------- diff --git a/docs/c_glib/annotation-glossary.html b/docs/c_glib/annotation-glossary.html new file mode 100644 index 0000000..f5b7f38 --- /dev/null +++ b/docs/c_glib/annotation-glossary.html @@ -0,0 +1,47 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title> Reference Manual: Annotation Glossary</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> +<link rel="home" href="index.html" title="Reference Manual"> +<link rel="up" href="index.html" title="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.20 (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="10"><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="#glsO">O</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="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="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> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.20</div> +</body> +</html> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/cf45c51a/docs/c_glib/api-index-0-3-0.html ---------------------------------------------------------------------- diff --git a/docs/c_glib/api-index-0-3-0.html b/docs/c_glib/api-index-0-3-0.html new file mode 100644 index 0000000..fc9924e --- /dev/null +++ b/docs/c_glib/api-index-0-3-0.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> Reference Manual: Index of new symbols in 0.3.0</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> +<link rel="home" href="index.html" title="Reference Manual"> +<link rel="up" href="index.html" title="Reference Manual"> +<link rel="prev" href="deprecated-api-index.html" title="Index of deprecated API"> +<link rel="next" href="annotation-glossary.html" title="Annotation Glossary"> +<meta name="generator" content="GTK-Doc V1.20 (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="10"><tr valign="middle"> +<td width="100%" align="left" class="shortcuts"><span id="nav_index"><a class="shortcut" href="#idxA">A</a> +  <span class="dim">|</span> + <a class="shortcut" href="#idxB">B</a> +  <span class="dim">|</span> + <a class="shortcut" href="#idxM">M</a> +  <span class="dim">|</span> + <a class="shortcut" href="#idxP">P</a> +  <span class="dim">|</span> + <a class="shortcut" href="#idxR">R</a> +  <span class="dim">|</span> + <a class="shortcut" href="#idxT">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="deprecated-api-index.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="annotation-glossary.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="index"> +<div class="titlepage"><div><div><h1 class="title"> +<a name="api-index-0-3-0"></a>Index of new symbols in 0.3.0</h1></div></div></div> +<a name="idx"></a><a name="idxA"></a><h3 class="title">A</h3> +<dt> +<a class="link" href="array-classes.html#garrow-array-get-null-bitmap" title="garrow_array_get_null_bitmap ()">garrow_array_get_null_bitmap</a>, function in <a class="link" href="array-classes.html" title="Array classes">GArrowStructArray</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="array-classes.html#garrow-array-get-value-data-type" title="garrow_array_get_value_data_type ()">garrow_array_get_value_data_type</a>, function in <a class="link" href="array-classes.html" title="Array classes">GArrowStructArray</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="array-classes.html#garrow-array-get-value-type" title="garrow_array_get_value_type ()">garrow_array_get_value_type</a>, function in <a class="link" href="array-classes.html" title="Array classes">GArrowStructArray</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="array-classes.html#garrow-array-is-null" title="garrow_array_is_null ()">garrow_array_is_null</a>, function in <a class="link" href="array-classes.html" title="Array classes">GArrowStructArray</a> +</dt> +<dd></dd> +<a name="idxB"></a><h3 class="title">B</h3> +<dt> +<a class="link" href="buffer-classes.html#garrow-buffer-copy" title="garrow_buffer_copy ()">garrow_buffer_copy</a>, function in <a class="link" href="buffer-classes.html" title="Buffer classes">GArrowBuffer</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="buffer-classes.html#garrow-buffer-get-capacity" title="garrow_buffer_get_capacity ()">garrow_buffer_get_capacity</a>, function in <a class="link" href="buffer-classes.html" title="Buffer classes">GArrowBuffer</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="buffer-classes.html#garrow-buffer-get-data" title="garrow_buffer_get_data ()">garrow_buffer_get_data</a>, function in <a class="link" href="buffer-classes.html" title="Buffer classes">GArrowBuffer</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="buffer-classes.html#garrow-buffer-get-mutable-data" title="garrow_buffer_get_mutable_data ()">garrow_buffer_get_mutable_data</a>, function in <a class="link" href="buffer-classes.html" title="Buffer classes">GArrowBuffer</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="buffer-classes.html#garrow-buffer-get-parent" title="garrow_buffer_get_parent ()">garrow_buffer_get_parent</a>, function in <a class="link" href="buffer-classes.html" title="Buffer classes">GArrowBuffer</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="buffer-classes.html#garrow-buffer-get-size" title="garrow_buffer_get_size ()">garrow_buffer_get_size</a>, function in <a class="link" href="buffer-classes.html" title="Buffer classes">GArrowBuffer</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="buffer-classes.html#garrow-buffer-is-mutable" title="garrow_buffer_is_mutable ()">garrow_buffer_is_mutable</a>, function in <a class="link" href="buffer-classes.html" title="Buffer classes">GArrowBuffer</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="buffer-classes.html#garrow-buffer-new" title="garrow_buffer_new ()">garrow_buffer_new</a>, function in <a class="link" href="buffer-classes.html" title="Buffer classes">GArrowBuffer</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="buffer-classes.html#garrow-buffer-slice" title="garrow_buffer_slice ()">garrow_buffer_slice</a>, function in <a class="link" href="buffer-classes.html" title="Buffer classes">GArrowBuffer</a> +</dt> +<dd></dd> +<a name="idxM"></a><h3 class="title">M</h3> +<dt> +<a class="link" href="buffer-classes.html#garrow-mutable-buffer-new" title="garrow_mutable_buffer_new ()">garrow_mutable_buffer_new</a>, function in <a class="link" href="buffer-classes.html" title="Buffer classes">GArrowBuffer</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="buffer-classes.html#garrow-mutable-buffer-slice" title="garrow_mutable_buffer_slice ()">garrow_mutable_buffer_slice</a>, function in <a class="link" href="buffer-classes.html" title="Buffer classes">GArrowBuffer</a> +</dt> +<dd></dd> +<a name="idxP"></a><h3 class="title">P</h3> +<dt> +<a class="link" href="buffer-classes.html#garrow-pool-buffer-new" title="garrow_pool_buffer_new ()">garrow_pool_buffer_new</a>, function in <a class="link" href="buffer-classes.html" title="Buffer classes">GArrowBuffer</a> +</dt> +<dd></dd> +<a name="idxR"></a><h3 class="title">R</h3> +<dt> +<a class="link" href="buffer-classes.html#garrow-resizable-buffer-reserve" title="garrow_resizable_buffer_reserve ()">garrow_resizable_buffer_reserve</a>, function in <a class="link" href="buffer-classes.html" title="Buffer classes">GArrowBuffer</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="buffer-classes.html#garrow-resizable-buffer-resize" title="garrow_resizable_buffer_resize ()">garrow_resizable_buffer_resize</a>, function in <a class="link" href="buffer-classes.html" title="Buffer classes">GArrowBuffer</a> +</dt> +<dd></dd> +<a name="idxT"></a><h3 class="title">T</h3> +<dt> +<a class="link" href="GArrowTable.html#garrow-table-add-column" title="garrow_table_add_column ()">garrow_table_add_column</a>, function in <a class="link" href="GArrowTable.html" title="GArrowTable">GArrowTable</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="GArrowTable.html#garrow-table-remove-column" title="garrow_table_remove_column ()">garrow_table_remove_column</a>, function in <a class="link" href="GArrowTable.html" title="GArrowTable">GArrowTable</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="GArrowTensor.html#garrow-tensor-get-buffer" title="garrow_tensor_get_buffer ()">garrow_tensor_get_buffer</a>, function in <a class="link" href="GArrowTensor.html" title="GArrowTensor">GArrowTensor</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="GArrowTensor.html#garrow-tensor-get-dimension-name" title="garrow_tensor_get_dimension_name ()">garrow_tensor_get_dimension_name</a>, function in <a class="link" href="GArrowTensor.html" title="GArrowTensor">GArrowTensor</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="GArrowTensor.html#garrow-tensor-get-n-dimensions" title="garrow_tensor_get_n_dimensions ()">garrow_tensor_get_n_dimensions</a>, function in <a class="link" href="GArrowTensor.html" title="GArrowTensor">GArrowTensor</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="GArrowTensor.html#garrow-tensor-get-shape" title="garrow_tensor_get_shape ()">garrow_tensor_get_shape</a>, function in <a class="link" href="GArrowTensor.html" title="GArrowTensor">GArrowTensor</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="GArrowTensor.html#garrow-tensor-get-size" title="garrow_tensor_get_size ()">garrow_tensor_get_size</a>, function in <a class="link" href="GArrowTensor.html" title="GArrowTensor">GArrowTensor</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="GArrowTensor.html#garrow-tensor-get-strides" title="garrow_tensor_get_strides ()">garrow_tensor_get_strides</a>, function in <a class="link" href="GArrowTensor.html" title="GArrowTensor">GArrowTensor</a> +</dt> +<dd></dd> +<dt> +<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>, function in <a class="link" href="GArrowTensor.html" title="GArrowTensor">GArrowTensor</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="GArrowTensor.html#garrow-tensor-get-value-type" title="garrow_tensor_get_value_type ()">garrow_tensor_get_value_type</a>, function in <a class="link" href="GArrowTensor.html" title="GArrowTensor">GArrowTensor</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="GArrowTensor.html#garrow-tensor-is-column-major" title="garrow_tensor_is_column_major ()">garrow_tensor_is_column_major</a>, function in <a class="link" href="GArrowTensor.html" title="GArrowTensor">GArrowTensor</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="GArrowTensor.html#garrow-tensor-is-contiguous" title="garrow_tensor_is_contiguous ()">garrow_tensor_is_contiguous</a>, function in <a class="link" href="GArrowTensor.html" title="GArrowTensor">GArrowTensor</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="GArrowTensor.html#garrow-tensor-is-mutable" title="garrow_tensor_is_mutable ()">garrow_tensor_is_mutable</a>, function in <a class="link" href="GArrowTensor.html" title="GArrowTensor">GArrowTensor</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="GArrowTensor.html#garrow-tensor-is-row-major" title="garrow_tensor_is_row_major ()">garrow_tensor_is_row_major</a>, function in <a class="link" href="GArrowTensor.html" title="GArrowTensor">GArrowTensor</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="GArrowTensor.html#garrow-tensor-new" title="garrow_tensor_new ()">garrow_tensor_new</a>, function in <a class="link" href="GArrowTensor.html" title="GArrowTensor">GArrowTensor</a> +</dt> +<dd></dd> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.20</div> +</body> +</html>
