Return-Path: X-Original-To: archive-asf-public-internal@cust-asf2.ponee.io Delivered-To: archive-asf-public-internal@cust-asf2.ponee.io Received: from cust-asf.ponee.io (cust-asf.ponee.io [163.172.22.183]) by cust-asf2.ponee.io (Postfix) with ESMTP id 66699200C86 for ; Tue, 25 Apr 2017 23:28:47 +0200 (CEST) Received: by cust-asf.ponee.io (Postfix) id 650CE160BB3; Tue, 25 Apr 2017 21:28:47 +0000 (UTC) Delivered-To: archive-asf-public@cust-asf.ponee.io Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by cust-asf.ponee.io (Postfix) with SMTP id 28EED160BB8 for ; Tue, 25 Apr 2017 23:28:45 +0200 (CEST) Received: (qmail 87406 invoked by uid 500); 25 Apr 2017 21:28:44 -0000 Mailing-List: contact commits-help@arrow.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@arrow.apache.org Delivered-To: mailing list commits@arrow.apache.org Received: (qmail 87179 invoked by uid 99); 25 Apr 2017 21:28:43 -0000 Received: from git1-us-west.apache.org (HELO git1-us-west.apache.org) (140.211.11.23) by apache.org (qpsmtpd/0.29) with ESMTP; Tue, 25 Apr 2017 21:28:43 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id 57A2ADFC4A; Tue, 25 Apr 2017 21:28:43 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit From: wesm@apache.org To: commits@arrow.apache.org Date: Tue, 25 Apr 2017 21:28:54 -0000 Message-Id: <87082c0add77408ebd3f539eff79e185@git.apache.org> In-Reply-To: References: X-Mailer: ASF-Git Admin Mailer Subject: [12/12] arrow-site git commit: Add initial GLib docs archived-at: Tue, 25 Apr 2017 21:28:47 -0000 Add initial GLib docs Project: http://git-wip-us.apache.org/repos/asf/arrow-site/repo Commit: http://git-wip-us.apache.org/repos/asf/arrow-site/commit/cf45c51a Tree: http://git-wip-us.apache.org/repos/asf/arrow-site/tree/cf45c51a Diff: http://git-wip-us.apache.org/repos/asf/arrow-site/diff/cf45c51a Branch: refs/heads/asf-site Commit: cf45c51a3f9016ef9917a4aaa994543977dc1525 Parents: 36041ec Author: Wes McKinney Authored: Tue Apr 25 17:28:29 2017 -0400 Committer: Wes McKinney Committed: Tue Apr 25 17:28:29 2017 -0400 ---------------------------------------------------------------------- docs/c_glib/GArrowChunkedArray.html | 322 +++ docs/c_glib/GArrowColumn.html | 397 +++ docs/c_glib/GArrowField.html | 378 +++ docs/c_glib/GArrowFile.html | 203 ++ docs/c_glib/GArrowFileOutputStream.html | 163 ++ docs/c_glib/GArrowFileReader.html | 303 +++ docs/c_glib/GArrowFileWriter.html | 224 ++ docs/c_glib/GArrowInputStream.html | 76 + docs/c_glib/GArrowMemoryMappedFile.html | 164 ++ docs/c_glib/GArrowOutputStream.html | 76 + docs/c_glib/GArrowRandomAccessFile.html | 228 ++ docs/c_glib/GArrowReadable.html | 144 ++ docs/c_glib/GArrowRecordBatch.html | 430 ++++ docs/c_glib/GArrowSchema.html | 330 +++ docs/c_glib/GArrowStreamReader.html | 230 ++ docs/c_glib/GArrowStreamWriter.html | 251 ++ docs/c_glib/GArrowTable.html | 402 +++ docs/c_glib/GArrowTensor.html | 643 +++++ docs/c_glib/GArrowWriteable.html | 183 ++ docs/c_glib/GArrowWriteableFile.html | 143 ++ docs/c_glib/annotation-glossary.html | 47 + docs/c_glib/api-index-0-3-0.html | 178 ++ docs/c_glib/api-index-full.html | 1423 +++++++++++ docs/c_glib/array-builder-classes.html | 2366 ++++++++++++++++++ docs/c_glib/array-builder.html | 33 + docs/c_glib/array-classes.html | 1714 +++++++++++++ docs/c_glib/array.html | 33 + docs/c_glib/arrow-glib-GArrowError.html | 177 ++ docs/c_glib/arrow-glib-GArrowFileMode.html | 106 + .../arrow-glib-GArrowMetadataVersion.html | 107 + docs/c_glib/arrow-glib-GArrowType.html | 269 ++ docs/c_glib/arrow-glib.devhelp2 | 413 +++ docs/c_glib/buffer-classes.html | 740 ++++++ docs/c_glib/buffer.html | 33 + docs/c_glib/data-type-classes.html | 1032 ++++++++ docs/c_glib/data.html | 88 + docs/c_glib/deprecated-api-index.html | 31 + docs/c_glib/error.html | 33 + docs/c_glib/home.png | Bin 0 -> 169 bytes docs/c_glib/index.html | 160 ++ docs/c_glib/index.sgml | 625 +++++ docs/c_glib/input-output.html | 38 + docs/c_glib/input.html | 41 + docs/c_glib/io.html | 75 + docs/c_glib/ipc.html | 57 + docs/c_glib/left-insensitive.png | Bin 0 -> 329 bytes docs/c_glib/left.png | Bin 0 -> 187 bytes docs/c_glib/metadata.html | 33 + docs/c_glib/mode.html | 33 + docs/c_glib/object-tree.html | 109 + docs/c_glib/output.html | 44 + docs/c_glib/reader.html | 38 + docs/c_glib/right-insensitive.png | Bin 0 -> 233 bytes docs/c_glib/right.png | Bin 0 -> 186 bytes docs/c_glib/schema.html | 38 + docs/c_glib/style.css | 461 ++++ docs/c_glib/table.html | 44 + docs/c_glib/tensor.html | 33 + docs/c_glib/type.html | 38 + docs/c_glib/up-insensitive.png | Bin 0 -> 293 bytes docs/c_glib/up.png | Bin 0 -> 187 bytes docs/c_glib/writer.html | 38 + 62 files changed, 16018 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/arrow-site/blob/cf45c51a/docs/c_glib/GArrowChunkedArray.html ---------------------------------------------------------------------- diff --git a/docs/c_glib/GArrowChunkedArray.html b/docs/c_glib/GArrowChunkedArray.html new file mode 100644 index 0000000..ed6086d --- /dev/null +++ b/docs/c_glib/GArrowChunkedArray.html @@ -0,0 +1,322 @@ + + + + + Reference Manual: GArrowChunkedArray + + + + + + + + + + + + + + + + +
+
+
+ + +
+

GArrowChunkedArray

+

GArrowChunkedArray — Chunked array class

+
+
+

Functions

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+GArrowChunkedArray * + +garrow_chunked_array_new () +
+guint64 + +garrow_chunked_array_get_length () +
+guint64 + +garrow_chunked_array_get_n_nulls () +
+guint + +garrow_chunked_array_get_n_chunks () +
+GArrowArray * + +garrow_chunked_array_get_chunk () +
+GList * + +garrow_chunked_array_get_chunks () +
+
+
+

Properties

+
+++++ + + + + + +
gpointerchunked-arrayWrite / Construct Only
+
+
+

Types and Values

+
++++ + + + + +
structGArrowChunkedArray
+
+
+

Object Hierarchy

+
    GObject
+    ╰── GArrowChunkedArray
+
+
+
+

Description

+

GArrowChunkedArray is a class for chunked array. Chunked array +makes a list of GArrowArrays one logical large array.

+
+
+

Functions

+
+

garrow_chunked_array_new ()

+
GArrowChunkedArray *
+garrow_chunked_array_new (GList *chunks);
+
+

Parameters

+
+++++ + + + + + +

chunks

The array chunks.

[element-type GArrowArray]
+
+
+

Returns

+

A newly created GArrowChunkedArray.

+

+
+
+
+
+

garrow_chunked_array_get_length ()

+
guint64
+garrow_chunked_array_get_length (GArrowChunkedArray *chunked_array);
+
+

Parameters

+
+++++ + + + + + +

chunked_array

A GArrowChunkedArray.

 
+
+
+

Returns

+

The total number of rows in the chunked array.

+

+
+
+
+
+

garrow_chunked_array_get_n_nulls ()

+
guint64
+garrow_chunked_array_get_n_nulls (GArrowChunkedArray *chunked_array);
+
+

Parameters

+
+++++ + + + + + +

chunked_array

A GArrowChunkedArray.

 
+
+
+

Returns

+

The total number of NULL in the chunked array.

+

+
+
+
+
+

garrow_chunked_array_get_n_chunks ()

+
guint
+garrow_chunked_array_get_n_chunks (GArrowChunkedArray *chunked_array);
+
+

Parameters

+
+++++ + + + + + +

chunked_array

A GArrowChunkedArray.

 
+
+
+

Returns

+

The total number of chunks in the chunked array.

+

+
+
+
+
+

garrow_chunked_array_get_chunk ()

+
GArrowArray *
+garrow_chunked_array_get_chunk (GArrowChunkedArray *chunked_array,
+                                guint i);
+
+

Parameters

+
+++++ + + + + + + + + + + + + +

chunked_array

A GArrowChunkedArray.

 

i

The index of the target chunk.

 
+
+
+

Returns

+

The i-th chunk of the chunked array.

+

[transfer full]

+
+
+
+
+

garrow_chunked_array_get_chunks ()

+
GList *
+garrow_chunked_array_get_chunks (GArrowChunkedArray *chunked_array);
+
+

Parameters

+
+++++ + + + + + +

chunked_array

A GArrowChunkedArray.

 
+
+
+

Returns

+

The chunks in the chunked array.

+

[element-type GArrowArray][transfer full]

+
+
+
+
+

Types and Values

+
+

struct GArrowChunkedArray

+
struct GArrowChunkedArray;
+

It wraps arrow::ChunkedArray.

+
+
+
+

Property Details

+
+

The “chunked-array” property

+
  “chunked-array”            gpointer
+

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

+

Flags: Write / Construct Only

+
+
+
+
+
+ Generated by GTK-Doc V1.20
+ + http://git-wip-us.apache.org/repos/asf/arrow-site/blob/cf45c51a/docs/c_glib/GArrowColumn.html ---------------------------------------------------------------------- diff --git a/docs/c_glib/GArrowColumn.html b/docs/c_glib/GArrowColumn.html new file mode 100644 index 0000000..d544e34 --- /dev/null +++ b/docs/c_glib/GArrowColumn.html @@ -0,0 +1,397 @@ + + + + + Reference Manual: GArrowColumn + + + + + + + + + + + + + + + + +
+
+
+ + +
+

GArrowColumn

+

GArrowColumn — Column class

+
+
+

Functions

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+GArrowColumn * + +garrow_column_new_array () +
+GArrowColumn * + +garrow_column_new_chunked_array () +
+guint64 + +garrow_column_get_length () +
+guint64 + +garrow_column_get_n_nulls () +
+GArrowField * + +garrow_column_get_field () +
const gchar * + +garrow_column_get_name () +
+GArrowDataType * + +garrow_column_get_data_type () +
+GArrowChunkedArray * + +garrow_column_get_data () +
+
+
+

Properties

+
+++++ + + + + + +
gpointercolumnWrite / Construct Only
+
+
+

Types and Values

+
++++ + + + + +
structGArrowColumn
+
+
+

Object Hierarchy

+
    GObject
+    ╰── GArrowColumn
+
+
+
+

Description

+

GArrowColumn is a class for column. Column has a GArrowField and +zero or more values. Values are GArrowChunkedArray.

+
+
+

Functions

+
+

garrow_column_new_array ()

+
GArrowColumn *
+garrow_column_new_array (GArrowField *field,
+                         GArrowArray *array);
+
+

Parameters

+
+++++ + + + + + + + + + + + + +

field

The metadata of the column.

 

array

The data of the column.

 
+
+
+

Returns

+

A newly created GArrowColumn.

+

+
+
+
+
+

garrow_column_new_chunked_array ()

+
GArrowColumn *
+garrow_column_new_chunked_array (GArrowField *field,
+                                 GArrowChunkedArray *chunked_array);
+
+

Parameters

+
+++++ + + + + + + + + + + + + +

field

The metadata of the column.

 

chunked_array

The data of the column.

 
+
+
+

Returns

+

A newly created GArrowColumn.

+

+
+
+
+
+

garrow_column_get_length ()

+
guint64
+garrow_column_get_length (GArrowColumn *column);
+
+

Parameters

+
+++++ + + + + + +

column

A GArrowColumn.

 
+
+
+

Returns

+

The number of data of the column.

+

+
+
+
+
+

garrow_column_get_n_nulls ()

+
guint64
+garrow_column_get_n_nulls (GArrowColumn *column);
+
+

Parameters

+
+++++ + + + + + +

column

A GArrowColumn.

 
+
+
+

Returns

+

The number of nulls of the column.

+

+
+
+
+
+

garrow_column_get_field ()

+
GArrowField *
+garrow_column_get_field (GArrowColumn *column);
+
+

Parameters

+
+++++ + + + + + +

column

A GArrowColumn.

 
+
+
+

Returns

+

The metadata of the column.

+

[transfer full]

+
+
+
+
+

garrow_column_get_name ()

+
const gchar *
+garrow_column_get_name (GArrowColumn *column);
+
+

Parameters

+
+++++ + + + + + +

column

A GArrowColumn.

 
+
+
+

Returns

+

The name of the column.

+

+
+
+
+
+

garrow_column_get_data_type ()

+
GArrowDataType *
+garrow_column_get_data_type (GArrowColumn *column);
+
+

Parameters

+
+++++ + + + + + +

column

A GArrowColumn.

 
+
+
+

Returns

+

The data type of the column.

+

[transfer full]

+
+
+
+
+

garrow_column_get_data ()

+
GArrowChunkedArray *
+garrow_column_get_data (GArrowColumn *column);
+
+

Parameters

+
+++++ + + + + + +

column

A GArrowColumn.

 
+
+
+

Returns

+

The data of the column.

+

[transfer full]

+
+
+
+
+

Types and Values

+
+

struct GArrowColumn

+
struct GArrowColumn;
+

It wraps arrow::Column.

+
+
+
+

Property Details

+
+

The “column” property

+
  “column”                   gpointer
+

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

+

Flags: Write / Construct Only

+
+
+
+
+
+ Generated by GTK-Doc V1.20
+ + http://git-wip-us.apache.org/repos/asf/arrow-site/blob/cf45c51a/docs/c_glib/GArrowField.html ---------------------------------------------------------------------- diff --git a/docs/c_glib/GArrowField.html b/docs/c_glib/GArrowField.html new file mode 100644 index 0000000..f44948a --- /dev/null +++ b/docs/c_glib/GArrowField.html @@ -0,0 +1,378 @@ + + + + + Reference Manual: GArrowField + + + + + + + + + + + + + + + + +
+
+
+ + +
+

GArrowField

+

GArrowField — Field class

+
+
+

Functions

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+GArrowField * + +garrow_field_new () +
+GArrowField * + +garrow_field_new_full () +
const gchar * + +garrow_field_get_name () +
+GArrowDataType * + +garrow_field_get_data_type () +
+gboolean + +garrow_field_is_nullable () +
+gboolean + +garrow_field_equal () +
+gchar * + +garrow_field_to_string () +
+
+
+

Properties

+
+++++ + + + + + +
gpointerfieldWrite / Construct Only
+
+
+

Types and Values

+
++++ + + + + +
structGArrowField
+
+
+

Object Hierarchy

+
    GObject
+    ╰── GArrowField
+
+
+
+

Description

+

GArrowField is a class for field. Field is metadata of a +column. It has name, data type (GArrowDataType) and nullable +information of the column.

+
+
+

Functions

+
+

garrow_field_new ()

+
GArrowField *
+garrow_field_new (const gchar *name,
+                  GArrowDataType *data_type);
+
+

Parameters

+
+++++ + + + + + + + + + + + + +

name

The name of the field.

 

data_type

The data type of the field.

 
+
+
+

Returns

+

A newly created GArrowField.

+

+
+
+
+
+

garrow_field_new_full ()

+
GArrowField *
+garrow_field_new_full (const gchar *name,
+                       GArrowDataType *data_type,
+                       gboolean nullable);
+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + +

name

The name of the field.

 

data_type

The data type of the field.

 

nullable

Whether null may be included or not.

 
+
+
+

Returns

+

A newly created GArrowField.

+

+
+
+
+
+

garrow_field_get_name ()

+
const gchar *
+garrow_field_get_name (GArrowField *field);
+
+

Parameters

+
+++++ + + + + + +

field

A GArrowField.

 
+
+
+

Returns

+

The name of the field.

+

+
+
+
+
+

garrow_field_get_data_type ()

+
GArrowDataType *
+garrow_field_get_data_type (GArrowField *field);
+
+

Parameters

+
+++++ + + + + + +

field

A GArrowField.

 
+
+
+

Returns

+

The data type of the field.

+

[transfer full]

+
+
+
+
+

garrow_field_is_nullable ()

+
gboolean
+garrow_field_is_nullable (GArrowField *field);
+
+

Parameters

+
+++++ + + + + + +

field

A GArrowField.

 
+
+
+

Returns

+

Whether the filed may include null or not.

+

+
+
+
+
+

garrow_field_equal ()

+
gboolean
+garrow_field_equal (GArrowField *field,
+                    GArrowField *other_field);
+
+

Parameters

+
+++++ + + + + + + + + + + + + +

field

A GArrowField.

 

other_field

A GArrowField.

 
+
+
+

Returns

+

Whether they are equal or not.

+

+
+
+
+
+

garrow_field_to_string ()

+
gchar *
+garrow_field_to_string (GArrowField *field);
+
+

Parameters

+
+++++ + + + + + +

field

A GArrowField.

 
+
+
+

Returns

+

The string representation of the field.

+

+
+
+
+
+

Types and Values

+
+

struct GArrowField

+
struct GArrowField;
+

It wraps arrow::Field.

+
+
+
+

Property Details

+
+

The “field” property

+
  “field”                    gpointer
+

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

+

Flags: Write / Construct Only

+
+
+
+
+
+ Generated by GTK-Doc V1.20
+ + http://git-wip-us.apache.org/repos/asf/arrow-site/blob/cf45c51a/docs/c_glib/GArrowFile.html ---------------------------------------------------------------------- diff --git a/docs/c_glib/GArrowFile.html b/docs/c_glib/GArrowFile.html new file mode 100644 index 0000000..8c2e77b --- /dev/null +++ b/docs/c_glib/GArrowFile.html @@ -0,0 +1,203 @@ + + + + + Reference Manual: GArrowFile + + + + + + + + + + + + + + + + +
+
+
+ + +
+

GArrowFile

+

GArrowFile — File interface

+
+
+

Functions

+
++++ + + + + + + + + + + + + + + +
+gboolean + +garrow_file_close () +
+gint64 + +garrow_file_tell () +
+GArrowFileMode + +garrow_file_get_mode () +
+
+
+

Types and Values

+
++++ + + + + +
 GArrowFileInterface
+
+
+

Object Hierarchy

+
    GInterface
+    ╰── GArrowFile
+
+
+
+

Description

+

GArrowFile is an interface for file.

+
+
+

Functions

+
+

garrow_file_close ()

+
gboolean
+garrow_file_close (GArrowFile *file,
+                   GError **error);
+
+

Parameters

+
+++++ + + + + + + + + + + + + +

file

A GArrowFile.

 

error

Return location for a GError or NULL.

[nullable]
+
+
+

Returns

+

TRUE on success, FALSE if there was an error.

+

+
+
+
+
+

garrow_file_tell ()

+
gint64
+garrow_file_tell (GArrowFile *file,
+                  GError **error);
+
+

Parameters

+
+++++ + + + + + + + + + + + + +

file

A GArrowFile.

 

error

Return location for a GError or NULL.

[nullable]
+
+
+

Returns

+

The current offset on success, -1 if there was an error.

+

+
+
+
+
+

garrow_file_get_mode ()

+
GArrowFileMode
+garrow_file_get_mode (GArrowFile *file);
+
+

Parameters

+
+++++ + + + + + +

file

A GArrowFile.

 
+
+
+

Returns

+

The mode of the file.

+

+
+
+
+
+

Types and Values

+
+

GArrowFileInterface

+
typedef struct _GArrowFileInterface GArrowFileInterface;
+

+

+
+
+
+
+
+ Generated by GTK-Doc V1.20
+ + http://git-wip-us.apache.org/repos/asf/arrow-site/blob/cf45c51a/docs/c_glib/GArrowFileOutputStream.html ---------------------------------------------------------------------- diff --git a/docs/c_glib/GArrowFileOutputStream.html b/docs/c_glib/GArrowFileOutputStream.html new file mode 100644 index 0000000..d3155f3 --- /dev/null +++ b/docs/c_glib/GArrowFileOutputStream.html @@ -0,0 +1,163 @@ + + + + + Reference Manual: GArrowFileOutputStream + + + + + + + + + + + + + + + + +
+
+
+ + +
+

GArrowFileOutputStream

+

GArrowFileOutputStream — A file output stream.

+
+
+

Functions

+
++++ + + + + +
+GArrowFileOutputStream * + +garrow_file_output_stream_open () +
+
+
+

Properties

+
+++++ + + + + + +
gpointerfile-output-streamWrite / Construct Only
+
+
+

Types and Values

+
++++ + + + + +
structGArrowFileOutputStream
+
+
+

Object Hierarchy

+
    GObject
+    ╰── GArrowFileOutputStream
+
+
+
+

Implemented Interfaces

+

+GArrowFileOutputStream implements +

+
+
+

Description

+

The GArrowFileOutputStream is a class for file output stream.

+
+
+

Functions

+
+

garrow_file_output_stream_open ()

+
GArrowFileOutputStream *
+garrow_file_output_stream_open (const gchar *path,
+                                gboolean append,
+                                GError **error);
+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + +

path

The path of the file output stream.

 

append

Whether the path is opened as append mode or recreate mode.

 

error

Return location for a GError or NULL.

[nullable]
+
+
+

Returns

+

A newly opened +GArrowFileOutputStream or NULL on error.

+

[nullable][transfer full]

+
+
+
+
+

Types and Values

+
+

struct GArrowFileOutputStream

+
struct GArrowFileOutputStream;
+

It wraps arrow::io::FileOutputStream.

+
+
+
+

Property Details

+
+

The “file-output-stream” property

+
  “file-output-stream”       gpointer
+

The raw std::shared<arrow::io::FileOutputStream> *.

+

Flags: Write / Construct Only

+
+
+
+
+
+ Generated by GTK-Doc V1.20
+ +