You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@arrow.apache.org by we...@apache.org on 2019/04/03 01:57:58 UTC
[arrow-site] branch asf-site updated: 0.13.0 main documentation
This is an automated email from the ASF dual-hosted git repository.
wesm pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/arrow-site.git
The following commit(s) were added to refs/heads/asf-site by this push:
new 2152ba2 0.13.0 main documentation
2152ba2 is described below
commit 2152ba23733d467a0bc93106b8bc9189c0a7fff3
Author: Wes McKinney <we...@apache.org>
AuthorDate: Tue Apr 2 20:57:46 2019 -0500
0.13.0 main documentation
---
docs/.buildinfo | 2 +-
docs/_modules/index.html | 56 +-
docs/_modules/pyarrow.html | 63 +-
docs/_modules/pyarrow/feather.html | 56 +-
docs/_modules/pyarrow/filesystem.html | 108 +-
docs/_modules/pyarrow/hdfs.html | 74 +-
docs/_modules/pyarrow/ipc.html | 68 +-
docs/_modules/pyarrow/parquet.html | 141 +--
docs/_modules/pyarrow/types.html | 132 ++-
docs/_sources/cpp/api.rst.txt | 2 +
docs/_sources/cpp/api/cuda.rst.txt | 69 ++
.../cpp/{api.rst.txt => api/utilities.rst.txt} | 19 +-
.../cpp/{api.rst.txt => examples/index.rst.txt} | 15 +-
.../row_columnar_conversion.rst.txt} | 19 +-
.../cpp/examples/tuple_range_conversion.rst.txt | 106 ++
docs/_sources/cpp/index.rst.txt | 2 +-
docs/_sources/developers/contributing.rst.txt | 88 ++
docs/_sources/developers/cpp.rst.txt | 921 ++++++++++++++++
docs/_sources/developers/documentation.rst.txt | 95 ++
.../{cpp/api.rst.txt => developers/index.rst.txt} | 17 +-
docs/_sources/developers/integration.rst.txt | 69 ++
.../python.rst.txt} | 231 ++--
docs/_sources/format/Layout.rst.txt | 29 +-
docs/_sources/format/README.rst.txt | 2 +-
docs/_sources/index.rst.txt | 32 +-
docs/_sources/python/benchmarks.rst.txt | 2 +
docs/_sources/python/development.rst.txt | 138 ++-
.../python/generated/pyarrow.Schema.rst.txt | 1 +
.../python/generated/pyarrow.UnionType.rst.txt | 1 +
.../python/generated/pyarrow.cuda.Context.rst.txt | 2 +
.../generated/pyarrow.plasma.PlasmaClient.rst.txt | 1 +
docs/_sources/python/index.rst.txt | 2 +-
docs/_sources/python/install.rst.txt | 29 +-
docs/_sources/python/parquet.rst.txt | 6 +-
docs/_sources/python/timestamps.rst.txt | 198 ++++
docs/_static/basic.css | 2 +-
docs/_static/css/badge_only.css | 2 +-
docs/_static/css/theme.css | 8 +-
docs/_static/doctools.js | 2 +-
docs/_static/documentation_options.js | 2 +-
docs/_static/js/theme.js | 6 +-
docs/_static/language_data.js | 2 +-
docs/_static/searchtools.js | 2 +-
docs/_static/websupport.js | 2 +-
docs/cpp/api.html | 75 +-
docs/cpp/api/array.html | 305 +++---
docs/cpp/api/builder.html | 531 +++++----
docs/cpp/api/cuda.html | 763 +++++++++++++
docs/cpp/api/datatype.html | 748 ++++++-------
docs/cpp/api/memory.html | 430 ++++----
docs/cpp/api/support.html | 190 ++--
docs/cpp/api/table.html | 344 +++---
docs/cpp/api/utilities.html | 367 +++++++
docs/cpp/arrays.html | 78 +-
docs/cpp/conventions.html | 64 +-
docs/cpp/datatypes.html | 78 +-
.../examples/index.html} | 115 +-
docs/cpp/examples/row_columnar_conversion.html | 441 ++++++++
docs/cpp/examples/tuple_range_conversion.html | 322 ++++++
docs/cpp/getting_started.html | 60 +-
docs/cpp/index.html | 67 +-
docs/cpp/memory.html | 78 +-
docs/cpp/overview.html | 60 +-
docs/cpp/tables.html | 82 +-
docs/developers/contributing.html | 300 ++++++
docs/developers/cpp.html | 1058 ++++++++++++++++++
docs/developers/documentation.html | 299 ++++++
docs/{cpp => developers}/index.html | 126 +--
docs/developers/integration.html | 284 +++++
.../development.html => developers/python.html} | 345 +++---
docs/format/Guidelines.html | 58 +-
docs/format/IPC.html | 58 +-
docs/format/Layout.html | 85 +-
docs/format/Metadata.html | 58 +-
docs/format/README.html | 60 +-
docs/genindex.html | 1126 ++++++++++++--------
docs/index.html | 126 ++-
docs/objects.inv | Bin 32136 -> 35288 bytes
docs/python/api.html | 60 +-
docs/python/api/arrays.html | 60 +-
docs/python/api/cuda.html | 60 +-
docs/python/api/datatypes.html | 60 +-
docs/python/api/files.html | 60 +-
docs/python/api/formats.html | 60 +-
docs/python/api/ipc.html | 60 +-
docs/python/api/memory.html | 60 +-
docs/python/api/misc.html | 60 +-
docs/python/api/plasma.html | 60 +-
docs/python/api/tables.html | 60 +-
docs/python/benchmarks.html | 66 +-
docs/python/csv.html | 62 +-
docs/python/cuda.html | 60 +-
docs/python/data.html | 92 +-
docs/python/development.html | 203 ++--
docs/python/extending.html | 172 ++-
docs/python/filesystems.html | 60 +-
docs/python/generated/pyarrow.Array.html | 66 +-
docs/python/generated/pyarrow.ArrayValue.html | 60 +-
docs/python/generated/pyarrow.BinaryArray.html | 66 +-
docs/python/generated/pyarrow.BinaryValue.html | 60 +-
docs/python/generated/pyarrow.BooleanArray.html | 66 +-
docs/python/generated/pyarrow.BooleanValue.html | 60 +-
docs/python/generated/pyarrow.Buffer.html | 60 +-
.../generated/pyarrow.BufferOutputStream.html | 60 +-
docs/python/generated/pyarrow.BufferReader.html | 60 +-
docs/python/generated/pyarrow.ChunkedArray.html | 60 +-
docs/python/generated/pyarrow.Column.html | 60 +-
.../generated/pyarrow.CompressedInputStream.html | 60 +-
.../generated/pyarrow.CompressedOutputStream.html | 60 +-
docs/python/generated/pyarrow.DataType.html | 60 +-
docs/python/generated/pyarrow.Date32Array.html | 66 +-
docs/python/generated/pyarrow.Date32Value.html | 60 +-
docs/python/generated/pyarrow.Date64Array.html | 66 +-
docs/python/generated/pyarrow.Date64Value.html | 60 +-
docs/python/generated/pyarrow.Decimal128Array.html | 66 +-
docs/python/generated/pyarrow.Decimal128Type.html | 60 +-
docs/python/generated/pyarrow.DecimalValue.html | 60 +-
docs/python/generated/pyarrow.DictionaryArray.html | 66 +-
docs/python/generated/pyarrow.DictionaryType.html | 60 +-
docs/python/generated/pyarrow.DictionaryValue.html | 60 +-
docs/python/generated/pyarrow.DoubleValue.html | 60 +-
docs/python/generated/pyarrow.Field.html | 60 +-
.../generated/pyarrow.FixedSizeBinaryArray.html | 66 +-
.../generated/pyarrow.FixedSizeBinaryType.html | 60 +-
.../generated/pyarrow.FixedSizeBinaryValue.html | 60 +-
.../generated/pyarrow.FixedSizeBufferWriter.html | 60 +-
docs/python/generated/pyarrow.FloatValue.html | 60 +-
.../generated/pyarrow.FloatingPointArray.html | 66 +-
.../generated/pyarrow.HadoopFileSystem.cat.html | 60 +-
.../generated/pyarrow.HadoopFileSystem.chmod.html | 60 +-
.../generated/pyarrow.HadoopFileSystem.chown.html | 60 +-
.../generated/pyarrow.HadoopFileSystem.delete.html | 60 +-
.../generated/pyarrow.HadoopFileSystem.df.html | 60 +-
.../pyarrow.HadoopFileSystem.disk_usage.html | 60 +-
.../pyarrow.HadoopFileSystem.download.html | 60 +-
.../generated/pyarrow.HadoopFileSystem.exists.html | 60 +-
.../pyarrow.HadoopFileSystem.get_capacity.html | 60 +-
.../pyarrow.HadoopFileSystem.get_space_used.html | 60 +-
.../generated/pyarrow.HadoopFileSystem.info.html | 60 +-
.../generated/pyarrow.HadoopFileSystem.ls.html | 60 +-
.../generated/pyarrow.HadoopFileSystem.mkdir.html | 60 +-
.../generated/pyarrow.HadoopFileSystem.open.html | 60 +-
.../generated/pyarrow.HadoopFileSystem.rename.html | 60 +-
.../generated/pyarrow.HadoopFileSystem.rm.html | 60 +-
.../generated/pyarrow.HadoopFileSystem.upload.html | 60 +-
docs/python/generated/pyarrow.HdfsFile.html | 60 +-
docs/python/generated/pyarrow.Int16Array.html | 66 +-
docs/python/generated/pyarrow.Int16Value.html | 60 +-
docs/python/generated/pyarrow.Int32Array.html | 66 +-
docs/python/generated/pyarrow.Int32Value.html | 60 +-
docs/python/generated/pyarrow.Int64Array.html | 66 +-
docs/python/generated/pyarrow.Int64Value.html | 60 +-
docs/python/generated/pyarrow.Int8Array.html | 66 +-
docs/python/generated/pyarrow.Int8Value.html | 60 +-
docs/python/generated/pyarrow.IntegerArray.html | 66 +-
docs/python/generated/pyarrow.ListArray.html | 66 +-
docs/python/generated/pyarrow.ListType.html | 60 +-
docs/python/generated/pyarrow.ListValue.html | 60 +-
docs/python/generated/pyarrow.LocalFileSystem.html | 60 +-
.../python/generated/pyarrow.MemoryMappedFile.html | 60 +-
docs/python/generated/pyarrow.MemoryPool.html | 60 +-
docs/python/generated/pyarrow.Message.html | 60 +-
docs/python/generated/pyarrow.MessageReader.html | 60 +-
docs/python/generated/pyarrow.NA.html | 60 +-
docs/python/generated/pyarrow.NativeFile.html | 60 +-
docs/python/generated/pyarrow.NullArray.html | 66 +-
docs/python/generated/pyarrow.NumericArray.html | 66 +-
docs/python/generated/pyarrow.OSFile.html | 60 +-
docs/python/generated/pyarrow.PythonFile.html | 60 +-
docs/python/generated/pyarrow.RecordBatch.html | 60 +-
.../generated/pyarrow.RecordBatchFileReader.html | 60 +-
.../generated/pyarrow.RecordBatchFileWriter.html | 60 +-
.../generated/pyarrow.RecordBatchStreamReader.html | 62 +-
.../generated/pyarrow.RecordBatchStreamWriter.html | 62 +-
docs/python/generated/pyarrow.ResizableBuffer.html | 60 +-
docs/python/generated/pyarrow.Scalar.html | 60 +-
docs/python/generated/pyarrow.Schema.html | 71 +-
.../generated/pyarrow.SerializationContext.html | 60 +-
.../generated/pyarrow.SerializedPyObject.html | 60 +-
docs/python/generated/pyarrow.StringArray.html | 66 +-
docs/python/generated/pyarrow.StringValue.html | 60 +-
docs/python/generated/pyarrow.StructArray.html | 66 +-
docs/python/generated/pyarrow.StructType.html | 60 +-
docs/python/generated/pyarrow.StructValue.html | 60 +-
docs/python/generated/pyarrow.Table.html | 60 +-
docs/python/generated/pyarrow.Tensor.html | 60 +-
docs/python/generated/pyarrow.Time32Array.html | 66 +-
docs/python/generated/pyarrow.Time32Type.html | 60 +-
docs/python/generated/pyarrow.Time32Value.html | 60 +-
docs/python/generated/pyarrow.Time64Array.html | 66 +-
docs/python/generated/pyarrow.Time64Type.html | 60 +-
docs/python/generated/pyarrow.Time64Value.html | 60 +-
docs/python/generated/pyarrow.TimestampArray.html | 66 +-
docs/python/generated/pyarrow.TimestampType.html | 60 +-
docs/python/generated/pyarrow.TimestampValue.html | 60 +-
docs/python/generated/pyarrow.UInt16Array.html | 66 +-
docs/python/generated/pyarrow.UInt16Value.html | 60 +-
docs/python/generated/pyarrow.UInt32Array.html | 66 +-
docs/python/generated/pyarrow.UInt32Value.html | 60 +-
docs/python/generated/pyarrow.UInt64Array.html | 66 +-
docs/python/generated/pyarrow.UInt64Value.html | 60 +-
docs/python/generated/pyarrow.UInt8Array.html | 66 +-
docs/python/generated/pyarrow.UInt8Value.html | 60 +-
docs/python/generated/pyarrow.UnionArray.html | 66 +-
docs/python/generated/pyarrow.UnionType.html | 69 +-
docs/python/generated/pyarrow.UnionValue.html | 60 +-
docs/python/generated/pyarrow.allocate_buffer.html | 60 +-
docs/python/generated/pyarrow.array.html | 60 +-
docs/python/generated/pyarrow.binary.html | 60 +-
docs/python/generated/pyarrow.bool_.html | 60 +-
docs/python/generated/pyarrow.chunked_array.html | 60 +-
docs/python/generated/pyarrow.column.html | 60 +-
docs/python/generated/pyarrow.compress.html | 60 +-
docs/python/generated/pyarrow.concat_tables.html | 60 +-
docs/python/generated/pyarrow.cpu_count.html | 60 +-
.../generated/pyarrow.create_memory_map.html | 60 +-
.../generated/pyarrow.csv.ConvertOptions.html | 60 +-
.../python/generated/pyarrow.csv.ParseOptions.html | 60 +-
docs/python/generated/pyarrow.csv.ReadOptions.html | 60 +-
docs/python/generated/pyarrow.csv.read_csv.html | 60 +-
.../generated/pyarrow.cuda.BufferReader.html | 60 +-
.../generated/pyarrow.cuda.BufferWriter.html | 60 +-
docs/python/generated/pyarrow.cuda.Context.html | 135 ++-
docs/python/generated/pyarrow.cuda.CudaBuffer.html | 64 +-
docs/python/generated/pyarrow.cuda.HostBuffer.html | 60 +-
.../generated/pyarrow.cuda.IpcMemHandle.html | 60 +-
.../generated/pyarrow.cuda.new_host_buffer.html | 60 +-
.../generated/pyarrow.cuda.read_message.html | 60 +-
.../generated/pyarrow.cuda.read_record_batch.html | 60 +-
.../pyarrow.cuda.serialize_record_batch.html | 60 +-
docs/python/generated/pyarrow.date32.html | 60 +-
docs/python/generated/pyarrow.date64.html | 60 +-
docs/python/generated/pyarrow.decimal128.html | 60 +-
docs/python/generated/pyarrow.decompress.html | 60 +-
.../generated/pyarrow.default_memory_pool.html | 60 +-
docs/python/generated/pyarrow.deserialize.html | 60 +-
.../generated/pyarrow.deserialize_components.html | 60 +-
.../python/generated/pyarrow.deserialize_from.html | 60 +-
docs/python/generated/pyarrow.dictionary.html | 60 +-
.../generated/pyarrow.feather.read_feather.html | 60 +-
.../generated/pyarrow.feather.write_feather.html | 60 +-
docs/python/generated/pyarrow.field.html | 60 +-
docs/python/generated/pyarrow.float16.html | 60 +-
docs/python/generated/pyarrow.float32.html | 60 +-
docs/python/generated/pyarrow.float64.html | 60 +-
docs/python/generated/pyarrow.foreign_buffer.html | 60 +-
.../python/generated/pyarrow.from_numpy_dtype.html | 60 +-
docs/python/generated/pyarrow.get_include.html | 60 +-
docs/python/generated/pyarrow.get_libraries.html | 60 +-
.../python/generated/pyarrow.get_library_dirs.html | 64 +-
.../generated/pyarrow.get_record_batch_size.html | 60 +-
docs/python/generated/pyarrow.get_tensor_size.html | 60 +-
docs/python/generated/pyarrow.hdfs.connect.html | 60 +-
docs/python/generated/pyarrow.input_stream.html | 60 +-
docs/python/generated/pyarrow.int16.html | 60 +-
docs/python/generated/pyarrow.int32.html | 60 +-
docs/python/generated/pyarrow.int64.html | 60 +-
docs/python/generated/pyarrow.int8.html | 60 +-
docs/python/generated/pyarrow.ipc.open_file.html | 60 +-
docs/python/generated/pyarrow.ipc.open_stream.html | 60 +-
docs/python/generated/pyarrow.list_.html | 60 +-
.../generated/pyarrow.log_memory_allocations.html | 60 +-
docs/python/generated/pyarrow.memory_map.html | 60 +-
docs/python/generated/pyarrow.null.html | 60 +-
docs/python/generated/pyarrow.output_stream.html | 60 +-
.../generated/pyarrow.parquet.ParquetDataset.html | 66 +-
.../generated/pyarrow.parquet.ParquetFile.html | 64 +-
.../generated/pyarrow.parquet.ParquetWriter.html | 60 +-
.../generated/pyarrow.parquet.read_metadata.html | 60 +-
.../generated/pyarrow.parquet.read_pandas.html | 60 +-
.../generated/pyarrow.parquet.read_schema.html | 60 +-
.../generated/pyarrow.parquet.read_table.html | 60 +-
.../generated/pyarrow.parquet.write_metadata.html | 60 +-
.../generated/pyarrow.parquet.write_table.html | 60 +-
.../pyarrow.parquet.write_to_dataset.html | 63 +-
docs/python/generated/pyarrow.plasma.ObjectID.html | 60 +-
.../generated/pyarrow.plasma.PlasmaBuffer.html | 60 +-
.../generated/pyarrow.plasma.PlasmaClient.html | 82 +-
docs/python/generated/pyarrow.py_buffer.html | 60 +-
docs/python/generated/pyarrow.read_message.html | 60 +-
.../generated/pyarrow.read_record_batch.html | 60 +-
docs/python/generated/pyarrow.read_serialized.html | 60 +-
docs/python/generated/pyarrow.read_tensor.html | 60 +-
docs/python/generated/pyarrow.schema.html | 60 +-
docs/python/generated/pyarrow.serialize.html | 60 +-
docs/python/generated/pyarrow.serialize_to.html | 60 +-
docs/python/generated/pyarrow.set_cpu_count.html | 60 +-
docs/python/generated/pyarrow.set_memory_pool.html | 60 +-
docs/python/generated/pyarrow.string.html | 60 +-
docs/python/generated/pyarrow.struct.html | 60 +-
docs/python/generated/pyarrow.time32.html | 60 +-
docs/python/generated/pyarrow.time64.html | 60 +-
docs/python/generated/pyarrow.timestamp.html | 60 +-
.../generated/pyarrow.total_allocated_bytes.html | 60 +-
docs/python/generated/pyarrow.types.is_binary.html | 60 +-
.../python/generated/pyarrow.types.is_boolean.html | 60 +-
docs/python/generated/pyarrow.types.is_date.html | 60 +-
docs/python/generated/pyarrow.types.is_date32.html | 60 +-
docs/python/generated/pyarrow.types.is_date64.html | 60 +-
.../python/generated/pyarrow.types.is_decimal.html | 60 +-
.../generated/pyarrow.types.is_dictionary.html | 60 +-
.../pyarrow.types.is_fixed_size_binary.html | 60 +-
.../python/generated/pyarrow.types.is_float16.html | 60 +-
.../python/generated/pyarrow.types.is_float32.html | 60 +-
.../python/generated/pyarrow.types.is_float64.html | 60 +-
.../generated/pyarrow.types.is_floating.html | 60 +-
docs/python/generated/pyarrow.types.is_int16.html | 60 +-
docs/python/generated/pyarrow.types.is_int32.html | 60 +-
docs/python/generated/pyarrow.types.is_int64.html | 60 +-
docs/python/generated/pyarrow.types.is_int8.html | 60 +-
.../python/generated/pyarrow.types.is_integer.html | 60 +-
docs/python/generated/pyarrow.types.is_list.html | 60 +-
docs/python/generated/pyarrow.types.is_map.html | 60 +-
docs/python/generated/pyarrow.types.is_nested.html | 60 +-
docs/python/generated/pyarrow.types.is_null.html | 60 +-
.../generated/pyarrow.types.is_signed_integer.html | 60 +-
docs/python/generated/pyarrow.types.is_string.html | 60 +-
docs/python/generated/pyarrow.types.is_struct.html | 60 +-
.../generated/pyarrow.types.is_temporal.html | 60 +-
docs/python/generated/pyarrow.types.is_time.html | 60 +-
docs/python/generated/pyarrow.types.is_time32.html | 60 +-
docs/python/generated/pyarrow.types.is_time64.html | 60 +-
.../generated/pyarrow.types.is_timestamp.html | 60 +-
docs/python/generated/pyarrow.types.is_uint16.html | 60 +-
docs/python/generated/pyarrow.types.is_uint32.html | 60 +-
docs/python/generated/pyarrow.types.is_uint64.html | 60 +-
docs/python/generated/pyarrow.types.is_uint8.html | 60 +-
.../python/generated/pyarrow.types.is_unicode.html | 60 +-
docs/python/generated/pyarrow.types.is_union.html | 60 +-
.../pyarrow.types.is_unsigned_integer.html | 60 +-
docs/python/generated/pyarrow.uint16.html | 60 +-
docs/python/generated/pyarrow.uint32.html | 60 +-
docs/python/generated/pyarrow.uint64.html | 60 +-
docs/python/generated/pyarrow.uint8.html | 60 +-
docs/python/generated/pyarrow.utf8.html | 60 +-
docs/python/generated/pyarrow.write_tensor.html | 60 +-
docs/python/getting_involved.html | 62 +-
docs/python/index.html | 81 +-
docs/python/install.html | 93 +-
docs/python/ipc.html | 156 ++-
docs/python/memory.html | 78 +-
docs/python/numpy.html | 60 +-
docs/python/pandas.html | 64 +-
docs/python/parquet.html | 79 +-
docs/python/plasma.html | 60 +-
docs/python/timestamps.html | 420 ++++++++
docs/search.html | 58 +-
docs/searchindex.js | 2 +-
348 files changed, 17388 insertions(+), 11909 deletions(-)
diff --git a/docs/.buildinfo b/docs/.buildinfo
index 20d544d..3e7cd7f 100644
--- a/docs/.buildinfo
+++ b/docs/.buildinfo
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 0389e3f68b4f37ac210ff8dcca58997d
+config: 6509b1643459e8f748e70793eda450b7
tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/_modules/index.html b/docs/_modules/index.html
index 91cee2a..f2170a2 100644
--- a/docs/_modules/index.html
+++ b/docs/_modules/index.html
@@ -9,7 +9,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Overview: module code — Apache Arrow v0.12.1.dev0+g8ca41384b.d20190120</title>
+ <title>Overview: module code — Apache Arrow v0.13.0</title>
@@ -18,32 +18,34 @@
-
-
+ <script type="text/javascript" src="../_static/js/modernizr.min.js"></script>
+ <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
+ <script type="text/javascript" src="../_static/jquery.js"></script>
+ <script type="text/javascript" src="../_static/underscore.js"></script>
+ <script type="text/javascript" src="../_static/doctools.js"></script>
+ <script type="text/javascript" src="../_static/language_data.js"></script>
+
+ <script type="text/javascript" src="../_static/js/theme.js"></script>
-
+
+
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
-
-
- <script src="../_static/js/modernizr.min.js"></script>
-
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
-
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
- <div class="wy-side-nav-search">
+ <div class="wy-side-nav-search" >
@@ -57,7 +59,7 @@
<div class="version">
- 0.12.1.dev0+g8ca41384b.d20190120
+ 0.13.0
</div>
@@ -81,7 +83,7 @@
- <p class="caption"><span class="caption-text">Memory Format</span></p>
+ <p class="caption"><span class="caption-text">Arrow Columnar Format</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../format/README.html">Arrow specification documents</a></li>
<li class="toctree-l1"><a class="reference internal" href="../format/Guidelines.html">Implementation guidelines</a></li>
@@ -89,14 +91,18 @@
<li class="toctree-l1"><a class="reference internal" href="../format/Metadata.html">Metadata: Logical types, schemas, data headers</a></li>
<li class="toctree-l1"><a class="reference internal" href="../format/IPC.html">Interprocess messaging / communication (IPC)</a></li>
</ul>
-<p class="caption"><span class="caption-text">Languages</span></p>
+<p class="caption"><span class="caption-text">Arrow Libraries</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../cpp/index.html">C++ Implementation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../python/index.html">Python bindings</a></li>
</ul>
-<p class="caption"><span class="caption-text">Other Topics</span></p>
+<p class="caption"><span class="caption-text">Development and Contributing</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../building.html">Building the Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../developers/contributing.html">Contribution Guidelines</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../developers/cpp.html">C++ Development</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../developers/python.html">Python Development</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../developers/integration.html">Integration Testing</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../developers/documentation.html">Building the Documentation</a></li>
</ul>
@@ -198,26 +204,16 @@
-
-
-
-
- <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
- <script type="text/javascript" src="../_static/jquery.js"></script>
- <script type="text/javascript" src="../_static/underscore.js"></script>
- <script type="text/javascript" src="../_static/doctools.js"></script>
- <script type="text/javascript" src="../_static/language_data.js"></script>
-
-
-
-
- <script type="text/javascript" src="../_static/js/theme.js"></script>
-
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
+
+
+
+
+
<script async src="https://www.googletagmanager.com/gtag/js?id=UA-107500873-1"></script>
<script>
window.dataLayer = window.dataLayer || [];
diff --git a/docs/_modules/pyarrow.html b/docs/_modules/pyarrow.html
index f8699a1..d86ffbb 100644
--- a/docs/_modules/pyarrow.html
+++ b/docs/_modules/pyarrow.html
@@ -9,7 +9,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>pyarrow — Apache Arrow v0.12.1.dev0+g8ca41384b.d20190120</title>
+ <title>pyarrow — Apache Arrow v0.13.0</title>
@@ -18,32 +18,34 @@
-
-
+ <script type="text/javascript" src="../_static/js/modernizr.min.js"></script>
+ <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
+ <script type="text/javascript" src="../_static/jquery.js"></script>
+ <script type="text/javascript" src="../_static/underscore.js"></script>
+ <script type="text/javascript" src="../_static/doctools.js"></script>
+ <script type="text/javascript" src="../_static/language_data.js"></script>
+
+ <script type="text/javascript" src="../_static/js/theme.js"></script>
-
+
+
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
-
-
- <script src="../_static/js/modernizr.min.js"></script>
-
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
-
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
- <div class="wy-side-nav-search">
+ <div class="wy-side-nav-search" >
@@ -57,7 +59,7 @@
<div class="version">
- 0.12.1.dev0+g8ca41384b.d20190120
+ 0.13.0
</div>
@@ -81,7 +83,7 @@
- <p class="caption"><span class="caption-text">Memory Format</span></p>
+ <p class="caption"><span class="caption-text">Arrow Columnar Format</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../format/README.html">Arrow specification documents</a></li>
<li class="toctree-l1"><a class="reference internal" href="../format/Guidelines.html">Implementation guidelines</a></li>
@@ -89,14 +91,18 @@
<li class="toctree-l1"><a class="reference internal" href="../format/Metadata.html">Metadata: Logical types, schemas, data headers</a></li>
<li class="toctree-l1"><a class="reference internal" href="../format/IPC.html">Interprocess messaging / communication (IPC)</a></li>
</ul>
-<p class="caption"><span class="caption-text">Languages</span></p>
+<p class="caption"><span class="caption-text">Arrow Libraries</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../cpp/index.html">C++ Implementation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../python/index.html">Python bindings</a></li>
</ul>
-<p class="caption"><span class="caption-text">Other Topics</span></p>
+<p class="caption"><span class="caption-text">Development and Contributing</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../building.html">Building the Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../developers/contributing.html">Contribution Guidelines</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../developers/cpp.html">C++ Development</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../developers/python.html">Python Development</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../developers/integration.html">Integration Testing</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../developers/documentation.html">Building the Documentation</a></li>
</ul>
@@ -206,13 +212,6 @@
<span class="kn">import</span> <span class="nn">pyarrow.compat</span> <span class="k">as</span> <span class="nn">compat</span>
-<span class="c1"># Workaround for https://issues.apache.org/jira/browse/ARROW-2657</span>
-<span class="c1"># and https://issues.apache.org/jira/browse/ARROW-2920</span>
-<span class="k">if</span> <span class="n">_sys</span><span class="o">.</span><span class="n">platform</span> <span class="ow">in</span> <span class="p">(</span><span class="s1">'linux'</span><span class="p">,</span> <span class="s1">'linux2'</span><span class="p">):</span>
- <span class="n">compat</span><span class="o">.</span><span class="n">import_tensorflow_extension</span><span class="p">()</span>
- <span class="n">compat</span><span class="o">.</span><span class="n">import_pytorch_extension</span><span class="p">()</span>
-
-
<span class="kn">from</span> <span class="nn">pyarrow.lib</span> <span class="k">import</span> <span class="n">cpu_count</span><span class="p">,</span> <span class="n">set_cpu_count</span>
<span class="kn">from</span> <span class="nn">pyarrow.lib</span> <span class="k">import</span> <span class="p">(</span><span class="n">null</span><span class="p">,</span> <span class="n">bool_</span><span class="p">,</span>
<span class="n">int8</span><span class="p">,</span> <span class="n">int16</span><span class="p">,</span> <span class="n">int32</span><span class="p">,</span> <span class="n">int64</span><span class="p">,</span>
@@ -451,26 +450,16 @@
-
-
-
-
- <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
- <script type="text/javascript" src="../_static/jquery.js"></script>
- <script type="text/javascript" src="../_static/underscore.js"></script>
- <script type="text/javascript" src="../_static/doctools.js"></script>
- <script type="text/javascript" src="../_static/language_data.js"></script>
-
-
-
-
- <script type="text/javascript" src="../_static/js/theme.js"></script>
-
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
+
+
+
+
+
<script async src="https://www.googletagmanager.com/gtag/js?id=UA-107500873-1"></script>
<script>
window.dataLayer = window.dataLayer || [];
diff --git a/docs/_modules/pyarrow/feather.html b/docs/_modules/pyarrow/feather.html
index b40cf28..cf64ba4 100644
--- a/docs/_modules/pyarrow/feather.html
+++ b/docs/_modules/pyarrow/feather.html
@@ -9,7 +9,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>pyarrow.feather — Apache Arrow v0.12.1.dev0+g8ca41384b.d20190120</title>
+ <title>pyarrow.feather — Apache Arrow v0.13.0</title>
@@ -18,32 +18,34 @@
-
-
+ <script type="text/javascript" src="../../_static/js/modernizr.min.js"></script>
+ <script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
+ <script type="text/javascript" src="../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../_static/doctools.js"></script>
+ <script type="text/javascript" src="../../_static/language_data.js"></script>
+
+ <script type="text/javascript" src="../../_static/js/theme.js"></script>
-
+
+
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<link rel="index" title="Index" href="../../genindex.html" />
<link rel="search" title="Search" href="../../search.html" />
-
-
- <script src="../../_static/js/modernizr.min.js"></script>
-
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
-
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
- <div class="wy-side-nav-search">
+ <div class="wy-side-nav-search" >
@@ -57,7 +59,7 @@
<div class="version">
- 0.12.1.dev0+g8ca41384b.d20190120
+ 0.13.0
</div>
@@ -81,7 +83,7 @@
- <p class="caption"><span class="caption-text">Memory Format</span></p>
+ <p class="caption"><span class="caption-text">Arrow Columnar Format</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../format/README.html">Arrow specification documents</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../format/Guidelines.html">Implementation guidelines</a></li>
@@ -89,14 +91,18 @@
<li class="toctree-l1"><a class="reference internal" href="../../format/Metadata.html">Metadata: Logical types, schemas, data headers</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../format/IPC.html">Interprocess messaging / communication (IPC)</a></li>
</ul>
-<p class="caption"><span class="caption-text">Languages</span></p>
+<p class="caption"><span class="caption-text">Arrow Libraries</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../cpp/index.html">C++ Implementation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../python/index.html">Python bindings</a></li>
</ul>
-<p class="caption"><span class="caption-text">Other Topics</span></p>
+<p class="caption"><span class="caption-text">Development and Contributing</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../../building.html">Building the Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../developers/contributing.html">Contribution Guidelines</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../developers/cpp.html">C++ Development</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../developers/python.html">Python Development</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../developers/integration.html">Integration Testing</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../developers/documentation.html">Building the Documentation</a></li>
</ul>
@@ -426,26 +432,16 @@
-
-
-
-
- <script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
- <script type="text/javascript" src="../../_static/jquery.js"></script>
- <script type="text/javascript" src="../../_static/underscore.js"></script>
- <script type="text/javascript" src="../../_static/doctools.js"></script>
- <script type="text/javascript" src="../../_static/language_data.js"></script>
-
-
-
-
- <script type="text/javascript" src="../../_static/js/theme.js"></script>
-
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
+
+
+
+
+
<script async src="https://www.googletagmanager.com/gtag/js?id=UA-107500873-1"></script>
<script>
window.dataLayer = window.dataLayer || [];
diff --git a/docs/_modules/pyarrow/filesystem.html b/docs/_modules/pyarrow/filesystem.html
index d4a4319..1848b7b 100644
--- a/docs/_modules/pyarrow/filesystem.html
+++ b/docs/_modules/pyarrow/filesystem.html
@@ -9,7 +9,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>pyarrow.filesystem — Apache Arrow v0.12.1.dev0+g8ca41384b.d20190120</title>
+ <title>pyarrow.filesystem — Apache Arrow v0.13.0</title>
@@ -18,32 +18,34 @@
-
-
+ <script type="text/javascript" src="../../_static/js/modernizr.min.js"></script>
+ <script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
+ <script type="text/javascript" src="../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../_static/doctools.js"></script>
+ <script type="text/javascript" src="../../_static/language_data.js"></script>
+
+ <script type="text/javascript" src="../../_static/js/theme.js"></script>
-
+
+
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<link rel="index" title="Index" href="../../genindex.html" />
<link rel="search" title="Search" href="../../search.html" />
-
-
- <script src="../../_static/js/modernizr.min.js"></script>
-
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
-
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
- <div class="wy-side-nav-search">
+ <div class="wy-side-nav-search" >
@@ -57,7 +59,7 @@
<div class="version">
- 0.12.1.dev0+g8ca41384b.d20190120
+ 0.13.0
</div>
@@ -81,7 +83,7 @@
- <p class="caption"><span class="caption-text">Memory Format</span></p>
+ <p class="caption"><span class="caption-text">Arrow Columnar Format</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../format/README.html">Arrow specification documents</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../format/Guidelines.html">Implementation guidelines</a></li>
@@ -89,14 +91,18 @@
<li class="toctree-l1"><a class="reference internal" href="../../format/Metadata.html">Metadata: Logical types, schemas, data headers</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../format/IPC.html">Interprocess messaging / communication (IPC)</a></li>
</ul>
-<p class="caption"><span class="caption-text">Languages</span></p>
+<p class="caption"><span class="caption-text">Arrow Libraries</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../cpp/index.html">C++ Implementation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../python/index.html">Python bindings</a></li>
</ul>
-<p class="caption"><span class="caption-text">Other Topics</span></p>
+<p class="caption"><span class="caption-text">Development and Contributing</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../../building.html">Building the Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../developers/contributing.html">Contribution Guidelines</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../developers/cpp.html">C++ Development</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../developers/python.html">Python Development</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../developers/integration.html">Integration Testing</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../developers/documentation.html">Building the Documentation</a></li>
</ul>
@@ -355,66 +361,66 @@
<span class="k">return</span> <span class="s1">'/'</span>
-<div class="viewcode-block" id="LocalFileSystem"><a class="viewcode-back" href="../../python/generated/pyarrow.LocalFileSystem.html#pyarrow.LocalFileSystem">[docs]</a><span class="k">class</span> <span class="nc">LocalFileSystem</span><span class="p">(</span><span class="n">FileSystem</span><span class="p">):</span>
+<span class="k">class</span> <span class="nc">LocalFileSystem</span><span class="p">(</span><span class="n">FileSystem</span><span class="p">):</span>
<span class="n">_instance</span> <span class="o">=</span> <span class="kc">None</span>
-<div class="viewcode-block" id="LocalFileSystem.get_instance"><a class="viewcode-back" href="../../python/generated/pyarrow.LocalFileSystem.html#pyarrow.LocalFileSystem.get_instance">[docs]</a> <span class="nd">@classmethod</span>
+ <span class="nd">@classmethod</span>
<span class="k">def</span> <span class="nf">get_instance</span><span class="p">(</span><span class="bp">cls</span><span class="p">):</span>
<span class="k">if</span> <span class="bp">cls</span><span class="o">.</span><span class="n">_instance</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="bp">cls</span><span class="o">.</span><span class="n">_instance</span> <span class="o">=</span> <span class="n">LocalFileSystem</span><span class="p">()</span>
- <span class="k">return</span> <span class="bp">cls</span><span class="o">.</span><span class="n">_instance</span></div>
+ <span class="k">return</span> <span class="bp">cls</span><span class="o">.</span><span class="n">_instance</span>
-<div class="viewcode-block" id="LocalFileSystem.ls"><a class="viewcode-back" href="../../python/generated/pyarrow.LocalFileSystem.html#pyarrow.LocalFileSystem.ls">[docs]</a> <span class="nd">@implements</span><span class="p">(</span><span class="n">FileSystem</span><span class="o">.</span><span class="n">ls</span><span class="p">)</span>
+ <span class="nd">@implements</span><span class="p">(</span><span class="n">FileSystem</span><span class="o">.</span><span class="n">ls</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">ls</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">path</span><span class="p">):</span>
<span class="n">path</span> <span class="o">=</span> <span class="n">_stringify_path</span><span class="p">(</span><span class="n">path</span><span class="p">)</span>
- <span class="k">return</span> <span class="nb">sorted</span><span class="p">(</span><span class="n">pjoin</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">x</span><span class="p">)</span> <span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="n">os</span><span class="o">.</span><span class="n">listdir</span><span class="p">(</span><span class="n">path</span><span class="p">))</span></div>
+ <span class="k">return</span> <span class="nb">sorted</span><span class="p">(</span><span class="n">pjoin</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">x</span><span class="p">)</span> <span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="n">os</span><span class="o">.</span><span class="n">listdir</span><span class="p">(</span><span class="n">path</span><span class="p">))</span>
-<div class="viewcode-block" id="LocalFileSystem.mkdir"><a class="viewcode-back" href="../../python/generated/pyarrow.LocalFileSystem.html#pyarrow.LocalFileSystem.mkdir">[docs]</a> <span class="nd">@implements</span><span class="p">(</span><span class="n">FileSystem</span><span class="o">.</span><span class="n">mkdir</span><span class="p">)</span>
+ <span class="nd">@implements</span><span class="p">(</span><span class="n">FileSystem</span><span class="o">.</span><span class="n">mkdir</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">mkdir</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">create_parents</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
<span class="n">path</span> <span class="o">=</span> <span class="n">_stringify_path</span><span class="p">(</span><span class="n">path</span><span class="p">)</span>
<span class="k">if</span> <span class="n">create_parents</span><span class="p">:</span>
<span class="n">os</span><span class="o">.</span><span class="n">makedirs</span><span class="p">(</span><span class="n">path</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
- <span class="n">os</span><span class="o">.</span><span class="n">mkdir</span><span class="p">(</span><span class="n">path</span><span class="p">)</span></div>
+ <span class="n">os</span><span class="o">.</span><span class="n">mkdir</span><span class="p">(</span><span class="n">path</span><span class="p">)</span>
-<div class="viewcode-block" id="LocalFileSystem.isdir"><a class="viewcode-back" href="../../python/generated/pyarrow.LocalFileSystem.html#pyarrow.LocalFileSystem.isdir">[docs]</a> <span class="nd">@implements</span><span class="p">(</span><span class="n">FileSystem</span><span class="o">.</span><span class="n">isdir</span><span class="p">)</span>
+ <span class="nd">@implements</span><span class="p">(</span><span class="n">FileSystem</span><span class="o">.</span><span class="n">isdir</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">isdir</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">path</span><span class="p">):</span>
<span class="n">path</span> <span class="o">=</span> <span class="n">_stringify_path</span><span class="p">(</span><span class="n">path</span><span class="p">)</span>
- <span class="k">return</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">isdir</span><span class="p">(</span><span class="n">path</span><span class="p">)</span></div>
+ <span class="k">return</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">isdir</span><span class="p">(</span><span class="n">path</span><span class="p">)</span>
-<div class="viewcode-block" id="LocalFileSystem.isfile"><a class="viewcode-back" href="../../python/generated/pyarrow.LocalFileSystem.html#pyarrow.LocalFileSystem.isfile">[docs]</a> <span class="nd">@implements</span><span class="p">(</span><span class="n">FileSystem</span><span class="o">.</span><span class="n">isfile</span><span class="p">)</span>
+ <span class="nd">@implements</span><span class="p">(</span><span class="n">FileSystem</span><span class="o">.</span><span class="n">isfile</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">isfile</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">path</span><span class="p">):</span>
<span class="n">path</span> <span class="o">=</span> <span class="n">_stringify_path</span><span class="p">(</span><span class="n">path</span><span class="p">)</span>
- <span class="k">return</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">isfile</span><span class="p">(</span><span class="n">path</span><span class="p">)</span></div>
+ <span class="k">return</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">isfile</span><span class="p">(</span><span class="n">path</span><span class="p">)</span>
<span class="nd">@implements</span><span class="p">(</span><span class="n">FileSystem</span><span class="o">.</span><span class="n">_isfilestore</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">_isfilestore</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="kc">True</span>
-<div class="viewcode-block" id="LocalFileSystem.exists"><a class="viewcode-back" href="../../python/generated/pyarrow.LocalFileSystem.html#pyarrow.LocalFileSystem.exists">[docs]</a> <span class="nd">@implements</span><span class="p">(</span><span class="n">FileSystem</span><span class="o">.</span><span class="n">exists</span><span class="p">)</span>
+ <span class="nd">@implements</span><span class="p">(</span><span class="n">FileSystem</span><span class="o">.</span><span class="n">exists</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">exists</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">path</span><span class="p">):</span>
<span class="n">path</span> <span class="o">=</span> <span class="n">_stringify_path</span><span class="p">(</span><span class="n">path</span><span class="p">)</span>
- <span class="k">return</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="n">path</span><span class="p">)</span></div>
+ <span class="k">return</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="n">path</span><span class="p">)</span>
-<div class="viewcode-block" id="LocalFileSystem.open"><a class="viewcode-back" href="../../python/generated/pyarrow.LocalFileSystem.html#pyarrow.LocalFileSystem.open">[docs]</a> <span class="nd">@implements</span><span class="p">(</span><span class="n">FileSystem</span><span class="o">.</span><span class="n">open</span><span class="p">)</span>
+ <span class="nd">@implements</span><span class="p">(</span><span class="n">FileSystem</span><span class="o">.</span><span class="n">open</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">open</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">mode</span><span class="o">=</span><span class="s1">'rb'</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Open file for reading or writing</span>
<span class="sd"> """</span>
<span class="n">path</span> <span class="o">=</span> <span class="n">_stringify_path</span><span class="p">(</span><span class="n">path</span><span class="p">)</span>
- <span class="k">return</span> <span class="nb">open</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">mode</span><span class="o">=</span><span class="n">mode</span><span class="p">)</span></div>
+ <span class="k">return</span> <span class="nb">open</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">mode</span><span class="o">=</span><span class="n">mode</span><span class="p">)</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">pathsep</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">sep</span>
-<div class="viewcode-block" id="LocalFileSystem.walk"><a class="viewcode-back" href="../../python/generated/pyarrow.LocalFileSystem.html#pyarrow.LocalFileSystem.walk">[docs]</a> <span class="k">def</span> <span class="nf">walk</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">path</span><span class="p">):</span>
+ <span class="k">def</span> <span class="nf">walk</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">path</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Directory tree generator, see os.walk</span>
<span class="sd"> """</span>
<span class="n">path</span> <span class="o">=</span> <span class="n">_stringify_path</span><span class="p">(</span><span class="n">path</span><span class="p">)</span>
- <span class="k">return</span> <span class="n">os</span><span class="o">.</span><span class="n">walk</span><span class="p">(</span><span class="n">path</span><span class="p">)</span></div></div>
+ <span class="k">return</span> <span class="n">os</span><span class="o">.</span><span class="n">walk</span><span class="p">(</span><span class="n">path</span><span class="p">)</span>
<span class="k">class</span> <span class="nc">DaskFileSystem</span><span class="p">(</span><span class="n">FileSystem</span><span class="p">):</span>
@@ -549,11 +555,11 @@
<span class="c1"># interface and return it</span>
<span class="k">if</span> <span class="ow">not</span> <span class="nb">issubclass</span><span class="p">(</span><span class="n">fs_type</span><span class="p">,</span> <span class="n">FileSystem</span><span class="p">):</span>
<span class="k">for</span> <span class="n">mro</span> <span class="ow">in</span> <span class="n">inspect</span><span class="o">.</span><span class="n">getmro</span><span class="p">(</span><span class="n">fs_type</span><span class="p">):</span>
- <span class="k">if</span> <span class="n">mro</span><span class="o">.</span><span class="vm">__name__</span> <span class="ow">is</span> <span class="s1">'S3FileSystem'</span><span class="p">:</span>
+ <span class="k">if</span> <span class="n">mro</span><span class="o">.</span><span class="vm">__name__</span> <span class="o">==</span> <span class="s1">'S3FileSystem'</span><span class="p">:</span>
<span class="k">return</span> <span class="n">S3FSWrapper</span><span class="p">(</span><span class="n">fs</span><span class="p">)</span>
<span class="c1"># In case its a simple LocalFileSystem (e.g. dask) use native arrow</span>
<span class="c1"># FS</span>
- <span class="k">elif</span> <span class="n">mro</span><span class="o">.</span><span class="vm">__name__</span> <span class="ow">is</span> <span class="s1">'LocalFileSystem'</span><span class="p">:</span>
+ <span class="k">elif</span> <span class="n">mro</span><span class="o">.</span><span class="vm">__name__</span> <span class="o">==</span> <span class="s1">'LocalFileSystem'</span><span class="p">:</span>
<span class="k">return</span> <span class="n">LocalFileSystem</span><span class="o">.</span><span class="n">get_instance</span><span class="p">()</span>
<span class="k">raise</span> <span class="ne">IOError</span><span class="p">(</span><span class="s1">'Unrecognized filesystem: </span><span class="si">{0}</span><span class="s1">'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">fs_type</span><span class="p">))</span>
@@ -563,7 +569,8 @@
<span class="k">def</span> <span class="nf">resolve_filesystem_and_path</span><span class="p">(</span><span class="n">where</span><span class="p">,</span> <span class="n">filesystem</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="sd">"""</span>
-<span class="sd"> return filesystem from path which could be an HDFS URI</span>
+<span class="sd"> Return filesystem from path which could be an HDFS URI, a local URI,</span>
+<span class="sd"> or a plain filesystem path.</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">_is_path_like</span><span class="p">(</span><span class="n">where</span><span class="p">):</span>
<span class="k">if</span> <span class="n">filesystem</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
@@ -571,7 +578,6 @@
<span class="s2">" there is nothing to open with filesystem."</span><span class="p">)</span>
<span class="k">return</span> <span class="n">filesystem</span><span class="p">,</span> <span class="n">where</span>
- <span class="c1"># input can be hdfs URI such as hdfs://host:port/myfile.parquet</span>
<span class="n">path</span> <span class="o">=</span> <span class="n">_stringify_path</span><span class="p">(</span><span class="n">where</span><span class="p">)</span>
<span class="k">if</span> <span class="n">filesystem</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
@@ -579,6 +585,7 @@
<span class="n">parsed_uri</span> <span class="o">=</span> <span class="n">urlparse</span><span class="p">(</span><span class="n">path</span><span class="p">)</span>
<span class="k">if</span> <span class="n">parsed_uri</span><span class="o">.</span><span class="n">scheme</span> <span class="o">==</span> <span class="s1">'hdfs'</span><span class="p">:</span>
+ <span class="c1"># Input is hdfs URI such as hdfs://host:port/myfile.parquet</span>
<span class="n">netloc_split</span> <span class="o">=</span> <span class="n">parsed_uri</span><span class="o">.</span><span class="n">netloc</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">':'</span><span class="p">)</span>
<span class="n">host</span> <span class="o">=</span> <span class="n">netloc_split</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
<span class="k">if</span> <span class="n">host</span> <span class="o">==</span> <span class="s1">''</span><span class="p">:</span>
@@ -587,10 +594,17 @@
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">netloc_split</span><span class="p">)</span> <span class="o">==</span> <span class="mi">2</span> <span class="ow">and</span> <span class="n">netloc_split</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span><span class="o">.</span><span class="n">isnumeric</span><span class="p">():</span>
<span class="n">port</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">netloc_split</span><span class="p">[</span><span class="mi">1</span><span class="p">])</span>
<span class="n">fs</span> <span class="o">=</span> <span class="n">pa</span><span class="o">.</span><span class="n">hdfs</span><span class="o">.</span><span class="n">connect</span><span class="p">(</span><span class="n">host</span><span class="o">=</span><span class="n">host</span><span class="p">,</span> <span class="n">port</span><span class="o">=</span><span class="n">port</span><span class="p">)</span>
+ <span class="n">fs_path</span> <span class="o">=</span> <span class="n">parsed_uri</span><span class="o">.</span><span class="n">path</span>
+ <span class="k">elif</span> <span class="n">parsed_uri</span><span class="o">.</span><span class="n">scheme</span> <span class="o">==</span> <span class="s1">'file'</span><span class="p">:</span>
+ <span class="c1"># Input is local URI such as file:///home/user/myfile.parquet</span>
+ <span class="n">fs</span> <span class="o">=</span> <span class="n">LocalFileSystem</span><span class="o">.</span><span class="n">get_instance</span><span class="p">()</span>
+ <span class="n">fs_path</span> <span class="o">=</span> <span class="n">parsed_uri</span><span class="o">.</span><span class="n">path</span>
<span class="k">else</span><span class="p">:</span>
+ <span class="c1"># Input is local path such as /home/user/myfile.parquet</span>
<span class="n">fs</span> <span class="o">=</span> <span class="n">LocalFileSystem</span><span class="o">.</span><span class="n">get_instance</span><span class="p">()</span>
+ <span class="n">fs_path</span> <span class="o">=</span> <span class="n">where</span>
- <span class="k">return</span> <span class="n">fs</span><span class="p">,</span> <span class="n">parsed_uri</span><span class="o">.</span><span class="n">path</span>
+ <span class="k">return</span> <span class="n">fs</span><span class="p">,</span> <span class="n">fs_path</span>
</pre></div>
</div>
@@ -620,26 +634,16 @@
-
-
-
-
- <script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
- <script type="text/javascript" src="../../_static/jquery.js"></script>
- <script type="text/javascript" src="../../_static/underscore.js"></script>
- <script type="text/javascript" src="../../_static/doctools.js"></script>
- <script type="text/javascript" src="../../_static/language_data.js"></script>
-
-
-
-
- <script type="text/javascript" src="../../_static/js/theme.js"></script>
-
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
+
+
+
+
+
<script async src="https://www.googletagmanager.com/gtag/js?id=UA-107500873-1"></script>
<script>
window.dataLayer = window.dataLayer || [];
diff --git a/docs/_modules/pyarrow/hdfs.html b/docs/_modules/pyarrow/hdfs.html
index 47e368a..d940b29 100644
--- a/docs/_modules/pyarrow/hdfs.html
+++ b/docs/_modules/pyarrow/hdfs.html
@@ -9,7 +9,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>pyarrow.hdfs — Apache Arrow v0.12.1.dev0+g8ca41384b.d20190120</title>
+ <title>pyarrow.hdfs — Apache Arrow v0.13.0</title>
@@ -18,32 +18,34 @@
-
-
+ <script type="text/javascript" src="../../_static/js/modernizr.min.js"></script>
+ <script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
+ <script type="text/javascript" src="../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../_static/doctools.js"></script>
+ <script type="text/javascript" src="../../_static/language_data.js"></script>
+
+ <script type="text/javascript" src="../../_static/js/theme.js"></script>
-
+
+
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<link rel="index" title="Index" href="../../genindex.html" />
<link rel="search" title="Search" href="../../search.html" />
-
-
- <script src="../../_static/js/modernizr.min.js"></script>
-
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
-
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
- <div class="wy-side-nav-search">
+ <div class="wy-side-nav-search" >
@@ -57,7 +59,7 @@
<div class="version">
- 0.12.1.dev0+g8ca41384b.d20190120
+ 0.13.0
</div>
@@ -81,7 +83,7 @@
- <p class="caption"><span class="caption-text">Memory Format</span></p>
+ <p class="caption"><span class="caption-text">Arrow Columnar Format</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../format/README.html">Arrow specification documents</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../format/Guidelines.html">Implementation guidelines</a></li>
@@ -89,14 +91,18 @@
<li class="toctree-l1"><a class="reference internal" href="../../format/Metadata.html">Metadata: Logical types, schemas, data headers</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../format/IPC.html">Interprocess messaging / communication (IPC)</a></li>
</ul>
-<p class="caption"><span class="caption-text">Languages</span></p>
+<p class="caption"><span class="caption-text">Arrow Libraries</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../cpp/index.html">C++ Implementation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../python/index.html">Python bindings</a></li>
</ul>
-<p class="caption"><span class="caption-text">Other Topics</span></p>
+<p class="caption"><span class="caption-text">Development and Contributing</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../../building.html">Building the Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../developers/contributing.html">Contribution Guidelines</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../developers/cpp.html">C++ Development</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../developers/python.html">Python Development</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../developers/integration.html">Integration Testing</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../developers/documentation.html">Building the Documentation</a></li>
</ul>
@@ -188,7 +194,7 @@
<span class="kn">import</span> <span class="nn">pyarrow.lib</span> <span class="k">as</span> <span class="nn">lib</span>
-<div class="viewcode-block" id="HadoopFileSystem"><a class="viewcode-back" href="../../python/api/files.html#pyarrow.HadoopFileSystem">[docs]</a><span class="k">class</span> <span class="nc">HadoopFileSystem</span><span class="p">(</span><span class="n">lib</span><span class="o">.</span><span class="n">HadoopFileSystem</span><span class="p">,</span> <span class="n">FileSystem</span><span class="p">):</span>
+<span class="k">class</span> <span class="nc">HadoopFileSystem</span><span class="p">(</span><span class="n">lib</span><span class="o">.</span><span class="n">HadoopFileSystem</span><span class="p">,</span> <span class="n">FileSystem</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> FileSystem interface for HDFS cluster. See pyarrow.hdfs.connect for full</span>
<span class="sd"> connection details</span>
@@ -240,9 +246,9 @@
<span class="sd"> """</span>
<span class="k">return</span> <span class="nb">super</span><span class="p">(</span><span class="n">HadoopFileSystem</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">mkdir</span><span class="p">(</span><span class="n">path</span><span class="p">)</span></div>
-<div class="viewcode-block" id="HadoopFileSystem.rename"><a class="viewcode-back" href="../../python/generated/pyarrow.HadoopFileSystem.rename.html#pyarrow.HadoopFileSystem.rename">[docs]</a> <span class="nd">@implements</span><span class="p">(</span><span class="n">FileSystem</span><span class="o">.</span><span class="n">rename</span><span class="p">)</span>
+ <span class="nd">@implements</span><span class="p">(</span><span class="n">FileSystem</span><span class="o">.</span><span class="n">rename</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">rename</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">new_path</span><span class="p">):</span>
- <span class="k">return</span> <span class="nb">super</span><span class="p">(</span><span class="n">HadoopFileSystem</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">rename</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">new_path</span><span class="p">)</span></div>
+ <span class="k">return</span> <span class="nb">super</span><span class="p">(</span><span class="n">HadoopFileSystem</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">rename</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">new_path</span><span class="p">)</span>
<div class="viewcode-block" id="HadoopFileSystem.exists"><a class="viewcode-back" href="../../python/generated/pyarrow.HadoopFileSystem.exists.html#pyarrow.HadoopFileSystem.exists">[docs]</a> <span class="nd">@implements</span><span class="p">(</span><span class="n">FileSystem</span><span class="o">.</span><span class="n">exists</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">exists</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">path</span><span class="p">):</span>
@@ -283,7 +289,7 @@
<span class="k">yield</span> <span class="n">top_path</span><span class="p">,</span> <span class="n">directories</span><span class="p">,</span> <span class="n">files</span>
<span class="k">for</span> <span class="n">dirname</span> <span class="ow">in</span> <span class="n">directories</span><span class="p">:</span>
<span class="k">for</span> <span class="n">tup</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">walk</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_path_join</span><span class="p">(</span><span class="n">top_path</span><span class="p">,</span> <span class="n">dirname</span><span class="p">)):</span>
- <span class="k">yield</span> <span class="n">tup</span></div>
+ <span class="k">yield</span> <span class="n">tup</span>
<span class="k">def</span> <span class="nf">_maybe_set_hadoop_classpath</span><span class="p">():</span>
@@ -310,8 +316,12 @@
<span class="n">xargs_echo</span> <span class="o">=</span> <span class="n">subprocess</span><span class="o">.</span><span class="n">Popen</span><span class="p">((</span><span class="s1">'xargs'</span><span class="p">,</span> <span class="s1">'echo'</span><span class="p">),</span>
<span class="n">stdin</span><span class="o">=</span><span class="n">find</span><span class="o">.</span><span class="n">stdout</span><span class="p">,</span>
<span class="n">stdout</span><span class="o">=</span><span class="n">subprocess</span><span class="o">.</span><span class="n">PIPE</span><span class="p">)</span>
- <span class="k">return</span> <span class="n">subprocess</span><span class="o">.</span><span class="n">check_output</span><span class="p">((</span><span class="s1">'tr'</span><span class="p">,</span> <span class="s2">"' '"</span><span class="p">,</span> <span class="s2">"':'"</span><span class="p">),</span>
+ <span class="n">jars</span> <span class="o">=</span> <span class="n">subprocess</span><span class="o">.</span><span class="n">check_output</span><span class="p">((</span><span class="s1">'tr'</span><span class="p">,</span> <span class="s2">"' '"</span><span class="p">,</span> <span class="s2">"':'"</span><span class="p">),</span>
<span class="n">stdin</span><span class="o">=</span><span class="n">xargs_echo</span><span class="o">.</span><span class="n">stdout</span><span class="p">)</span>
+ <span class="n">hadoop_conf</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s2">"HADOOP_CONF_DIR"</span><span class="p">]</span> \
+ <span class="k">if</span> <span class="s2">"HADOOP_CONF_DIR"</span> <span class="ow">in</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span> \
+ <span class="k">else</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s2">"HADOOP_HOME"</span><span class="p">]</span> <span class="o">+</span> <span class="s2">"/etc/hadoop"</span>
+ <span class="k">return</span> <span class="p">(</span><span class="n">hadoop_conf</span> <span class="o">+</span> <span class="s2">":"</span><span class="p">)</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="s2">"utf-8"</span><span class="p">)</span> <span class="o">+</span> <span class="n">jars</span>
<span class="k">def</span> <span class="nf">_hadoop_classpath_glob</span><span class="p">(</span><span class="n">hadoop_bin</span><span class="p">):</span>
@@ -334,7 +344,7 @@
<span class="k">return</span> <span class="n">directories</span><span class="p">,</span> <span class="n">files</span>
-<div class="viewcode-block" id="connect"><a class="viewcode-back" href="../../python/generated/pyarrow.hdfs.connect.html#pyarrow.connect">[docs]</a><span class="k">def</span> <span class="nf">connect</span><span class="p">(</span><span class="n">host</span><span class="o">=</span><span class="s2">"default"</span><span class="p">,</span> <span class="n">port</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">user</span><span class="o" [...]
+<span class="k">def</span> <span class="nf">connect</span><span class="p">(</span><span class="n">host</span><span class="o">=</span><span class="s2">"default"</span><span class="p">,</span> <span class="n">port</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">user</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">kerb_ticket</span><span class="o">=</span><span class="kc">None</span> [...]
<span class="n">driver</span><span class="o">=</span><span class="s1">'libhdfs'</span><span class="p">,</span> <span class="n">extra_conf</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Connect to an HDFS cluster. All parameters are optional and should</span>
@@ -369,7 +379,7 @@
<span class="n">fs</span> <span class="o">=</span> <span class="n">HadoopFileSystem</span><span class="p">(</span><span class="n">host</span><span class="o">=</span><span class="n">host</span><span class="p">,</span> <span class="n">port</span><span class="o">=</span><span class="n">port</span><span class="p">,</span> <span class="n">user</span><span class="o">=</span><span class="n">user</span><span class="p">,</span>
<span class="n">kerb_ticket</span><span class="o">=</span><span class="n">kerb_ticket</span><span class="p">,</span> <span class="n">driver</span><span class="o">=</span><span class="n">driver</span><span class="p">,</span>
<span class="n">extra_conf</span><span class="o">=</span><span class="n">extra_conf</span><span class="p">)</span>
- <span class="k">return</span> <span class="n">fs</span></div>
+ <span class="k">return</span> <span class="n">fs</span>
</pre></div>
</div>
@@ -399,26 +409,16 @@
-
-
-
-
- <script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
- <script type="text/javascript" src="../../_static/jquery.js"></script>
- <script type="text/javascript" src="../../_static/underscore.js"></script>
- <script type="text/javascript" src="../../_static/doctools.js"></script>
- <script type="text/javascript" src="../../_static/language_data.js"></script>
-
-
-
-
- <script type="text/javascript" src="../../_static/js/theme.js"></script>
-
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
+
+
+
+
+
<script async src="https://www.googletagmanager.com/gtag/js?id=UA-107500873-1"></script>
<script>
window.dataLayer = window.dataLayer || [];
diff --git a/docs/_modules/pyarrow/ipc.html b/docs/_modules/pyarrow/ipc.html
index 0fd7429..b7a6a2c 100644
--- a/docs/_modules/pyarrow/ipc.html
+++ b/docs/_modules/pyarrow/ipc.html
@@ -9,7 +9,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>pyarrow.ipc — Apache Arrow v0.12.1.dev0+g8ca41384b.d20190120</title>
+ <title>pyarrow.ipc — Apache Arrow v0.13.0</title>
@@ -18,32 +18,34 @@
-
-
+ <script type="text/javascript" src="../../_static/js/modernizr.min.js"></script>
+ <script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
+ <script type="text/javascript" src="../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../_static/doctools.js"></script>
+ <script type="text/javascript" src="../../_static/language_data.js"></script>
+
+ <script type="text/javascript" src="../../_static/js/theme.js"></script>
-
+
+
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<link rel="index" title="Index" href="../../genindex.html" />
<link rel="search" title="Search" href="../../search.html" />
-
-
- <script src="../../_static/js/modernizr.min.js"></script>
-
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
-
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
- <div class="wy-side-nav-search">
+ <div class="wy-side-nav-search" >
@@ -57,7 +59,7 @@
<div class="version">
- 0.12.1.dev0+g8ca41384b.d20190120
+ 0.13.0
</div>
@@ -81,7 +83,7 @@
- <p class="caption"><span class="caption-text">Memory Format</span></p>
+ <p class="caption"><span class="caption-text">Arrow Columnar Format</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../format/README.html">Arrow specification documents</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../format/Guidelines.html">Implementation guidelines</a></li>
@@ -89,14 +91,18 @@
<li class="toctree-l1"><a class="reference internal" href="../../format/Metadata.html">Metadata: Logical types, schemas, data headers</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../format/IPC.html">Interprocess messaging / communication (IPC)</a></li>
</ul>
-<p class="caption"><span class="caption-text">Languages</span></p>
+<p class="caption"><span class="caption-text">Arrow Libraries</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../cpp/index.html">C++ Implementation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../python/index.html">Python bindings</a></li>
</ul>
-<p class="caption"><span class="caption-text">Other Topics</span></p>
+<p class="caption"><span class="caption-text">Development and Contributing</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../../building.html">Building the Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../developers/contributing.html">Contribution Guidelines</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../developers/cpp.html">C++ Development</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../developers/python.html">Python Development</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../developers/integration.html">Integration Testing</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../developers/documentation.html">Building the Documentation</a></li>
</ul>
@@ -209,7 +215,7 @@
<span class="k">return</span> <span class="n">table</span><span class="o">.</span><span class="n">to_pandas</span><span class="p">(</span><span class="o">**</span><span class="n">options</span><span class="p">)</span>
-<div class="viewcode-block" id="RecordBatchStreamReader"><a class="viewcode-back" href="../../python/generated/pyarrow.RecordBatchStreamReader.html#pyarrow.RecordBatchStreamReader">[docs]</a><span class="k">class</span> <span class="nc">RecordBatchStreamReader</span><span class="p">(</span><span class="n">lib</span><span class="o">.</span><span class="n">_RecordBatchReader</span><span class="p">,</span> <span class="n">_ReadPandasOption</span><span class="p">):</span>
+<div class="viewcode-block" id="RecordBatchStreamReader"><a class="viewcode-back" href="../../python/generated/pyarrow.RecordBatchStreamReader.html#pyarrow.RecordBatchStreamReader">[docs]</a><span class="k">class</span> <span class="nc">RecordBatchStreamReader</span><span class="p">(</span><span class="n">lib</span><span class="o">.</span><span class="n">_RecordBatchStreamReader</span><span class="p">,</span> <span class="n">_ReadPandasOption</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Reader for the Arrow streaming binary format</span>
@@ -222,7 +228,7 @@
<span class="bp">self</span><span class="o">.</span><span class="n">_open</span><span class="p">(</span><span class="n">source</span><span class="p">)</span></div></div>
-<div class="viewcode-block" id="RecordBatchStreamWriter"><a class="viewcode-back" href="../../python/generated/pyarrow.RecordBatchStreamWriter.html#pyarrow.RecordBatchStreamWriter">[docs]</a><span class="k">class</span> <span class="nc">RecordBatchStreamWriter</span><span class="p">(</span><span class="n">lib</span><span class="o">.</span><span class="n">_RecordBatchWriter</span><span class="p">):</span>
+<div class="viewcode-block" id="RecordBatchStreamWriter"><a class="viewcode-back" href="../../python/generated/pyarrow.RecordBatchStreamWriter.html#pyarrow.RecordBatchStreamWriter">[docs]</a><span class="k">class</span> <span class="nc">RecordBatchStreamWriter</span><span class="p">(</span><span class="n">lib</span><span class="o">.</span><span class="n">_RecordBatchStreamWriter</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Writer for the Arrow streaming binary format</span>
@@ -268,7 +274,7 @@
<span class="bp">self</span><span class="o">.</span><span class="n">_open</span><span class="p">(</span><span class="n">sink</span><span class="p">,</span> <span class="n">schema</span><span class="p">)</span></div></div>
-<div class="viewcode-block" id="open_stream"><a class="viewcode-back" href="../../python/generated/pyarrow.ipc.open_stream.html#pyarrow.open_stream">[docs]</a><span class="k">def</span> <span class="nf">open_stream</span><span class="p">(</span><span class="n">source</span><span class="p">):</span>
+<span class="k">def</span> <span class="nf">open_stream</span><span class="p">(</span><span class="n">source</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Create reader for Arrow streaming format</span>
@@ -284,10 +290,10 @@
<span class="sd"> -------</span>
<span class="sd"> reader : RecordBatchStreamReader</span>
<span class="sd"> """</span>
- <span class="k">return</span> <span class="n">RecordBatchStreamReader</span><span class="p">(</span><span class="n">source</span><span class="p">)</span></div>
+ <span class="k">return</span> <span class="n">RecordBatchStreamReader</span><span class="p">(</span><span class="n">source</span><span class="p">)</span>
-<div class="viewcode-block" id="open_file"><a class="viewcode-back" href="../../python/generated/pyarrow.ipc.open_file.html#pyarrow.open_file">[docs]</a><span class="k">def</span> <span class="nf">open_file</span><span class="p">(</span><span class="n">source</span><span class="p">,</span> <span class="n">footer_offset</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
+<span class="k">def</span> <span class="nf">open_file</span><span class="p">(</span><span class="n">source</span><span class="p">,</span> <span class="n">footer_offset</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Create reader for Arrow file format</span>
@@ -303,7 +309,7 @@
<span class="sd"> -------</span>
<span class="sd"> reader : RecordBatchFileReader</span>
<span class="sd"> """</span>
- <span class="k">return</span> <span class="n">RecordBatchFileReader</span><span class="p">(</span><span class="n">source</span><span class="p">,</span> <span class="n">footer_offset</span><span class="o">=</span><span class="n">footer_offset</span><span class="p">)</span></div>
+ <span class="k">return</span> <span class="n">RecordBatchFileReader</span><span class="p">(</span><span class="n">source</span><span class="p">,</span> <span class="n">footer_offset</span><span class="o">=</span><span class="n">footer_offset</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">serialize_pandas</span><span class="p">(</span><span class="n">df</span><span class="p">,</span> <span class="n">nthreads</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">preserve_index</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
@@ -379,26 +385,16 @@
-
-
-
-
- <script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
- <script type="text/javascript" src="../../_static/jquery.js"></script>
- <script type="text/javascript" src="../../_static/underscore.js"></script>
- <script type="text/javascript" src="../../_static/doctools.js"></script>
- <script type="text/javascript" src="../../_static/language_data.js"></script>
-
-
-
-
- <script type="text/javascript" src="../../_static/js/theme.js"></script>
-
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
+
+
+
+
+
<script async src="https://www.googletagmanager.com/gtag/js?id=UA-107500873-1"></script>
<script>
window.dataLayer = window.dataLayer || [];
diff --git a/docs/_modules/pyarrow/parquet.html b/docs/_modules/pyarrow/parquet.html
index a3da4eb..0c62aa9 100644
--- a/docs/_modules/pyarrow/parquet.html
+++ b/docs/_modules/pyarrow/parquet.html
@@ -9,7 +9,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>pyarrow.parquet — Apache Arrow v0.12.1.dev0+g8ca41384b.d20190120</title>
+ <title>pyarrow.parquet — Apache Arrow v0.13.0</title>
@@ -18,32 +18,34 @@
-
-
+ <script type="text/javascript" src="../../_static/js/modernizr.min.js"></script>
+ <script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
+ <script type="text/javascript" src="../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../_static/doctools.js"></script>
+ <script type="text/javascript" src="../../_static/language_data.js"></script>
+
+ <script type="text/javascript" src="../../_static/js/theme.js"></script>
-
+
+
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<link rel="index" title="Index" href="../../genindex.html" />
<link rel="search" title="Search" href="../../search.html" />
-
-
- <script src="../../_static/js/modernizr.min.js"></script>
-
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
-
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
- <div class="wy-side-nav-search">
+ <div class="wy-side-nav-search" >
@@ -57,7 +59,7 @@
<div class="version">
- 0.12.1.dev0+g8ca41384b.d20190120
+ 0.13.0
</div>
@@ -81,7 +83,7 @@
- <p class="caption"><span class="caption-text">Memory Format</span></p>
+ <p class="caption"><span class="caption-text">Arrow Columnar Format</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../format/README.html">Arrow specification documents</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../format/Guidelines.html">Implementation guidelines</a></li>
@@ -89,14 +91,18 @@
<li class="toctree-l1"><a class="reference internal" href="../../format/Metadata.html">Metadata: Logical types, schemas, data headers</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../format/IPC.html">Interprocess messaging / communication (IPC)</a></li>
</ul>
-<p class="caption"><span class="caption-text">Languages</span></p>
+<p class="caption"><span class="caption-text">Arrow Libraries</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../cpp/index.html">C++ Implementation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../python/index.html">Python bindings</a></li>
</ul>
-<p class="caption"><span class="caption-text">Other Topics</span></p>
+<p class="caption"><span class="caption-text">Development and Contributing</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../../building.html">Building the Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../developers/contributing.html">Contribution Guidelines</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../developers/cpp.html">C++ Development</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../developers/python.html">Python Development</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../developers/integration.html">Integration Testing</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../developers/documentation.html">Building the Documentation</a></li>
</ul>
@@ -181,6 +187,7 @@
<span class="kn">from</span> <span class="nn">collections</span> <span class="k">import</span> <span class="n">defaultdict</span>
<span class="kn">from</span> <span class="nn">concurrent</span> <span class="k">import</span> <span class="n">futures</span>
+<span class="kn">from</span> <span class="nn">functools</span> <span class="k">import</span> <span class="n">partial</span>
<span class="kn">from</span> <span class="nn">six.moves.urllib.parse</span> <span class="k">import</span> <span class="n">urlparse</span>
<span class="kn">import</span> <span class="nn">json</span>
@@ -420,7 +427,9 @@
<span class="n">index_columns</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">if</span> <span class="n">indices</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="ow">and</span> <span class="n">index_columns</span><span class="p">:</span>
- <span class="n">indices</span> <span class="o">+=</span> <span class="nb">map</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">reader</span><span class="o">.</span><span class="n">column_name_idx</span><span class="p">,</span> <span class="n">index_columns</span><span class="p">)</span>
+ <span class="n">indices</span> <span class="o">+=</span> <span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">reader</span><span class="o">.</span><span class="n">column_name_idx</span><span class="p">(</span><span class="n">descr</span><span class="p">[</span><span class="s1">'field_name'</span><span class="p">])</span>
+ <span class="k">for</span> <span class="n">descr</span> <span class="ow">in</span> <span class="n">index_columns</span>
+ <span class="k">if</span> <span class="n">descr</span><span class="p">[</span><span class="s1">'kind'</span><span class="p">]</span> <span class="o">==</span> <span class="s1">'serialized'</span><span class="p">]</span>
<span class="k">return</span> <span class="n">indices</span></div>
@@ -596,14 +605,17 @@
<span class="sd"> ----------</span>
<span class="sd"> path : str or pathlib.Path</span>
<span class="sd"> Path to file in the file system where this piece is located</span>
+<span class="sd"> open_file_func : callable</span>
+<span class="sd"> Function to use for obtaining file handle to dataset piece</span>
<span class="sd"> partition_keys : list of tuples</span>
<span class="sd"> [(column name, ordinal index)]</span>
<span class="sd"> row_group : int, default None</span>
<span class="sd"> Row group to load. By default, reads all row groups</span>
<span class="sd"> """</span>
-
- <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">row_group</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">partition_keys</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
+ <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">open_file_func</span><span class="o">=</span><span class="n">partial</span><span class="p">(</span><span class="nb">open</span><span class="p">,</span> <span class="n">mode</span><span class="o">=</span><span class="s1">'rb'</span><span class="p">),</span>
+ <span class="n">row_group</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">partition_keys</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">path</span> <span class="o">=</span> <span class="n">_stringify_path</span><span class="p">(</span><span class="n">path</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">open_file_func</span> <span class="o">=</span> <span class="n">open_file_func</span>
<span class="bp">self</span><span class="o">.</span><span class="n">row_group</span> <span class="o">=</span> <span class="n">row_group</span>
<span class="bp">self</span><span class="o">.</span><span class="n">partition_keys</span> <span class="o">=</span> <span class="n">partition_keys</span> <span class="ow">or</span> <span class="p">[]</span>
@@ -638,24 +650,24 @@
<span class="k">return</span> <span class="n">result</span>
- <span class="k">def</span> <span class="nf">get_metadata</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">open_file_func</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
+ <span class="k">def</span> <span class="nf">get_metadata</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Given a function that can create an open ParquetFile object, return the</span>
<span class="sd"> file's metadata</span>
<span class="sd"> """</span>
- <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_open</span><span class="p">(</span><span class="n">open_file_func</span><span class="p">)</span><span class="o">.</span><span class="n">metadata</span>
+ <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">open</span><span class="p">()</span><span class="o">.</span><span class="n">metadata</span>
- <span class="k">def</span> <span class="nf">_open</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">open_file_func</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
+ <span class="k">def</span> <span class="nf">open</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Returns instance of ParquetFile</span>
<span class="sd"> """</span>
- <span class="n">reader</span> <span class="o">=</span> <span class="n">open_file_func</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">path</span><span class="p">)</span>
+ <span class="n">reader</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">open_file_func</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">path</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">reader</span><span class="p">,</span> <span class="n">ParquetFile</span><span class="p">):</span>
<span class="n">reader</span> <span class="o">=</span> <span class="n">ParquetFile</span><span class="p">(</span><span class="n">reader</span><span class="p">)</span>
<span class="k">return</span> <span class="n">reader</span>
<span class="k">def</span> <span class="nf">read</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">columns</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">use_threads</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">partitions</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
- <span class="n">open_file_func</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">file</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">use_pandas_metadata</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
+ <span class="n">file</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">use_pandas_metadata</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Read this piece as a pyarrow.Table</span>
@@ -675,8 +687,8 @@
<span class="sd"> -------</span>
<span class="sd"> table : pyarrow.Table</span>
<span class="sd"> """</span>
- <span class="k">if</span> <span class="n">open_file_func</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
- <span class="n">reader</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_open</span><span class="p">(</span><span class="n">open_file_func</span><span class="p">)</span>
+ <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">open_file_func</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
+ <span class="n">reader</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">open</span><span class="p">()</span>
<span class="k">elif</span> <span class="n">file</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">reader</span> <span class="o">=</span> <span class="n">ParquetFile</span><span class="p">(</span><span class="n">file</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
@@ -870,10 +882,11 @@
<span class="sd">"""</span>
<span class="sd"> """</span>
- <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">dirpath</span><span class="p">,</span> <span class="n">filesystem</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">pathsep</span><span class="o">=</span><span class="s1">'/'</span><span class="p">,</span>
- <span class="n">partition_scheme</span><span class="o">=</span><span class="s1">'hive'</span><span class="p">,</span> <span class="n">metadata_nthreads</span><span class="o">=</span><span class="mi">1</span><span class="p">):</span>
+ <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">dirpath</span><span class="p">,</span> <span class="n">open_file_func</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">filesystem</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
+ <span class="n">pathsep</span><span class="o">=</span><span class="s1">'/'</span><span class="p">,</span> <span class="n">partition_scheme</span><span class="o">=</span><span class="s1">'hive'</span><span class="p">,</span> <span class="n">metadata_nthreads</span><span class="o">=</span><span class="mi">1</span><span class="p">):</span>
<span class="n">filesystem</span><span class="p">,</span> <span class="n">dirpath</span> <span class="o">=</span> <span class="n">_get_filesystem_and_path</span><span class="p">(</span><span class="n">filesystem</span><span class="p">,</span> <span class="n">dirpath</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">filesystem</span> <span class="o">=</span> <span class="n">filesystem</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">open_file_func</span> <span class="o">=</span> <span class="n">open_file_func</span>
<span class="bp">self</span><span class="o">.</span><span class="n">pathsep</span> <span class="o">=</span> <span class="n">pathsep</span>
<span class="bp">self</span><span class="o">.</span><span class="n">dirpath</span> <span class="o">=</span> <span class="n">_stringify_path</span><span class="p">(</span><span class="n">dirpath</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">partition_scheme</span> <span class="o">=</span> <span class="n">partition_scheme</span>
@@ -933,6 +946,7 @@
<span class="k">def</span> <span class="nf">_should_silently_exclude</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">file_name</span><span class="p">):</span>
<span class="k">return</span> <span class="p">(</span><span class="n">file_name</span><span class="o">.</span><span class="n">endswith</span><span class="p">(</span><span class="s1">'.crc'</span><span class="p">)</span> <span class="ow">or</span> <span class="c1"># Checksums</span>
+ <span class="n">file_name</span><span class="o">.</span><span class="n">endswith</span><span class="p">(</span><span class="s1">'_$folder$'</span><span class="p">)</span> <span class="ow">or</span> <span class="c1"># HDFS directories in S3</span>
<span class="n">file_name</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s1">'.'</span><span class="p">)</span> <span class="ow">or</span> <span class="c1"># Hidden files</span>
<span class="n">file_name</span> <span class="ow">in</span> <span class="n">EXCLUDED_PARQUET_PATHS</span><span class="p">)</span>
@@ -966,7 +980,8 @@
<span class="k">def</span> <span class="nf">_push_pieces</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">files</span><span class="p">,</span> <span class="n">part_keys</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">pieces</span><span class="o">.</span><span class="n">extend</span><span class="p">([</span>
- <span class="n">ParquetDatasetPiece</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">partition_keys</span><span class="o">=</span><span class="n">part_keys</span><span class="p">)</span>
+ <span class="n">ParquetDatasetPiece</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">partition_keys</span><span class="o">=</span><span class="n">part_keys</span><span class="p">,</span>
+ <span class="n">open_file_func</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">open_file_func</span><span class="p">)</span>
<span class="k">for</span> <span class="n">path</span> <span class="ow">in</span> <span class="n">files</span>
<span class="p">])</span>
@@ -1033,10 +1048,13 @@
<span class="sd"> How many threads to allow the thread pool which is used to read the</span>
<span class="sd"> dataset metadata. Increasing this is helpful to read partitioned</span>
<span class="sd"> datasets.</span>
+<span class="sd"> memory_map : boolean, default True</span>
+<span class="sd"> If the source is a file path, use a memory map to read each file in the</span>
+<span class="sd"> dataset if possible, which can improve performance in some environments</span>
<span class="sd"> """</span>
<div class="viewcode-block" id="ParquetDataset.__init__"><a class="viewcode-back" href="../../python/generated/pyarrow.parquet.ParquetDataset.html#pyarrow.parquet.ParquetDataset.__init__">[docs]</a> <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">path_or_paths</span><span class="p">,</span> <span class="n">filesystem</span><span class="o">=</span><span class="kc">None</span><span cl [...]
<span class="n">metadata</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">split_row_groups</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">validate_schema</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
- <span class="n">filters</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">metadata_nthreads</span><span class="o">=</span><span class="mi">1</span><span class="p">):</span>
+ <span class="n">filters</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">metadata_nthreads</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span> <span class="n">memory_map</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
<span class="n">a_path</span> <span class="o">=</span> <span class="n">path_or_paths</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">a_path</span><span class="p">,</span> <span class="nb">list</span><span class="p">):</span>
<span class="n">a_path</span> <span class="o">=</span> <span class="n">a_path</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
@@ -1047,21 +1065,26 @@
<span class="k">else</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">paths</span> <span class="o">=</span> <span class="n">_parse_uri</span><span class="p">(</span><span class="n">path_or_paths</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">memory_map</span> <span class="o">=</span> <span class="n">memory_map</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_open_file_func</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_get_open_file_func</span><span class="p">()</span>
+
<span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">pieces</span><span class="p">,</span>
<span class="bp">self</span><span class="o">.</span><span class="n">partitions</span><span class="p">,</span>
<span class="bp">self</span><span class="o">.</span><span class="n">common_metadata_path</span><span class="p">,</span>
<span class="bp">self</span><span class="o">.</span><span class="n">metadata_path</span><span class="p">)</span> <span class="o">=</span> <span class="n">_make_manifest</span><span class="p">(</span>
- <span class="n">path_or_paths</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">fs</span><span class="p">,</span> <span class="n">metadata_nthreads</span><span class="o">=</span><span class="n">metadata_nthreads</span><span class="p">)</span>
+ <span class="n">path_or_paths</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">fs</span><span class="p">,</span> <span class="n">metadata_nthreads</span><span class="o">=</span><span class="n">metadata_nthreads</span><span class="p">,</span>
+ <span class="n">open_file_func</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">_open_file_func</span><span class="p">)</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">common_metadata_path</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">with</span> <span class="bp">self</span><span class="o">.</span><span class="n">fs</span><span class="o">.</span><span class="n">open</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">common_metadata_path</span><span class="p">)</span> <span class="k">as</span> <span class="n">f</span><span class="p">:</span>
- <span class="bp">self</span><span class="o">.</span><span class="n">common_metadata</span> <span class="o">=</span> <span class="n">ParquetFile</span><span class="p">(</span><span class="n">f</span><span class="p">)</span><span class="o">.</span><span class="n">metadata</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">common_metadata</span> <span class="o">=</span> <span class="p">(</span><span class="n">ParquetFile</span><span class="p">(</span><span class="n">f</span><span class="p">,</span> <span class="n">memory_map</span><span class="o">=</span><span class="n">memory_map</span><span class="p">)</span>
+ <span class="o">.</span><span class="n">metadata</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">common_metadata</span> <span class="o">=</span> <span class="kc">None</span>
<span class="k">if</span> <span class="n">metadata</span> <span class="ow">is</span> <span class="kc">None</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">metadata_path</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">with</span> <span class="bp">self</span><span class="o">.</span><span class="n">fs</span><span class="o">.</span><span class="n">open</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">metadata_path</span><span class="p">)</span> <span class="k">as</span> <span class="n">f</span><span class="p">:</span>
- <span class="bp">self</span><span class="o">.</span><span class="n">metadata</span> <span class="o">=</span> <span class="n">ParquetFile</span><span class="p">(</span><span class="n">f</span><span class="p">)</span><span class="o">.</span><span class="n">metadata</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">metadata</span> <span class="o">=</span> <span class="n">ParquetFile</span><span class="p">(</span><span class="n">f</span><span class="p">,</span> <span class="n">memory_map</span><span class="o">=</span><span class="n">memory_map</span><span class="p">)</span><span class="o">.</span><span class="n">metadata</span>
<span class="k">else</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">metadata</span> <span class="o">=</span> <span class="n">metadata</span>
@@ -1080,13 +1103,11 @@
<span class="bp">self</span><span class="o">.</span><span class="n">_filter</span><span class="p">(</span><span class="n">filters</span><span class="p">)</span></div>
<div class="viewcode-block" id="ParquetDataset.validate_schemas"><a class="viewcode-back" href="../../python/generated/pyarrow.parquet.ParquetDataset.html#pyarrow.parquet.ParquetDataset.validate_schemas">[docs]</a> <span class="k">def</span> <span class="nf">validate_schemas</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
- <span class="n">open_file</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_get_open_file_func</span><span class="p">()</span>
-
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">metadata</span> <span class="ow">is</span> <span class="kc">None</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">schema</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">common_metadata</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">schema</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">common_metadata</span><span class="o">.</span><span class="n">schema</span>
<span class="k">else</span><span class="p">:</span>
- <span class="bp">self</span><span class="o">.</span><span class="n">schema</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">pieces</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">get_metadata</span><span class="p">(</span><span class="n">open_file</span><span class="p">)</span><span class="o">.</span><span class="n">schema</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">schema</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">pieces</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">get_metadata</span><span class="p">()</span><span class="o">.</span><span class="n">schema</span>
<span class="k">elif</span> <span class="bp">self</span><span class="o">.</span><span class="n">schema</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">schema</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">metadata</span><span class="o">.</span><span class="n">schema</span>
@@ -1101,7 +1122,7 @@
<span class="n">dataset_schema</span> <span class="o">=</span> <span class="n">dataset_schema</span><span class="o">.</span><span class="n">remove</span><span class="p">(</span><span class="n">field_idx</span><span class="p">)</span>
<span class="k">for</span> <span class="n">piece</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">pieces</span><span class="p">:</span>
- <span class="n">file_metadata</span> <span class="o">=</span> <span class="n">piece</span><span class="o">.</span><span class="n">get_metadata</span><span class="p">(</span><span class="n">open_file</span><span class="p">)</span>
+ <span class="n">file_metadata</span> <span class="o">=</span> <span class="n">piece</span><span class="o">.</span><span class="n">get_metadata</span><span class="p">()</span>
<span class="n">file_schema</span> <span class="o">=</span> <span class="n">file_metadata</span><span class="o">.</span><span class="n">schema</span><span class="o">.</span><span class="n">to_arrow_schema</span><span class="p">()</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">dataset_schema</span><span class="o">.</span><span class="n">equals</span><span class="p">(</span><span class="n">file_schema</span><span class="p">,</span> <span class="n">check_metadata</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">'Schema in </span><span class="si">{0!s}</span><span class="s1"> was different. </span><span class="se">\n</span><span class="s1">'</span>
@@ -1127,13 +1148,10 @@
<span class="sd"> pyarrow.Table</span>
<span class="sd"> Content of the file as a table (of columns)</span>
<span class="sd"> """</span>
- <span class="n">open_file</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_get_open_file_func</span><span class="p">()</span>
-
<span class="n">tables</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">for</span> <span class="n">piece</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">pieces</span><span class="p">:</span>
<span class="n">table</span> <span class="o">=</span> <span class="n">piece</span><span class="o">.</span><span class="n">read</span><span class="p">(</span><span class="n">columns</span><span class="o">=</span><span class="n">columns</span><span class="p">,</span> <span class="n">use_threads</span><span class="o">=</span><span class="n">use_threads</span><span class="p">,</span>
<span class="n">partitions</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">partitions</span><span class="p">,</span>
- <span class="n">open_file_func</span><span class="o">=</span><span class="n">open_file</span><span class="p">,</span>
<span class="n">use_pandas_metadata</span><span class="o">=</span><span class="n">use_pandas_metadata</span><span class="p">)</span>
<span class="n">tables</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">table</span><span class="p">)</span>
@@ -1175,10 +1193,12 @@
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">fs</span> <span class="ow">is</span> <span class="kc">None</span> <span class="ow">or</span> <span class="nb">isinstance</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">fs</span><span class="p">,</span> <span class="n">LocalFileSystem</span><span class="p">):</span>
<span class="k">def</span> <span class="nf">open_file</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">meta</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="k">return</span> <span class="n">ParquetFile</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">metadata</span><span class="o">=</span><span class="n">meta</span><span class="p">,</span>
+ <span class="n">memory_map</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">memory_map</span><span class="p">,</span>
<span class="n">common_metadata</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">common_metadata</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">def</span> <span class="nf">open_file</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">meta</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="k">return</span> <span class="n">ParquetFile</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">fs</span><span class="o">.</span><span class="n">open</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">mode</span><span class="o">=</span><span class="s1">'rb'</span><span class="p">),</span>
+ <span class="n">memory_map</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">memory_map</span><span class="p">,</span>
<span class="n">metadata</span><span class="o">=</span><span class="n">meta</span><span class="p">,</span>
<span class="n">common_metadata</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">common_metadata</span><span class="p">)</span>
<span class="k">return</span> <span class="n">open_file</span>
@@ -1197,7 +1217,8 @@
<span class="bp">self</span><span class="o">.</span><span class="n">pieces</span> <span class="o">=</span> <span class="p">[</span><span class="n">p</span> <span class="k">for</span> <span class="n">p</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">pieces</span> <span class="k">if</span> <span class="n">all_filters_accept</span><span class="p">(</span><span class="n">p</span><span class="p">)]</span></div>
-<span class="k">def</span> <span class="nf">_make_manifest</span><span class="p">(</span><span class="n">path_or_paths</span><span class="p">,</span> <span class="n">fs</span><span class="p">,</span> <span class="n">pathsep</span><span class="o">=</span><span class="s1">'/'</span><span class="p">,</span> <span class="n">metadata_nthreads</span><span class="o">=</span><span class="mi">1</span><span class="p">):</span>
+<span class="k">def</span> <span class="nf">_make_manifest</span><span class="p">(</span><span class="n">path_or_paths</span><span class="p">,</span> <span class="n">fs</span><span class="p">,</span> <span class="n">pathsep</span><span class="o">=</span><span class="s1">'/'</span><span class="p">,</span> <span class="n">metadata_nthreads</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span>
+ <span class="n">open_file_func</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="n">partitions</span> <span class="o">=</span> <span class="kc">None</span>
<span class="n">common_metadata_path</span> <span class="o">=</span> <span class="kc">None</span>
<span class="n">metadata_path</span> <span class="o">=</span> <span class="kc">None</span>
@@ -1208,6 +1229,7 @@
<span class="k">if</span> <span class="n">_is_path_like</span><span class="p">(</span><span class="n">path_or_paths</span><span class="p">)</span> <span class="ow">and</span> <span class="n">fs</span><span class="o">.</span><span class="n">isdir</span><span class="p">(</span><span class="n">path_or_paths</span><span class="p">):</span>
<span class="n">manifest</span> <span class="o">=</span> <span class="n">ParquetManifest</span><span class="p">(</span><span class="n">path_or_paths</span><span class="p">,</span> <span class="n">filesystem</span><span class="o">=</span><span class="n">fs</span><span class="p">,</span>
+ <span class="n">open_file_func</span><span class="o">=</span><span class="n">open_file_func</span><span class="p">,</span>
<span class="n">pathsep</span><span class="o">=</span><span class="n">fs</span><span class="o">.</span><span class="n">pathsep</span><span class="p">,</span>
<span class="n">metadata_nthreads</span><span class="o">=</span><span class="n">metadata_nthreads</span><span class="p">)</span>
<span class="n">common_metadata_path</span> <span class="o">=</span> <span class="n">manifest</span><span class="o">.</span><span class="n">common_metadata_path</span>
@@ -1227,7 +1249,7 @@
<span class="k">if</span> <span class="ow">not</span> <span class="n">fs</span><span class="o">.</span><span class="n">isfile</span><span class="p">(</span><span class="n">path</span><span class="p">):</span>
<span class="k">raise</span> <span class="ne">IOError</span><span class="p">(</span><span class="s1">'Passed non-file path: </span><span class="si">{0}</span><span class="s1">'</span>
<span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">path</span><span class="p">))</span>
- <span class="n">piece</span> <span class="o">=</span> <span class="n">ParquetDatasetPiece</span><span class="p">(</span><span class="n">path</span><span class="p">)</span>
+ <span class="n">piece</span> <span class="o">=</span> <span class="n">ParquetDatasetPiece</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">open_file_func</span><span class="o">=</span><span class="n">open_file_func</span><span class="p">)</span>
<span class="n">pieces</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">piece</span><span class="p">)</span>
<span class="k">return</span> <span class="n">pieces</span><span class="p">,</span> <span class="n">partitions</span><span class="p">,</span> <span class="n">common_metadata_path</span><span class="p">,</span> <span class="n">metadata_path</span>
@@ -1350,8 +1372,8 @@
<span class="k">assert</span> <span class="n">fs</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="n">path</span><span class="p">)</span>
-<div class="viewcode-block" id="write_to_dataset"><a class="viewcode-back" href="../../python/generated/pyarrow.parquet.write_to_dataset.html#pyarrow.parquet.write_to_dataset">[docs]</a><span class="k">def</span> <span class="nf">write_to_dataset</span><span class="p">(</span><span class="n">table</span><span class="p">,</span> <span class="n">root_path</span><span class="p">,</span> <span class="n">partition_cols</span><span class="o">=</span><span class="kc">None</span><span class="p"> [...]
- <span class="n">filesystem</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">preserve_index</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
+<div class="viewcode-block" id="write_to_dataset"><a class="viewcode-back" href="../../python/generated/pyarrow.parquet.write_to_dataset.html#pyarrow.parquet.write_to_dataset">[docs]</a><span class="k">def</span> <span class="nf">write_to_dataset</span><span class="p">(</span><span class="n">table</span><span class="p">,</span> <span class="n">root_path</span><span class="p">,</span> <span class="n">partition_cols</span><span class="o">=</span><span class="kc">None</span><span class="p"> [...]
+ <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Wrapper around parquet.write_table for writing a Table to</span>
<span class="sd"> Parquet format by partitions.</span>
@@ -1382,8 +1404,6 @@
<span class="sd"> partition_cols : list,</span>
<span class="sd"> Column names by which to partition the dataset</span>
<span class="sd"> Columns are partitioned in the order they are given</span>
-<span class="sd"> preserve_index : bool,</span>
-<span class="sd"> Parameter for instantiating Table; preserve pandas index or not.</span>
<span class="sd"> **kwargs : dict, kwargs for write_table function.</span>
<span class="sd"> """</span>
<span class="n">fs</span><span class="p">,</span> <span class="n">root_path</span> <span class="o">=</span> <span class="n">_get_filesystem_and_path</span><span class="p">(</span><span class="n">filesystem</span><span class="p">,</span> <span class="n">root_path</span><span class="p">)</span>
@@ -1391,7 +1411,7 @@
<span class="n">_mkdir_if_not_exists</span><span class="p">(</span><span class="n">fs</span><span class="p">,</span> <span class="n">root_path</span><span class="p">)</span>
<span class="k">if</span> <span class="n">partition_cols</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="ow">and</span> <span class="nb">len</span><span class="p">(</span><span class="n">partition_cols</span><span class="p">)</span> <span class="o">></span> <span class="mi">0</span><span class="p">:</span>
- <span class="n">df</span> <span class="o">=</span> <span class="n">table</span><span class="o">.</span><span class="n">to_pandas</span><span class="p">()</span>
+ <span class="n">df</span> <span class="o">=</span> <span class="n">table</span><span class="o">.</span><span class="n">to_pandas</span><span class="p">(</span><span class="n">ignore_metadata</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<span class="n">partition_keys</span> <span class="o">=</span> <span class="p">[</span><span class="n">df</span><span class="p">[</span><span class="n">col</span><span class="p">]</span> <span class="k">for</span> <span class="n">col</span> <span class="ow">in</span> <span class="n">partition_cols</span><span class="p">]</span>
<span class="n">data_df</span> <span class="o">=</span> <span class="n">df</span><span class="o">.</span><span class="n">drop</span><span class="p">(</span><span class="n">partition_cols</span><span class="p">,</span> <span class="n">axis</span><span class="o">=</span><span class="s1">'columns'</span><span class="p">)</span>
<span class="n">data_cols</span> <span class="o">=</span> <span class="n">df</span><span class="o">.</span><span class="n">columns</span><span class="o">.</span><span class="n">drop</span><span class="p">(</span><span class="n">partition_cols</span><span class="p">)</span>
@@ -1399,10 +1419,11 @@
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">'No data left to save outside partition columns'</span><span class="p">)</span>
<span class="n">subschema</span> <span class="o">=</span> <span class="n">table</span><span class="o">.</span><span class="n">schema</span>
+
<span class="c1"># ARROW-2891: Ensure the output_schema is preserved when writing a</span>
<span class="c1"># partitioned dataset</span>
<span class="k">for</span> <span class="n">col</span> <span class="ow">in</span> <span class="n">table</span><span class="o">.</span><span class="n">schema</span><span class="o">.</span><span class="n">names</span><span class="p">:</span>
- <span class="k">if</span> <span class="p">(</span><span class="n">col</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s1">'__index_level_'</span><span class="p">)</span> <span class="ow">or</span> <span class="n">col</span> <span class="ow">in</span> <span class="n">partition_cols</span><span class="p">):</span>
+ <span class="k">if</span> <span class="n">col</span> <span class="ow">in</span> <span class="n">partition_cols</span><span class="p">:</span>
<span class="n">subschema</span> <span class="o">=</span> <span class="n">subschema</span><span class="o">.</span><span class="n">remove</span><span class="p">(</span><span class="n">subschema</span><span class="o">.</span><span class="n">get_field_index</span><span class="p">(</span><span class="n">col</span><span class="p">))</span>
<span class="k">for</span> <span class="n">keys</span><span class="p">,</span> <span class="n">subgroup</span> <span class="ow">in</span> <span class="n">data_df</span><span class="o">.</span><span class="n">groupby</span><span class="p">(</span><span class="n">partition_keys</span><span class="p">):</span>
@@ -1411,10 +1432,8 @@
<span class="n">subdir</span> <span class="o">=</span> <span class="s1">'/'</span><span class="o">.</span><span class="n">join</span><span class="p">(</span>
<span class="p">[</span><span class="s1">'</span><span class="si">{colname}</span><span class="s1">=</span><span class="si">{value}</span><span class="s1">'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">colname</span><span class="o">=</span><span class="n">name</span><span class="p">,</span> <span class="n">value</span><span class="o">=</span><span class="n">val</span><span class="p">)</span>
<span class="k">for</span> <span class="n">name</span><span class="p">,</span> <span class="n">val</span> <span class="ow">in</span> <span class="nb">zip</span><span class="p">(</span><span class="n">partition_cols</span><span class="p">,</span> <span class="n">keys</span><span class="p">)])</span>
- <span class="n">subtable</span> <span class="o">=</span> <span class="n">pa</span><span class="o">.</span><span class="n">Table</span><span class="o">.</span><span class="n">from_pandas</span><span class="p">(</span><span class="n">subgroup</span><span class="p">,</span>
- <span class="n">preserve_index</span><span class="o">=</span><span class="n">preserve_index</span><span class="p">,</span>
- <span class="n">schema</span><span class="o">=</span><span class="n">subschema</span><span class="p">,</span>
- <span class="n">safe</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
+ <span class="n">subtable</span> <span class="o">=</span> <span class="n">pa</span><span class="o">.</span><span class="n">Table</span><span class="o">.</span><span class="n">from_pandas</span><span class="p">(</span><span class="n">subgroup</span><span class="p">,</span> <span class="n">preserve_index</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span>
+ <span class="n">schema</span><span class="o">=</span><span class="n">subschema</span><span class="p">,</span> <span class="n">safe</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
<span class="n">prefix</span> <span class="o">=</span> <span class="s1">'/'</span><span class="o">.</span><span class="n">join</span><span class="p">([</span><span class="n">root_path</span><span class="p">,</span> <span class="n">subdir</span><span class="p">])</span>
<span class="n">_mkdir_if_not_exists</span><span class="p">(</span><span class="n">fs</span><span class="p">,</span> <span class="n">prefix</span><span class="p">)</span>
<span class="n">outfile</span> <span class="o">=</span> <span class="n">guid</span><span class="p">()</span> <span class="o">+</span> <span class="s1">'.parquet'</span>
@@ -1517,26 +1536,16 @@
-
-
-
-
- <script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
- <script type="text/javascript" src="../../_static/jquery.js"></script>
- <script type="text/javascript" src="../../_static/underscore.js"></script>
- <script type="text/javascript" src="../../_static/doctools.js"></script>
- <script type="text/javascript" src="../../_static/language_data.js"></script>
-
-
-
-
- <script type="text/javascript" src="../../_static/js/theme.js"></script>
-
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
+
+
+
+
+
<script async src="https://www.googletagmanager.com/gtag/js?id=UA-107500873-1"></script>
<script>
window.dataLayer = window.dataLayer || [];
diff --git a/docs/_modules/pyarrow/types.html b/docs/_modules/pyarrow/types.html
index f488498..759da4b 100644
--- a/docs/_modules/pyarrow/types.html
+++ b/docs/_modules/pyarrow/types.html
@@ -9,7 +9,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>pyarrow.types — Apache Arrow v0.12.1.dev0+g8ca41384b.d20190120</title>
+ <title>pyarrow.types — Apache Arrow v0.13.0</title>
@@ -18,32 +18,34 @@
-
-
+ <script type="text/javascript" src="../../_static/js/modernizr.min.js"></script>
+ <script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
+ <script type="text/javascript" src="../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../_static/doctools.js"></script>
+ <script type="text/javascript" src="../../_static/language_data.js"></script>
+
+ <script type="text/javascript" src="../../_static/js/theme.js"></script>
-
+
+
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<link rel="index" title="Index" href="../../genindex.html" />
<link rel="search" title="Search" href="../../search.html" />
-
-
- <script src="../../_static/js/modernizr.min.js"></script>
-
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
-
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
- <div class="wy-side-nav-search">
+ <div class="wy-side-nav-search" >
@@ -57,7 +59,7 @@
<div class="version">
- 0.12.1.dev0+g8ca41384b.d20190120
+ 0.13.0
</div>
@@ -81,7 +83,7 @@
- <p class="caption"><span class="caption-text">Memory Format</span></p>
+ <p class="caption"><span class="caption-text">Arrow Columnar Format</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../format/README.html">Arrow specification documents</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../format/Guidelines.html">Implementation guidelines</a></li>
@@ -89,14 +91,18 @@
<li class="toctree-l1"><a class="reference internal" href="../../format/Metadata.html">Metadata: Logical types, schemas, data headers</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../format/IPC.html">Interprocess messaging / communication (IPC)</a></li>
</ul>
-<p class="caption"><span class="caption-text">Languages</span></p>
+<p class="caption"><span class="caption-text">Arrow Libraries</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../cpp/index.html">C++ Implementation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../python/index.html">Python bindings</a></li>
</ul>
-<p class="caption"><span class="caption-text">Other Topics</span></p>
+<p class="caption"><span class="caption-text">Development and Contributing</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../../building.html">Building the Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../developers/contributing.html">Contribution Guidelines</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../developers/cpp.html">C++ Development</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../developers/python.html">Python Development</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../developers/integration.html">Integration Testing</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../developers/documentation.html">Building the Documentation</a></li>
</ul>
@@ -207,18 +213,18 @@
<span class="k">return</span> <span class="n">t</span><span class="o">.</span><span class="n">id</span> <span class="o">==</span> <span class="n">lib</span><span class="o">.</span><span class="n">Type_NA</span></div>
-<div class="viewcode-block" id="is_boolean"><a class="viewcode-back" href="../../python/generated/pyarrow.types.is_boolean.html#pyarrow.types.is_boolean">[docs]</a><span class="k">def</span> <span class="nf">is_boolean</span><span class="p">(</span><span class="n">t</span><span class="p">):</span>
+<span class="k">def</span> <span class="nf">is_boolean</span><span class="p">(</span><span class="n">t</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Return True if value is an instance of a boolean type</span>
<span class="sd"> """</span>
- <span class="k">return</span> <span class="n">t</span><span class="o">.</span><span class="n">id</span> <span class="o">==</span> <span class="n">lib</span><span class="o">.</span><span class="n">Type_BOOL</span></div>
+ <span class="k">return</span> <span class="n">t</span><span class="o">.</span><span class="n">id</span> <span class="o">==</span> <span class="n">lib</span><span class="o">.</span><span class="n">Type_BOOL</span>
-<div class="viewcode-block" id="is_integer"><a class="viewcode-back" href="../../python/generated/pyarrow.types.is_integer.html#pyarrow.types.is_integer">[docs]</a><span class="k">def</span> <span class="nf">is_integer</span><span class="p">(</span><span class="n">t</span><span class="p">):</span>
+<span class="k">def</span> <span class="nf">is_integer</span><span class="p">(</span><span class="n">t</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Return True if value is an instance of any integer type</span>
<span class="sd"> """</span>
- <span class="k">return</span> <span class="n">t</span><span class="o">.</span><span class="n">id</span> <span class="ow">in</span> <span class="n">_INTEGER_TYPES</span></div>
+ <span class="k">return</span> <span class="n">t</span><span class="o">.</span><span class="n">id</span> <span class="ow">in</span> <span class="n">_INTEGER_TYPES</span>
<div class="viewcode-block" id="is_signed_integer"><a class="viewcode-back" href="../../python/generated/pyarrow.types.is_signed_integer.html#pyarrow.types.is_signed_integer">[docs]</a><span class="k">def</span> <span class="nf">is_signed_integer</span><span class="p">(</span><span class="n">t</span><span class="p">):</span>
@@ -235,32 +241,32 @@
<span class="k">return</span> <span class="n">t</span><span class="o">.</span><span class="n">id</span> <span class="ow">in</span> <span class="n">_UNSIGNED_INTEGER_TYPES</span></div>
-<div class="viewcode-block" id="is_int8"><a class="viewcode-back" href="../../python/generated/pyarrow.types.is_int8.html#pyarrow.types.is_int8">[docs]</a><span class="k">def</span> <span class="nf">is_int8</span><span class="p">(</span><span class="n">t</span><span class="p">):</span>
+<span class="k">def</span> <span class="nf">is_int8</span><span class="p">(</span><span class="n">t</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Return True if value is an instance of an int8 type</span>
<span class="sd"> """</span>
- <span class="k">return</span> <span class="n">t</span><span class="o">.</span><span class="n">id</span> <span class="o">==</span> <span class="n">lib</span><span class="o">.</span><span class="n">Type_INT8</span></div>
+ <span class="k">return</span> <span class="n">t</span><span class="o">.</span><span class="n">id</span> <span class="o">==</span> <span class="n">lib</span><span class="o">.</span><span class="n">Type_INT8</span>
-<div class="viewcode-block" id="is_int16"><a class="viewcode-back" href="../../python/generated/pyarrow.types.is_int16.html#pyarrow.types.is_int16">[docs]</a><span class="k">def</span> <span class="nf">is_int16</span><span class="p">(</span><span class="n">t</span><span class="p">):</span>
+<span class="k">def</span> <span class="nf">is_int16</span><span class="p">(</span><span class="n">t</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Return True if value is an instance of an int16 type</span>
<span class="sd"> """</span>
- <span class="k">return</span> <span class="n">t</span><span class="o">.</span><span class="n">id</span> <span class="o">==</span> <span class="n">lib</span><span class="o">.</span><span class="n">Type_INT16</span></div>
+ <span class="k">return</span> <span class="n">t</span><span class="o">.</span><span class="n">id</span> <span class="o">==</span> <span class="n">lib</span><span class="o">.</span><span class="n">Type_INT16</span>
-<div class="viewcode-block" id="is_int32"><a class="viewcode-back" href="../../python/generated/pyarrow.types.is_int32.html#pyarrow.types.is_int32">[docs]</a><span class="k">def</span> <span class="nf">is_int32</span><span class="p">(</span><span class="n">t</span><span class="p">):</span>
+<span class="k">def</span> <span class="nf">is_int32</span><span class="p">(</span><span class="n">t</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Return True if value is an instance of an int32 type</span>
<span class="sd"> """</span>
- <span class="k">return</span> <span class="n">t</span><span class="o">.</span><span class="n">id</span> <span class="o">==</span> <span class="n">lib</span><span class="o">.</span><span class="n">Type_INT32</span></div>
+ <span class="k">return</span> <span class="n">t</span><span class="o">.</span><span class="n">id</span> <span class="o">==</span> <span class="n">lib</span><span class="o">.</span><span class="n">Type_INT32</span>
-<div class="viewcode-block" id="is_int64"><a class="viewcode-back" href="../../python/generated/pyarrow.types.is_int64.html#pyarrow.types.is_int64">[docs]</a><span class="k">def</span> <span class="nf">is_int64</span><span class="p">(</span><span class="n">t</span><span class="p">):</span>
+<span class="k">def</span> <span class="nf">is_int64</span><span class="p">(</span><span class="n">t</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Return True if value is an instance of an int64 type</span>
<span class="sd"> """</span>
- <span class="k">return</span> <span class="n">t</span><span class="o">.</span><span class="n">id</span> <span class="o">==</span> <span class="n">lib</span><span class="o">.</span><span class="n">Type_INT64</span></div>
+ <span class="k">return</span> <span class="n">t</span><span class="o">.</span><span class="n">id</span> <span class="o">==</span> <span class="n">lib</span><span class="o">.</span><span class="n">Type_INT64</span>
<div class="viewcode-block" id="is_uint8"><a class="viewcode-back" href="../../python/generated/pyarrow.types.is_uint8.html#pyarrow.types.is_uint8">[docs]</a><span class="k">def</span> <span class="nf">is_uint8</span><span class="p">(</span><span class="n">t</span><span class="p">):</span>
@@ -291,39 +297,39 @@
<span class="k">return</span> <span class="n">t</span><span class="o">.</span><span class="n">id</span> <span class="o">==</span> <span class="n">lib</span><span class="o">.</span><span class="n">Type_UINT64</span></div>
-<div class="viewcode-block" id="is_floating"><a class="viewcode-back" href="../../python/generated/pyarrow.types.is_floating.html#pyarrow.types.is_floating">[docs]</a><span class="k">def</span> <span class="nf">is_floating</span><span class="p">(</span><span class="n">t</span><span class="p">):</span>
+<span class="k">def</span> <span class="nf">is_floating</span><span class="p">(</span><span class="n">t</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Return True if value is an instance of a floating point numeric type</span>
<span class="sd"> """</span>
- <span class="k">return</span> <span class="n">t</span><span class="o">.</span><span class="n">id</span> <span class="ow">in</span> <span class="n">_FLOATING_TYPES</span></div>
+ <span class="k">return</span> <span class="n">t</span><span class="o">.</span><span class="n">id</span> <span class="ow">in</span> <span class="n">_FLOATING_TYPES</span>
-<div class="viewcode-block" id="is_float16"><a class="viewcode-back" href="../../python/generated/pyarrow.types.is_float16.html#pyarrow.types.is_float16">[docs]</a><span class="k">def</span> <span class="nf">is_float16</span><span class="p">(</span><span class="n">t</span><span class="p">):</span>
+<span class="k">def</span> <span class="nf">is_float16</span><span class="p">(</span><span class="n">t</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Return True if value is an instance of an float16 (half-precision) type</span>
<span class="sd"> """</span>
- <span class="k">return</span> <span class="n">t</span><span class="o">.</span><span class="n">id</span> <span class="o">==</span> <span class="n">lib</span><span class="o">.</span><span class="n">Type_HALF_FLOAT</span></div>
+ <span class="k">return</span> <span class="n">t</span><span class="o">.</span><span class="n">id</span> <span class="o">==</span> <span class="n">lib</span><span class="o">.</span><span class="n">Type_HALF_FLOAT</span>
-<div class="viewcode-block" id="is_float32"><a class="viewcode-back" href="../../python/generated/pyarrow.types.is_float32.html#pyarrow.types.is_float32">[docs]</a><span class="k">def</span> <span class="nf">is_float32</span><span class="p">(</span><span class="n">t</span><span class="p">):</span>
+<span class="k">def</span> <span class="nf">is_float32</span><span class="p">(</span><span class="n">t</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Return True if value is an instance of an float32 (single precision) type</span>
<span class="sd"> """</span>
- <span class="k">return</span> <span class="n">t</span><span class="o">.</span><span class="n">id</span> <span class="o">==</span> <span class="n">lib</span><span class="o">.</span><span class="n">Type_FLOAT</span></div>
+ <span class="k">return</span> <span class="n">t</span><span class="o">.</span><span class="n">id</span> <span class="o">==</span> <span class="n">lib</span><span class="o">.</span><span class="n">Type_FLOAT</span>
-<div class="viewcode-block" id="is_float64"><a class="viewcode-back" href="../../python/generated/pyarrow.types.is_float64.html#pyarrow.types.is_float64">[docs]</a><span class="k">def</span> <span class="nf">is_float64</span><span class="p">(</span><span class="n">t</span><span class="p">):</span>
+<span class="k">def</span> <span class="nf">is_float64</span><span class="p">(</span><span class="n">t</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Return True if value is an instance of an float64 (double precision) type</span>
<span class="sd"> """</span>
- <span class="k">return</span> <span class="n">t</span><span class="o">.</span><span class="n">id</span> <span class="o">==</span> <span class="n">lib</span><span class="o">.</span><span class="n">Type_DOUBLE</span></div>
+ <span class="k">return</span> <span class="n">t</span><span class="o">.</span><span class="n">id</span> <span class="o">==</span> <span class="n">lib</span><span class="o">.</span><span class="n">Type_DOUBLE</span>
-<div class="viewcode-block" id="is_list"><a class="viewcode-back" href="../../python/generated/pyarrow.types.is_list.html#pyarrow.types.is_list">[docs]</a><span class="k">def</span> <span class="nf">is_list</span><span class="p">(</span><span class="n">t</span><span class="p">):</span>
+<span class="k">def</span> <span class="nf">is_list</span><span class="p">(</span><span class="n">t</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Return True if value is an instance of a list type</span>
<span class="sd"> """</span>
- <span class="k">return</span> <span class="n">t</span><span class="o">.</span><span class="n">id</span> <span class="o">==</span> <span class="n">lib</span><span class="o">.</span><span class="n">Type_LIST</span></div>
+ <span class="k">return</span> <span class="n">t</span><span class="o">.</span><span class="n">id</span> <span class="o">==</span> <span class="n">lib</span><span class="o">.</span><span class="n">Type_LIST</span>
<div class="viewcode-block" id="is_struct"><a class="viewcode-back" href="../../python/generated/pyarrow.types.is_struct.html#pyarrow.types.is_struct">[docs]</a><span class="k">def</span> <span class="nf">is_struct</span><span class="p">(</span><span class="n">t</span><span class="p">):</span>
@@ -383,11 +389,11 @@
<span class="k">return</span> <span class="n">t</span><span class="o">.</span><span class="n">id</span> <span class="o">==</span> <span class="n">lib</span><span class="o">.</span><span class="n">Type_TIME64</span></div>
-<div class="viewcode-block" id="is_binary"><a class="viewcode-back" href="../../python/generated/pyarrow.types.is_binary.html#pyarrow.types.is_binary">[docs]</a><span class="k">def</span> <span class="nf">is_binary</span><span class="p">(</span><span class="n">t</span><span class="p">):</span>
+<span class="k">def</span> <span class="nf">is_binary</span><span class="p">(</span><span class="n">t</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Return True if value is an instance of a variable-length binary type</span>
<span class="sd"> """</span>
- <span class="k">return</span> <span class="n">t</span><span class="o">.</span><span class="n">id</span> <span class="o">==</span> <span class="n">lib</span><span class="o">.</span><span class="n">Type_BINARY</span></div>
+ <span class="k">return</span> <span class="n">t</span><span class="o">.</span><span class="n">id</span> <span class="o">==</span> <span class="n">lib</span><span class="o">.</span><span class="n">Type_BINARY</span>
<div class="viewcode-block" id="is_unicode"><a class="viewcode-back" href="../../python/generated/pyarrow.types.is_unicode.html#pyarrow.types.is_unicode">[docs]</a><span class="k">def</span> <span class="nf">is_unicode</span><span class="p">(</span><span class="n">t</span><span class="p">):</span>
@@ -404,53 +410,53 @@
<span class="k">return</span> <span class="n">t</span><span class="o">.</span><span class="n">id</span> <span class="o">==</span> <span class="n">lib</span><span class="o">.</span><span class="n">Type_STRING</span></div>
-<div class="viewcode-block" id="is_fixed_size_binary"><a class="viewcode-back" href="../../python/generated/pyarrow.types.is_fixed_size_binary.html#pyarrow.types.is_fixed_size_binary">[docs]</a><span class="k">def</span> <span class="nf">is_fixed_size_binary</span><span class="p">(</span><span class="n">t</span><span class="p">):</span>
+<span class="k">def</span> <span class="nf">is_fixed_size_binary</span><span class="p">(</span><span class="n">t</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Return True if value is an instance of a fixed size binary type</span>
<span class="sd"> """</span>
- <span class="k">return</span> <span class="n">t</span><span class="o">.</span><span class="n">id</span> <span class="o">==</span> <span class="n">lib</span><span class="o">.</span><span class="n">Type_FIXED_SIZE_BINARY</span></div>
+ <span class="k">return</span> <span class="n">t</span><span class="o">.</span><span class="n">id</span> <span class="o">==</span> <span class="n">lib</span><span class="o">.</span><span class="n">Type_FIXED_SIZE_BINARY</span>
-<div class="viewcode-block" id="is_date"><a class="viewcode-back" href="../../python/generated/pyarrow.types.is_date.html#pyarrow.types.is_date">[docs]</a><span class="k">def</span> <span class="nf">is_date</span><span class="p">(</span><span class="n">t</span><span class="p">):</span>
+<span class="k">def</span> <span class="nf">is_date</span><span class="p">(</span><span class="n">t</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Return True if value is an instance of a date type</span>
<span class="sd"> """</span>
- <span class="k">return</span> <span class="n">t</span><span class="o">.</span><span class="n">id</span> <span class="ow">in</span> <span class="n">_DATE_TYPES</span></div>
+ <span class="k">return</span> <span class="n">t</span><span class="o">.</span><span class="n">id</span> <span class="ow">in</span> <span class="n">_DATE_TYPES</span>
-<div class="viewcode-block" id="is_date32"><a class="viewcode-back" href="../../python/generated/pyarrow.types.is_date32.html#pyarrow.types.is_date32">[docs]</a><span class="k">def</span> <span class="nf">is_date32</span><span class="p">(</span><span class="n">t</span><span class="p">):</span>
+<span class="k">def</span> <span class="nf">is_date32</span><span class="p">(</span><span class="n">t</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Return True if value is an instance of a date32 (days) type</span>
<span class="sd"> """</span>
- <span class="k">return</span> <span class="n">t</span><span class="o">.</span><span class="n">id</span> <span class="o">==</span> <span class="n">lib</span><span class="o">.</span><span class="n">Type_DATE32</span></div>
+ <span class="k">return</span> <span class="n">t</span><span class="o">.</span><span class="n">id</span> <span class="o">==</span> <span class="n">lib</span><span class="o">.</span><span class="n">Type_DATE32</span>
-<div class="viewcode-block" id="is_date64"><a class="viewcode-back" href="../../python/generated/pyarrow.types.is_date64.html#pyarrow.types.is_date64">[docs]</a><span class="k">def</span> <span class="nf">is_date64</span><span class="p">(</span><span class="n">t</span><span class="p">):</span>
+<span class="k">def</span> <span class="nf">is_date64</span><span class="p">(</span><span class="n">t</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Return True if value is an instance of a date64 (milliseconds) type</span>
<span class="sd"> """</span>
- <span class="k">return</span> <span class="n">t</span><span class="o">.</span><span class="n">id</span> <span class="o">==</span> <span class="n">lib</span><span class="o">.</span><span class="n">Type_DATE64</span></div>
+ <span class="k">return</span> <span class="n">t</span><span class="o">.</span><span class="n">id</span> <span class="o">==</span> <span class="n">lib</span><span class="o">.</span><span class="n">Type_DATE64</span>
-<div class="viewcode-block" id="is_map"><a class="viewcode-back" href="../../python/generated/pyarrow.types.is_map.html#pyarrow.types.is_map">[docs]</a><span class="k">def</span> <span class="nf">is_map</span><span class="p">(</span><span class="n">t</span><span class="p">):</span>
+<span class="k">def</span> <span class="nf">is_map</span><span class="p">(</span><span class="n">t</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Return True if value is an instance of a map logical type</span>
<span class="sd"> """</span>
- <span class="k">return</span> <span class="n">t</span><span class="o">.</span><span class="n">id</span> <span class="o">==</span> <span class="n">lib</span><span class="o">.</span><span class="n">Type_MAP</span></div>
+ <span class="k">return</span> <span class="n">t</span><span class="o">.</span><span class="n">id</span> <span class="o">==</span> <span class="n">lib</span><span class="o">.</span><span class="n">Type_MAP</span>
-<div class="viewcode-block" id="is_decimal"><a class="viewcode-back" href="../../python/generated/pyarrow.types.is_decimal.html#pyarrow.types.is_decimal">[docs]</a><span class="k">def</span> <span class="nf">is_decimal</span><span class="p">(</span><span class="n">t</span><span class="p">):</span>
+<span class="k">def</span> <span class="nf">is_decimal</span><span class="p">(</span><span class="n">t</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Return True if value is an instance of a decimal type</span>
<span class="sd"> """</span>
- <span class="k">return</span> <span class="n">t</span><span class="o">.</span><span class="n">id</span> <span class="o">==</span> <span class="n">lib</span><span class="o">.</span><span class="n">Type_DECIMAL</span></div>
+ <span class="k">return</span> <span class="n">t</span><span class="o">.</span><span class="n">id</span> <span class="o">==</span> <span class="n">lib</span><span class="o">.</span><span class="n">Type_DECIMAL</span>
-<div class="viewcode-block" id="is_dictionary"><a class="viewcode-back" href="../../python/generated/pyarrow.types.is_dictionary.html#pyarrow.types.is_dictionary">[docs]</a><span class="k">def</span> <span class="nf">is_dictionary</span><span class="p">(</span><span class="n">t</span><span class="p">):</span>
+<span class="k">def</span> <span class="nf">is_dictionary</span><span class="p">(</span><span class="n">t</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Return True if value is an instance of a dictionary-encoded type</span>
<span class="sd"> """</span>
- <span class="k">return</span> <span class="n">t</span><span class="o">.</span><span class="n">id</span> <span class="o">==</span> <span class="n">lib</span><span class="o">.</span><span class="n">Type_DICTIONARY</span></div>
+ <span class="k">return</span> <span class="n">t</span><span class="o">.</span><span class="n">id</span> <span class="o">==</span> <span class="n">lib</span><span class="o">.</span><span class="n">Type_DICTIONARY</span>
<span class="k">def</span> <span class="nf">is_primitive</span><span class="p">(</span><span class="n">t</span><span class="p">):</span>
@@ -487,26 +493,16 @@
-
-
-
-
- <script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
- <script type="text/javascript" src="../../_static/jquery.js"></script>
- <script type="text/javascript" src="../../_static/underscore.js"></script>
- <script type="text/javascript" src="../../_static/doctools.js"></script>
- <script type="text/javascript" src="../../_static/language_data.js"></script>
-
-
-
-
- <script type="text/javascript" src="../../_static/js/theme.js"></script>
-
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
+
+
+
+
+
<script async src="https://www.googletagmanager.com/gtag/js?id=UA-107500873-1"></script>
<script>
window.dataLayer = window.dataLayer || [];
diff --git a/docs/_sources/cpp/api.rst.txt b/docs/_sources/cpp/api.rst.txt
index f6c0418..522609e 100644
--- a/docs/_sources/cpp/api.rst.txt
+++ b/docs/_sources/cpp/api.rst.txt
@@ -28,3 +28,5 @@ API Reference
api/array
api/builder
api/table
+ api/utilities
+ api/cuda
diff --git a/docs/_sources/cpp/api/cuda.rst.txt b/docs/_sources/cpp/api/cuda.rst.txt
new file mode 100644
index 0000000..e0b90e3
--- /dev/null
+++ b/docs/_sources/cpp/api/cuda.rst.txt
@@ -0,0 +1,69 @@
+.. Licensed to the Apache Software Foundation (ASF) under one
+.. or more contributor license agreements. See the NOTICE file
+.. distributed with this work for additional information
+.. regarding copyright ownership. The ASF licenses this file
+.. to you under the Apache License, Version 2.0 (the
+.. "License"); you may not use this file except in compliance
+.. with the License. You may obtain a copy of the License at
+
+.. http://www.apache.org/licenses/LICENSE-2.0
+
+.. Unless required by applicable law or agreed to in writing,
+.. software distributed under the License is distributed on an
+.. "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+.. KIND, either express or implied. See the License for the
+.. specific language governing permissions and limitations
+.. under the License.
+
+============
+CUDA support
+============
+
+CUDA Contexts
+=============
+
+.. doxygenclass:: arrow::cuda::CudaDeviceManager
+ :project: arrow_cpp
+ :members:
+
+.. doxygenclass:: arrow::cuda::CudaContext
+ :project: arrow_cpp
+ :members:
+
+Device and Host Buffers
+=======================
+
+.. doxygenclass:: arrow::cuda::CudaBuffer
+ :project: arrow_cpp
+ :members:
+
+.. doxygenfunction:: arrow::cuda::AllocateCudaHostBuffer
+ :project: arrow_cpp
+
+.. doxygenclass:: arrow::cuda::CudaHostBuffer
+ :project: arrow_cpp
+ :members:
+
+Device Memory Input / Output
+============================
+
+.. doxygenclass:: arrow::cuda::CudaBufferReader
+ :project: arrow_cpp
+ :members:
+
+.. doxygenclass:: arrow::cuda::CudaBufferWriter
+ :project: arrow_cpp
+ :members:
+
+CUDA IPC
+========
+
+.. doxygenclass:: arrow::cuda::CudaIpcMemHandle
+ :project: arrow_cpp
+ :members:
+
+.. doxygenfunction:: arrow::cuda::SerializeRecordBatch
+ :project: arrow_cpp
+
+.. doxygenfunction:: arrow::cuda::ReadRecordBatch
+ :project: arrow_cpp
diff --git a/docs/_sources/cpp/api.rst.txt b/docs/_sources/cpp/api/utilities.rst.txt
similarity index 83%
copy from docs/_sources/cpp/api.rst.txt
copy to docs/_sources/cpp/api/utilities.rst.txt
index f6c0418..1c18a20 100644
--- a/docs/_sources/cpp/api.rst.txt
+++ b/docs/_sources/cpp/api/utilities.rst.txt
@@ -15,16 +15,13 @@
.. specific language governing permissions and limitations
.. under the License.
-*************
-API Reference
-*************
+=========
+Utilities
+=========
-.. toctree::
- :maxdepth: 3
+Decimal Numbers
+===============
- api/support
- api/memory
- api/datatype
- api/array
- api/builder
- api/table
+.. doxygenclass:: arrow::Decimal128
+ :project: arrow_cpp
+ :members:
diff --git a/docs/_sources/cpp/api.rst.txt b/docs/_sources/cpp/examples/index.rst.txt
similarity index 84%
copy from docs/_sources/cpp/api.rst.txt
copy to docs/_sources/cpp/examples/index.rst.txt
index f6c0418..464c77f 100644
--- a/docs/_sources/cpp/api.rst.txt
+++ b/docs/_sources/cpp/examples/index.rst.txt
@@ -15,16 +15,11 @@
.. specific language governing permissions and limitations
.. under the License.
-*************
-API Reference
-*************
+Examples
+========
.. toctree::
- :maxdepth: 3
+ :maxdepth: 1
- api/support
- api/memory
- api/datatype
- api/array
- api/builder
- api/table
+ row_columnar_conversion
+ std::tuple-like ranges to Arrow <tuple_range_conversion>
diff --git a/docs/_sources/cpp/index.rst.txt b/docs/_sources/cpp/examples/row_columnar_conversion.rst.txt
similarity index 71%
copy from docs/_sources/cpp/index.rst.txt
copy to docs/_sources/cpp/examples/row_columnar_conversion.rst.txt
index 1d70e6a..02fd61b 100644
--- a/docs/_sources/cpp/index.rst.txt
+++ b/docs/_sources/cpp/examples/row_columnar_conversion.rst.txt
@@ -15,18 +15,13 @@
.. specific language governing permissions and limitations
.. under the License.
-C++ Implementation
-==================
+.. default-domain:: cpp
+.. highlight:: cpp
-.. toctree::
- :maxdepth: 2
+Row to columnar conversion
+==========================
- getting_started
- examples
- api
+The following example converts an array of structs to a :class:`arrow::Table`
+instance, and then converts it back to the original array of structs.
-.. TODO add "topics" chapter
-.. - nested arrays
-.. - dictionary encoding
-
-.. TODO add "building" or "development" chapter
+.. literalinclude:: ../../../../cpp/examples/arrow/row-wise-conversion-example.cc
diff --git a/docs/_sources/cpp/examples/tuple_range_conversion.rst.txt b/docs/_sources/cpp/examples/tuple_range_conversion.rst.txt
new file mode 100644
index 0000000..64ba237
--- /dev/null
+++ b/docs/_sources/cpp/examples/tuple_range_conversion.rst.txt
@@ -0,0 +1,106 @@
+.. Licensed to the Apache Software Foundation (ASF) under one
+.. or more contributor license agreements. See the NOTICE file
+.. distributed with this work for additional information
+.. regarding copyright ownership. The ASF licenses this file
+.. to you under the Apache License, Version 2.0 (the
+.. "License"); you may not use this file except in compliance
+.. with the License. You may obtain a copy of the License at
+
+.. http://www.apache.org/licenses/LICENSE-2.0
+
+.. Unless required by applicable law or agreed to in writing,
+.. software distributed under the License is distributed on an
+.. "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+.. KIND, either express or implied. See the License for the
+.. specific language governing permissions and limitations
+.. under the License.
+
+.. default-domain:: cpp
+.. highlight:: cpp
+
+Conversion of range of ``std::tuple``-like to ``Table`` instances
+=================================================================
+
+While the above example shows a quite manual approach of a row to columnar
+conversion, Arrow also provides some template logic to convert ranges of
+``std::tuple<..>``-like objects to tables.
+
+In the most simple case, you only need to provide the input data and the
+type conversion is then inferred at compile time.
+
+.. code::
+
+ std::vector<std::tuple<double, std::string>> rows = ..
+ std::shared_ptr<Table> table;
+
+ if (!arrow::stl::TableFromTupleRange(
+ arrow::default_memory_pool(),
+ rows, names, &table).ok()
+ ) {
+ // Error handling code should go here.
+ }
+
+In reverse, you can use ``TupleRangeFromTable`` to fill an already
+pre-allocated range with the data from a ``Table`` instance.
+
+.. code::
+
+ // An important aspect here is that the table columns need to be in the
+ // same order as the columns will later appear in the tuple. As the tuple
+ // is unnamed, matching is done on positions.
+ std::shared_ptr<Table> table = ..
+
+ // The range needs to be pre-allocated to the respective amount of rows.
+ // This allows us to pass in an arbitrary range object, not only
+ // `std::vector`.
+ std::vector<std::tuple<double, std::string>> rows(2);
+ if (!arrow::stl::TupleRangeFromTable(*table, &rows).ok()) {
+ // Error handling code should go here.
+ }
+
+Arrow itself already supports some C(++) data types for this conversion. If you
+want to support additional data types, you need to implement a specialization
+of ``arrow::stl::ConversionTraits<T>`` and the more general
+``arrow::CTypeTraits<T>``.
+
+
+.. code::
+
+ namespace arrow {
+
+ template<>
+ struct CTypeTraits<boost::posix_time::ptime> {
+ using ArrowType = ::arrow::TimestampType;
+
+ static std::shared_ptr<::arrow::DataType> type_singleton() {
+ return ::arrow::timestamp(::arrow::TimeUnit::MICRO);
+ }
+ };
+
+ }
+
+ namespace arrow { namespace stl {
+
+ template <>
+ struct ConversionTraits<boost::posix_time::ptime> : public CTypeTraits<boost::posix_time::ptime> {
+ constexpr static bool nullable = false;
+
+ // This is the specialization to load a scalar value into an Arrow builder.
+ static Status AppendRow(
+ typename TypeTraits<TimestampType>::BuilderType& builder,
+ boost::posix_time::ptime cell) {
+ boost::posix_time::ptime const epoch({1970, 1, 1}, {0, 0, 0, 0});
+ return builder.Append((cell - epoch).total_microseconds());
+ }
+
+ // Specify how we can fill the tuple from the values stored in the Arrow
+ // array.
+ static boost::posix_time::ptime GetEntry(
+ const TimestampArray& array, size_t j) {
+ return psapp::arrow::internal::timestamp_epoch
+ + boost::posix_time::time_duration(0, 0, 0, array.Value(j));
+ }
+ };
+
+ }}
+
diff --git a/docs/_sources/cpp/index.rst.txt b/docs/_sources/cpp/index.rst.txt
index 1d70e6a..b3f6e4c 100644
--- a/docs/_sources/cpp/index.rst.txt
+++ b/docs/_sources/cpp/index.rst.txt
@@ -22,7 +22,7 @@ C++ Implementation
:maxdepth: 2
getting_started
- examples
+ Examples <examples/index>
api
.. TODO add "topics" chapter
diff --git a/docs/_sources/developers/contributing.rst.txt b/docs/_sources/developers/contributing.rst.txt
new file mode 100644
index 0000000..326bdda
--- /dev/null
+++ b/docs/_sources/developers/contributing.rst.txt
@@ -0,0 +1,88 @@
+.. Licensed to the Apache Software Foundation (ASF) under one
+.. or more contributor license agreements. See the NOTICE file
+.. distributed with this work for additional information
+.. regarding copyright ownership. The ASF licenses this file
+.. to you under the Apache License, Version 2.0 (the
+.. "License"); you may not use this file except in compliance
+.. with the License. You may obtain a copy of the License at
+
+.. http://www.apache.org/licenses/LICENSE-2.0
+
+.. Unless required by applicable law or agreed to in writing,
+.. software distributed under the License is distributed on an
+.. "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+.. KIND, either express or implied. See the License for the
+.. specific language governing permissions and limitations
+.. under the License.
+
+.. _contributing:
+
+***********************
+Contribution Guidelines
+***********************
+
+There are many ways to contribute to Apache Arrow:
+
+* Contributing code (we call them "patches")
+* Writing documentation (another form of code, in a way)
+* Participating in discussions on JIRA or the mailing list
+* Helping users of the libraries
+* Reporting bugs and asking questions
+
+Mailing Lists and Issue Tracker
+===============================
+
+Projects in The Apache Software Foundation ("the ASF") use public, archived
+mailing lists to create a public record of each project's development
+activities and decision making process. As such, all contributors generally
+must be subscribed to the dev@arrow.apache.org mailing list to participate in
+the community.
+
+Note that you must be subscribed to the mailing list in order to post to it. To
+subscribe, send a blank email to dev-subscribe@arrow.apache.org.
+
+We use the `ASF JIRA <https://issues.apache.org/jira>`_ to manage our
+development "todo" list and to maintain changelogs for releases. You must
+create an account and be added as a "Contributor" to Apache Arrow to be able to
+assign yourself issues. Any project maintainer will be able to help you with
+this one-time setup.
+
+GitHub issues
+-------------
+
+We support GitHub issues as a lightweight way to ask questions and engage with
+the Arrow developer community. We use JIRA for maintaining a queue of
+development work and as the public record for work on the project. So, feel
+free to open GitHub issues, but bugs and feature requests will eventually need
+to end up in JIRA, either before or after completing a pull request. Don't be
+surprised if you are immediately asked by a project maintainer to open a JIRA
+issue.
+
+How to contribute patches
+=========================
+
+We prefer to receive contributions in the form of GitHub pull requests. Please
+send pull requests against the `github.com/apache/arrow
+<https://github.com/apache/arrow>`_ repository following the procedure below.
+
+If you are looking for some ideas on what to contribute, check out the JIRA
+issues for the Apache Arrow project. Comment on the issue and/or contact
+dev@arrow.apache.org with your questions and ideas.
+
+If you’d like to report a bug but don’t have time to fix it, you can still post
+it on JIRA, or email the mailing list dev@arrow.apache.org.
+
+To contribute a patch:
+
+* Break your work into small, single-purpose patches if possible. It’s much
+ harder to merge in a large change with a lot of disjoint features.
+* Create a JIRA for your patch on the Arrow Project JIRA.
+* Submit the patch as a GitHub pull request against the master branch. For a
+ tutorial, see the GitHub guides on forking a repo and sending a pull
+ request. Prefix your pull request name with the JIRA name (ex:
+ https://github.com/apache/arrow/pull/240).
+* Make sure that your code passes the unit tests. You can find instructions how
+ to run the unit tests for each Arrow component in its respective README file.
+* Add new unit tests for your code.
+
+Thank you in advance for your contributions!
diff --git a/docs/_sources/developers/cpp.rst.txt b/docs/_sources/developers/cpp.rst.txt
new file mode 100644
index 0000000..9025bce
--- /dev/null
+++ b/docs/_sources/developers/cpp.rst.txt
@@ -0,0 +1,921 @@
+.. Licensed to the Apache Software Foundation (ASF) under one
+.. or more contributor license agreements. See the NOTICE file
+.. distributed with this work for additional information
+.. regarding copyright ownership. The ASF licenses this file
+.. to you under the Apache License, Version 2.0 (the
+.. "License"); you may not use this file except in compliance
+.. with the License. You may obtain a copy of the License at
+
+.. http://www.apache.org/licenses/LICENSE-2.0
+
+.. Unless required by applicable law or agreed to in writing,
+.. software distributed under the License is distributed on an
+.. "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+.. KIND, either express or implied. See the License for the
+.. specific language governing permissions and limitations
+.. under the License.
+
+.. _cpp-development:
+
+***************
+C++ Development
+***************
+
+System setup
+============
+
+Arrow uses CMake as a build configuration system. We recommend building
+out-of-source. If you are not familiar with this terminology:
+
+* **In-source build**: ``cmake`` is invoked directly from the ``cpp``
+ directory. This can be inflexible when you wish to maintain multiple build
+ environments (e.g. one for debug builds and another for release builds)
+* **Out-of-source build**: ``cmake`` is invoked from another directory,
+ creating an isolated build environment that does not interact with any other
+ build environment. For example, you could create ``cpp/build-debug`` and
+ invoke ``cmake $CMAKE_ARGS ..`` from this directory
+
+Building requires:
+
+* A C++11-enabled compiler. On Linux, gcc 4.8 and higher should be
+ sufficient. For Windows, at least Visual Studio 2015 is required.
+* CMake 3.2 or higher
+* Boost
+* ``bison`` and ``flex`` (for building Apache Thrift from source only, an
+ Apache Parquet dependency.)
+
+Running the unit tests using ``ctest`` requires:
+
+* python
+
+On Ubuntu/Debian you can install the requirements with:
+
+.. code-block:: shell
+
+ sudo apt-get install \
+ autoconf \
+ build-essential \
+ cmake \
+ libboost-dev \
+ libboost-filesystem-dev \
+ libboost-regex-dev \
+ libboost-system-dev \
+ python \
+ bison \
+ flex
+
+On Alpine Linux:
+
+.. code-block:: shell
+
+ apk add autoconf \
+ bash \
+ boost-dev \
+ cmake \
+ g++ \
+ gcc \
+ make
+
+On macOS, you can use `Homebrew <https://brew.sh/>`_.
+
+.. code-block:: shell
+
+ git clone https://github.com/apache/arrow.git
+ cd arrow
+ brew update && brew bundle --file=c_glib/Brewfile
+
+Building
+========
+
+The build system uses ``CMAKE_BUILD_TYPE=release`` by default, so if this
+argument is omitted then a release build will be produced.
+
+Minimal release build:
+
+.. code-block:: shell
+
+ git clone https://github.com/apache/arrow.git
+ cd arrow/cpp
+ mkdir release
+ cd release
+ cmake -DARROW_BUILD_TESTS=ON ..
+ make unittest
+
+Minimal debug build:
+
+.. code-block:: shell
+
+ git clone https://github.com/apache/arrow.git
+ cd arrow/cpp
+ mkdir debug
+ cd debug
+ cmake -DCMAKE_BUILD_TYPE=Debug -DARROW_BUILD_TESTS=ON ..
+ make unittest
+
+If you do not need to build the test suite, you can omit the
+``ARROW_BUILD_TESTS`` option (the default is not to build the unit tests).
+
+On some Linux distributions, running the test suite might require setting an
+explicit locale. If you see any locale-related errors, try setting the
+environment variable (which requires the `locales` package or equivalent):
+
+.. code-block:: shell
+
+ export LC_ALL="en_US.UTF-8"
+
+Faster builds with Ninja
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+Many contributors use the `Ninja build system <https://ninja-build.org/>`_ to
+get faster builds. It especially speeds up incremental builds. To use
+``ninja``, pass ``-GNinja`` when calling ``cmake`` and then use the ``ninja``
+command instead of ``make``.
+
+Optional Components
+~~~~~~~~~~~~~~~~~~~
+
+By default, the C++ build system creates a fairly minimal build. We have
+several optional system components which you can opt into building by passing
+boolean flags to ``cmake``.
+
+* ``-DARROW_CUDA=ON``: CUDA integration for GPU development. Depends on NVIDIA
+ CUDA toolkit. The CUDA toolchain used to build the library can be customized
+ by using the ``$CUDA_HOME`` environment variable.
+* ``-DARROW_FLIGHT=ON``: Arrow Flight RPC system, which depends at least on
+ gRPC
+* ``-DARROW_GANDIVA=ON``: Gandiva expression compiler, depends on LLVM,
+ Protocol Buffers, and re2
+* ``-DARROW_HDFS=ON``: Arrow integration with libhdfs for accessing the Hadoop
+ Filesystem
+* ``-DARROW_HIVESERVER2=ON``: Client library for HiveServer2 database protocol
+* ``-DARROW_ORC=ON``: Arrow integration with Apache ORC
+* ``-DARROW_PARQUET=ON``: Apache Parquet libraries and Arrow integration
+* ``-DARROW_PLASMA=ON``: Plasma Shared Memory Object Store
+* ``-DARROW_PLASMA_JAVA_CLIENT=ON``: Build Java client for Plasma
+* ``-DARROW_PYTHON=ON``: Arrow Python C++ integration library (required for
+ building pyarrow). This library must be built against the same Python version
+ for which you are building pyarrow, e.g. Python 2.7 or Python 3.6. NumPy must
+ also be installed.
+
+Some features of the core Arrow shared library can be switched off for improved
+build times if they are not required for your application:
+
+* ``-DARROW_COMPUTE=ON``: build the in-memory analytics module
+* ``-DARROW_IPC=ON``: build the IPC extensions (requiring Flatbuffers)
+
+CMake version requirements
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+While we support CMake 3.2 and higher, some features require a newer version of
+CMake:
+
+* Building the benchmarks requires 3.6 or higher
+* Building zstd from source requires 3.7 or higher
+* Building Gandiva JNI bindings requires 3.11 or higher
+
+LLVM and Clang Tools
+~~~~~~~~~~~~~~~~~~~~
+
+We are currently using LLVM 7 for library builds and for other developer tools
+such as code formatting with ``clang-format``. LLVM can be installed via most
+modern package managers (apt, yum, conda, Homebrew, chocolatey).
+
+Build Dependency Management
+===========================
+
+The build system supports a number of third-party dependencies
+
+ * ``BOOST``: for cross-platform support
+ * ``BROTLI``: for data compression
+ * ``double-conversion``: for text-to-numeric conversions
+ * ``Snappy``: for data compression
+ * ``gflags``: for command line utilities (formerly Googleflags)
+ * ``glog``: for logging
+ * ``Thrift``: Apache Thrift, for data serialization
+ * ``Protobuf``: Google Protocol Buffers, for data serialization
+ * ``GTEST``: Googletest, for testing
+ * ``benchmark``: Google benchmark, for testing
+ * ``RapidJSON``: for data serialization
+ * ``Flatbuffers``: for data serialization
+ * ``ZLIB``: for data compression
+ * ``BZip2``: for data compression
+ * ``LZ4``: for data compression
+ * ``ZSTD``: for data compression
+ * ``RE2``: for regular expressions
+ * ``gRPC``: for remote procedure calls
+ * ``c-ares``: a dependency of gRPC
+ * ``LLVM``: a dependency of Gandiva
+
+The CMake option ``ARROW_DEPENDENCY_SOURCE`` is a global option that instructs
+the build system how to resolve each dependency. There are a few options:
+
+* ``AUTO``: try to find package in the system default locations and build from
+ source if not found
+* ``BUNDLED``: Building the dependency automatically from source
+* ``SYSTEM``: Finding the dependency in system paths using CMake's built-in
+ ``find_package`` function, or using ``pkg-config`` for packages that do not
+ have this feature
+* ``BREW``: Use Homebrew default paths as an alternative ``SYSTEM`` path
+* ``CONDA``: Use ``$CONDA_PREFIX`` as alternative ``SYSTEM`` PATH
+
+The default method is ``AUTO`` unless you are developing within an active conda
+environment (detected by presence of the ``$CONDA_PREFIX`` environment
+variable), in which case it is ``CONDA``.
+
+Individual Dependency Resolution
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+While ``-DARROW_DEPENDENCY_SOURCE=$SOURCE`` sets a global default for all
+packages, the resolution strategy can be overridden for individual packages by
+setting ``-D$PACKAGE_NAME_SOURCE=..``. For example, to build Protocol Buffers
+from source, set
+
+.. code-block:: shell
+
+ -DProtobuf_SOURCE=BUNDLED
+
+This variable is unfortunately case-sensitive; the name used for each package
+is listed above, but the most up-to-date listing can be found in
+`cpp/cmake_modules/ThirdpartyToolchain.cmake <https://github.com/apache/arrow/blob/master/cpp/cmake_modules/ThirdpartyToolchain.cmake>`_.
+
+Bundled Dependency Versions
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+When using the ``BUNDLED`` method to build a dependency from source, the
+version number from ``cpp/thirdparty/versions.txt`` is used. There is also a
+dependency source downloader script (see below), which can be used to set up
+offline builds.
+
+Boost-related Options
+~~~~~~~~~~~~~~~~~~~~~
+
+We depend on some Boost C++ libraries for cross-platform suport. In most cases,
+the Boost version available in your package manager may be new enough, and the
+build system will find it automatically. If you have Boost installed in a
+non-standard location, you can specify it by passing
+``-DBOOST_ROOT=$MY_BOOST_ROOT`` or setting the ``BOOST_ROOT`` environment
+variable.
+
+Unlike most of the other dependencies, if Boost is not found by the build
+system it will not be built automatically from source. To opt-in to a vendored
+Boost build, pass ``-DARROW_BOOST_VENDORED=ON``. This automatically sets the
+option ``-DARROW_BOOST_USE_SHARED=OFF`` to statically-link Boost into the
+produced libraries and executables.
+
+Offline Builds
+~~~~~~~~~~~~~~
+
+If you do not use the above variables to direct the Arrow build system to
+preinstalled dependencies, they will be built automatically by the Arrow build
+system. The source archive for each dependency will be downloaded via the
+internet, which can cause issues in environments with limited access to the
+internet.
+
+To enable offline builds, you can download the source artifacts yourself and
+use environment variables of the form ``ARROW_$LIBRARY_URL`` to direct the
+build system to read from a local file rather than accessing the internet.
+
+To make this easier for you, we have prepared a script
+``thirdparty/download_dependencies.sh`` which will download the correct version
+of each dependency to a directory of your choosing. It will print a list of
+bash-style environment variable statements at the end to use for your build
+script.
+
+.. code-block:: shell
+
+ # Download tarballs into $HOME/arrow-thirdparty
+ $ ./thirdparty/download_dependencies.sh $HOME/arrow-thirdparty
+
+You can then invoke CMake to create the build directory and it will use the
+declared environment variable pointing to downloaded archives instead of
+downloading them (one for each build dir!).
+
+General C++ Development
+=======================
+
+This section provides information for developers who wish to contribute to the
+C++ codebase.
+
+.. note::
+
+ Since most of the project's developers work on Linux or macOS, not all
+ features or developer tools are uniformly supported on Windows. If you are
+ on Windows, have a look at the later section on Windows development.
+
+Code Style, Linting, and CI
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+This project follows `Google's C++ Style Guide
+<https://google.github.io/styleguide/cppguide.html>`_ with minor exceptions:
+
+* We relax the line length restriction to 90 characters.
+* We use doxygen style comments ("///") in header files for comments that we
+ wish to show up in API documentation
+* We use the ``NULLPTR`` macro in header files (instead of ``nullptr``) defined
+ in ``src/arrow/util/macros.h`` to support building C++/CLI (ARROW-1134)
+
+Our continuous integration builds in Travis CI and Appveyor run the unit test
+suites on a variety of platforms and configuration, including using
+``valgrind`` to check for memory leaks or bad memory accesses. In addition, the
+codebase is subjected to a number of code style and code cleanliness checks.
+
+In order to have a passing CI build, your modified git branch must pass the
+following checks:
+
+* C++ builds without compiler warnings with ``-DBUILD_WARNING_LEVEL=CHECKIN``
+* C++ unit test suite with valgrind enabled, use ``-DARROW_TEST_MEMCHECK=ON``
+ when invoking CMake
+* Passes cpplint checks, checked with ``make lint``
+* Conforms to ``clang-format`` style, checked with ``make check-format``
+* Passes C++/CLI header file checks, invoked with
+ ``cpp/build-support/lint_cpp_cli.py cpp/src``
+* CMake files pass style checks, can be fixed by running
+ ``run-cmake-format.py`` from the root of the repository. This requires Python
+ 3 and `cmake_format <https://github.com/cheshirekow/cmake_format>`_ (note:
+ this currently does not work on Windows)
+
+In order to account for variations in the behavior of ``clang-format`` between
+major versions of LLVM, we pin the version of ``clang-format`` used (current
+LLVM 7).
+
+Depending on how you installed clang-format, the build system may not be able
+to find it. You can provide an explicit path to your LLVM installation (or the
+root path for the clang tools) with the environment variable
+`$CLANG_TOOLS_PATH` or by passing ``-DClangTools_PATH=$PATH_TO_CLANG_TOOLS`` when
+invoking CMake.
+
+To make linting more reproducible for everyone, we provide a ``docker-compose``
+target that is executable from the root of the repository:
+
+.. code-block:: shell
+
+ docker-compose run lint
+
+See :ref:`integration` for more information about the project's
+``docker-compose`` configuration.
+
+Modular Build Targets
+~~~~~~~~~~~~~~~~~~~~~
+
+Since there are several major parts of the C++ project, we have provided
+modular CMake targets for building each library component, group of unit tests
+and benchmarks, and their dependencies:
+
+* ``make arrow`` for Arrow core libraries
+* ``make parquet`` for Parquet libraries
+* ``make gandiva`` for Gandiva (LLVM expression compiler) libraries
+* ``make plasma`` for Plasma libraries, server
+
+To build the unit tests or benchmarks, add ``-tests`` or ``-benchmarks`` to the
+target name. So ``make arrow-tests`` will build the Arrow core unit
+tests. Using the ``-all`` target, e.g. ``parquet-all``, will build everything.
+
+If you wish to only build and install one or more project subcomponents, we
+have provided the CMake option ``ARROW_OPTIONAL_INSTALL`` to only install
+targets that have been built. For example, if you only wish to build the
+Parquet libraries, its tests, and its dependencies, you can run:
+
+.. code-block:: shell
+
+ cmake .. -DARROW_PARQUET=ON \
+ -DARROW_OPTIONAL_INSTALL=ON \
+ -DARROW_BUILD_TESTS=ON
+ make parquet
+ make install
+
+If you omit an explicit target when invoking ``make``, all targets will be
+built.
+
+Building API Documentation
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+While we publish the API documentation as part of the main Sphinx-based
+documentation site, you can also build the C++ API documentation anytime using
+Doxygen. Run the following command from the ``cpp/apidoc`` directory:
+
+.. code-block:: shell
+
+ doxygen Doxyfile
+
+This requires `Doxygen <https://www.doxygen.org>`_ to be installed.
+
+Benchmarking
+~~~~~~~~~~~~
+
+Follow the directions for simple build except run cmake with the
+``ARROW_BUILD_BENCHMARKS`` parameter set to ``ON``:
+
+.. code-block:: shell
+
+ cmake -DARROW_BUILD_TESTS=ON -DARROW_BUILD_BENCHMARKS=ON ..
+
+and instead of make unittest run either ``make; ctest`` to run both unit tests
+and benchmarks or ``make benchmark`` to run only the benchmarks. Benchmark logs
+will be placed in the build directory under ``build/benchmark-logs``.
+
+You can also invoke a single benchmark executable directly:
+
+.. code-block:: shell
+
+ ./release/arrow-builder-benchmark
+
+The build system uses ``CMAKE_BUILD_TYPE=release`` by default which enables
+compiler optimizations. It is also recommended to disable CPU throttling or
+such hardware features as "Turbo Boost" to obtain more consistent and
+comparable. benchmark results
+
+Testing with LLVM AddressSanitizer
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+To use AddressSanitizer (ASAN) to find bad memory accesses or leaks with LLVM,
+pass ``-DARROW_USE_ASAN=ON`` when building. You must use clang to compile with
+ASAN, and ``ARROW_USE_ASAN`` is mutually-exclusive with the valgrind option
+``ARROW_TEST_MEMCHECK``.
+
+Fuzz testing with libfuzzer
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Fuzzers can help finding unhandled exceptions and problems with untrusted input
+that may lead to crashes, security issues and undefined behavior. They do this
+by generating random input data and observing the behavior of the executed
+code. To build the fuzzer code, LLVM is required (GCC-based compilers won't
+work). You can build them using the following code:
+
+.. code-block:: shell
+
+ cmake -DARROW_FUZZING=ON -DARROW_USE_ASAN=ON ..
+
+``ARROW_FUZZING`` will enable building of fuzzer executables as well as enable the
+addition of coverage helpers via ``ARROW_USE_COVERAGE``, so that the fuzzer can observe
+the program execution.
+
+It is also wise to enable some sanitizers like ``ARROW_USE_ASAN`` (see above), which
+activates the address sanitizer. This way, we ensure that bad memory operations
+provoked by the fuzzer will be found early. You may also enable other sanitizers as
+well. Just keep in mind that some of them do not work together and some may result
+in very long execution times, which will slow down the fuzzing procedure.
+
+Now you can start one of the fuzzer, e.g.:
+
+.. code-block:: shell
+
+ ./debug/debug/ipc-fuzzing-test
+
+This will try to find a malformed input that crashes the payload and will show the
+stack trace as well as the input data. After a problem was found this way, it should
+be reported and fixed. Usually, the fuzzing process cannot be continued until the
+fix is applied, since the fuzzer usually converts to the problem again.
+
+If you build fuzzers with ASAN, you need to set the ``ASAN_SYMBOLIZER_PATH``
+environment variable to the absolute path of ``llvm-symbolizer``, which is a tool
+that ships with LLVM.
+
+.. code-block:: shell
+
+ export ASAN_SYMBOLIZER_PATH=$(type -p llvm-symbolizer)
+
+Note that some fuzzer builds currently reject paths with a version qualifier
+(like ``llvm-sanitizer-5.0``). To overcome this, set an appropriate symlink
+(here, when using LLVM 5.0):
+
+.. code-block:: shell
+
+ ln -sf /usr/bin/llvm-sanitizer-5.0 /usr/bin/llvm-sanitizer
+
+There are some problems that may occur during the compilation process:
+
+- libfuzzer was not distributed with your LLVM: ``ld: file not found: .../libLLVMFuzzer.a``
+- your LLVM is too old: ``clang: error: unsupported argument 'fuzzer' to option 'fsanitize='``
+
+Extra debugging help
+~~~~~~~~~~~~~~~~~~~~
+
+If you use the CMake option ``-DARROW_EXTRA_ERROR_CONTEXT=ON`` it will compile
+the libraries with extra debugging information on error checks inside the
+``RETURN_NOT_OK`` macro. In unit tests with ``ASSERT_OK``, this will yield error
+outputs like:
+
+.. code-block:: shell
+
+ ../src/arrow/ipc/ipc-read-write-test.cc:609: Failure
+ Failed
+ ../src/arrow/ipc/metadata-internal.cc:508 code: TypeToFlatbuffer(fbb, *field.type(), &children, &layout, &type_enum, dictionary_memo, &type_offset)
+ ../src/arrow/ipc/metadata-internal.cc:598 code: FieldToFlatbuffer(fbb, *schema.field(i), dictionary_memo, &offset)
+ ../src/arrow/ipc/metadata-internal.cc:651 code: SchemaToFlatbuffer(fbb, schema, dictionary_memo, &fb_schema)
+ ../src/arrow/ipc/writer.cc:697 code: WriteSchemaMessage(schema_, dictionary_memo_, &schema_fb)
+ ../src/arrow/ipc/writer.cc:730 code: WriteSchema()
+ ../src/arrow/ipc/writer.cc:755 code: schema_writer.Write(&dictionaries_)
+ ../src/arrow/ipc/writer.cc:778 code: CheckStarted()
+ ../src/arrow/ipc/ipc-read-write-test.cc:574 code: writer->WriteRecordBatch(batch)
+ NotImplemented: Unable to convert type: decimal(19, 4)
+
+Deprecations and API Changes
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+We use the compiler definition ``ARROW_NO_DEPRECATED_API`` to disable APIs that
+have been deprecated. It is a good practice to compile third party applications
+with this flag to proactively catch and account for API changes.
+
+Cleaning includes with include-what-you-use (IWYU)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+We occasionally use Google's `include-what-you-use
+<https://github.com/include-what-you-use/include-what-you-use>`_ tool, also
+known as IWYU, to remove unnecessary imports. Since setting up IWYU can be a
+bit tedious, we provide a ``docker-compose`` target for running it on the C++
+codebase:
+
+.. code-block:: shell
+
+ make -f Makefile.docker build-iwyu
+ docker-compose run lint
+
+Checking for ABI and API stability
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+To build ABI compliance reports, you need to install the two tools
+``abi-dumper`` and ``abi-compliance-checker``.
+
+Build Arrow C++ in Debug mode, alternatively you could use ``-Og`` which also
+builds with the necessary symbols but includes a bit of code optimization.
+Once the build has finished, you can generate ABI reports using:
+
+.. code-block:: shell
+
+ abi-dumper -lver 9 debug/libarrow.so -o ABI-9.dump
+
+The above version number is freely selectable. As we want to compare versions,
+you should now ``git checkout`` the version you want to compare it to and re-run
+the above command using a different version number. Once both reports are
+generated, you can build a comparision report using
+
+.. code-block:: shell
+
+ abi-compliance-checker -l libarrow -d1 ABI-PY-9.dump -d2 ABI-PY-10.dump
+
+The report is then generated in ``compat_reports/libarrow`` as a HTML.
+
+Developing on Windows
+=====================
+
+Like Linux and macOS, we have worked to enable builds to work "out of the box"
+with CMake for a reasonably large subset of the project.
+
+System Setup
+~~~~~~~~~~~~
+
+Microsoft provides the free Visual Studio Community edition. When doing
+development in the the shell, you must initialize the development
+environment.
+
+For Visual Studio 2015, execute the following batch script:
+
+.. code-block:: shell
+
+ "C:\Program Files (x86)\Microsoft Visual Studio 14.0\VC\vcvarsall.bat" amd64
+
+For Visual Studio 2017, the script is:
+
+.. code-block:: shell
+
+ "C:\Program Files (x86)\Microsoft Visual Studio\2017\Community\Common7\Tools\VsDevCmd.bat" -arch=amd64
+
+One can configure a console emulator like `cmder <https://cmder.net/>`_ to
+automatically launch this when starting a new development console.
+
+Using conda-forge for build dependencies
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+`Miniconda <https://conda.io/miniconda.html>`_ is a minimal Python distribution
+including the `conda <https://conda.io>`_ package manager. Some memers of the
+Apache Arrow community participate in the maintenance of `conda-forge
+<https://conda-forge.org/>`_, a community-maintained cross-platform package
+repository for conda.
+
+To use ``conda-forge`` for your C++ build dependencies on Windows, first
+download and install a 64-bit distribution from the `Miniconda homepage
+<https://conda.io/miniconda.html>`_
+
+To configure ``conda`` to use the ``conda-forge`` channel by default, launch a
+command prompt (``cmd.exe``) and run the command:
+
+.. code-block:: shell
+
+ conda config --add channels conda-forge
+
+Now, you can bootstrap a build environment (call from the root directory of the
+Arrow codebase):
+
+.. code-block:: shell
+
+ conda create -y -n arrow-dev --file=ci\conda_env_cpp.yml
+
+Then "activate" this conda environment with:
+
+.. code-block:: shell
+
+ activate arrow-dev
+
+If the environment has been activated, the Arrow build system will
+automatically see the ``%CONDA_PREFIX%`` environment variable and use that for
+resolving the build dependencies. This is equivalent to setting
+
+.. code-block:: shell
+
+ -DARROW_DEPENDENCY_SOURCE=SYSTEM ^
+ -DARROW_PACKAGE_PREFIX=%CONDA_PREFIX%\Library
+
+Note that these packages are only supported for release builds. If you intend
+to use ``-DCMAKE_BUILD_TYPE=debug`` then you must build the packages from
+source.
+
+.. note::
+
+ If you run into any problems using conda packages for dependencies, a very
+ common problem is mixing packages from the ``defaults`` channel with those
+ from ``conda-forge``. You can examine the installed packages in your
+ environment (and their origin) with ``conda list``
+
+Building using Visual Studio (MSVC) Solution Files
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Change working directory in ``cmd.exe`` to the root directory of Arrow and do
+an out of source build by generating a MSVC solution:
+
+.. code-block:: shell
+
+ cd cpp
+ mkdir build
+ cd build
+ cmake .. -G "Visual Studio 14 2015 Win64" ^
+ -DARROW_BUILD_TESTS=ON ^
+ -DGTest_SOURCE=BUNDLED
+ cmake --build . --config Release
+
+.. note::
+
+ Currently building the unit tests does not work properly with googletest
+ from conda-forge, so we must use the ``BUNDLED`` source for building that
+ dependency
+
+Building with Ninja and clcache
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The `Ninja <https://ninja-build.org/>`_ build system offsets better build
+parallelization, and the optional `clcache
+<https://github.com/frerich/clcache/>`_ compiler cache which keeps track of
+past compilations to avoid running them over and over again (in a way similar
+to the Unix-specific ``ccache``).
+
+Activate your conda build environment to first install those utilities:
+
+.. code-block:: shell
+
+ activate arrow-dev
+ conda install -c conda-forge ninja
+ pip install git+https://github.com/frerich/clcache.git
+
+Change working directory in ``cmd.exe`` to the root directory of Arrow and
+do an out of source build by generating Ninja files:
+
+.. code-block:: shell
+
+ cd cpp
+ mkdir build
+ cd build
+ cmake -G "Ninja" -DARROW_BUILD_TESTS=ON ^
+ -DGTest_SOURCE=BUNDLED ..
+ cmake --build . --config Release
+
+Building with NMake
+~~~~~~~~~~~~~~~~~~~
+
+Change working directory in ``cmd.exe`` to the root directory of Arrow and
+do an out of source build using `nmake`:
+
+.. code-block:: shell
+
+ cd cpp
+ mkdir build
+ cd build
+ cmake -G "NMake Makefiles" ..
+ cmake --build . --config Release
+ nmake
+
+Debug builds
+~~~~~~~~~~~~
+
+To build Debug version of Arrow you should have pre-installed a Debug version
+of Boost. It's recommended to configure cmake build with the following
+variables for Debug build:
+
+* ``-DARROW_BOOST_USE_SHARED=OFF``: enables static linking with boost debug
+ libs and simplifies run-time loading of 3rd parties
+* ``-DBOOST_ROOT``: sets the root directory of boost libs. (Optional)
+* ``-DBOOST_LIBRARYDIR``: sets the directory with boost lib files. (Optional)
+
+The command line to build Arrow in Debug will look something like this:
+
+.. code-block:: shell
+
+ cd cpp
+ mkdir build
+ cd build
+ cmake .. -G "Visual Studio 14 2015 Win64" ^
+ -DARROW_BOOST_USE_SHARED=OFF ^
+ -DCMAKE_BUILD_TYPE=Debug ^
+ -DBOOST_ROOT=C:/local/boost_1_63_0 ^
+ -DBOOST_LIBRARYDIR=C:/local/boost_1_63_0/lib64-msvc-14.0
+ cmake --build . --config Debug
+
+Windows dependency resolution issues
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Because Windows uses `.lib` files for both static and dynamic linking of
+dependencies, the static library sometimes may be named something different
+like ``%PACKAGE%_static.lib`` to distinguish itself. If you are statically
+linking some dependencies, we provide some options
+
+* ``-DBROTLI_MSVC_STATIC_LIB_SUFFIX=%BROTLI_SUFFIX%``
+* ``-DSNAPPY_MSVC_STATIC_LIB_SUFFIX=%SNAPPY_SUFFIX%``
+* ``-LZ4_MSVC_STATIC_LIB_SUFFIX=%LZ4_SUFFIX%``
+* ``-ZSTD_MSVC_STATIC_LIB_SUFFIX=%ZSTD_SUFFIX%``
+
+To get the latest build instructions, you can reference `ci/appveyor-built.bat
+<https://github.com/apache/arrow/blob/master/ci/appveyor-cpp-build.bat>`_,
+which is used by automated Appveyor builds.
+
+Statically linking to Arrow on Windows
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The Arrow headers on Windows static library builds (enabled by the CMake
+option ``ARROW_BUILD_STATIC``) use the preprocessor macro ``ARROW_STATIC`` to
+suppress dllimport/dllexport marking of symbols. Projects that statically link
+against Arrow on Windows additionally need this definition. The Unix builds do
+not use the macro.
+
+Replicating Appveyor Builds
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+For people more familiar with linux development but need to replicate a failing
+appveyor build, here are some rough notes from replicating the
+``Static_Crt_Build`` (make unittest will probably still fail but many unit
+tests can be made with there individual make targets).
+
+1. Microsoft offers trial VMs for `Windows with Microsoft Visual Studio
+ <https://developer.microsoft.com/en-us/windows/downloads/virtual-machines>`_.
+ Download and install a version.
+2. Run the VM and install CMake and Miniconda or Anaconda (these instructions
+ assume Anaconda).
+3. Download `pre-built Boost debug binaries
+ <https://sourceforge.net/projects/boost/files/boost-binaries/>`_ and install
+ it (run from command prompt opened by "Developer Command Prompt for MSVC
+ 2017"):
+
+.. code-block:: shell
+
+ cd $EXTRACT_BOOST_DIRECTORY
+ .\bootstrap.bat
+ @rem This is for static libraries needed for static_crt_build in appvyor
+ .\b2 link=static -with-filesystem -with-regex -with-system install
+ @rem this should put libraries and headers in c:\Boost
+
+4. Activate ananaconda/miniconda:
+
+.. code-block:: shell
+
+ @rem this might differ for miniconda
+ C:\Users\User\Anaconda3\Scripts\activate
+
+5. Clone and change directories to the arrow source code (you might need to
+ install git).
+6. Setup environment variables:
+
+.. code-block:: shell
+
+ @rem Change the build type based on which appveyor job you want.
+ SET JOB=Static_Crt_Build
+ SET GENERATOR=Ninja
+ SET APPVEYOR_BUILD_WORKER_IMAGE=Visual Studio 2017
+ SET USE_CLCACHE=false
+ SET ARROW_BUILD_GANDIVA=OFF
+ SET ARROW_LLVM_VERSION=7.0.*
+ SET PYTHON=3.6
+ SET ARCH=64
+ SET PATH=C:\Users\User\Anaconda3;C:\Users\User\Anaconda3\Scripts;C:\Users\User\Anaconda3\Library\bin;%PATH%
+ SET BOOST_LIBRARYDIR=C:\Boost\lib
+ SET BOOST_ROOT=C:\Boost
+
+7. Run appveyor scripts:
+
+.. code-block:: shell
+
+ .\ci\appveyor-install.bat
+ @rem this might fail but at this point most unit tests should be buildable by there individual targets
+ @rem see next line for example.
+ .\ci\appveyor-build.bat
+ cmake --build . --config Release --target arrow-compute-hash-test
+
+Apache Parquet Development
+==========================
+
+To build the C++ libraries for Apache Parquet, add the flag
+``-DARROW_PARQUET=ON`` when invoking CMake. The Parquet libraries and unit tests
+can be built with the ``parquet`` make target:
+
+.. code-block:: shell
+
+ make parquet
+
+Running ``ctest -L unittest`` will run all built C++ unit tests, while ``ctest -L
+parquet`` will run only the Parquet unit tests. The unit tests depend on an
+environment variable ``PARQUET_TEST_DATA`` that depends on a git submodule to the
+repository https://github.com/apache/parquet-testing:
+
+.. code-block:: shell
+
+ git submodule update --init
+ export PARQUET_TEST_DATA=$ARROW_ROOT/cpp/submodules/parquet-testing/data
+
+Here ``$ARROW_ROOT`` is the absolute path to the Arrow codebase.
+
+Arrow Flight RPC
+================
+
+In addition to the Arrow dependencies, Flight requires:
+
+* gRPC (>= 1.14, roughly)
+* Protobuf (>= 3.6, earlier versions may work)
+* c-ares (used by gRPC)
+
+By default, Arrow will try to download and build these dependencies
+when building Flight.
+
+The optional ``flight`` libraries and tests can be built by passing
+``-DARROW_FLIGHT=ON``.
+
+.. code-block:: shell
+
+ cmake .. -DARROW_FLIGHT=ON -DARROW_BUILD_TESTS=ON
+ make
+
+You can also use existing installations of the extra dependencies.
+When building, set the environment variables ``gRPC_ROOT`` and/or
+``Protobuf_ROOT`` and/or ``c-ares_ROOT``.
+
+We are developing against recent versions of gRPC, and the versions. The
+``grpc-cpp`` package available from https://conda-forge.org/ is one reliable
+way to obtain gRPC in a cross-platform way. You may try using system libraries
+for gRPC and Protobuf, but these are likely to be too old. On macOS, you can
+try `Homebrew <https://brew.sh/>`_:
+
+.. code-block:: shell
+
+ brew install grpc
+
+Development Conventions
+=======================
+
+This section provides some information about some of the abstractions and
+development approaches we use to solve problems common to many parts of the C++
+project.
+
+Memory Pools
+~~~~~~~~~~~~
+
+We provide a default memory pool with ``arrow::default_memory_pool()``. As a
+matter of convenience, some of the array builder classes have constructors
+which use the default pool without explicitly passing it. You can disable these
+constructors in your application (so that you are accounting properly for all
+memory allocations) by defining ``ARROW_NO_DEFAULT_MEMORY_POOL``.
+
+Header files
+~~~~~~~~~~~~
+
+We use the ``.h`` extension for C++ header files. Any header file name not
+containing ``internal`` is considered to be a public header, and will be
+automatically installed by the build.
+
+Error Handling and Exceptions
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+For error handling, we use ``arrow::Status`` values instead of throwing C++
+exceptions. Since the Arrow C++ libraries are intended to be useful as a
+component in larger C++ projects, using ``Status`` objects can help with good
+code hygiene by making explicit when a function is expected to be able to fail.
+
+For expressing invariants and "cannot fail" errors, we use DCHECK macros
+defined in ``arrow/util/logging.h``. These checks are disabled in release builds
+and are intended to catch internal development errors, particularly when
+refactoring. These macros are not to be included in any public header files.
+
+Since we do not use exceptions, we avoid doing expensive work in object
+constructors. Objects that are expensive to construct may often have private
+constructors, with public static factory methods that return ``Status``.
+
+There are a number of object constructors, like ``arrow::Schema`` and
+``arrow::RecordBatch`` where larger STL container objects like ``std::vector`` may
+be created. While it is possible for ``std::bad_alloc`` to be thrown in these
+constructors, the circumstances where they would are somewhat esoteric, and it
+is likely that an application would have encountered other more serious
+problems prior to having ``std::bad_alloc`` thrown in a constructor.
diff --git a/docs/_sources/developers/documentation.rst.txt b/docs/_sources/developers/documentation.rst.txt
new file mode 100644
index 0000000..452305b
--- /dev/null
+++ b/docs/_sources/developers/documentation.rst.txt
@@ -0,0 +1,95 @@
+.. Licensed to the Apache Software Foundation (ASF) under one
+.. or more contributor license agreements. See the NOTICE file
+.. distributed with this work for additional information
+.. regarding copyright ownership. The ASF licenses this file
+.. to you under the Apache License, Version 2.0 (the
+.. "License"); you may not use this file except in compliance
+.. with the License. You may obtain a copy of the License at
+
+.. http://www.apache.org/licenses/LICENSE-2.0
+
+.. Unless required by applicable law or agreed to in writing,
+.. software distributed under the License is distributed on an
+.. "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+.. KIND, either express or implied. See the License for the
+.. specific language governing permissions and limitations
+.. under the License.
+
+.. _building-docs:
+
+Building the Documentation
+==========================
+
+Prerequisites
+-------------
+
+The documentation build process uses `Doxygen <http://www.doxygen.nl/>`_ and
+`Sphinx <http://www.sphinx-doc.org/>`_ along with a few extensions.
+
+If you're using Conda, the required software can be installed in a single line:
+
+.. code-block:: shell
+
+ conda install -c conda-forge --file=ci/conda_env_sphinx.yml
+
+Otherwise, you'll first need to install `Doxygen <http://www.doxygen.nl/>`_
+yourself (for example from your distribution's official repositories, if
+using Linux). Then you can install the Python-based requirements with the
+following command:
+
+.. code-block:: shell
+
+ pip install -r docs/requirements.txt
+
+Building
+--------
+
+.. note::
+
+ If you are building the documentation on Windows, not all sections
+ may build properly.
+
+These two steps are mandatory and must be executed in order.
+
+#. Process the C++ API using Doxygen
+
+ .. code-block:: shell
+
+ pushd cpp/apidoc
+ doxygen
+ popd
+
+#. Build the complete documentation using Sphinx.
+
+ .. note::
+
+ This step requires the the pyarrow library is installed
+ in your python environment. One way to accomplish
+ this is to follow the build instructions at :ref:`python-development`
+ and then run `python setup.py install` in arrow/python
+ (it is best to do this in a dedicated conda/virtual environment).
+
+ .. code-block:: shell
+
+ pushd docs
+ make html
+ popd
+
+After these steps are completed, the documentation is rendered in HTML
+format in ``docs/_build/html``. In particular, you can point your browser
+at ``docs/_build/html/index.html`` to read the docs and review any changes
+you made.
+
+
+.. _building-docker:
+
+Building with Docker
+--------------------
+
+You can use Docker to build the documentation:
+
+.. code-block:: shell
+
+ make -f Makefile.docker docs
+
+The final output is located under ``docs/_build/html``.
diff --git a/docs/_sources/cpp/api.rst.txt b/docs/_sources/developers/index.rst.txt
similarity index 84%
copy from docs/_sources/cpp/api.rst.txt
copy to docs/_sources/developers/index.rst.txt
index f6c0418..a58f969 100644
--- a/docs/_sources/cpp/api.rst.txt
+++ b/docs/_sources/developers/index.rst.txt
@@ -15,16 +15,11 @@
.. specific language governing permissions and limitations
.. under the License.
-*************
-API Reference
-*************
-
.. toctree::
- :maxdepth: 3
+ :maxdepth: 2
- api/support
- api/memory
- api/datatype
- api/array
- api/builder
- api/table
+ contributing
+ cpp
+ python
+ integration
+ documentation
diff --git a/docs/_sources/developers/integration.rst.txt b/docs/_sources/developers/integration.rst.txt
new file mode 100644
index 0000000..df56231
--- /dev/null
+++ b/docs/_sources/developers/integration.rst.txt
@@ -0,0 +1,69 @@
+.. Licensed to the Apache Software Foundation (ASF) under one
+.. or more contributor license agreements. See the NOTICE file
+.. distributed with this work for additional information
+.. regarding copyright ownership. The ASF licenses this file
+.. to you under the Apache License, Version 2.0 (the
+.. "License"); you may not use this file except in compliance
+.. with the License. You may obtain a copy of the License at
+
+.. http://www.apache.org/licenses/LICENSE-2.0
+
+.. Unless required by applicable law or agreed to in writing,
+.. software distributed under the License is distributed on an
+.. "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+.. KIND, either express or implied. See the License for the
+.. specific language governing permissions and limitations
+.. under the License.
+
+.. _integration:
+
+Integration Testing
+===================
+
+Prerequisites
+-------------
+
+Arrow uses `Docker <https://docs.docker.com/>`_ and
+`docker-compose <https://docs.docker.com/compose/>`_ for integration testing.
+You can follow the installation `instructions <https://docs.docker.com/compose/install/>`_.
+
+Docker images (services)
+------------------------
+
+The docker-compose services are defined in the ``docker-compose.yml`` file.
+Each service usually correspond to a language binding or an important service to
+test with Arrow.
+
+Services are configured with 2 local mounts, ``/arrow`` for the top-level source
+directory and ``/build`` for caching build artifacts. The source level
+directory mount can be paired with git checkout to test a specific commit. The
+build mount is used for caching and sharing state between staged images.
+
+- *c_glib*: Builds the GLib bindings
+- *cpp*: Builds the C++ project
+- *go*: Builds the go project
+- *java*: Builds the Java project
+- *js*: Builds the Javascript project
+- *python*: Builds the python bindings
+- *r*: Builds the R bindings
+- *rust*: Builds the rust project
+- *lint*: Run various lint on the C++ sources
+- *iwyu*: Run include-what-you-use on the C++ sources
+- *clang-format*: Run clang-format on the C++ sources
+- *docs*: Builds this documentation
+
+You can build and run a service by using the `build` and `run` docker-compose
+sub-command, e.g. `docker-compose build python && docker-compose run python`.
+We do not publish the build images, you need to build them manually. This
+method requires the user to build the images in reverse dependency order. To
+simplify this, we provide a Makefile.
+
+.. code-block:: shell
+
+ # Build and run manually
+ docker-compose build cpp
+ docker-compose build python
+ docker-compose run python
+
+ # Using the makefile with proper image dependency resolution
+ make -f Makefile.docker python
diff --git a/docs/_sources/python/development.rst.txt b/docs/_sources/developers/python.rst.txt
similarity index 57%
copy from docs/_sources/python/development.rst.txt
copy to docs/_sources/developers/python.rst.txt
index d855371..0ebe8f1 100644
--- a/docs/_sources/python/development.rst.txt
+++ b/docs/_sources/developers/python.rst.txt
@@ -16,13 +16,83 @@
.. under the License.
.. currentmodule:: pyarrow
-.. _development:
+.. _python-development:
-***********
-Development
-***********
+******************
+Python Development
+******************
-Developing on Linux and MacOS
+This page provides general Python development guidelines and source build
+instructions for all platforms.
+
+Coding Style
+============
+
+We follow a similar PEP8-like coding style to the `pandas project
+<https://github.com/pandas-dev/pandas>`_.
+
+The code must pass ``flake8`` (available from pip or conda) or it will fail the
+build. Check for style errors before submitting your pull request with:
+
+.. code-block:: shell
+
+ flake8 .
+ flake8 --config=.flake8.cython .
+
+Unit Testing
+============
+
+We are using `pytest <https://docs.pytest.org/en/latest/>`_ to develop our unit
+test suite. After building the project (see below) you can run its unit tests
+like so:
+
+.. code-block:: shell
+
+ pytest pyarrow
+
+Package requirements to run the unit tests are found in
+``requirements-test.txt`` and can be installed if needed with ``pip -r
+requirements-test.txt``.
+
+The project has a number of custom command line options for its test
+suite. Some tests are disabled by default, for example. To see all the options,
+run
+
+.. code-block:: shell
+
+ pytest pyarrow --help
+
+and look for the "custom options" section.
+
+Test Groups
+-----------
+
+We have many tests that are grouped together using pytest marks. Some of these
+are disabled by default. To enable a test group, pass ``--$GROUP_NAME``,
+e.g. ``--parquet``. To disable a test group, prepend ``disable``, so
+``--disable-parquet`` for example. To run **only** the unit tests for a
+particular group, prepend ``only-`` instead, for example ``--only-parquet``.
+
+The test groups currently include:
+
+* ``gandiva``: tests for Gandiva expression compiler (uses LLVM)
+* ``hdfs``: tests that use libhdfs or libhdfs3 to access the Hadoop filesystem
+* ``hypothesis``: tests that use the ``hypothesis`` module for generating
+ random test cases. Note that ``--hypothesis`` doesn't work due to a quirk
+ with pytest, so you have to pass ``--enable-hypothesis``
+* ``large_memory``: Test requiring a large amount of system RAM
+* ``orc``: Apache ORC tests
+* ``parquet``: Apache Parquet tests
+* ``plasma``: Plasma Object Store tests
+* ``s3``: Tests for Amazon S3
+* ``tensorflow``: Tests that involve TensorFlow
+
+Benchmarking
+------------
+
+For running the benchmarks, see :ref:`python-benchmarks`.
+
+Building on Linux and MacOS
=============================
System Requirements
@@ -31,25 +101,20 @@ System Requirements
On macOS, any modern XCode (6.4 or higher; the current version is 8.3.1) is
sufficient.
-On Linux, for this guide, we recommend using gcc 4.8 or 4.9, or clang 3.7 or
+On Linux, for this guide, we require a minimum of gcc 4.8, or clang 3.7 or
higher. You can check your version by running
.. code-block:: shell
$ gcc --version
-On Ubuntu 16.04 and higher, you can obtain gcc 4.9 with:
+If the system compiler is older than gcc 4.8, it can be set to a newer version
+using the ``$CC`` and ``$CXX`` environment variables:
.. code-block:: shell
- $ sudo apt-get install g++-4.9
-
-Finally, set gcc 4.9 as the active compiler using:
-
-.. code-block:: shell
-
- export CC=gcc-4.9
- export CXX=g++-4.9
+ export CC=gcc-4.8
+ export CXX=g++-4.8
Environment Setup and Build
---------------------------
@@ -74,7 +139,7 @@ Using Conda
~~~~~~~~~~~
Let's create a conda environment with all the C++ build and Python dependencies
-from conda-forge:
+from conda-forge, targeting development for Python 3.7:
On Linux and OSX:
@@ -84,22 +149,23 @@ On Linux and OSX:
--file arrow/ci/conda_env_unix.yml \
--file arrow/ci/conda_env_cpp.yml \
--file arrow/ci/conda_env_python.yml \
- python=3.6
+ compilers \
+ python=3.7
+
+As of January 2019, the `compilers` package is needed on many Linux distributions to use packages from conda-forge.
+
+With this out of the way, you can now activate the conda environment
conda activate pyarrow-dev
-For Windows, see the `Developing on Windows`_ section below.
+For Windows, see the `Building on Windows`_ section below.
We need to set some environment variables to let Arrow's build system know
about our build toolchain:
.. code-block:: shell
- export ARROW_BUILD_TYPE=release
- export ARROW_BUILD_TOOLCHAIN=$CONDA_PREFIX
export ARROW_HOME=$CONDA_PREFIX
- export PARQUET_HOME=$CONDA_PREFIX
- export BOOST_HOME=$CONDA_PREFIX
Using pip
~~~~~~~~~
@@ -161,10 +227,7 @@ about our build toolchain:
.. code-block:: shell
- export ARROW_BUILD_TYPE=release
-
export ARROW_HOME=$(pwd)/dist
- export PARQUET_HOME=$(pwd)/dist
export LD_LIBRARY_PATH=$(pwd)/dist/lib:$LD_LIBRARY_PATH
Build and test
@@ -177,26 +240,34 @@ Now build and install the Arrow C++ libraries:
mkdir arrow/cpp/build
pushd arrow/cpp/build
- cmake -DCMAKE_BUILD_TYPE=$ARROW_BUILD_TYPE \
- -DCMAKE_INSTALL_PREFIX=$ARROW_HOME \
+ cmake -DCMAKE_INSTALL_PREFIX=$ARROW_HOME \
-DCMAKE_INSTALL_LIBDIR=lib \
- -DARROW_PARQUET=on \
- -DARROW_PYTHON=on \
- -DARROW_PLASMA=on \
- -DARROW_BUILD_TESTS=OFF \
+ -DARROW_FLIGHT=ON \
+ -DARROW_GANDIVA=ON \
+ -DARROW_ORC=ON \
+ -DARROW_PARQUET=ON \
+ -DARROW_PYTHON=ON \
+ -DARROW_PLASMA=ON \
+ -DARROW_BUILD_TESTS=ON \
..
make -j4
make install
popd
-If you don't want to build and install the Plasma in-memory object store,
-you can omit the ``-DARROW_PLASMA=on`` flag.
-Also, if multiple versions of Python are installed in your environment,
-you may have to pass additional parameters to cmake so that
-it can find the right executable, headers and libraries.
-For example, specifying `-DPYTHON_EXECUTABLE=$VIRTUAL_ENV/bin/python`
-(assuming that you're in virtualenv) enables cmake to choose
-the python executable which you are using.
+Many of these components are optional, and can be switched off by setting them
+to ``OFF``:
+
+* ``ARROW_FLIGHT``: RPC framework
+* ``ARROW_GANDIVA``: LLVM-based expression compiler
+* ``ARROW_ORC``: Support for Apache ORC file format
+* ``ARROW_PARQUET``: Support for Apache Parquet file format
+* ``ARROW_PLASMA``: Shared memory object store
+
+If multiple versions of Python are installed in your environment, you may have
+to pass additional parameters to cmake so that it can find the right
+executable, headers and libraries. For example, specifying
+`-DPYTHON_EXECUTABLE=$VIRTUAL_ENV/bin/python` (assuming that you're in
+virtualenv) enables cmake to choose the python executable which you are using.
.. note::
@@ -210,11 +281,15 @@ Now, build pyarrow:
.. code-block:: shell
pushd arrow/python
- python setup.py build_ext --build-type=$ARROW_BUILD_TYPE \
- --with-parquet --with-plasma --inplace
+ export PYARROW_WITH_FLIGHT=1
+ export PYARROW_WITH_GANDIVA=1
+ export PYARROW_WITH_ORC=1
+ export PYARROW_WITH_PARQUET=1
+ python setup.py build_ext --build-type=$ARROW_BUILD_TYPE --inplace
popd
-If you did not build with plasma, you can omit ``--with-plasma``.
+If you did not build one of the optional components, set the corresponding
+``PYARROW_WITH_$COMPONENT`` environment variable to 0.
You should be able to run the unit tests with:
@@ -242,56 +317,25 @@ libraries), one can set ``--bundle-arrow-cpp``:
pip install wheel # if not installed
python setup.py build_ext --build-type=$ARROW_BUILD_TYPE \
- --with-parquet --with-plasma --bundle-arrow-cpp bdist_wheel
-
-Again, if you did not build with plasma, you should omit ``--with-plasma``.
+ --bundle-arrow-cpp bdist_wheel
-Building with optional ORC integration
---------------------------------------
+Building with CUDA support
+~~~~~~~~~~~~~~~~~~~~~~~~~~
-To build Arrow with support for the `Apache ORC file format <https://orc.apache.org/>`_,
-we recommend the following:
-
-#. Install the ORC C++ libraries and tools using ``conda``:
-
- .. code-block:: shell
-
- conda install -c conda-forge orc
-
-#. Set ``ORC_HOME`` and ``PROTOBUF_HOME`` to the location of the installed
- Orc and protobuf C++ libraries, respectively (otherwise Arrow will try
- to download source versions of those libraries and recompile them):
-
- .. code-block:: shell
-
- export ORC_HOME=$CONDA_PREFIX
- export PROTOBUF_HOME=$CONDA_PREFIX
-
-#. Add ``-DARROW_ORC=on`` to the CMake flags.
-#. Add ``--with-orc`` to the ``setup.py`` flags.
-
-Known issues
-------------
-
-If using packages provided by conda-forge (see "Using Conda" above)
-together with a reasonably recent compiler, you may get "undefined symbol"
-errors when importing pyarrow. In that case you'll need to force the C++
-ABI version to the older version used by conda-forge binaries:
+The :mod:`pyarrow.cuda` module offers support for using Arrow platform
+components with Nvidia's CUDA-enabled GPU devices. To build with this support,
+pass ``-DARROW_CUDA=ON`` when building the C++ libraries, and set the following
+environment variable when building pyarrow:
.. code-block:: shell
- export CXXFLAGS="-D_GLIBCXX_USE_CXX11_ABI=0"
- export PYARROW_CXXFLAGS=$CXXFLAGS
-
-Be sure to add ``-DCMAKE_CXX_FLAGS=$CXXFLAGS`` to the cmake invocations
-when rebuilding.
+ export PYARROW_WITH_CUDA=1
-Developing on Windows
-=====================
+Building on Windows
+===================
-First, we bootstrap a conda environment similar to the `C++ build instructions
-<https://github.com/apache/arrow/blob/master/cpp/apidoc/Windows.md>`_. This
-includes all the dependencies for Arrow and the Apache Parquet C++ libraries.
+First, we bootstrap a conda environment similar to above, but skipping some of
+the Linux/macOS-only packages:
First, starting from fresh clones of Apache Arrow:
@@ -313,13 +357,11 @@ Now, we build and install Arrow C++ libraries
mkdir cpp\build
cd cpp\build
- set ARROW_BUILD_TOOLCHAIN=%CONDA_PREFIX%\Library
set ARROW_HOME=C:\thirdparty
cmake -G "Visual Studio 14 2015 Win64" ^
-DCMAKE_INSTALL_PREFIX=%ARROW_HOME% ^
- -DCMAKE_BUILD_TYPE=Release ^
- -DARROW_BUILD_TESTS=on ^
-DARROW_CXXFLAGS="/WX /MP" ^
+ -DARROW_GANDIVA=on ^
-DARROW_PARQUET=on ^
-DARROW_PYTHON=on ..
cmake --build . --target INSTALL --config Release
@@ -336,7 +378,9 @@ Now, we can build pyarrow:
.. code-block:: shell
cd python
- python setup.py build_ext --inplace --with-parquet
+ set PYARROW_WITH_GANDIVA=1
+ set PYARROW_WITH_PARQUET=1
+ python setup.py build_ext --inplace
Then run the unit tests with:
@@ -356,7 +400,10 @@ Getting ``python-test.exe`` to run is a bit tricky because your
Now ``python-test.exe`` or simply ``ctest`` (to run all tests) should work.
-Building the Documentation
-==========================
+Windows Caveats
+---------------
+
+Some components are not supported yet on Windows:
-See :ref:`building-docs` for instructions to build the HTML documentation.
+* Flight RPC
+* Plasma
diff --git a/docs/_sources/format/Layout.rst.txt b/docs/_sources/format/Layout.rst.txt
index f3e5290..99a798a 100644
--- a/docs/_sources/format/Layout.rst.txt
+++ b/docs/_sources/format/Layout.rst.txt
@@ -64,9 +64,11 @@ Base requirements
data
* It is required to have all the contiguous memory buffers in an IPC payload
aligned at 8-byte boundaries. In other words, each buffer must start at
- an aligned 8-byte offset.
-* The general recommendation is to align the buffers at 64-byte boundary, but
- this is not absolutely necessary.
+ an aligned 8-byte offset. Additionally, each buffer should be padded to a multiple
+ of 8 bytes.
+* For performance reasons it **preferred/recommended** to align buffers to a
+ 64-byte boundary and pad to a multiple of 64 bytes, but this is not absolutely
+ necessary. The rationale is discussed in more details below.
* Any relative type can have null slots
* Arrays are immutable once created. Implementations can provide APIs to mutate
an array, but applying mutations will require a new array data structure to
@@ -122,14 +124,16 @@ practices for optimized memory access:
* Elements in numeric arrays will be guaranteed to be retrieved via aligned access.
* On some architectures alignment can help limit partially used cache lines.
-* 64 byte alignment is recommended by the `Intel performance guide`_ for
- data-structures over 64 bytes (which will be a common case for Arrow Arrays).
-Recommending padding to a multiple of 64 bytes allows for using `SIMD`_ instructions
+The recommendation for 64 byte alignment comes from the `Intel performance guide`_
+that recommends alignment of memory to match SIMD register width.
+The specific padding length was chosen because it matches the largest known
+SIMD instruction registers available as of April 2016 (Intel AVX-512).
+
+The recommended padding of 64 bytes allows for using `SIMD`_ instructions
consistently in loops without additional conditional checks.
This should allow for simpler, efficient and CPU cache-friendly code.
-The specific padding length was chosen because it matches the largest known
-SIMD instruction registers available as of April 2016 (Intel AVX-512). In other
+In other
words, we can load the entire 64-byte buffer into a 512-bit wide SIMD register
and get data-level parallelism on all the columnar values packed into the 64-byte
buffer. Guaranteed padding can also allow certain compilers
@@ -162,9 +166,8 @@ Null bitmaps
Any relative type can have null value slots, whether primitive or nested type.
An array with nulls must have a contiguous memory buffer, known as the null (or
-validity) bitmap, whose length is a multiple of 64 bytes (as discussed above)
-and large enough to have at least 1 bit for each array
-slot.
+validity) bitmap, whose length is a multiple of 8 bytes (64 bytes recommended)
+and large enough to have at least 1 bit for each array slot.
Whether any array slot is valid (non-null) is encoded in the respective bits of
this bitmap. A 1 (set bit) for index ``j`` indicates that the value is not null,
@@ -321,7 +324,7 @@ Example Layout: ``List<List<byte>>``
``[[[1, 2], [3, 4]], [[5, 6, 7], null, [8]], [[9, 10]]]``
-will be be represented as follows: ::
+will be represented as follows: ::
* Length 3
* Nulls count: 0
@@ -354,6 +357,8 @@ will be be represented as follows: ::
|-------------------------------|-------------|
| 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 | unspecified |
+Note that while the inner offsets buffer encodes the start position in the inner values array, the outer offsets buffer encodes the start position of corresponding outer element in the inner offsets buffer.
+
Struct type
-----------
diff --git a/docs/_sources/format/README.rst.txt b/docs/_sources/format/README.rst.txt
index f2f770b..4044026 100644
--- a/docs/_sources/format/README.rst.txt
+++ b/docs/_sources/format/README.rst.txt
@@ -25,7 +25,7 @@ Currently, the Arrow specification consists of these pieces:
- Logical Types, Schemas, and Record Batch Metadata (see Schema.fbs)
- Encapsulated Messages (see Message.fbs)
- Mechanics of messaging between Arrow systems (IPC, RPC, etc.) (see :doc:`IPC`)
-- Tensor (Multi-dimensional array) Metadata (see Tensor.fbs)
+- Tensor (Multi-dimensional array) Metadata (see Tensor.fbs and SparseTensor.fbs)
The metadata currently uses Google's `flatbuffers library`_ for serializing a
couple related pieces of information:
diff --git a/docs/_sources/index.rst.txt b/docs/_sources/index.rst.txt
index 2b367b3..3a5728a 100644
--- a/docs/_sources/index.rst.txt
+++ b/docs/_sources/index.rst.txt
@@ -18,15 +18,25 @@
Apache Arrow
============
-Apache Arrow is a cross-language development platform for in-memory data. It
-specifies a standardized language-independent columnar memory format for flat
-and hierarchical data, organized for efficient analytic operations on modern
-hardware. It also provides computational libraries and zero-copy streaming
-messaging and interprocess communication.
+Apache Arrow is a development platform for in-memory analytics. It contains a
+set of technologies that enable big data systems to process and move data
+fast. It specifies a standardized language-independent columnar memory format
+for flat and hierarchical data, organized for efficient analytic operations on
+modern hardware.
+
+The project is developing a multi-language collection of libraries for solving
+systems problems related to in-memory analytical data processing. This includes
+such topics as:
+
+* Zero-copy shared memory and RPC-based data movement
+* Reading and writing file formats (like CSV, Apache ORC, and Apache Parquet)
+* In-memory analytics and query processing
+
+.. _toc.columnar:
.. toctree::
:maxdepth: 1
- :caption: Memory Format
+ :caption: Arrow Columnar Format
format/README
format/Guidelines
@@ -34,15 +44,19 @@ messaging and interprocess communication.
format/Metadata
format/IPC
+.. _toc.usage:
+
.. toctree::
:maxdepth: 2
- :caption: Languages
+ :caption: Arrow Libraries
cpp/index
python/index
+.. _toc.development:
+
.. toctree::
:maxdepth: 2
- :caption: Other Topics
+ :caption: Development and Contributing
- building
+ developers/index
diff --git a/docs/_sources/python/benchmarks.rst.txt b/docs/_sources/python/benchmarks.rst.txt
index 12205c5..5ecff1a 100644
--- a/docs/_sources/python/benchmarks.rst.txt
+++ b/docs/_sources/python/benchmarks.rst.txt
@@ -15,6 +15,8 @@
.. specific language governing permissions and limitations
.. under the License.
+.. _python-benchmarks:
+
Benchmarks
==========
diff --git a/docs/_sources/python/development.rst.txt b/docs/_sources/python/development.rst.txt
index d855371..c0f7b38 100644
--- a/docs/_sources/python/development.rst.txt
+++ b/docs/_sources/python/development.rst.txt
@@ -31,25 +31,20 @@ System Requirements
On macOS, any modern XCode (6.4 or higher; the current version is 8.3.1) is
sufficient.
-On Linux, for this guide, we recommend using gcc 4.8 or 4.9, or clang 3.7 or
+On Linux, for this guide, we require a minimum of gcc 4.8, or clang 3.7 or
higher. You can check your version by running
.. code-block:: shell
$ gcc --version
-On Ubuntu 16.04 and higher, you can obtain gcc 4.9 with:
+If the system compiler is older than gcc 4.8, it can be set to a newer version
+using the ``$CC`` and ``$CXX`` environment variables:
.. code-block:: shell
- $ sudo apt-get install g++-4.9
-
-Finally, set gcc 4.9 as the active compiler using:
-
-.. code-block:: shell
-
- export CC=gcc-4.9
- export CXX=g++-4.9
+ export CC=gcc-4.8
+ export CXX=g++-4.8
Environment Setup and Build
---------------------------
@@ -74,7 +69,7 @@ Using Conda
~~~~~~~~~~~
Let's create a conda environment with all the C++ build and Python dependencies
-from conda-forge:
+from conda-forge, targeting development for Python 3.7:
On Linux and OSX:
@@ -84,7 +79,12 @@ On Linux and OSX:
--file arrow/ci/conda_env_unix.yml \
--file arrow/ci/conda_env_cpp.yml \
--file arrow/ci/conda_env_python.yml \
- python=3.6
+ compilers \
+ python=3.7
+
+As of January 2019, the `compilers` package is needed on many Linux distributions to use packages from conda-forge.
+
+With this out of the way, you can now activate the conda environment
conda activate pyarrow-dev
@@ -95,11 +95,7 @@ about our build toolchain:
.. code-block:: shell
- export ARROW_BUILD_TYPE=release
- export ARROW_BUILD_TOOLCHAIN=$CONDA_PREFIX
export ARROW_HOME=$CONDA_PREFIX
- export PARQUET_HOME=$CONDA_PREFIX
- export BOOST_HOME=$CONDA_PREFIX
Using pip
~~~~~~~~~
@@ -161,10 +157,7 @@ about our build toolchain:
.. code-block:: shell
- export ARROW_BUILD_TYPE=release
-
export ARROW_HOME=$(pwd)/dist
- export PARQUET_HOME=$(pwd)/dist
export LD_LIBRARY_PATH=$(pwd)/dist/lib:$LD_LIBRARY_PATH
Build and test
@@ -177,26 +170,34 @@ Now build and install the Arrow C++ libraries:
mkdir arrow/cpp/build
pushd arrow/cpp/build
- cmake -DCMAKE_BUILD_TYPE=$ARROW_BUILD_TYPE \
- -DCMAKE_INSTALL_PREFIX=$ARROW_HOME \
+ cmake -DCMAKE_INSTALL_PREFIX=$ARROW_HOME \
-DCMAKE_INSTALL_LIBDIR=lib \
- -DARROW_PARQUET=on \
- -DARROW_PYTHON=on \
- -DARROW_PLASMA=on \
- -DARROW_BUILD_TESTS=OFF \
+ -DARROW_FLIGHT=ON \
+ -DARROW_GANDIVA=ON \
+ -DARROW_ORC=ON \
+ -DARROW_PARQUET=ON \
+ -DARROW_PYTHON=ON \
+ -DARROW_PLASMA=ON \
+ -DARROW_BUILD_TESTS=ON \
..
make -j4
make install
popd
-If you don't want to build and install the Plasma in-memory object store,
-you can omit the ``-DARROW_PLASMA=on`` flag.
-Also, if multiple versions of Python are installed in your environment,
-you may have to pass additional parameters to cmake so that
-it can find the right executable, headers and libraries.
-For example, specifying `-DPYTHON_EXECUTABLE=$VIRTUAL_ENV/bin/python`
-(assuming that you're in virtualenv) enables cmake to choose
-the python executable which you are using.
+Many of these components are optional, and can be switched off by setting them
+to ``OFF``:
+
+* ``ARROW_FLIGHT``: RPC framework
+* ``ARROW_GANDIVA``: LLVM-based expression compiler
+* ``ARROW_ORC``: Support for Apache ORC file format
+* ``ARROW_PARQUET``: Support for Apache Parquet file format
+* ``ARROW_PLASMA``: Shared memory object store
+
+If multiple versions of Python are installed in your environment, you may have
+to pass additional parameters to cmake so that it can find the right
+executable, headers and libraries. For example, specifying
+`-DPYTHON_EXECUTABLE=$VIRTUAL_ENV/bin/python` (assuming that you're in
+virtualenv) enables cmake to choose the python executable which you are using.
.. note::
@@ -210,11 +211,15 @@ Now, build pyarrow:
.. code-block:: shell
pushd arrow/python
- python setup.py build_ext --build-type=$ARROW_BUILD_TYPE \
- --with-parquet --with-plasma --inplace
+ export PYARROW_WITH_FLIGHT=1
+ export PYARROW_WITH_GANDIVA=1
+ export PYARROW_WITH_ORC=1
+ export PYARROW_WITH_PARQUET=1
+ python setup.py build_ext --build-type=$ARROW_BUILD_TYPE --inplace
popd
-If you did not build with plasma, you can omit ``--with-plasma``.
+If you did not build one of the optional components, set the corresponding
+``PYARROW_WITH_$COMPONENT`` environment variable to 0.
You should be able to run the unit tests with:
@@ -242,56 +247,25 @@ libraries), one can set ``--bundle-arrow-cpp``:
pip install wheel # if not installed
python setup.py build_ext --build-type=$ARROW_BUILD_TYPE \
- --with-parquet --with-plasma --bundle-arrow-cpp bdist_wheel
-
-Again, if you did not build with plasma, you should omit ``--with-plasma``.
-
-Building with optional ORC integration
---------------------------------------
+ --bundle-arrow-cpp bdist_wheel
-To build Arrow with support for the `Apache ORC file format <https://orc.apache.org/>`_,
-we recommend the following:
+Building with CUDA support
+~~~~~~~~~~~~~~~~~~~~~~~~~~
-#. Install the ORC C++ libraries and tools using ``conda``:
-
- .. code-block:: shell
-
- conda install -c conda-forge orc
-
-#. Set ``ORC_HOME`` and ``PROTOBUF_HOME`` to the location of the installed
- Orc and protobuf C++ libraries, respectively (otherwise Arrow will try
- to download source versions of those libraries and recompile them):
-
- .. code-block:: shell
-
- export ORC_HOME=$CONDA_PREFIX
- export PROTOBUF_HOME=$CONDA_PREFIX
-
-#. Add ``-DARROW_ORC=on`` to the CMake flags.
-#. Add ``--with-orc`` to the ``setup.py`` flags.
-
-Known issues
-------------
-
-If using packages provided by conda-forge (see "Using Conda" above)
-together with a reasonably recent compiler, you may get "undefined symbol"
-errors when importing pyarrow. In that case you'll need to force the C++
-ABI version to the older version used by conda-forge binaries:
+The :mod:`pyarrow.cuda` module offers support for using Arrow platform
+components with Nvidia's CUDA-enabled GPU devices. To build with this support,
+pass ``-DARROW_CUDA=ON`` when building the C++ libraries, and set the following
+environment variable when building pyarrow:
.. code-block:: shell
- export CXXFLAGS="-D_GLIBCXX_USE_CXX11_ABI=0"
- export PYARROW_CXXFLAGS=$CXXFLAGS
-
-Be sure to add ``-DCMAKE_CXX_FLAGS=$CXXFLAGS`` to the cmake invocations
-when rebuilding.
+ export PYARROW_WITH_CUDA=1
Developing on Windows
=====================
-First, we bootstrap a conda environment similar to the `C++ build instructions
-<https://github.com/apache/arrow/blob/master/cpp/apidoc/Windows.md>`_. This
-includes all the dependencies for Arrow and the Apache Parquet C++ libraries.
+First, we bootstrap a conda environment similar to above, but skipping some of
+the Linux/macOS-only packages:
First, starting from fresh clones of Apache Arrow:
@@ -313,13 +287,13 @@ Now, we build and install Arrow C++ libraries
mkdir cpp\build
cd cpp\build
- set ARROW_BUILD_TOOLCHAIN=%CONDA_PREFIX%\Library
set ARROW_HOME=C:\thirdparty
cmake -G "Visual Studio 14 2015 Win64" ^
-DCMAKE_INSTALL_PREFIX=%ARROW_HOME% ^
-DCMAKE_BUILD_TYPE=Release ^
-DARROW_BUILD_TESTS=on ^
-DARROW_CXXFLAGS="/WX /MP" ^
+ -DARROW_GANDIVA=on ^
-DARROW_PARQUET=on ^
-DARROW_PYTHON=on ..
cmake --build . --target INSTALL --config Release
@@ -356,6 +330,14 @@ Getting ``python-test.exe`` to run is a bit tricky because your
Now ``python-test.exe`` or simply ``ctest`` (to run all tests) should work.
+Windows Caveats
+---------------
+
+Some components are not supported yet on Windows:
+
+* Flight RPC
+* Plasma
+
Building the Documentation
==========================
diff --git a/docs/_sources/python/generated/pyarrow.Schema.rst.txt b/docs/_sources/python/generated/pyarrow.Schema.rst.txt
index 23191b7..488f321 100644
--- a/docs/_sources/python/generated/pyarrow.Schema.rst.txt
+++ b/docs/_sources/python/generated/pyarrow.Schema.rst.txt
@@ -36,6 +36,7 @@ pyarrow.Schema
~Schema.metadata
~Schema.names
+ ~Schema.pandas_metadata
~Schema.types
\ No newline at end of file
diff --git a/docs/_sources/python/generated/pyarrow.UnionType.rst.txt b/docs/_sources/python/generated/pyarrow.UnionType.rst.txt
index 992ed9a..278627f 100644
--- a/docs/_sources/python/generated/pyarrow.UnionType.rst.txt
+++ b/docs/_sources/python/generated/pyarrow.UnionType.rst.txt
@@ -28,5 +28,6 @@ pyarrow.UnionType
~UnionType.id
~UnionType.mode
~UnionType.num_children
+ ~UnionType.type_codes
\ No newline at end of file
diff --git a/docs/_sources/python/generated/pyarrow.cuda.Context.rst.txt b/docs/_sources/python/generated/pyarrow.cuda.Context.rst.txt
index bf4b008..768070e 100644
--- a/docs/_sources/python/generated/pyarrow.cuda.Context.rst.txt
+++ b/docs/_sources/python/generated/pyarrow.cuda.Context.rst.txt
@@ -14,8 +14,10 @@ pyarrow.cuda.Context
.. autosummary::
~Context.buffer_from_data
+ ~Context.buffer_from_object
~Context.foreign_buffer
~Context.from_numba
+ ~Context.get_device_address
~Context.get_num_devices
~Context.new_buffer
~Context.open_ipc_buffer
diff --git a/docs/_sources/python/generated/pyarrow.plasma.PlasmaClient.rst.txt b/docs/_sources/python/generated/pyarrow.plasma.PlasmaClient.rst.txt
index 89d20b1..52f3dd7 100644
--- a/docs/_sources/python/generated/pyarrow.plasma.PlasmaClient.rst.txt
+++ b/docs/_sources/python/generated/pyarrow.plasma.PlasmaClient.rst.txt
@@ -30,6 +30,7 @@ pyarrow.plasma.PlasmaClient
~PlasmaClient.put
~PlasmaClient.put_raw_buffer
~PlasmaClient.seal
+ ~PlasmaClient.store_capacity
~PlasmaClient.subscribe
~PlasmaClient.to_capsule
diff --git a/docs/_sources/python/index.rst.txt b/docs/_sources/python/index.rst.txt
index 9f96771..7f227c5 100644
--- a/docs/_sources/python/index.rst.txt
+++ b/docs/_sources/python/index.rst.txt
@@ -41,11 +41,11 @@ files into Arrow structures.
plasma
numpy
pandas
+ timestamps
csv
parquet
cuda
extending
api
- development
getting_involved
benchmarks
diff --git a/docs/_sources/python/install.rst.txt b/docs/_sources/python/install.rst.txt
index 8092b6c..8a47b4a 100644
--- a/docs/_sources/python/install.rst.txt
+++ b/docs/_sources/python/install.rst.txt
@@ -18,19 +18,34 @@
Installing PyArrow
==================
-Conda
------
+System Compatibility
+--------------------
-To install the latest version of PyArrow from conda-forge using conda:
+PyArrow is regularly built and tested on Windows, macOS and various Linux
+distributions (including Ubuntu 16.04, Ubuntu 18.04). We strongly recommend
+using a 64-bit system.
+
+Python Compatibility
+--------------------
+
+PyArrow pledges to maintain compatibility with Python 2.7 until the end of 2019.
+Other than that, PyArrow is currently compatible with Python 3.5, 3.6 and 3.7.
+
+Using Conda
+-----------
+
+Install the latest version of PyArrow from
+`conda-forge <https://conda-forge.org/>`_ using `Conda <https://conda.io>`_:
.. code-block:: bash
conda install -c conda-forge pyarrow
-Pip
----
+Using Pip
+---------
-Install the latest version from PyPI (Windows, Linux, and macOS):
+Install the latest version from `PyPI <https://pypi.org/>`_ (Windows, Linux,
+and macOS):
.. code-block:: bash
@@ -48,4 +63,4 @@ need to install the `Visual C++ Redistributable for Visual Studio 2015
Installing from source
----------------------
-See :ref:`development`.
+See :ref:`python-development`.
diff --git a/docs/_sources/python/parquet.rst.txt b/docs/_sources/python/parquet.rst.txt
index 5422ebe..bd3b349 100644
--- a/docs/_sources/python/parquet.rst.txt
+++ b/docs/_sources/python/parquet.rst.txt
@@ -37,7 +37,7 @@ which includes a native, multithreaded C++ adapter to and from in-memory Arrow
data. PyArrow includes Python bindings to this code, which thus enables reading
and writing Parquet files with pandas as well.
-Obtaining PyArrow with Parquet Support
+Obtaining pyarrow with Parquet Support
--------------------------------------
If you installed ``pyarrow`` with pip or conda, it should be built with Parquet
@@ -49,8 +49,8 @@ support bundled:
If you are building ``pyarrow`` from source, you must use
``-DARROW_PARQUET=ON`` when compiling the C++ libraries and enable the Parquet
-extensions when building ``pyarrow``. See the :ref:`Development <development>`
-page for more details.
+extensions when building ``pyarrow``. See the :ref:`Python Development
+<python-development>` page for more details.
Reading and Writing Single Files
--------------------------------
diff --git a/docs/_sources/python/timestamps.rst.txt b/docs/_sources/python/timestamps.rst.txt
new file mode 100644
index 0000000..d02aba6
--- /dev/null
+++ b/docs/_sources/python/timestamps.rst.txt
@@ -0,0 +1,198 @@
+.. Licensed to the Apache Software Foundation (ASF) under one
+.. or more contributor license agreements. See the NOTICE file
+.. distributed with this work for additional information
+.. regarding copyright ownership. The ASF licenses this file
+.. to you under the Apache License, Version 2.0 (the
+.. "License"); you may not use this file except in compliance
+.. with the License. You may obtain a copy of the License at
+
+.. http://www.apache.org/licenses/LICENSE-2.0
+
+.. Unless required by applicable law or agreed to in writing,
+.. software distributed under the License is distributed on an
+.. "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+.. KIND, either express or implied. See the License for the
+.. specific language governing permissions and limitations
+.. under the License.
+
+**********
+Timestamps
+**********
+
+Arrow/Pandas Timestamps
+=======================
+
+Arrow timestamps are stored as a 64-bit integer with column metadata to
+associate a time unit (e.g. milliseconds, microseconds, or nanoseconds), and an
+optional time zone. Pandas (`Timestamp`) uses a 64-bit integer represesenting
+nanoseconds and an optional time zone.
+Python/Pandas timestamp types without a associated time zone are referred to as
+"Time Zone Naive". Python/Pandas timestamp types with an associated time zone are
+referred to as "Time Zone Aware".
+
+
+Timestamp Conversions
+=====================
+
+Pandas/Arrow ⇄ Spark
+--------------------
+
+Spark stores timestamps as 64-bit integers representing microseconds since
+the UNIX epoch. It does not store any metadata about time zones with its
+timestamps.
+
+Spark interprets timestamps with the *session local time zone*, (i.e.
+``spark.sql.session.timeZone``). If that time zone is undefined, Spark turns to
+the default system time zone. For simplicity's sake below, the session
+local time zone is always defined.
+
+This implies a few things when round-tripping timestamps:
+
+#. Timezone information is lost (all timestamps that result from
+ converting from spark to arrow/pandas are "time zone naive").
+#. Timestamps are truncated to microseconds.
+#. The session time zone might have unintuitive impacts on
+ translation of timestamp values.
+
+Spark to Pandas (through Apache Arrow)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The following cases assume the Spark configuration
+``spark.sql.execution.arrow.enabled`` is set to ``"true"``.
+
+::
+
+ >>> pdf = pd.DataFrame({'naive': [datetime(2019, 1, 1, 0)],
+ ... 'aware': [Timestamp(year=2019, month=1, day=1,
+ ... nanosecond=500, tz=timezone(timedelta(hours=-8)))]})
+ >>> pdf
+ naive aware
+ 0 2018-10-01 2018-10-01 00:00:00.000000500-08:00
+
+ >>> spark.conf.set("spark.sql.session.timeZone", "UTC")
+ >>> utc_df = sqlContext.createDataFrame(pdf)
+ >>> utf_df.show()
+ +-------------------+-------------------+
+ | naive| aware|
+ +-------------------+-------------------+
+ |2019-01-01 00:00:00|2019-01-01 08:00:00|
+ +-------------------+-------------------+
+
+Note that conversion of the aware timestamp is shifted to reflect the time
+assuming UTC (it represents the same instant in time). For naive
+timestamps, Spark treats them as being in the system local
+time zone and converts them UTC. Recall that internally, the schema
+for spark dataframe's does not store any time zone information with
+timestamps.
+
+Now if the session time zone is set to US Pacific Time (PST) we don't
+see any shift in the display of the aware time zone (it
+still represents the same instant in time):
+
+::
+
+ >>> spark.conf.set("spark.sql.session.timeZone", "US/Pacific")
+ >>> pst_df = sqlContext.createDataFrame(pdf)
+ >>> pst_df.show()
+ +-------------------+-------------------+
+ | naive| aware|
+ +-------------------+-------------------+
+ |2019-01-01 00:00:00|2019-01-01 00:00:00|
+ +-------------------+-------------------+
+
+Looking again at utc_df.show() we see one of the impacts of the session time
+zone. The naive timestamp was initially converted assuming UTC, the instant it
+reflects is actually earlier than the naive time zone from the PST converted
+data frame:
+
+::
+
+ >>> utc_df.show()
+ +-------------------+-------------------+
+ | naive| aware|
+ +-------------------+-------------------+
+ |2018-12-31 16:00:00|2019-01-01 00:00:00|
+ +-------------------+-------------------+
+
+Spark to Pandas
+~~~~~~~~~~~~~~~
+
+We can observe what happens when converting back to Arrow/Pandas. Assuming the
+session time zone is still PST:
+
+::
+
+ >>> pst_df.show()
+ +-------------------+-------------------+
+ | naive| aware|
+ +-------------------+-------------------+
+ |2019-01-01 00:00:00|2019-01-01 00:00:00|
+ +-------------------+-------------------+
+
+
+ >>> pst_df.toPandas()
+ naive aware
+ 0 2019-01-01 2019-01-01
+ >>> pst_df.toPandas().info()
+ <class 'pandas.core.frame.DataFrame'>
+ RangeIndex: 1 entries, 0 to 0
+ Data columns (total 2 columns):
+ naive 1 non-null datetime64[ns]
+ aware 1 non-null datetime64[ns]
+ dtypes: datetime64[ns](2)
+ memory usage: 96.0 bytes
+
+Notice that, in addition to being a "time zone naive" timestamp, the 'aware'
+value will now differ when converting to an epoch offset. Spark does the conversion
+by first converting to the session time zone (or system local time zone if
+session time zones isn't set) and then localizes to remove the time zone
+information. This results in the timestamp being 8 hours before the original
+time:
+
+::
+
+ >>> pst_df.toPandas()['aware'][0]
+ Timestamp('2019-01-01 00:00:00')
+ >>> pdf['aware'][0]
+ Timestamp('2019-01-01 00:00:00.000000500-0800', tz='UTC-08:00')
+ >>> (pst_df.toPandas()['aware'][0].timestamp()-pdf['aware'][0].timestamp())/3600
+ -8.0
+
+The same type of conversion happens with the data frame converted while
+the session time zone was UTC. In this case both naive and aware
+represent different instants in time (the naive instant is due to
+the change in session time zone between creating data frames):
+
+::
+
+ >>> utc_df.show()
+ +-------------------+-------------------+
+ | naive| aware|
+ +-------------------+-------------------+
+ |2018-12-31 16:00:00|2019-01-01 00:00:00|
+ +-------------------+-------------------+
+
+ >>> utc_df.toPandas()
+ naive aware
+ 0 2018-12-31 16:00:00 2019-01-01
+
+Note that the surprising shift for aware doesn't happen
+when the session time zone is UTC (but the timestamps
+still become "time zone naive"):
+
+::
+
+ >>> spark.conf.set("spark.sql.session.timeZone", "UTC")
+ >>> pst_df.show()
+ +-------------------+-------------------+
+ | naive| aware|
+ +-------------------+-------------------+
+ |2019-01-01 08:00:00|2019-01-01 08:00:00|
+ +-------------------+-------------------+
+
+ >>> pst_df.toPandas()['aware'][0]
+ Timestamp('2019-01-01 08:00:00')
+ >>> pdf['aware'][0]
+ Timestamp('2019-01-01 00:00:00.000000500-0800', tz='UTC-08:00')
+ >>> (pst_df.toPandas()['aware'][0].timestamp()-pdf['aware'][0].timestamp())/3600
+ 0.0
diff --git a/docs/_static/basic.css b/docs/_static/basic.css
index 104f076..0807176 100644
--- a/docs/_static/basic.css
+++ b/docs/_static/basic.css
@@ -4,7 +4,7 @@
*
* Sphinx stylesheet -- basic theme.
*
- * :copyright: Copyright 2007-2018 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
diff --git a/docs/_static/css/badge_only.css b/docs/_static/css/badge_only.css
index 323730a..3c33cef 100644
--- a/docs/_static/css/badge_only.css
+++ b/docs/_static/css/badge_only.css
@@ -1 +1 @@
-.fa:before{-webkit-font-smoothing:antialiased}.clearfix{*zoom:1}.clearfix:before,.clearfix:after{display:table;content:""}.clearfix:after{clear:both}@font-face{font-family:FontAwesome;font-weight:normal;font-style:normal;src:url("../fonts/fontawesome-webfont.eot");src:url("../fonts/fontawesome-webfont.eot?#iefix") format("embedded-opentype"),url("../fonts/fontawesome-webfont.woff") format("woff"),url("../fonts/fontawesome-webfont.ttf") format("truetype"),url("../fonts/fontawesome-webfon [...]
+.fa:before{-webkit-font-smoothing:antialiased}.clearfix{*zoom:1}.clearfix:before,.clearfix:after{display:table;content:""}.clearfix:after{clear:both}@font-face{font-family:FontAwesome;font-weight:normal;font-style:normal;src:url("../fonts/fontawesome-webfont.eot");src:url("../fonts/fontawesome-webfont.eot?#iefix") format("embedded-opentype"),url("../fonts/fontawesome-webfont.woff") format("woff"),url("../fonts/fontawesome-webfont.ttf") format("truetype"),url("../fonts/fontawesome-webfon [...]
diff --git a/docs/_static/css/theme.css b/docs/_static/css/theme.css
index b19dbfe..aed8cef 100644
--- a/docs/_static/css/theme.css
+++ b/docs/_static/css/theme.css
@@ -1,6 +1,6 @@
-/* sphinx_rtd_theme version 0.4.2 | MIT license */
-/* Built 20181005 13:10 */
-*{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}article,aside,details,figcaption,figure,footer,header,hgroup,nav,section{display:block}audio,canvas,video{display:inline-block;*display:inline;*zoom:1}audio:not([controls]){display:none}[hidden]{display:none}*{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}html{font-size:100%;-webkit-text-size-adjust:100%;-ms-text-size-adjust:100%}body{margin:0}a:hover,a:active{outline:0}abbr[ [...]
+/* sphinx_rtd_theme version 0.4.3 | MIT license */
+/* Built 20190212 16:02 */
+*{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}article,aside,details,figcaption,figure,footer,header,hgroup,nav,section{display:block}audio,canvas,video{display:inline-block;*display:inline;*zoom:1}audio:not([controls]){display:none}[hidden]{display:none}*{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}html{font-size:100%;-webkit-text-size-adjust:100%;-ms-text-size-adjust:100%}body{margin:0}a:hover,a:active{outline:0}abbr[ [...]
* Font Awesome 4.7.0 by @davegandy - http://fontawesome.io - @fontawesome
* License - http://fontawesome.io/license (Font: SIL OFL 1.1, CSS: MIT License)
- */@font-face{font-family:'FontAwesome';src:url("../fonts/fontawesome-webfont.eot?v=4.7.0");src:url("../fonts/fontawesome-webfont.eot?#iefix&v=4.7.0") format("embedded-opentype"),url("../fonts/fontawesome-webfont.woff2?v=4.7.0") format("woff2"),url("../fonts/fontawesome-webfont.woff?v=4.7.0") format("woff"),url("../fonts/fontawesome-webfont.ttf?v=4.7.0") format("truetype"),url("../fonts/fontawesome-webfont.svg?v=4.7.0#fontawesomeregular") format("svg");font-weight:normal;font-style:norma [...]
+ */@font-face{font-family:'FontAwesome';src:url("../fonts/fontawesome-webfont.eot?v=4.7.0");src:url("../fonts/fontawesome-webfont.eot?#iefix&v=4.7.0") format("embedded-opentype"),url("../fonts/fontawesome-webfont.woff2?v=4.7.0") format("woff2"),url("../fonts/fontawesome-webfont.woff?v=4.7.0") format("woff"),url("../fonts/fontawesome-webfont.ttf?v=4.7.0") format("truetype"),url("../fonts/fontawesome-webfont.svg?v=4.7.0#fontawesomeregular") format("svg");font-weight:normal;font-style:norma [...]
diff --git a/docs/_static/doctools.js b/docs/_static/doctools.js
index ffadbec..344db17 100644
--- a/docs/_static/doctools.js
+++ b/docs/_static/doctools.js
@@ -4,7 +4,7 @@
*
* Sphinx JavaScript utilities for all documentation.
*
- * :copyright: Copyright 2007-2018 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
diff --git a/docs/_static/documentation_options.js b/docs/_static/documentation_options.js
index 5f0bd5a..1c53465 100644
--- a/docs/_static/documentation_options.js
+++ b/docs/_static/documentation_options.js
@@ -1,6 +1,6 @@
var DOCUMENTATION_OPTIONS = {
URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
- VERSION: '0.12.1.dev0+g8ca41384b.d20190120',
+ VERSION: '0.13.0',
LANGUAGE: 'None',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
diff --git a/docs/_static/js/theme.js b/docs/_static/js/theme.js
index 96672c6..8555d79 100644
--- a/docs/_static/js/theme.js
+++ b/docs/_static/js/theme.js
@@ -1,3 +1,3 @@
-/* sphinx_rtd_theme version 0.4.2 | MIT license */
-/* Built 20181005 13:10 */
-require=function r(s,a,l){function c(e,n){if(!a[e]){if(!s[e]){var i="function"==typeof require&&require;if(!n&&i)return i(e,!0);if(u)return u(e,!0);var t=new Error("Cannot find module '"+e+"'");throw t.code="MODULE_NOT_FOUND",t}var o=a[e]={exports:{}};s[e][0].call(o.exports,function(n){return c(s[e][1][n]||n)},o,o.exports,r,s,a,l)}return a[e].exports}for(var u="function"==typeof require&&require,n=0;n<l.length;n++)c(l[n]);return c}({"sphinx-rtd-theme":[function(n,e,i){var jQuery="undefin [...]
\ No newline at end of file
+/* sphinx_rtd_theme version 0.4.3 | MIT license */
+/* Built 20190212 16:02 */
+require=function r(s,a,l){function c(e,n){if(!a[e]){if(!s[e]){var i="function"==typeof require&&require;if(!n&&i)return i(e,!0);if(u)return u(e,!0);var t=new Error("Cannot find module '"+e+"'");throw t.code="MODULE_NOT_FOUND",t}var o=a[e]={exports:{}};s[e][0].call(o.exports,function(n){return c(s[e][1][n]||n)},o,o.exports,r,s,a,l)}return a[e].exports}for(var u="function"==typeof require&&require,n=0;n<l.length;n++)c(l[n]);return c}({"sphinx-rtd-theme":[function(n,e,i){var jQuery="undefin [...]
\ No newline at end of file
diff --git a/docs/_static/language_data.js b/docs/_static/language_data.js
index 908a627..5266fb1 100644
--- a/docs/_static/language_data.js
+++ b/docs/_static/language_data.js
@@ -5,7 +5,7 @@
* This script contains the language-specific data used by searchtools.js,
* namely the list of stopwords, stemmer, scorer and splitter.
*
- * :copyright: Copyright 2007-2018 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
diff --git a/docs/_static/searchtools.js b/docs/_static/searchtools.js
index 02ccf02..5ff3180 100644
--- a/docs/_static/searchtools.js
+++ b/docs/_static/searchtools.js
@@ -4,7 +4,7 @@
*
* Sphinx JavaScript utilities for the full-text search.
*
- * :copyright: Copyright 2007-2018 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
diff --git a/docs/_static/websupport.js b/docs/_static/websupport.js
index 78e14bb..3b4999e 100644
--- a/docs/_static/websupport.js
+++ b/docs/_static/websupport.js
@@ -4,7 +4,7 @@
*
* sphinx.websupport utilities for all documentation.
*
- * :copyright: Copyright 2007-2018 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
diff --git a/docs/cpp/api.html b/docs/cpp/api.html
index 50689dd..0308916 100644
--- a/docs/cpp/api.html
+++ b/docs/cpp/api.html
@@ -9,7 +9,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>API Reference — Apache Arrow v0.12.1.dev0+g8ca41384b.d20190120</title>
+ <title>API Reference — Apache Arrow v0.13.0</title>
@@ -18,34 +18,36 @@
-
-
+ <script type="text/javascript" src="../_static/js/modernizr.min.js"></script>
+ <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
+ <script type="text/javascript" src="../_static/jquery.js"></script>
+ <script type="text/javascript" src="../_static/underscore.js"></script>
+ <script type="text/javascript" src="../_static/doctools.js"></script>
+ <script type="text/javascript" src="../_static/language_data.js"></script>
+
+ <script type="text/javascript" src="../_static/js/theme.js"></script>
-
+
+
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="Programming Support" href="api/support.html" />
- <link rel="prev" title="Examples" href="examples.html" />
-
-
- <script src="../_static/js/modernizr.min.js"></script>
-
+ <link rel="prev" title="Conversion of range of std::tuple-like to Table instances" href="examples/tuple_range_conversion.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
-
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
- <div class="wy-side-nav-search">
+ <div class="wy-side-nav-search" >
@@ -59,7 +61,7 @@
<div class="version">
- 0.12.1.dev0+g8ca41384b.d20190120
+ 0.13.0
</div>
@@ -83,7 +85,7 @@
- <p class="caption"><span class="caption-text">Memory Format</span></p>
+ <p class="caption"><span class="caption-text">Arrow Columnar Format</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../format/README.html">Arrow specification documents</a></li>
<li class="toctree-l1"><a class="reference internal" href="../format/Guidelines.html">Implementation guidelines</a></li>
@@ -91,11 +93,11 @@
<li class="toctree-l1"><a class="reference internal" href="../format/Metadata.html">Metadata: Logical types, schemas, data headers</a></li>
<li class="toctree-l1"><a class="reference internal" href="../format/IPC.html">Interprocess messaging / communication (IPC)</a></li>
</ul>
-<p class="caption"><span class="caption-text">Languages</span></p>
+<p class="caption"><span class="caption-text">Arrow Libraries</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="index.html">C++ Implementation</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="getting_started.html">Getting Started</a></li>
-<li class="toctree-l2"><a class="reference internal" href="examples.html">Examples</a></li>
+<li class="toctree-l2"><a class="reference internal" href="examples/index.html">Examples</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">API Reference</a><ul>
<li class="toctree-l3"><a class="reference internal" href="api/support.html">Programming Support</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/memory.html">Memory (management)</a></li>
@@ -103,15 +105,21 @@
<li class="toctree-l3"><a class="reference internal" href="api/array.html">Arrays</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/builder.html">Array Builders</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/table.html">Two-dimensional Datasets</a></li>
+<li class="toctree-l3"><a class="reference internal" href="api/utilities.html">Utilities</a></li>
+<li class="toctree-l3"><a class="reference internal" href="api/cuda.html">CUDA support</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../python/index.html">Python bindings</a></li>
</ul>
-<p class="caption"><span class="caption-text">Other Topics</span></p>
+<p class="caption"><span class="caption-text">Development and Contributing</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../building.html">Building the Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../developers/contributing.html">Contribution Guidelines</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../developers/cpp.html">C++ Development</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../developers/python.html">Python Development</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../developers/integration.html">Integration Testing</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../developers/documentation.html">Building the Documentation</a></li>
</ul>
@@ -227,6 +235,17 @@
<li class="toctree-l2"><a class="reference internal" href="api/table.html#record-batches">Record Batches</a></li>
</ul>
</li>
+<li class="toctree-l1"><a class="reference internal" href="api/utilities.html">Utilities</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="api/utilities.html#decimal-numbers">Decimal Numbers</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="api/cuda.html">CUDA support</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="api/cuda.html#cuda-contexts">CUDA Contexts</a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/cuda.html#device-and-host-buffers">Device and Host Buffers</a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/cuda.html#device-memory-input-output">Device Memory Input / Output</a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/cuda.html#cuda-ipc">CUDA IPC</a></li>
+</ul>
+</li>
</ul>
</div>
</div>
@@ -242,7 +261,7 @@
<a href="api/support.html" class="btn btn-neutral float-right" title="Programming Support" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
- <a href="examples.html" class="btn btn-neutral" title="Examples" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+ <a href="examples/tuple_range_conversion.html" class="btn btn-neutral float-left" title="Conversion of range of std::tuple-like to Table instances" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
@@ -268,26 +287,16 @@
-
-
-
-
- <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
- <script type="text/javascript" src="../_static/jquery.js"></script>
- <script type="text/javascript" src="../_static/underscore.js"></script>
- <script type="text/javascript" src="../_static/doctools.js"></script>
- <script type="text/javascript" src="../_static/language_data.js"></script>
-
-
-
-
- <script type="text/javascript" src="../_static/js/theme.js"></script>
-
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
+
+
+
+
+
<script async src="https://www.googletagmanager.com/gtag/js?id=UA-107500873-1"></script>
<script>
window.dataLayer = window.dataLayer || [];
diff --git a/docs/cpp/api/array.html b/docs/cpp/api/array.html
index 6a9f942..4248d65 100644
--- a/docs/cpp/api/array.html
+++ b/docs/cpp/api/array.html
@@ -9,7 +9,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Arrays — Apache Arrow v0.12.1.dev0+g8ca41384b.d20190120</title>
+ <title>Arrays — Apache Arrow v0.13.0</title>
@@ -18,34 +18,36 @@
-
-
+ <script type="text/javascript" src="../../_static/js/modernizr.min.js"></script>
+ <script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
+ <script type="text/javascript" src="../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../_static/doctools.js"></script>
+ <script type="text/javascript" src="../../_static/language_data.js"></script>
+
+ <script type="text/javascript" src="../../_static/js/theme.js"></script>
-
+
+
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<link rel="index" title="Index" href="../../genindex.html" />
<link rel="search" title="Search" href="../../search.html" />
<link rel="next" title="Array Builders" href="builder.html" />
<link rel="prev" title="Data Types" href="datatype.html" />
-
-
- <script src="../../_static/js/modernizr.min.js"></script>
-
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
-
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
- <div class="wy-side-nav-search">
+ <div class="wy-side-nav-search" >
@@ -59,7 +61,7 @@
<div class="version">
- 0.12.1.dev0+g8ca41384b.d20190120
+ 0.13.0
</div>
@@ -83,7 +85,7 @@
- <p class="caption"><span class="caption-text">Memory Format</span></p>
+ <p class="caption"><span class="caption-text">Arrow Columnar Format</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../format/README.html">Arrow specification documents</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../format/Guidelines.html">Implementation guidelines</a></li>
@@ -91,11 +93,11 @@
<li class="toctree-l1"><a class="reference internal" href="../../format/Metadata.html">Metadata: Logical types, schemas, data headers</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../format/IPC.html">Interprocess messaging / communication (IPC)</a></li>
</ul>
-<p class="caption"><span class="caption-text">Languages</span></p>
+<p class="caption"><span class="caption-text">Arrow Libraries</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="../index.html">C++ Implementation</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="../getting_started.html">Getting Started</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../examples.html">Examples</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../examples/index.html">Examples</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="../api.html">API Reference</a><ul class="current">
<li class="toctree-l3"><a class="reference internal" href="support.html">Programming Support</a></li>
<li class="toctree-l3"><a class="reference internal" href="memory.html">Memory (management)</a></li>
@@ -107,15 +109,21 @@
</li>
<li class="toctree-l3"><a class="reference internal" href="builder.html">Array Builders</a></li>
<li class="toctree-l3"><a class="reference internal" href="table.html">Two-dimensional Datasets</a></li>
+<li class="toctree-l3"><a class="reference internal" href="utilities.html">Utilities</a></li>
+<li class="toctree-l3"><a class="reference internal" href="cuda.html">CUDA support</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../python/index.html">Python bindings</a></li>
</ul>
-<p class="caption"><span class="caption-text">Other Topics</span></p>
+<p class="caption"><span class="caption-text">Development and Contributing</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../../building.html">Building the Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../developers/contributing.html">Contribution Guidelines</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../developers/cpp.html">C++ Development</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../developers/python.html">Python Development</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../developers/integration.html">Integration Testing</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../developers/documentation.html">Building the Documentation</a></li>
</ul>
@@ -187,72 +195,85 @@
<div class="section" id="arrays">
<h1>Arrays<a class="headerlink" href="#arrays" title="Permalink to this headline">¶</a></h1>
<dl class="class">
-<dt id="_CPPv3N5arrow5ArrayE">
-<span id="_CPPv2N5arrow5ArrayE"></span><span id="arrow::Array"></span><span class="target" id="classarrow_1_1_array"></span><em class="property">class </em><code class="descname">Array</code><a class="headerlink" href="#_CPPv3N5arrow5ArrayE" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4N5arrow5ArrayE">
+<span id="_CPPv3N5arrow5ArrayE"></span><span id="_CPPv2N5arrow5ArrayE"></span><span id="arrow::Array"></span><span class="target" id="classarrow_1_1_array"></span><em class="property">class </em><code class="descname">Array</code><a class="headerlink" href="#_CPPv4N5arrow5ArrayE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p><a class="reference internal" href="#classarrow_1_1_array"><span class="std std-ref">Array</span></a> base type Immutable data array with some logical type and some length. </p>
<p>Any memory is owned by the respective <a class="reference internal" href="memory.html#classarrow_1_1_buffer"><span class="std std-ref">Buffer</span></a> instance (or its parents).</p>
<p>The base class is only required to have a null bitmap buffer if the null count is greater than 0</p>
<p>If known, the null count can be provided in the base <a class="reference internal" href="#classarrow_1_1_array"><span class="std std-ref">Array</span></a> constructor. If the null count is not known, pass -1 to indicate that the null count is to be computed on the first call to <a class="reference internal" href="#classarrow_1_1_array_1a0537d3b69a889b951e88be2fe9f3d96a"><span class="std std-ref">null_count()</span></a> </p>
-<p>Subclassed by <a class="reference internal" href="#classarrow_1_1_dictionary_array"><span class="std std-ref">arrow::DictionaryArray</span></a>, <a class="reference internal" href="#classarrow_1_1_flat_array"><span class="std std-ref">arrow::FlatArray</span></a>, <a class="reference internal" href="#classarrow_1_1_list_array"><span class="std std-ref">arrow::ListArray</span></a>, <a class="reference internal" href="#classarrow_1_1_struct_array"><span class="std std-ref">arrow::StructA [...]
+<p>Subclassed by <a class="reference internal" href="#classarrow_1_1_dictionary_array"><span class="std std-ref">arrow::DictionaryArray</span></a>, arrow::ExtensionArray, <a class="reference internal" href="#classarrow_1_1_flat_array"><span class="std std-ref">arrow::FlatArray</span></a>, <a class="reference internal" href="#classarrow_1_1_list_array"><span class="std std-ref">arrow::ListArray</span></a>, <a class="reference internal" href="#classarrow_1_1_struct_array"><span class="std [...]
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric">Public Functions</p>
<dl class="function">
-<dt id="_CPPv3NK5arrow5Array6IsNullE7int64_t">
-<span id="_CPPv2NK5arrow5Array6IsNullE7int64_t"></span><span id="arrow::Array::IsNull__int64_tC"></span><span class="target" id="classarrow_1_1_array_1a18c61cd4c8c158a30f30023eabc83acb"></span>bool <code class="descname">IsNull</code><span class="sig-paren">(</span>int64_t <em>i</em><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv3NK5arrow5Array6IsNullE7int64_t" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4NK5arrow5Array6IsNullE7int64_t">
+<span id="_CPPv3NK5arrow5Array6IsNullE7int64_t"></span><span id="_CPPv2NK5arrow5Array6IsNullE7int64_t"></span><span id="arrow::Array::IsNull__int64_tC"></span><span class="target" id="classarrow_1_1_array_1a18c61cd4c8c158a30f30023eabc83acb"></span>bool <code class="descname">IsNull</code><span class="sig-paren">(</span>int64_t <em>i</em><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv4NK5arrow5Array6IsNullE7int64_t" title="Permalink to th [...]
<dd><p>Return true if value at index is null. Does not boundscheck. </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3NK5arrow5Array7IsValidE7int64_t">
-<span id="_CPPv2NK5arrow5Array7IsValidE7int64_t"></span><span id="arrow::Array::IsValid__int64_tC"></span><span class="target" id="classarrow_1_1_array_1ae554bfb313cd6b161f63fb2966dbd662"></span>bool <code class="descname">IsValid</code><span class="sig-paren">(</span>int64_t <em>i</em><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv3NK5arrow5Array7IsValidE7int64_t" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4NK5arrow5Array7IsValidE7int64_t">
+<span id="_CPPv3NK5arrow5Array7IsValidE7int64_t"></span><span id="_CPPv2NK5arrow5Array7IsValidE7int64_t"></span><span id="arrow::Array::IsValid__int64_tC"></span><span class="target" id="classarrow_1_1_array_1ae554bfb313cd6b161f63fb2966dbd662"></span>bool <code class="descname">IsValid</code><span class="sig-paren">(</span>int64_t <em>i</em><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv4NK5arrow5Array7IsValidE7int64_t" title="Permalink [...]
<dd><p>Return true if value at index is valid (not null). </p>
<p>Does not boundscheck </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3NK5arrow5Array6lengthEv">
-<span id="_CPPv2NK5arrow5Array6lengthEv"></span><span id="arrow::Array::lengthC"></span><span class="target" id="classarrow_1_1_array_1a49c7fb3f73d2d43e7338591c5a8bd8bf"></span>int64_t <code class="descname">length</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv3NK5arrow5Array6lengthEv" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4NK5arrow5Array6lengthEv">
+<span id="_CPPv3NK5arrow5Array6lengthEv"></span><span id="_CPPv2NK5arrow5Array6lengthEv"></span><span id="arrow::Array::lengthC"></span><span class="target" id="classarrow_1_1_array_1a49c7fb3f73d2d43e7338591c5a8bd8bf"></span>int64_t <code class="descname">length</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv4NK5arrow5Array6lengthEv" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Size in the number of elements this array contains. </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3NK5arrow5Array6offsetEv">
-<span id="_CPPv2NK5arrow5Array6offsetEv"></span><span id="arrow::Array::offsetC"></span><span class="target" id="classarrow_1_1_array_1a1a0c6c1aa06cffd1dcb3813f0d24b2fd"></span>int64_t <code class="descname">offset</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv3NK5arrow5Array6offsetEv" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4NK5arrow5Array6offsetEv">
+<span id="_CPPv3NK5arrow5Array6offsetEv"></span><span id="_CPPv2NK5arrow5Array6offsetEv"></span><span id="arrow::Array::offsetC"></span><span class="target" id="classarrow_1_1_array_1a1a0c6c1aa06cffd1dcb3813f0d24b2fd"></span>int64_t <code class="descname">offset</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv4NK5arrow5Array6offsetEv" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>A relative position into another array’s data, to enable zero-copy slicing. </p>
<p>This value defaults to zero </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3NK5arrow5Array10null_countEv">
-<span id="_CPPv2NK5arrow5Array10null_countEv"></span><span id="arrow::Array::null_countC"></span><span class="target" id="classarrow_1_1_array_1a0537d3b69a889b951e88be2fe9f3d96a"></span>int64_t <code class="descname">null_count</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv3NK5arrow5Array10null_countEv" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4NK5arrow5Array10null_countEv">
+<span id="_CPPv3NK5arrow5Array10null_countEv"></span><span id="_CPPv2NK5arrow5Array10null_countEv"></span><span id="arrow::Array::null_countC"></span><span class="target" id="classarrow_1_1_array_1a0537d3b69a889b951e88be2fe9f3d96a"></span>int64_t <code class="descname">null_count</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv4NK5arrow5Array10null_countEv" title="Permalink to this definition">¶</a><b [...]
<dd><p>The number of null entries in the array. </p>
<p>If the null count was not known at time of construction (and set to a negative value), then the null count will be computed and cached on the first invocation of this function </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3NK5arrow5Array11null_bitmapEv">
-<span id="_CPPv2NK5arrow5Array11null_bitmapEv"></span><span id="arrow::Array::null_bitmapC"></span><span class="target" id="classarrow_1_1_array_1a76c4756ac85b29f9135064d68d2ef908"></span>std::shared_ptr<<a class="reference internal" href="memory.html#_CPPv3N5arrow6BufferE" title="arrow::Buffer">Buffer</a>> <code class="descname">null_bitmap</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv3NK5ar [...]
+<dt id="_CPPv4NK5arrow5Array11null_bitmapEv">
+<span id="_CPPv3NK5arrow5Array11null_bitmapEv"></span><span id="_CPPv2NK5arrow5Array11null_bitmapEv"></span><span id="arrow::Array::null_bitmapC"></span><span class="target" id="classarrow_1_1_array_1a76c4756ac85b29f9135064d68d2ef908"></span>std::shared_ptr<<a class="reference internal" href="memory.html#_CPPv4N5arrow6BufferE" title="arrow::Buffer">Buffer</a>> <code class="descname">null_bitmap</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="proper [...]
<dd><p><a class="reference internal" href="memory.html#classarrow_1_1_buffer"><span class="std std-ref">Buffer</span></a> for the null bitmap. </p>
<p>Note that for <code class="docutils literal notranslate"><span class="pre">null_count</span> <span class="pre">==</span> <span class="pre">0</span></code>, this can be null. This buffer does not account for any slice offset </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3NK5arrow5Array16null_bitmap_dataEv">
-<span id="_CPPv2NK5arrow5Array16null_bitmap_dataEv"></span><span id="arrow::Array::null_bitmap_dataC"></span><span class="target" id="classarrow_1_1_array_1a7a8838fbc97b9b3b8ca15cb163b2027c"></span><em class="property">const</em> uint8_t *<code class="descname">null_bitmap_data</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv3NK5arrow5Array16null_bitmap_dataEv" title="Permalink to this definition">¶</ [...]
+<dt id="_CPPv4NK5arrow5Array16null_bitmap_dataEv">
+<span id="_CPPv3NK5arrow5Array16null_bitmap_dataEv"></span><span id="_CPPv2NK5arrow5Array16null_bitmap_dataEv"></span><span id="arrow::Array::null_bitmap_dataC"></span><span class="target" id="classarrow_1_1_array_1a7a8838fbc97b9b3b8ca15cb163b2027c"></span><em class="property">const</em> uint8_t *<code class="descname">null_bitmap_data</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv4NK5arrow5Array16n [...]
<dd><p>Raw pointer to the null bitmap. </p>
<p>Note that for <code class="docutils literal notranslate"><span class="pre">null_count</span> <span class="pre">==</span> <span class="pre">0</span></code>, this can be null. This buffer does not account for any slice offset </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3NK5arrow5Array11RangeEqualsE7int64_t7int64_t7int64_tRKNSt10shared_ptrI5ArrayEE">
-<span id="_CPPv2NK5arrow5Array11RangeEqualsE7int64_t7int64_t7int64_tRKNSt10shared_ptrI5ArrayEE"></span><span id="arrow::Array::RangeEquals__int64_t.int64_t.int64_t.std::shared_ptr:Array:CRC"></span><span class="target" id="classarrow_1_1_array_1a537467bcecb4471b18d3271f14ca9ad2"></span>bool <code class="descname">RangeEquals</code><span class="sig-paren">(</span>int64_t <em>start_idx</em>, int64_t <em>end_idx</em>, int64_t <em>other_start_idx</em>, <em class="property">const</em> std::sh [...]
+<dt id="_CPPv4NK5arrow5Array6EqualsERK5ArrayRK12EqualOptions">
+<span id="_CPPv3NK5arrow5Array6EqualsERK5ArrayRK12EqualOptions"></span><span id="_CPPv2NK5arrow5Array6EqualsERK5ArrayRK12EqualOptions"></span><span id="arrow::Array::Equals__ArrayCR.EqualOptionsCRC"></span><span class="target" id="classarrow_1_1_array_1a686cf58bab513d8ecfe3a285f4562eab"></span>bool <code class="descname">Equals</code><span class="sig-paren">(</span><em class="property">const</em> <a class="reference internal" href="#_CPPv4N5arrow5ArrayE" title="arrow::Array">Array</a> &a [...]
+<dd><p>Equality comparison with another array. </p>
+</dd></dl>
+
+<dl class="function">
+<dt id="_CPPv4NK5arrow5Array12ApproxEqualsERKNSt10shared_ptrI5ArrayEERK12EqualOptions">
+<span id="_CPPv3NK5arrow5Array12ApproxEqualsERKNSt10shared_ptrI5ArrayEERK12EqualOptions"></span><span id="_CPPv2NK5arrow5Array12ApproxEqualsERKNSt10shared_ptrI5ArrayEERK12EqualOptions"></span><span id="arrow::Array::ApproxEquals__std::shared_ptr:Array:CR.EqualOptionsCRC"></span><span class="target" id="classarrow_1_1_array_1a381e6469686eccd2545cf1dc171f6cb7"></span>bool <code class="descname">ApproxEquals</code><span class="sig-paren">(</span><em class="property">const</em> std::shared_p [...]
+<dd><p>Approximate equality comparison with another array. </p>
+<p>epsilon is only used if this is FloatArray or DoubleArray </p>
+</dd></dl>
+
+<dl class="function">
+<dt id="_CPPv4NK5arrow5Array11RangeEqualsE7int64_t7int64_t7int64_tRK5Array">
+<span id="_CPPv3NK5arrow5Array11RangeEqualsE7int64_t7int64_t7int64_tRK5Array"></span><span id="_CPPv2NK5arrow5Array11RangeEqualsE7int64_t7int64_t7int64_tRK5Array"></span><span id="arrow::Array::RangeEquals__int64_t.int64_t.int64_t.ArrayCRC"></span><span class="target" id="classarrow_1_1_array_1ace5ac1affa59422d70a8b3f6929b70bc"></span>bool <code class="descname">RangeEquals</code><span class="sig-paren">(</span>int64_t <em>start_idx</em>, int64_t <em>end_idx</em>, int64_t <em>other_start [...]
<dd><p>Compare if the range of slots specified are equal for the given array and this array. </p>
<p>end_idx exclusive. This methods does not bounds check. </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3NK5arrow5Array5SliceE7int64_t7int64_t">
-<span id="_CPPv2NK5arrow5Array5SliceE7int64_t7int64_t"></span><span id="arrow::Array::Slice__int64_t.int64_tC"></span><span class="target" id="classarrow_1_1_array_1ae32f72c78fe10ce17f0a817e302e17d1"></span>std::shared_ptr<<a class="reference internal" href="#_CPPv3N5arrow5ArrayE" title="arrow::Array">Array</a>> <code class="descname">Slice</code><span class="sig-paren">(</span>int64_t <em>offset</em>, int64_t <em>length</em><span class="sig-paren">)</span> <em class="property">con [...]
+<dt id="_CPPv4NK5arrow5Array5SliceE7int64_t7int64_t">
+<span id="_CPPv3NK5arrow5Array5SliceE7int64_t7int64_t"></span><span id="_CPPv2NK5arrow5Array5SliceE7int64_t7int64_t"></span><span id="arrow::Array::Slice__int64_t.int64_tC"></span><span class="target" id="classarrow_1_1_array_1ae32f72c78fe10ce17f0a817e302e17d1"></span>std::shared_ptr<<a class="reference internal" href="#_CPPv4N5arrow5ArrayE" title="arrow::Array">Array</a>> <code class="descname">Slice</code><span class="sig-paren">(</span>int64_t <em>offset</em>, int64_t <em>length [...]
<dd><p>Construct a zero-copy slice of the array with the indicated offset and length. </p>
<p><dl class="docutils">
<dt><strong>Return</strong></dt>
@@ -268,14 +289,14 @@
</dd></dl>
<dl class="function">
-<dt id="_CPPv3NK5arrow5Array5SliceE7int64_t">
-<span id="_CPPv2NK5arrow5Array5SliceE7int64_t"></span><span id="arrow::Array::Slice__int64_tC"></span><span class="target" id="classarrow_1_1_array_1a5cf4c3330e850670aa52dab3b21869ea"></span>std::shared_ptr<<a class="reference internal" href="#_CPPv3N5arrow5ArrayE" title="arrow::Array">Array</a>> <code class="descname">Slice</code><span class="sig-paren">(</span>int64_t <em>offset</em><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv [...]
+<dt id="_CPPv4NK5arrow5Array5SliceE7int64_t">
+<span id="_CPPv3NK5arrow5Array5SliceE7int64_t"></span><span id="_CPPv2NK5arrow5Array5SliceE7int64_t"></span><span id="arrow::Array::Slice__int64_tC"></span><span class="target" id="classarrow_1_1_array_1a5cf4c3330e850670aa52dab3b21869ea"></span>std::shared_ptr<<a class="reference internal" href="#_CPPv4N5arrow5ArrayE" title="arrow::Array">Array</a>> <code class="descname">Slice</code><span class="sig-paren">(</span>int64_t <em>offset</em><span class="sig-paren">)</span> <em class=" [...]
<dd><p>Slice from offset until end of the array. </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3NK5arrow5Array8ToStringEv">
-<span id="_CPPv2NK5arrow5Array8ToStringEv"></span><span id="arrow::Array::ToStringC"></span><span class="target" id="classarrow_1_1_array_1a41c7af0e40ac55f2ce11785fea3e051e"></span>std::string <code class="descname">ToString</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv3NK5arrow5Array8ToStringEv" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4NK5arrow5Array8ToStringEv">
+<span id="_CPPv3NK5arrow5Array8ToStringEv"></span><span id="_CPPv2NK5arrow5Array8ToStringEv"></span><span id="arrow::Array::ToStringC"></span><span class="target" id="classarrow_1_1_array_1a41c7af0e40ac55f2ce11785fea3e051e"></span>std::string <code class="descname">ToString</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv4NK5arrow5Array8ToStringEv" title="Permalink to this definition">¶</a><br /></dt>
<dd><p><dl class="docutils">
<dt><strong>Return</strong></dt>
<dd>PrettyPrint representation of array suitable for debugging </dd>
@@ -289,8 +310,8 @@
<div class="section" id="concrete-array-subclasses">
<h2>Concrete array subclasses<a class="headerlink" href="#concrete-array-subclasses" title="Permalink to this headline">¶</a></h2>
<dl class="class">
-<dt id="_CPPv3N5arrow15DictionaryArrayE">
-<span id="_CPPv2N5arrow15DictionaryArrayE"></span><span id="arrow::DictionaryArray"></span><span class="target" id="classarrow_1_1_dictionary_array"></span><em class="property">class </em><code class="descname">DictionaryArray</code> : <em class="property">public</em> arrow::<a class="reference internal" href="#_CPPv3N5arrow5ArrayE" title="arrow::Array">Array</a><a class="headerlink" href="#_CPPv3N5arrow15DictionaryArrayE" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4N5arrow15DictionaryArrayE">
+<span id="_CPPv3N5arrow15DictionaryArrayE"></span><span id="_CPPv2N5arrow15DictionaryArrayE"></span><span id="arrow::DictionaryArray"></span><span class="target" id="classarrow_1_1_dictionary_array"></span><em class="property">class </em><code class="descname">DictionaryArray</code> : <em class="property">public</em> arrow::<a class="reference internal" href="#_CPPv4N5arrow5ArrayE" title="arrow::Array">Array</a><a class="headerlink" href="#_CPPv4N5arrow15DictionaryArrayE" title="Permalin [...]
<dd><p>Concrete <a class="reference internal" href="#classarrow_1_1_array"><span class="std std-ref">Array</span></a> class for dictionary data. </p>
<p>A dictionary array contains an array of non-negative integers (the “dictionary indices”) along with a data type containing a “dictionary” corresponding to the distinct values represented in the data.</p>
<p>For example, the array</p>
@@ -301,8 +322,8 @@
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric">Public Functions</p>
<dl class="function">
-<dt id="_CPPv3NK5arrow15DictionaryArray9TransposeEP10MemoryPoolRKNSt10shared_ptrI8DataTypeEERKNSt6vectorI7int32_tEEPNSt10shared_ptrI5ArrayEE">
-<span id="_CPPv2NK5arrow15DictionaryArray9TransposeEP10MemoryPoolRKNSt10shared_ptrI8DataTypeEERKNSt6vectorI7int32_tEEPNSt10shared_ptrI5ArrayEE"></span><span id="arrow::DictionaryArray::Transpose__MemoryPoolP.std::shared_ptr:DataType:CR.std::vector:int32_t:CR.std::shared_ptr:Array:PC"></span><span class="target" id="classarrow_1_1_dictionary_array_1aa78d3c5f146d10895e32c15f77b0c1f4"></span><a class="reference internal" href="support.html#_CPPv3N5arrow6StatusE" title="arrow::Status">Status [...]
+<dt id="_CPPv4NK5arrow15DictionaryArray9TransposeEP10MemoryPoolRKNSt10shared_ptrI8DataTypeEERKNSt6vectorI7int32_tEEPNSt10shared_ptrI5ArrayEE">
+<span id="_CPPv3NK5arrow15DictionaryArray9TransposeEP10MemoryPoolRKNSt10shared_ptrI8DataTypeEERKNSt6vectorI7int32_tEEPNSt10shared_ptrI5ArrayEE"></span><span id="_CPPv2NK5arrow15DictionaryArray9TransposeEP10MemoryPoolRKNSt10shared_ptrI8DataTypeEERKNSt6vectorI7int32_tEEPNSt10shared_ptrI5ArrayEE"></span><span id="arrow::DictionaryArray::Transpose__MemoryPoolP.std::shared_ptr:DataType:CR.std::vector:int32_t:CR.std::shared_ptr:Array:PC"></span><span class="target" id="classarrow_1_1_dictionar [...]
<dd><p>Transpose this <a class="reference internal" href="#classarrow_1_1_dictionary_array"><span class="std std-ref">DictionaryArray</span></a>. </p>
<p>This method constructs a new dictionary array with the given dictionary type, transposing indices using the transpose map. The type and the transpose map are typically computed using <a class="reference internal" href="datatype.html#classarrow_1_1_dictionary_type_1a2bfe17968624fedc6abfbc2ee30415e0"><span class="std std-ref">DictionaryType::Unify</span></a>.</p>
<p><dl class="docutils">
@@ -322,8 +343,8 @@
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric">Public Static Functions</p>
<dl class="function">
-<dt id="_CPPv3N5arrow15DictionaryArray10FromArraysERKNSt10shared_ptrI8DataTypeEERKNSt10shared_ptrI5ArrayEEPNSt10shared_ptrI5ArrayEE">
-<span id="_CPPv2N5arrow15DictionaryArray10FromArraysERKNSt10shared_ptrI8DataTypeEERKNSt10shared_ptrI5ArrayEEPNSt10shared_ptrI5ArrayEE"></span><span id="arrow::DictionaryArray::FromArrays__std::shared_ptr:DataType:CR.std::shared_ptr:Array:CR.std::shared_ptr:Array:P"></span><span class="target" id="classarrow_1_1_dictionary_array_1a7d280025b617d4aa1db5624509cd3c4e"></span><em class="property">static</em> <a class="reference internal" href="support.html#_CPPv3N5arrow6StatusE" title="arrow:: [...]
+<dt id="_CPPv4N5arrow15DictionaryArray10FromArraysERKNSt10shared_ptrI8DataTypeEERKNSt10shared_ptrI5ArrayEEPNSt10shared_ptrI5ArrayEE">
+<span id="_CPPv3N5arrow15DictionaryArray10FromArraysERKNSt10shared_ptrI8DataTypeEERKNSt10shared_ptrI5ArrayEEPNSt10shared_ptrI5ArrayEE"></span><span id="_CPPv2N5arrow15DictionaryArray10FromArraysERKNSt10shared_ptrI8DataTypeEERKNSt10shared_ptrI5ArrayEEPNSt10shared_ptrI5ArrayEE"></span><span id="arrow::DictionaryArray::FromArrays__std::shared_ptr:DataType:CR.std::shared_ptr:Array:CR.std::shared_ptr:Array:P"></span><span class="target" id="classarrow_1_1_dictionary_array_1a7d280025b617d4aa1d [...]
<dd><p>Construct <a class="reference internal" href="#classarrow_1_1_dictionary_array"><span class="std std-ref">DictionaryArray</span></a> from dictionary data type and indices array. </p>
<p>This function does the validation of the indices and input type. It checks if all indices are non-negative and smaller than the size of the dictionary</p>
<p><dl class="docutils">
@@ -344,34 +365,34 @@
<div class="section" id="non-nested">
<h3>Non-nested<a class="headerlink" href="#non-nested" title="Permalink to this headline">¶</a></h3>
<dl class="class">
-<dt id="_CPPv3N5arrow9FlatArrayE">
-<span id="_CPPv2N5arrow9FlatArrayE"></span><span id="arrow::FlatArray"></span><span class="target" id="classarrow_1_1_flat_array"></span><em class="property">class </em><code class="descname">FlatArray</code> : <em class="property">public</em> arrow::<a class="reference internal" href="#_CPPv3N5arrow5ArrayE" title="arrow::Array">Array</a><a class="headerlink" href="#_CPPv3N5arrow9FlatArrayE" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4N5arrow9FlatArrayE">
+<span id="_CPPv3N5arrow9FlatArrayE"></span><span id="_CPPv2N5arrow9FlatArrayE"></span><span id="arrow::FlatArray"></span><span class="target" id="classarrow_1_1_flat_array"></span><em class="property">class </em><code class="descname">FlatArray</code> : <em class="property">public</em> arrow::<a class="reference internal" href="#_CPPv4N5arrow5ArrayE" title="arrow::Array">Array</a><a class="headerlink" href="#_CPPv4N5arrow9FlatArrayE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Base class for non-nested arrays. </p>
<p>Subclassed by <a class="reference internal" href="#classarrow_1_1_binary_array"><span class="std std-ref">arrow::BinaryArray</span></a>, <a class="reference internal" href="#classarrow_1_1_null_array"><span class="std std-ref">arrow::NullArray</span></a>, <a class="reference internal" href="#classarrow_1_1_primitive_array"><span class="std std-ref">arrow::PrimitiveArray</span></a></p>
</dd></dl>
<dl class="class">
-<dt id="_CPPv3N5arrow9NullArrayE">
-<span id="_CPPv2N5arrow9NullArrayE"></span><span id="arrow::NullArray"></span><span class="target" id="classarrow_1_1_null_array"></span><em class="property">class </em><code class="descname">NullArray</code> : <em class="property">public</em> arrow::<a class="reference internal" href="#_CPPv3N5arrow9FlatArrayE" title="arrow::FlatArray">FlatArray</a><a class="headerlink" href="#_CPPv3N5arrow9NullArrayE" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4N5arrow9NullArrayE">
+<span id="_CPPv3N5arrow9NullArrayE"></span><span id="_CPPv2N5arrow9NullArrayE"></span><span id="arrow::NullArray"></span><span class="target" id="classarrow_1_1_null_array"></span><em class="property">class </em><code class="descname">NullArray</code> : <em class="property">public</em> arrow::<a class="reference internal" href="#_CPPv4N5arrow9FlatArrayE" title="arrow::FlatArray">FlatArray</a><a class="headerlink" href="#_CPPv4N5arrow9NullArrayE" title="Permalink to this definition">¶</a> [...]
<dd><p>Degenerate null type <a class="reference internal" href="#classarrow_1_1_array"><span class="std std-ref">Array</span></a>. </p>
</dd></dl>
<dl class="class">
-<dt id="_CPPv3N5arrow11BinaryArrayE">
-<span id="_CPPv2N5arrow11BinaryArrayE"></span><span id="arrow::BinaryArray"></span><span class="target" id="classarrow_1_1_binary_array"></span><em class="property">class </em><code class="descname">BinaryArray</code> : <em class="property">public</em> arrow::<a class="reference internal" href="#_CPPv3N5arrow9FlatArrayE" title="arrow::FlatArray">FlatArray</a><a class="headerlink" href="#_CPPv3N5arrow11BinaryArrayE" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4N5arrow11BinaryArrayE">
+<span id="_CPPv3N5arrow11BinaryArrayE"></span><span id="_CPPv2N5arrow11BinaryArrayE"></span><span id="arrow::BinaryArray"></span><span class="target" id="classarrow_1_1_binary_array"></span><em class="property">class </em><code class="descname">BinaryArray</code> : <em class="property">public</em> arrow::<a class="reference internal" href="#_CPPv4N5arrow9FlatArrayE" title="arrow::FlatArray">FlatArray</a><a class="headerlink" href="#_CPPv4N5arrow11BinaryArrayE" title="Permalink to this de [...]
<dd><p>Concrete <a class="reference internal" href="#classarrow_1_1_array"><span class="std std-ref">Array</span></a> class for variable-size binary data. </p>
<p>Subclassed by <a class="reference internal" href="#classarrow_1_1_string_array"><span class="std std-ref">arrow::StringArray</span></a></p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric">Public Functions</p>
<dl class="function">
-<dt id="_CPPv3NK5arrow11BinaryArray8GetValueE7int64_tP7int32_t">
-<span id="_CPPv2NK5arrow11BinaryArray8GetValueE7int64_tP7int32_t"></span><span id="arrow::BinaryArray::GetValue__int64_t.int32_tPC"></span><span class="target" id="classarrow_1_1_binary_array_1aeecc06f2bad333947dfeadbe600ef501"></span><em class="property">const</em> uint8_t *<code class="descname">GetValue</code><span class="sig-paren">(</span>int64_t <em>i</em>, int32_t *<em>out_length</em><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv [...]
+<dt id="_CPPv4NK5arrow11BinaryArray8GetValueE7int64_tP7int32_t">
+<span id="_CPPv3NK5arrow11BinaryArray8GetValueE7int64_tP7int32_t"></span><span id="_CPPv2NK5arrow11BinaryArray8GetValueE7int64_tP7int32_t"></span><span id="arrow::BinaryArray::GetValue__int64_t.int32_tPC"></span><span class="target" id="classarrow_1_1_binary_array_1aeecc06f2bad333947dfeadbe600ef501"></span><em class="property">const</em> uint8_t *<code class="descname">GetValue</code><span class="sig-paren">(</span>int64_t <em>i</em>, int32_t *<em>out_length</em><span class="sig-paren">) [...]
<dd><p>Return the pointer to the given elements bytes. </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3NK5arrow11BinaryArray7GetViewE7int64_t">
-<span id="_CPPv2NK5arrow11BinaryArray7GetViewE7int64_t"></span><span id="arrow::BinaryArray::GetView__int64_tC"></span><span class="target" id="classarrow_1_1_binary_array_1aad9deb72684e2d7e81cfd48e5f4ba526"></span>util::string_view <code class="descname">GetView</code><span class="sig-paren">(</span>int64_t <em>i</em><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv3NK5arrow11BinaryArray7GetViewE7int64_t" title="Permalink to this definiti [...]
+<dt id="_CPPv4NK5arrow11BinaryArray7GetViewE7int64_t">
+<span id="_CPPv3NK5arrow11BinaryArray7GetViewE7int64_t"></span><span id="_CPPv2NK5arrow11BinaryArray7GetViewE7int64_t"></span><span id="arrow::BinaryArray::GetView__int64_tC"></span><span class="target" id="classarrow_1_1_binary_array_1aad9deb72684e2d7e81cfd48e5f4ba526"></span>util::string_view <code class="descname">GetView</code><span class="sig-paren">(</span>int64_t <em>i</em><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv4NK5arrow11 [...]
<dd><p>Get binary value as a string_view. </p>
<p><dl class="docutils">
<dt><strong>Return</strong></dt>
@@ -386,8 +407,8 @@
</dd></dl>
<dl class="function">
-<dt id="_CPPv3NK5arrow11BinaryArray9GetStringE7int64_t">
-<span id="_CPPv2NK5arrow11BinaryArray9GetStringE7int64_t"></span><span id="arrow::BinaryArray::GetString__int64_tC"></span><span class="target" id="classarrow_1_1_binary_array_1a431adaf266ff3857ad6a4d2cb9028990"></span>std::string <code class="descname">GetString</code><span class="sig-paren">(</span>int64_t <em>i</em><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv3NK5arrow11BinaryArray9GetStringE7int64_t" title="Permalink to this defini [...]
+<dt id="_CPPv4NK5arrow11BinaryArray9GetStringE7int64_t">
+<span id="_CPPv3NK5arrow11BinaryArray9GetStringE7int64_t"></span><span id="_CPPv2NK5arrow11BinaryArray9GetStringE7int64_t"></span><span id="arrow::BinaryArray::GetString__int64_tC"></span><span class="target" id="classarrow_1_1_binary_array_1a431adaf266ff3857ad6a4d2cb9028990"></span>std::string <code class="descname">GetString</code><span class="sig-paren">(</span>int64_t <em>i</em><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv4NK5arrow [...]
<dd><p>Get binary value as a std::string. </p>
<p><dl class="docutils">
<dt><strong>Return</strong></dt>
@@ -402,14 +423,14 @@
</dd></dl>
<dl class="function">
-<dt id="_CPPv3NK5arrow11BinaryArray13value_offsetsEv">
-<span id="_CPPv2NK5arrow11BinaryArray13value_offsetsEv"></span><span id="arrow::BinaryArray::value_offsetsC"></span><span class="target" id="classarrow_1_1_binary_array_1a417393ec572689d803009520a52ea6ec"></span>std::shared_ptr<<a class="reference internal" href="memory.html#_CPPv3N5arrow6BufferE" title="arrow::Buffer">Buffer</a>> <code class="descname">value_offsets</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="head [...]
+<dt id="_CPPv4NK5arrow11BinaryArray13value_offsetsEv">
+<span id="_CPPv3NK5arrow11BinaryArray13value_offsetsEv"></span><span id="_CPPv2NK5arrow11BinaryArray13value_offsetsEv"></span><span id="arrow::BinaryArray::value_offsetsC"></span><span class="target" id="classarrow_1_1_binary_array_1a417393ec572689d803009520a52ea6ec"></span>std::shared_ptr<<a class="reference internal" href="memory.html#_CPPv4N5arrow6BufferE" title="arrow::Buffer">Buffer</a>> <code class="descname">value_offsets</code><span class="sig-paren">(</span><span class="si [...]
<dd><p>Note that this buffer does not account for any slice offset. </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3NK5arrow11BinaryArray10value_dataEv">
-<span id="_CPPv2NK5arrow11BinaryArray10value_dataEv"></span><span id="arrow::BinaryArray::value_dataC"></span><span class="target" id="classarrow_1_1_binary_array_1aaf953d6848a3cf7da34d8f320c9d27c9"></span>std::shared_ptr<<a class="reference internal" href="memory.html#_CPPv3N5arrow6BufferE" title="arrow::Buffer">Buffer</a>> <code class="descname">value_data</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" h [...]
+<dt id="_CPPv4NK5arrow11BinaryArray10value_dataEv">
+<span id="_CPPv3NK5arrow11BinaryArray10value_dataEv"></span><span id="_CPPv2NK5arrow11BinaryArray10value_dataEv"></span><span id="arrow::BinaryArray::value_dataC"></span><span class="target" id="classarrow_1_1_binary_array_1aaf953d6848a3cf7da34d8f320c9d27c9"></span>std::shared_ptr<<a class="reference internal" href="memory.html#_CPPv4N5arrow6BufferE" title="arrow::Buffer">Buffer</a>> <code class="descname">value_data</code><span class="sig-paren">(</span><span class="sig-paren">)</ [...]
<dd><p>Note that this buffer does not account for any slice offset. </p>
</dd></dl>
@@ -417,21 +438,21 @@
</dd></dl>
<dl class="class">
-<dt id="_CPPv3N5arrow11StringArrayE">
-<span id="_CPPv2N5arrow11StringArrayE"></span><span id="arrow::StringArray"></span><span class="target" id="classarrow_1_1_string_array"></span><em class="property">class </em><code class="descname">StringArray</code> : <em class="property">public</em> arrow::<a class="reference internal" href="#_CPPv3N5arrow11BinaryArrayE" title="arrow::BinaryArray">BinaryArray</a><a class="headerlink" href="#_CPPv3N5arrow11StringArrayE" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4N5arrow11StringArrayE">
+<span id="_CPPv3N5arrow11StringArrayE"></span><span id="_CPPv2N5arrow11StringArrayE"></span><span id="arrow::StringArray"></span><span class="target" id="classarrow_1_1_string_array"></span><em class="property">class </em><code class="descname">StringArray</code> : <em class="property">public</em> arrow::<a class="reference internal" href="#_CPPv4N5arrow11BinaryArrayE" title="arrow::BinaryArray">BinaryArray</a><a class="headerlink" href="#_CPPv4N5arrow11StringArrayE" title="Permalink to [...]
<dd><p>Concrete <a class="reference internal" href="#classarrow_1_1_array"><span class="std std-ref">Array</span></a> class for variable-size string (utf-8) data. </p>
</dd></dl>
<dl class="class">
-<dt id="_CPPv3N5arrow14PrimitiveArrayE">
-<span id="_CPPv2N5arrow14PrimitiveArrayE"></span><span id="arrow::PrimitiveArray"></span><span class="target" id="classarrow_1_1_primitive_array"></span><em class="property">class </em><code class="descname">PrimitiveArray</code> : <em class="property">public</em> arrow::<a class="reference internal" href="#_CPPv3N5arrow9FlatArrayE" title="arrow::FlatArray">FlatArray</a><a class="headerlink" href="#_CPPv3N5arrow14PrimitiveArrayE" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4N5arrow14PrimitiveArrayE">
+<span id="_CPPv3N5arrow14PrimitiveArrayE"></span><span id="_CPPv2N5arrow14PrimitiveArrayE"></span><span id="arrow::PrimitiveArray"></span><span class="target" id="classarrow_1_1_primitive_array"></span><em class="property">class </em><code class="descname">PrimitiveArray</code> : <em class="property">public</em> arrow::<a class="reference internal" href="#_CPPv4N5arrow9FlatArrayE" title="arrow::FlatArray">FlatArray</a><a class="headerlink" href="#_CPPv4N5arrow14PrimitiveArrayE" title="Pe [...]
<dd><p>Base class for arrays of fixed-size logical types. </p>
<p>Subclassed by <a class="reference internal" href="#classarrow_1_1_boolean_array"><span class="std std-ref">arrow::BooleanArray</span></a>, <a class="reference internal" href="#classarrow_1_1_fixed_size_binary_array"><span class="std std-ref">arrow::FixedSizeBinaryArray</span></a>, <a class="reference internal" href="#classarrow_1_1_numeric_array"><span class="std std-ref">arrow::NumericArray< TYPE ></span></a></p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric">Public Functions</p>
<dl class="function">
-<dt id="_CPPv3NK5arrow14PrimitiveArray6valuesEv">
-<span id="_CPPv2NK5arrow14PrimitiveArray6valuesEv"></span><span id="arrow::PrimitiveArray::valuesC"></span><span class="target" id="classarrow_1_1_primitive_array_1a0c05d9ba21020050abe94e1446a3cee1"></span>std::shared_ptr<<a class="reference internal" href="memory.html#_CPPv3N5arrow6BufferE" title="arrow::Buffer">Buffer</a>> <code class="descname">values</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href= [...]
+<dt id="_CPPv4NK5arrow14PrimitiveArray6valuesEv">
+<span id="_CPPv3NK5arrow14PrimitiveArray6valuesEv"></span><span id="_CPPv2NK5arrow14PrimitiveArray6valuesEv"></span><span id="arrow::PrimitiveArray::valuesC"></span><span class="target" id="classarrow_1_1_primitive_array_1a0c05d9ba21020050abe94e1446a3cee1"></span>std::shared_ptr<<a class="reference internal" href="memory.html#_CPPv4N5arrow6BufferE" title="arrow::Buffer">Buffer</a>> <code class="descname">values</code><span class="sig-paren">(</span><span class="sig-paren">)</span> [...]
<dd><p>Does not account for any slice offset. </p>
</dd></dl>
@@ -439,27 +460,27 @@
</dd></dl>
<dl class="class">
-<dt id="_CPPv3N5arrow12BooleanArrayE">
-<span id="_CPPv2N5arrow12BooleanArrayE"></span><span id="arrow::BooleanArray"></span><span class="target" id="classarrow_1_1_boolean_array"></span><em class="property">class </em><code class="descname">BooleanArray</code> : <em class="property">public</em> arrow::<a class="reference internal" href="#_CPPv3N5arrow14PrimitiveArrayE" title="arrow::PrimitiveArray">PrimitiveArray</a><a class="headerlink" href="#_CPPv3N5arrow12BooleanArrayE" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4N5arrow12BooleanArrayE">
+<span id="_CPPv3N5arrow12BooleanArrayE"></span><span id="_CPPv2N5arrow12BooleanArrayE"></span><span id="arrow::BooleanArray"></span><span class="target" id="classarrow_1_1_boolean_array"></span><em class="property">class </em><code class="descname">BooleanArray</code> : <em class="property">public</em> arrow::<a class="reference internal" href="#_CPPv4N5arrow14PrimitiveArrayE" title="arrow::PrimitiveArray">PrimitiveArray</a><a class="headerlink" href="#_CPPv4N5arrow12BooleanArrayE" title [...]
<dd><p>Concrete <a class="reference internal" href="#classarrow_1_1_array"><span class="std std-ref">Array</span></a> class for boolean data. </p>
</dd></dl>
<dl class="class">
-<dt id="_CPPv3N5arrow20FixedSizeBinaryArrayE">
-<span id="_CPPv2N5arrow20FixedSizeBinaryArrayE"></span><span id="arrow::FixedSizeBinaryArray"></span><span class="target" id="classarrow_1_1_fixed_size_binary_array"></span><em class="property">class </em><code class="descname">FixedSizeBinaryArray</code> : <em class="property">public</em> arrow::<a class="reference internal" href="#_CPPv3N5arrow14PrimitiveArrayE" title="arrow::PrimitiveArray">PrimitiveArray</a><a class="headerlink" href="#_CPPv3N5arrow20FixedSizeBinaryArrayE" title="Per [...]
+<dt id="_CPPv4N5arrow20FixedSizeBinaryArrayE">
+<span id="_CPPv3N5arrow20FixedSizeBinaryArrayE"></span><span id="_CPPv2N5arrow20FixedSizeBinaryArrayE"></span><span id="arrow::FixedSizeBinaryArray"></span><span class="target" id="classarrow_1_1_fixed_size_binary_array"></span><em class="property">class </em><code class="descname">FixedSizeBinaryArray</code> : <em class="property">public</em> arrow::<a class="reference internal" href="#_CPPv4N5arrow14PrimitiveArrayE" title="arrow::PrimitiveArray">PrimitiveArray</a><a class="headerlink" [...]
<dd><p>Concrete <a class="reference internal" href="#classarrow_1_1_array"><span class="std std-ref">Array</span></a> class for fixed-size binary data. </p>
<p>Subclassed by <a class="reference internal" href="#classarrow_1_1_decimal128_array"><span class="std std-ref">arrow::Decimal128Array</span></a></p>
</dd></dl>
<dl class="class">
-<dt id="_CPPv3N5arrow15Decimal128ArrayE">
-<span id="_CPPv2N5arrow15Decimal128ArrayE"></span><span id="arrow::Decimal128Array"></span><span class="target" id="classarrow_1_1_decimal128_array"></span><em class="property">class </em><code class="descname">Decimal128Array</code> : <em class="property">public</em> arrow::<a class="reference internal" href="#_CPPv3N5arrow20FixedSizeBinaryArrayE" title="arrow::FixedSizeBinaryArray">FixedSizeBinaryArray</a><a class="headerlink" href="#_CPPv3N5arrow15Decimal128ArrayE" title="Permalink to [...]
+<dt id="_CPPv4N5arrow15Decimal128ArrayE">
+<span id="_CPPv3N5arrow15Decimal128ArrayE"></span><span id="_CPPv2N5arrow15Decimal128ArrayE"></span><span id="arrow::Decimal128Array"></span><span class="target" id="classarrow_1_1_decimal128_array"></span><em class="property">class </em><code class="descname">Decimal128Array</code> : <em class="property">public</em> arrow::<a class="reference internal" href="#_CPPv4N5arrow20FixedSizeBinaryArrayE" title="arrow::FixedSizeBinaryArray">FixedSizeBinaryArray</a><a class="headerlink" href="#_C [...]
<dd><p>Concrete <a class="reference internal" href="#classarrow_1_1_array"><span class="std std-ref">Array</span></a> class for 128-bit decimal data. </p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric">Public Functions</p>
<dl class="function">
-<dt id="_CPPv3N5arrow15Decimal128Array15Decimal128ArrayERKNSt10shared_ptrI9ArrayDataEE">
-<span id="_CPPv2N5arrow15Decimal128Array15Decimal128ArrayERKNSt10shared_ptrI9ArrayDataEE"></span><span id="arrow::Decimal128Array::Decimal128Array__std::shared_ptr:ArrayData:CR"></span><span class="target" id="classarrow_1_1_decimal128_array_1a1520cf3809bc92851ad099403164538a"></span><code class="descname">Decimal128Array</code><span class="sig-paren">(</span><em class="property">const</em> std::shared_ptr<ArrayData> &<em>data</em><span class="sig-paren">)</span><a class="heade [...]
+<dt id="_CPPv4N5arrow15Decimal128Array15Decimal128ArrayERKNSt10shared_ptrI9ArrayDataEE">
+<span id="_CPPv3N5arrow15Decimal128Array15Decimal128ArrayERKNSt10shared_ptrI9ArrayDataEE"></span><span id="_CPPv2N5arrow15Decimal128Array15Decimal128ArrayERKNSt10shared_ptrI9ArrayDataEE"></span><span id="arrow::Decimal128Array::Decimal128Array__std::shared_ptr:ArrayData:CR"></span><span class="target" id="classarrow_1_1_decimal128_array_1a1520cf3809bc92851ad099403164538a"></span><code class="descname">Decimal128Array</code><span class="sig-paren">(</span><em class="property">const</em> s [...]
<dd><p>Construct <a class="reference internal" href="#classarrow_1_1_decimal128_array"><span class="std std-ref">Decimal128Array</span></a> from ArrayData instance. </p>
</dd></dl>
@@ -467,8 +488,8 @@
</dd></dl>
<dl class="class">
-<dt id="_CPPv3N5arrow12NumericArrayE">
-<span id="_CPPv2N5arrow12NumericArrayE"></span><span id="arrow::NumericArray"></span><span class="target" id="classarrow_1_1_numeric_array"></span><em class="property">template </em><<em class="property">typename</em> TYPE><br /><em class="property">class </em><code class="descname">NumericArray</code> : <em class="property">public</em> arrow::<a class="reference internal" href="#_CPPv3N5arrow14PrimitiveArrayE" title="arrow::PrimitiveArray">PrimitiveArray</a><a class="headerlink" h [...]
+<dt id="_CPPv4N5arrow12NumericArrayE">
+<span id="_CPPv3N5arrow12NumericArrayE"></span><span id="_CPPv2N5arrow12NumericArrayE"></span><span id="arrow::NumericArray"></span><span class="target" id="classarrow_1_1_numeric_array"></span><em class="property">template </em><<em class="property">typename</em> TYPE><br /><em class="property">class </em><code class="descname">NumericArray</code> : <em class="property">public</em> arrow::<a class="reference internal" href="#_CPPv4N5arrow14PrimitiveArrayE" title="arrow::PrimitiveA [...]
<dd><p>Concrete <a class="reference internal" href="#classarrow_1_1_array"><span class="std std-ref">Array</span></a> class for numeric data. </p>
</dd></dl>
@@ -476,26 +497,26 @@
<div class="section" id="nested">
<h3>Nested<a class="headerlink" href="#nested" title="Permalink to this headline">¶</a></h3>
<dl class="class">
-<dt id="_CPPv3N5arrow10UnionArrayE">
-<span id="_CPPv2N5arrow10UnionArrayE"></span><span id="arrow::UnionArray"></span><span class="target" id="classarrow_1_1_union_array"></span><em class="property">class </em><code class="descname">UnionArray</code> : <em class="property">public</em> arrow::<a class="reference internal" href="#_CPPv3N5arrow5ArrayE" title="arrow::Array">Array</a><a class="headerlink" href="#_CPPv3N5arrow10UnionArrayE" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4N5arrow10UnionArrayE">
+<span id="_CPPv3N5arrow10UnionArrayE"></span><span id="_CPPv2N5arrow10UnionArrayE"></span><span id="arrow::UnionArray"></span><span class="target" id="classarrow_1_1_union_array"></span><em class="property">class </em><code class="descname">UnionArray</code> : <em class="property">public</em> arrow::<a class="reference internal" href="#_CPPv4N5arrow5ArrayE" title="arrow::Array">Array</a><a class="headerlink" href="#_CPPv4N5arrow10UnionArrayE" title="Permalink to this definition">¶</a><br [...]
<dd><p>Concrete <a class="reference internal" href="#classarrow_1_1_array"><span class="std std-ref">Array</span></a> class for union data. </p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric">Public Functions</p>
<dl class="function">
-<dt id="_CPPv3NK5arrow10UnionArray8type_idsEv">
-<span id="_CPPv2NK5arrow10UnionArray8type_idsEv"></span><span id="arrow::UnionArray::type_idsC"></span><span class="target" id="classarrow_1_1_union_array_1a679049e92aec3deacda4178e55cd1215"></span>std::shared_ptr<<a class="reference internal" href="memory.html#_CPPv3N5arrow6BufferE" title="arrow::Buffer">Buffer</a>> <code class="descname">type_ids</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPP [...]
+<dt id="_CPPv4NK5arrow10UnionArray8type_idsEv">
+<span id="_CPPv3NK5arrow10UnionArray8type_idsEv"></span><span id="_CPPv2NK5arrow10UnionArray8type_idsEv"></span><span id="arrow::UnionArray::type_idsC"></span><span class="target" id="classarrow_1_1_union_array_1a679049e92aec3deacda4178e55cd1215"></span>std::shared_ptr<<a class="reference internal" href="memory.html#_CPPv4N5arrow6BufferE" title="arrow::Buffer">Buffer</a>> <code class="descname">type_ids</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em clas [...]
<dd><p>Note that this buffer does not account for any slice offset. </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3NK5arrow10UnionArray13value_offsetsEv">
-<span id="_CPPv2NK5arrow10UnionArray13value_offsetsEv"></span><span id="arrow::UnionArray::value_offsetsC"></span><span class="target" id="classarrow_1_1_union_array_1a8b2f7da8a7e992670924f06d40c3fd58"></span>std::shared_ptr<<a class="reference internal" href="memory.html#_CPPv3N5arrow6BufferE" title="arrow::Buffer">Buffer</a>> <code class="descname">value_offsets</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerl [...]
+<dt id="_CPPv4NK5arrow10UnionArray13value_offsetsEv">
+<span id="_CPPv3NK5arrow10UnionArray13value_offsetsEv"></span><span id="_CPPv2NK5arrow10UnionArray13value_offsetsEv"></span><span id="arrow::UnionArray::value_offsetsC"></span><span class="target" id="classarrow_1_1_union_array_1a8b2f7da8a7e992670924f06d40c3fd58"></span>std::shared_ptr<<a class="reference internal" href="memory.html#_CPPv4N5arrow6BufferE" title="arrow::Buffer">Buffer</a>> <code class="descname">value_offsets</code><span class="sig-paren">(</span><span class="sig-pa [...]
<dd><p>Note that this buffer does not account for any slice offset. </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3NK5arrow10UnionArray11UnsafeChildEi">
-<span id="_CPPv2NK5arrow10UnionArray11UnsafeChildEi"></span><span id="arrow::UnionArray::UnsafeChild__iC"></span><span class="target" id="classarrow_1_1_union_array_1ad8d6e36f334279b7ba7e0863fb3e2934"></span><em class="property">const</em> <a class="reference internal" href="#_CPPv3N5arrow5ArrayE" title="arrow::Array">Array</a> *<code class="descname">UnsafeChild</code><span class="sig-paren">(</span>int <em>pos</em><span class="sig-paren">)</span> <em class="property">const</em><a class [...]
+<dt id="_CPPv4NK5arrow10UnionArray11UnsafeChildEi">
+<span id="_CPPv3NK5arrow10UnionArray11UnsafeChildEi"></span><span id="_CPPv2NK5arrow10UnionArray11UnsafeChildEi"></span><span id="arrow::UnionArray::UnsafeChild__iC"></span><span class="target" id="classarrow_1_1_union_array_1ad8d6e36f334279b7ba7e0863fb3e2934"></span><em class="property">const</em> <a class="reference internal" href="#_CPPv4N5arrow5ArrayE" title="arrow::Array">Array</a> *<code class="descname">UnsafeChild</code><span class="sig-paren">(</span>int <em>pos</em><span class= [...]
<dd><p>Only use this while the <a class="reference internal" href="#classarrow_1_1_union_array"><span class="std std-ref">UnionArray</span></a> is in scope. </p>
</dd></dl>
@@ -503,8 +524,8 @@
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric">Public Static Functions</p>
<dl class="function">
-<dt id="_CPPv3N5arrow10UnionArray9MakeDenseERK5ArrayRK5ArrayRKNSt6vectorINSt10shared_ptrI5ArrayEEEEPNSt10shared_ptrI5ArrayEE">
-<span id="_CPPv2N5arrow10UnionArray9MakeDenseERK5ArrayRK5ArrayRKNSt6vectorINSt10shared_ptrI5ArrayEEEEPNSt10shared_ptrI5ArrayEE"></span><span id="arrow::UnionArray::MakeDense__ArrayCR.ArrayCR.std::vector:std::shared_ptr:Array::CR.std::shared_ptr:Array:P"></span><span class="target" id="classarrow_1_1_union_array_1a1e25bd6a74bb47aee3612d82516ae9fe"></span><em class="property">static</em> <a class="reference internal" href="support.html#_CPPv3N5arrow6StatusE" title="arrow::Status">Status</a [...]
+<dt id="_CPPv4N5arrow10UnionArray9MakeDenseERK5ArrayRK5ArrayRKNSt6vectorINSt10shared_ptrI5ArrayEEEEPNSt10shared_ptrI5ArrayEE">
+<span id="_CPPv3N5arrow10UnionArray9MakeDenseERK5ArrayRK5ArrayRKNSt6vectorINSt10shared_ptrI5ArrayEEEEPNSt10shared_ptrI5ArrayEE"></span><span id="_CPPv2N5arrow10UnionArray9MakeDenseERK5ArrayRK5ArrayRKNSt6vectorINSt10shared_ptrI5ArrayEEEEPNSt10shared_ptrI5ArrayEE"></span><span id="arrow::UnionArray::MakeDense__ArrayCR.ArrayCR.std::vector:std::shared_ptr:Array::CR.std::shared_ptr:Array:P"></span><span class="target" id="classarrow_1_1_union_array_1a1e25bd6a74bb47aee3612d82516ae9fe"></span>< [...]
<dd><p>Construct Dense <a class="reference internal" href="#classarrow_1_1_union_array"><span class="std std-ref">UnionArray</span></a> from types_ids, value_offsets and children. </p>
<p>This function does the bare minimum of validation of the offsets and input types. The value_offsets are assumed to be well-formed.</p>
<p><dl class="docutils">
@@ -521,8 +542,8 @@
</dd></dl>
<dl class="function">
-<dt id="_CPPv3N5arrow10UnionArray10MakeSparseERK5ArrayRKNSt6vectorINSt10shared_ptrI5ArrayEEEEPNSt10shared_ptrI5ArrayEE">
-<span id="_CPPv2N5arrow10UnionArray10MakeSparseERK5ArrayRKNSt6vectorINSt10shared_ptrI5ArrayEEEEPNSt10shared_ptrI5ArrayEE"></span><span id="arrow::UnionArray::MakeSparse__ArrayCR.std::vector:std::shared_ptr:Array::CR.std::shared_ptr:Array:P"></span><span class="target" id="classarrow_1_1_union_array_1a570002863522922769fde0ad36260f7f"></span><em class="property">static</em> <a class="reference internal" href="support.html#_CPPv3N5arrow6StatusE" title="arrow::Status">Status</a> <code class [...]
+<dt id="_CPPv4N5arrow10UnionArray10MakeSparseERK5ArrayRKNSt6vectorINSt10shared_ptrI5ArrayEEEEPNSt10shared_ptrI5ArrayEE">
+<span id="_CPPv3N5arrow10UnionArray10MakeSparseERK5ArrayRKNSt6vectorINSt10shared_ptrI5ArrayEEEEPNSt10shared_ptrI5ArrayEE"></span><span id="_CPPv2N5arrow10UnionArray10MakeSparseERK5ArrayRKNSt6vectorINSt10shared_ptrI5ArrayEEEEPNSt10shared_ptrI5ArrayEE"></span><span id="arrow::UnionArray::MakeSparse__ArrayCR.std::vector:std::shared_ptr:Array::CR.std::shared_ptr:Array:P"></span><span class="target" id="classarrow_1_1_union_array_1a570002863522922769fde0ad36260f7f"></span><em class="property" [...]
<dd><p>Construct Sparse <a class="reference internal" href="#classarrow_1_1_union_array"><span class="std std-ref">UnionArray</span></a> from type_ids and children. </p>
<p>This function does the bare minimum of validation of the offsets and input types.</p>
<p><dl class="docutils">
@@ -541,26 +562,26 @@
</dd></dl>
<dl class="class">
-<dt id="_CPPv3N5arrow9ListArrayE">
-<span id="_CPPv2N5arrow9ListArrayE"></span><span id="arrow::ListArray"></span><span class="target" id="classarrow_1_1_list_array"></span><em class="property">class </em><code class="descname">ListArray</code> : <em class="property">public</em> arrow::<a class="reference internal" href="#_CPPv3N5arrow5ArrayE" title="arrow::Array">Array</a><a class="headerlink" href="#_CPPv3N5arrow9ListArrayE" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4N5arrow9ListArrayE">
+<span id="_CPPv3N5arrow9ListArrayE"></span><span id="_CPPv2N5arrow9ListArrayE"></span><span id="arrow::ListArray"></span><span class="target" id="classarrow_1_1_list_array"></span><em class="property">class </em><code class="descname">ListArray</code> : <em class="property">public</em> arrow::<a class="reference internal" href="#_CPPv4N5arrow5ArrayE" title="arrow::Array">Array</a><a class="headerlink" href="#_CPPv4N5arrow9ListArrayE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Concrete <a class="reference internal" href="#classarrow_1_1_array"><span class="std std-ref">Array</span></a> class for list data. </p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric">Public Functions</p>
<dl class="function">
-<dt id="_CPPv3NK5arrow9ListArray6valuesEv">
-<span id="_CPPv2NK5arrow9ListArray6valuesEv"></span><span id="arrow::ListArray::valuesC"></span><span class="target" id="classarrow_1_1_list_array_1a9e35034963e4e4f37ae5d84847ba4603"></span>std::shared_ptr<<a class="reference internal" href="#_CPPv3N5arrow5ArrayE" title="arrow::Array">Array</a>> <code class="descname">values</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv3NK5arrow9ListArray6val [...]
+<dt id="_CPPv4NK5arrow9ListArray6valuesEv">
+<span id="_CPPv3NK5arrow9ListArray6valuesEv"></span><span id="_CPPv2NK5arrow9ListArray6valuesEv"></span><span id="arrow::ListArray::valuesC"></span><span class="target" id="classarrow_1_1_list_array_1a9e35034963e4e4f37ae5d84847ba4603"></span>std::shared_ptr<<a class="reference internal" href="#_CPPv4N5arrow5ArrayE" title="arrow::Array">Array</a>> <code class="descname">values</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a cl [...]
<dd><p>Return array object containing the list’s values. </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3NK5arrow9ListArray13value_offsetsEv">
-<span id="_CPPv2NK5arrow9ListArray13value_offsetsEv"></span><span id="arrow::ListArray::value_offsetsC"></span><span class="target" id="classarrow_1_1_list_array_1ac81bd6404ab50657916f5ce3d0029dd4"></span>std::shared_ptr<<a class="reference internal" href="memory.html#_CPPv3N5arrow6BufferE" title="arrow::Buffer">Buffer</a>> <code class="descname">value_offsets</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" [...]
+<dt id="_CPPv4NK5arrow9ListArray13value_offsetsEv">
+<span id="_CPPv3NK5arrow9ListArray13value_offsetsEv"></span><span id="_CPPv2NK5arrow9ListArray13value_offsetsEv"></span><span id="arrow::ListArray::value_offsetsC"></span><span class="target" id="classarrow_1_1_list_array_1ac81bd6404ab50657916f5ce3d0029dd4"></span>std::shared_ptr<<a class="reference internal" href="memory.html#_CPPv4N5arrow6BufferE" title="arrow::Buffer">Buffer</a>> <code class="descname">value_offsets</code><span class="sig-paren">(</span><span class="sig-paren">) [...]
<dd><p>Note that this buffer does not account for any slice offset. </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3NK5arrow9ListArray17raw_value_offsetsEv">
-<span id="_CPPv2NK5arrow9ListArray17raw_value_offsetsEv"></span><span id="arrow::ListArray::raw_value_offsetsC"></span><span class="target" id="classarrow_1_1_list_array_1a211baa16fe1ddfc52933f2bc09441e75"></span><em class="property">const</em> int32_t *<code class="descname">raw_value_offsets</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv3NK5arrow9ListArray17raw_value_offsetsEv" title="Permalink to [...]
+<dt id="_CPPv4NK5arrow9ListArray17raw_value_offsetsEv">
+<span id="_CPPv3NK5arrow9ListArray17raw_value_offsetsEv"></span><span id="_CPPv2NK5arrow9ListArray17raw_value_offsetsEv"></span><span id="arrow::ListArray::raw_value_offsetsC"></span><span class="target" id="classarrow_1_1_list_array_1a211baa16fe1ddfc52933f2bc09441e75"></span><em class="property">const</em> int32_t *<code class="descname">raw_value_offsets</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_C [...]
<dd><p>Return pointer to raw value offsets accounting for any slice offset. </p>
</dd></dl>
@@ -568,8 +589,8 @@
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric">Public Static Functions</p>
<dl class="function">
-<dt id="_CPPv3N5arrow9ListArray10FromArraysERK5ArrayRK5ArrayP10MemoryPoolPNSt10shared_ptrI5ArrayEE">
-<span id="_CPPv2N5arrow9ListArray10FromArraysERK5ArrayRK5ArrayP10MemoryPoolPNSt10shared_ptrI5ArrayEE"></span><span id="arrow::ListArray::FromArrays__ArrayCR.ArrayCR.MemoryPoolP.std::shared_ptr:Array:P"></span><span class="target" id="classarrow_1_1_list_array_1a62dff3a3932441aeeaa0d768adec91ca"></span><em class="property">static</em> <a class="reference internal" href="support.html#_CPPv3N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descname">FromArrays</code><span class [...]
+<dt id="_CPPv4N5arrow9ListArray10FromArraysERK5ArrayRK5ArrayP10MemoryPoolPNSt10shared_ptrI5ArrayEE">
+<span id="_CPPv3N5arrow9ListArray10FromArraysERK5ArrayRK5ArrayP10MemoryPoolPNSt10shared_ptrI5ArrayEE"></span><span id="_CPPv2N5arrow9ListArray10FromArraysERK5ArrayRK5ArrayP10MemoryPoolPNSt10shared_ptrI5ArrayEE"></span><span id="arrow::ListArray::FromArrays__ArrayCR.ArrayCR.MemoryPoolP.std::shared_ptr:Array:P"></span><span class="target" id="classarrow_1_1_list_array_1a62dff3a3932441aeeaa0d768adec91ca"></span><em class="property">static</em> <a class="reference internal" href="support.htm [...]
<dd><p>Construct <a class="reference internal" href="#classarrow_1_1_list_array"><span class="std std-ref">ListArray</span></a> from array of offsets and child value array. </p>
<p>This function does the bare minimum of validation of the offsets and input types, and will allocate a new offsets array if necessary (i.e. if the offsets contain any nulls). If the offsets do not have nulls, they are assumed to be well-formed</p>
<p><dl class="docutils">
@@ -589,20 +610,20 @@
</dd></dl>
<dl class="class">
-<dt id="_CPPv3N5arrow11StructArrayE">
-<span id="_CPPv2N5arrow11StructArrayE"></span><span id="arrow::StructArray"></span><span class="target" id="classarrow_1_1_struct_array"></span><em class="property">class </em><code class="descname">StructArray</code> : <em class="property">public</em> arrow::<a class="reference internal" href="#_CPPv3N5arrow5ArrayE" title="arrow::Array">Array</a><a class="headerlink" href="#_CPPv3N5arrow11StructArrayE" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4N5arrow11StructArrayE">
+<span id="_CPPv3N5arrow11StructArrayE"></span><span id="_CPPv2N5arrow11StructArrayE"></span><span id="arrow::StructArray"></span><span class="target" id="classarrow_1_1_struct_array"></span><em class="property">class </em><code class="descname">StructArray</code> : <em class="property">public</em> arrow::<a class="reference internal" href="#_CPPv4N5arrow5ArrayE" title="arrow::Array">Array</a><a class="headerlink" href="#_CPPv4N5arrow11StructArrayE" title="Permalink to this definition">¶< [...]
<dd><p>Concrete <a class="reference internal" href="#classarrow_1_1_array"><span class="std std-ref">Array</span></a> class for struct data. </p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric">Public Functions</p>
<dl class="function">
-<dt id="_CPPv3NK5arrow11StructArray14GetFieldByNameERKNSt6stringE">
-<span id="_CPPv2NK5arrow11StructArray14GetFieldByNameERKNSt6stringE"></span><span id="arrow::StructArray::GetFieldByName__ssCRC"></span><span class="target" id="classarrow_1_1_struct_array_1a3ae1f625a93bdc6592821e7e9ef3f054"></span>std::shared_ptr<<a class="reference internal" href="#_CPPv3N5arrow5ArrayE" title="arrow::Array">Array</a>> <code class="descname">GetFieldByName</code><span class="sig-paren">(</span><em class="property">const</em> std::string &<em>name</em><span cla [...]
+<dt id="_CPPv4NK5arrow11StructArray14GetFieldByNameERKNSt6stringE">
+<span id="_CPPv3NK5arrow11StructArray14GetFieldByNameERKNSt6stringE"></span><span id="_CPPv2NK5arrow11StructArray14GetFieldByNameERKNSt6stringE"></span><span id="arrow::StructArray::GetFieldByName__ssCRC"></span><span class="target" id="classarrow_1_1_struct_array_1a3ae1f625a93bdc6592821e7e9ef3f054"></span>std::shared_ptr<<a class="reference internal" href="#_CPPv4N5arrow5ArrayE" title="arrow::Array">Array</a>> <code class="descname">GetFieldByName</code><span class="sig-paren">(</ [...]
<dd><p>Returns null if name not found. </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3NK5arrow11StructArray7FlattenEP10MemoryPoolP11ArrayVector">
-<span id="_CPPv2NK5arrow11StructArray7FlattenEP10MemoryPoolP11ArrayVector"></span><span id="arrow::StructArray::Flatten__MemoryPoolP.ArrayVectorPC"></span><span class="target" id="classarrow_1_1_struct_array_1a33cb8ba10aa4e3ea908c1711cbaa3c5b"></span><a class="reference internal" href="support.html#_CPPv3N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descname">Flatten</code><span class="sig-paren">(</span><a class="reference internal" href="memory.html#_CPPv3N5arrow10Memo [...]
+<dt id="_CPPv4NK5arrow11StructArray7FlattenEP10MemoryPoolP11ArrayVector">
+<span id="_CPPv3NK5arrow11StructArray7FlattenEP10MemoryPoolP11ArrayVector"></span><span id="_CPPv2NK5arrow11StructArray7FlattenEP10MemoryPoolP11ArrayVector"></span><span id="arrow::StructArray::Flatten__MemoryPoolP.ArrayVectorPC"></span><span class="target" id="classarrow_1_1_struct_array_1a33cb8ba10aa4e3ea908c1711cbaa3c5b"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descname">Flatten</code><span class="sig- [...]
<dd><p>Flatten this array as a vector of arrays, one for each field. </p>
<p><dl class="docutils">
<dt><strong>Parameters</strong></dt>
@@ -623,34 +644,34 @@
<div class="section" id="chunked-arrays">
<h2>Chunked Arrays<a class="headerlink" href="#chunked-arrays" title="Permalink to this headline">¶</a></h2>
<dl class="class">
-<dt id="_CPPv3N5arrow12ChunkedArrayE">
-<span id="_CPPv2N5arrow12ChunkedArrayE"></span><span id="arrow::ChunkedArray"></span><span class="target" id="classarrow_1_1_chunked_array"></span><em class="property">class </em><code class="descname">ChunkedArray</code><a class="headerlink" href="#_CPPv3N5arrow12ChunkedArrayE" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4N5arrow12ChunkedArrayE">
+<span id="_CPPv3N5arrow12ChunkedArrayE"></span><span id="_CPPv2N5arrow12ChunkedArrayE"></span><span id="arrow::ChunkedArray"></span><span class="target" id="classarrow_1_1_chunked_array"></span><em class="property">class </em><code class="descname">ChunkedArray</code><a class="headerlink" href="#_CPPv4N5arrow12ChunkedArrayE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>A data structure managing a list of primitive Arrow arrays logically as one large array. </p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric">Public Functions</p>
<dl class="function">
-<dt id="_CPPv3N5arrow12ChunkedArray12ChunkedArrayERK11ArrayVector">
-<span id="_CPPv2N5arrow12ChunkedArray12ChunkedArrayERK11ArrayVector"></span><span id="arrow::ChunkedArray::ChunkedArray__ArrayVectorCR"></span><span class="target" id="classarrow_1_1_chunked_array_1a2640fe6c89743e608e6e2495d5041d87"></span><code class="descname">ChunkedArray</code><span class="sig-paren">(</span><em class="property">const</em> ArrayVector &<em>chunks</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv3N5arrow12ChunkedArray12ChunkedArrayERK11ArrayVe [...]
+<dt id="_CPPv4N5arrow12ChunkedArray12ChunkedArrayERK11ArrayVector">
+<span id="_CPPv3N5arrow12ChunkedArray12ChunkedArrayERK11ArrayVector"></span><span id="_CPPv2N5arrow12ChunkedArray12ChunkedArrayERK11ArrayVector"></span><span id="arrow::ChunkedArray::ChunkedArray__ArrayVectorCR"></span><span class="target" id="classarrow_1_1_chunked_array_1a2640fe6c89743e608e6e2495d5041d87"></span><code class="descname">ChunkedArray</code><span class="sig-paren">(</span><em class="property">const</em> ArrayVector &<em>chunks</em><span class="sig-paren">)</span><a cla [...]
<dd><p>Construct a chunked array from a vector of arrays. </p>
<p>The vector should be non-empty and all its elements should have the same data type. </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3N5arrow12ChunkedArray12ChunkedArrayERKNSt10shared_ptrI5ArrayEE">
-<span id="_CPPv2N5arrow12ChunkedArray12ChunkedArrayERKNSt10shared_ptrI5ArrayEE"></span><span id="arrow::ChunkedArray::ChunkedArray__std::shared_ptr:Array:CR"></span><span class="target" id="classarrow_1_1_chunked_array_1a09cbc488c79b1ee9d20526fc99d71d93"></span><code class="descname">ChunkedArray</code><span class="sig-paren">(</span><em class="property">const</em> std::shared_ptr<<a class="reference internal" href="#_CPPv3N5arrow5ArrayE" title="arrow::Array">Array</a>> &<em>ch [...]
+<dt id="_CPPv4N5arrow12ChunkedArray12ChunkedArrayERKNSt10shared_ptrI5ArrayEE">
+<span id="_CPPv3N5arrow12ChunkedArray12ChunkedArrayERKNSt10shared_ptrI5ArrayEE"></span><span id="_CPPv2N5arrow12ChunkedArray12ChunkedArrayERKNSt10shared_ptrI5ArrayEE"></span><span id="arrow::ChunkedArray::ChunkedArray__std::shared_ptr:Array:CR"></span><span class="target" id="classarrow_1_1_chunked_array_1a09cbc488c79b1ee9d20526fc99d71d93"></span><code class="descname">ChunkedArray</code><span class="sig-paren">(</span><em class="property">const</em> std::shared_ptr<<a class="referenc [...]
<dd><p>Construct a chunked array from a single <a class="reference internal" href="#classarrow_1_1_array"><span class="std std-ref">Array</span></a>. </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3N5arrow12ChunkedArray12ChunkedArrayERK11ArrayVectorRKNSt10shared_ptrI8DataTypeEE">
-<span id="_CPPv2N5arrow12ChunkedArray12ChunkedArrayERK11ArrayVectorRKNSt10shared_ptrI8DataTypeEE"></span><span id="arrow::ChunkedArray::ChunkedArray__ArrayVectorCR.std::shared_ptr:DataType:CR"></span><span class="target" id="classarrow_1_1_chunked_array_1ae73d53d335133270c6653e5de0d352cc"></span><code class="descname">ChunkedArray</code><span class="sig-paren">(</span><em class="property">const</em> ArrayVector &<em>chunks</em>, <em class="property">const</em> std::shared_ptr<<a c [...]
+<dt id="_CPPv4N5arrow12ChunkedArray12ChunkedArrayERK11ArrayVectorRKNSt10shared_ptrI8DataTypeEE">
+<span id="_CPPv3N5arrow12ChunkedArray12ChunkedArrayERK11ArrayVectorRKNSt10shared_ptrI8DataTypeEE"></span><span id="_CPPv2N5arrow12ChunkedArray12ChunkedArrayERK11ArrayVectorRKNSt10shared_ptrI8DataTypeEE"></span><span id="arrow::ChunkedArray::ChunkedArray__ArrayVectorCR.std::shared_ptr:DataType:CR"></span><span class="target" id="classarrow_1_1_chunked_array_1ae73d53d335133270c6653e5de0d352cc"></span><code class="descname">ChunkedArray</code><span class="sig-paren">(</span><em class="prope [...]
<dd><p>Construct a chunked array from a vector of arrays and a data type. </p>
<p>As the data type is passed explicitly, the vector may be empty. </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3NK5arrow12ChunkedArray6lengthEv">
-<span id="_CPPv2NK5arrow12ChunkedArray6lengthEv"></span><span id="arrow::ChunkedArray::lengthC"></span><span class="target" id="classarrow_1_1_chunked_array_1a4df41bf1a05cd1083a2c4502e0a85f87"></span>int64_t <code class="descname">length</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv3NK5arrow12ChunkedArray6lengthEv" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4NK5arrow12ChunkedArray6lengthEv">
+<span id="_CPPv3NK5arrow12ChunkedArray6lengthEv"></span><span id="_CPPv2NK5arrow12ChunkedArray6lengthEv"></span><span id="arrow::ChunkedArray::lengthC"></span><span class="target" id="classarrow_1_1_chunked_array_1a4df41bf1a05cd1083a2c4502e0a85f87"></span>int64_t <code class="descname">length</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv4NK5arrow12ChunkedArray6lengthEv" title="Permalink to this def [...]
<dd><p><dl class="docutils">
<dt><strong>Return</strong></dt>
<dd>the total length of the chunked array; computed on construction </dd>
@@ -659,8 +680,8 @@
</dd></dl>
<dl class="function">
-<dt id="_CPPv3NK5arrow12ChunkedArray10null_countEv">
-<span id="_CPPv2NK5arrow12ChunkedArray10null_countEv"></span><span id="arrow::ChunkedArray::null_countC"></span><span class="target" id="classarrow_1_1_chunked_array_1a962541b044ac5a7a6a87499cef7957bb"></span>int64_t <code class="descname">null_count</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv3NK5arrow12ChunkedArray10null_countEv" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4NK5arrow12ChunkedArray10null_countEv">
+<span id="_CPPv3NK5arrow12ChunkedArray10null_countEv"></span><span id="_CPPv2NK5arrow12ChunkedArray10null_countEv"></span><span id="arrow::ChunkedArray::null_countC"></span><span class="target" id="classarrow_1_1_chunked_array_1a962541b044ac5a7a6a87499cef7957bb"></span>int64_t <code class="descname">null_count</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv4NK5arrow12ChunkedArray10null_countEv" title [...]
<dd><p><dl class="docutils">
<dt><strong>Return</strong></dt>
<dd>the total number of nulls among all chunks </dd>
@@ -669,8 +690,8 @@
</dd></dl>
<dl class="function">
-<dt id="_CPPv3NK5arrow12ChunkedArray5chunkEi">
-<span id="_CPPv2NK5arrow12ChunkedArray5chunkEi"></span><span id="arrow::ChunkedArray::chunk__iC"></span><span class="target" id="classarrow_1_1_chunked_array_1a92ec02f5904ac3e4dac5328e44ebf0fb"></span>std::shared_ptr<<a class="reference internal" href="#_CPPv3N5arrow5ArrayE" title="arrow::Array">Array</a>> <code class="descname">chunk</code><span class="sig-paren">(</span>int <em>i</em><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPP [...]
+<dt id="_CPPv4NK5arrow12ChunkedArray5chunkEi">
+<span id="_CPPv3NK5arrow12ChunkedArray5chunkEi"></span><span id="_CPPv2NK5arrow12ChunkedArray5chunkEi"></span><span id="arrow::ChunkedArray::chunk__iC"></span><span class="target" id="classarrow_1_1_chunked_array_1a92ec02f5904ac3e4dac5328e44ebf0fb"></span>std::shared_ptr<<a class="reference internal" href="#_CPPv4N5arrow5ArrayE" title="arrow::Array">Array</a>> <code class="descname">chunk</code><span class="sig-paren">(</span>int <em>i</em><span class="sig-paren">)</span> <em class [...]
<dd><p><dl class="docutils">
<dt><strong>Return</strong></dt>
<dd>chunk a particular chunk from the chunked array </dd>
@@ -679,8 +700,8 @@
</dd></dl>
<dl class="function">
-<dt id="_CPPv3NK5arrow12ChunkedArray5SliceE7int64_t7int64_t">
-<span id="_CPPv2NK5arrow12ChunkedArray5SliceE7int64_t7int64_t"></span><span id="arrow::ChunkedArray::Slice__int64_t.int64_tC"></span><span class="target" id="classarrow_1_1_chunked_array_1a99573028501f20b3f0707d85e8cce2ad"></span>std::shared_ptr<<a class="reference internal" href="#_CPPv3N5arrow12ChunkedArrayE" title="arrow::ChunkedArray">ChunkedArray</a>> <code class="descname">Slice</code><span class="sig-paren">(</span>int64_t <em>offset</em>, int64_t <em>length</em><span class= [...]
+<dt id="_CPPv4NK5arrow12ChunkedArray5SliceE7int64_t7int64_t">
+<span id="_CPPv3NK5arrow12ChunkedArray5SliceE7int64_t7int64_t"></span><span id="_CPPv2NK5arrow12ChunkedArray5SliceE7int64_t7int64_t"></span><span id="arrow::ChunkedArray::Slice__int64_t.int64_tC"></span><span class="target" id="classarrow_1_1_chunked_array_1a99573028501f20b3f0707d85e8cce2ad"></span>std::shared_ptr<<a class="reference internal" href="#_CPPv4N5arrow12ChunkedArrayE" title="arrow::ChunkedArray">ChunkedArray</a>> <code class="descname">Slice</code><span class="sig-paren [...]
<dd><p>Construct a zero-copy slice of the chunked array with the indicated offset and length. </p>
<p><dl class="docutils">
<dt><strong>Return</strong></dt>
@@ -696,14 +717,14 @@
</dd></dl>
<dl class="function">
-<dt id="_CPPv3NK5arrow12ChunkedArray5SliceE7int64_t">
-<span id="_CPPv2NK5arrow12ChunkedArray5SliceE7int64_t"></span><span id="arrow::ChunkedArray::Slice__int64_tC"></span><span class="target" id="classarrow_1_1_chunked_array_1abf30b26c92cf037191e8574763e22a2e"></span>std::shared_ptr<<a class="reference internal" href="#_CPPv3N5arrow12ChunkedArrayE" title="arrow::ChunkedArray">ChunkedArray</a>> <code class="descname">Slice</code><span class="sig-paren">(</span>int64_t <em>offset</em><span class="sig-paren">)</span> <em class="property" [...]
+<dt id="_CPPv4NK5arrow12ChunkedArray5SliceE7int64_t">
+<span id="_CPPv3NK5arrow12ChunkedArray5SliceE7int64_t"></span><span id="_CPPv2NK5arrow12ChunkedArray5SliceE7int64_t"></span><span id="arrow::ChunkedArray::Slice__int64_tC"></span><span class="target" id="classarrow_1_1_chunked_array_1abf30b26c92cf037191e8574763e22a2e"></span>std::shared_ptr<<a class="reference internal" href="#_CPPv4N5arrow12ChunkedArrayE" title="arrow::ChunkedArray">ChunkedArray</a>> <code class="descname">Slice</code><span class="sig-paren">(</span>int64_t <em>of [...]
<dd><p>Slice from offset until end of the chunked array. </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3NK5arrow12ChunkedArray7FlattenEP10MemoryPoolPNSt6vectorINSt10shared_ptrI12ChunkedArrayEEEE">
-<span id="_CPPv2NK5arrow12ChunkedArray7FlattenEP10MemoryPoolPNSt6vectorINSt10shared_ptrI12ChunkedArrayEEEE"></span><span id="arrow::ChunkedArray::Flatten__MemoryPoolP.std::vector:std::shared_ptr:ChunkedArray::PC"></span><span class="target" id="classarrow_1_1_chunked_array_1a8d4af28e378addf17162ad421bc0cdd6"></span><a class="reference internal" href="support.html#_CPPv3N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descname">Flatten</code><span class="sig-paren">(</span>< [...]
+<dt id="_CPPv4NK5arrow12ChunkedArray7FlattenEP10MemoryPoolPNSt6vectorINSt10shared_ptrI12ChunkedArrayEEEE">
+<span id="_CPPv3NK5arrow12ChunkedArray7FlattenEP10MemoryPoolPNSt6vectorINSt10shared_ptrI12ChunkedArrayEEEE"></span><span id="_CPPv2NK5arrow12ChunkedArray7FlattenEP10MemoryPoolPNSt6vectorINSt10shared_ptrI12ChunkedArrayEEEE"></span><span id="arrow::ChunkedArray::Flatten__MemoryPoolP.std::vector:std::shared_ptr:ChunkedArray::PC"></span><span class="target" id="classarrow_1_1_chunked_array_1a8d4af28e378addf17162ad421bc0cdd6"></span><a class="reference internal" href="support.html#_CPPv4N5arr [...]
<dd><p>Flatten this chunked array as a vector of chunked arrays, one for each struct field. </p>
<p><dl class="docutils">
<dt><strong>Parameters</strong></dt>
@@ -717,15 +738,15 @@
</dd></dl>
<dl class="function">
-<dt id="_CPPv3NK5arrow12ChunkedArray6EqualsERK12ChunkedArray">
-<span id="_CPPv2NK5arrow12ChunkedArray6EqualsERK12ChunkedArray"></span><span id="arrow::ChunkedArray::Equals__ChunkedArrayCRC"></span><span class="target" id="classarrow_1_1_chunked_array_1ab7ad74cc587d5d622c7e62cbf1b0b9f9"></span>bool <code class="descname">Equals</code><span class="sig-paren">(</span><em class="property">const</em> <a class="reference internal" href="#_CPPv3N5arrow12ChunkedArrayE" title="arrow::ChunkedArray">ChunkedArray</a> &<em>other</em><span class="sig-paren">) [...]
+<dt id="_CPPv4NK5arrow12ChunkedArray6EqualsERK12ChunkedArray">
+<span id="_CPPv3NK5arrow12ChunkedArray6EqualsERK12ChunkedArray"></span><span id="_CPPv2NK5arrow12ChunkedArray6EqualsERK12ChunkedArray"></span><span id="arrow::ChunkedArray::Equals__ChunkedArrayCRC"></span><span class="target" id="classarrow_1_1_chunked_array_1ab7ad74cc587d5d622c7e62cbf1b0b9f9"></span>bool <code class="descname">Equals</code><span class="sig-paren">(</span><em class="property">const</em> <a class="reference internal" href="#_CPPv4N5arrow12ChunkedArrayE" title="arrow::Chun [...]
<dd><p>Determine if two chunked arrays are equal. </p>
<p>Two chunked arrays can be equal only if they have equal datatypes. However, they may be equal even if they have different chunkings. </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3NK5arrow12ChunkedArray6EqualsERKNSt10shared_ptrI12ChunkedArrayEE">
-<span id="_CPPv2NK5arrow12ChunkedArray6EqualsERKNSt10shared_ptrI12ChunkedArrayEE"></span><span id="arrow::ChunkedArray::Equals__std::shared_ptr:ChunkedArray:CRC"></span><span class="target" id="classarrow_1_1_chunked_array_1a67c23032d122d1a87acf0bc2b2e52d54"></span>bool <code class="descname">Equals</code><span class="sig-paren">(</span><em class="property">const</em> std::shared_ptr<<a class="reference internal" href="#_CPPv3N5arrow12ChunkedArrayE" title="arrow::ChunkedArray">Chunked [...]
+<dt id="_CPPv4NK5arrow12ChunkedArray6EqualsERKNSt10shared_ptrI12ChunkedArrayEE">
+<span id="_CPPv3NK5arrow12ChunkedArray6EqualsERKNSt10shared_ptrI12ChunkedArrayEE"></span><span id="_CPPv2NK5arrow12ChunkedArray6EqualsERKNSt10shared_ptrI12ChunkedArrayEE"></span><span id="arrow::ChunkedArray::Equals__std::shared_ptr:ChunkedArray:CRC"></span><span class="target" id="classarrow_1_1_chunked_array_1a67c23032d122d1a87acf0bc2b2e52d54"></span>bool <code class="descname">Equals</code><span class="sig-paren">(</span><em class="property">const</em> std::shared_ptr<<a class="ref [...]
<dd><p>Determine if two chunked arrays are equal. </p>
</dd></dl>
@@ -746,7 +767,7 @@
<a href="builder.html" class="btn btn-neutral float-right" title="Array Builders" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
- <a href="datatype.html" class="btn btn-neutral" title="Data Types" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+ <a href="datatype.html" class="btn btn-neutral float-left" title="Data Types" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
@@ -772,26 +793,16 @@
-
-
-
-
- <script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
- <script type="text/javascript" src="../../_static/jquery.js"></script>
- <script type="text/javascript" src="../../_static/underscore.js"></script>
- <script type="text/javascript" src="../../_static/doctools.js"></script>
- <script type="text/javascript" src="../../_static/language_data.js"></script>
-
-
-
-
- <script type="text/javascript" src="../../_static/js/theme.js"></script>
-
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
+
+
+
+
+
<script async src="https://www.googletagmanager.com/gtag/js?id=UA-107500873-1"></script>
<script>
window.dataLayer = window.dataLayer || [];
diff --git a/docs/cpp/api/builder.html b/docs/cpp/api/builder.html
index eddfa9b..2110c46 100644
--- a/docs/cpp/api/builder.html
+++ b/docs/cpp/api/builder.html
@@ -9,7 +9,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Array Builders — Apache Arrow v0.12.1.dev0+g8ca41384b.d20190120</title>
+ <title>Array Builders — Apache Arrow v0.13.0</title>
@@ -18,34 +18,36 @@
-
-
+ <script type="text/javascript" src="../../_static/js/modernizr.min.js"></script>
+ <script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
+ <script type="text/javascript" src="../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../_static/doctools.js"></script>
+ <script type="text/javascript" src="../../_static/language_data.js"></script>
+
+ <script type="text/javascript" src="../../_static/js/theme.js"></script>
-
+
+
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<link rel="index" title="Index" href="../../genindex.html" />
<link rel="search" title="Search" href="../../search.html" />
<link rel="next" title="Two-dimensional Datasets" href="table.html" />
<link rel="prev" title="Arrays" href="array.html" />
-
-
- <script src="../../_static/js/modernizr.min.js"></script>
-
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
-
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
- <div class="wy-side-nav-search">
+ <div class="wy-side-nav-search" >
@@ -59,7 +61,7 @@
<div class="version">
- 0.12.1.dev0+g8ca41384b.d20190120
+ 0.13.0
</div>
@@ -83,7 +85,7 @@
- <p class="caption"><span class="caption-text">Memory Format</span></p>
+ <p class="caption"><span class="caption-text">Arrow Columnar Format</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../format/README.html">Arrow specification documents</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../format/Guidelines.html">Implementation guidelines</a></li>
@@ -91,11 +93,11 @@
<li class="toctree-l1"><a class="reference internal" href="../../format/Metadata.html">Metadata: Logical types, schemas, data headers</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../format/IPC.html">Interprocess messaging / communication (IPC)</a></li>
</ul>
-<p class="caption"><span class="caption-text">Languages</span></p>
+<p class="caption"><span class="caption-text">Arrow Libraries</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="../index.html">C++ Implementation</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="../getting_started.html">Getting Started</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../examples.html">Examples</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../examples/index.html">Examples</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="../api.html">API Reference</a><ul class="current">
<li class="toctree-l3"><a class="reference internal" href="support.html">Programming Support</a></li>
<li class="toctree-l3"><a class="reference internal" href="memory.html">Memory (management)</a></li>
@@ -106,15 +108,21 @@
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="table.html">Two-dimensional Datasets</a></li>
+<li class="toctree-l3"><a class="reference internal" href="utilities.html">Utilities</a></li>
+<li class="toctree-l3"><a class="reference internal" href="cuda.html">CUDA support</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../python/index.html">Python bindings</a></li>
</ul>
-<p class="caption"><span class="caption-text">Other Topics</span></p>
+<p class="caption"><span class="caption-text">Development and Contributing</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../../building.html">Building the Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../developers/contributing.html">Contribution Guidelines</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../developers/cpp.html">C++ Development</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../developers/python.html">Python Development</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../developers/integration.html">Integration Testing</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../developers/documentation.html">Building the Documentation</a></li>
</ul>
@@ -186,8 +194,8 @@
<div class="section" id="array-builders">
<h1>Array Builders<a class="headerlink" href="#array-builders" title="Permalink to this headline">¶</a></h1>
<dl class="class">
-<dt id="_CPPv3N5arrow12ArrayBuilderE">
-<span id="_CPPv2N5arrow12ArrayBuilderE"></span><span id="arrow::ArrayBuilder"></span><span class="target" id="classarrow_1_1_array_builder"></span><em class="property">class </em><code class="descname">ArrayBuilder</code><a class="headerlink" href="#_CPPv3N5arrow12ArrayBuilderE" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4N5arrow12ArrayBuilderE">
+<span id="_CPPv3N5arrow12ArrayBuilderE"></span><span id="_CPPv2N5arrow12ArrayBuilderE"></span><span id="arrow::ArrayBuilder"></span><span class="target" id="classarrow_1_1_array_builder"></span><em class="property">class </em><code class="descname">ArrayBuilder</code><a class="headerlink" href="#_CPPv4N5arrow12ArrayBuilderE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Base class for all data array builders. </p>
<p>This class provides a facilities for incrementally building the null bitmap (see Append methods) and as a side effect the current number of slots and the null count.</p>
<p><dl class="docutils">
@@ -195,19 +203,19 @@
<dd>Users are expected to use builders as one of the concrete types below. For example, ArrayBuilder* pointing to <a class="reference internal" href="#classarrow_1_1_binary_builder"><span class="std std-ref">BinaryBuilder</span></a> should be downcast before use. </dd>
</dl>
</p>
-<p>Subclassed by <a class="reference internal" href="#classarrow_1_1_binary_builder"><span class="std std-ref">arrow::BinaryBuilder</span></a>, <a class="reference internal" href="#classarrow_1_1_boolean_builder"><span class="std std-ref">arrow::BooleanBuilder</span></a>, <a class="reference internal" href="#classarrow_1_1_dictionary_builder"><span class="std std-ref">arrow::DictionaryBuilder< T ></span></a>, arrow::DictionaryBuilder< NullType >, <a class="reference internal" [...]
+<p>Subclassed by <a class="reference internal" href="#classarrow_1_1_binary_builder"><span class="std std-ref">arrow::BinaryBuilder</span></a>, <a class="reference internal" href="#classarrow_1_1_boolean_builder"><span class="std std-ref">arrow::BooleanBuilder</span></a>, arrow::DenseUnionBuilder, <a class="reference internal" href="#classarrow_1_1_dictionary_builder"><span class="std std-ref">arrow::DictionaryBuilder< T ></span></a>, arrow::DictionaryBuilder< NullType >, <a [...]
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric">Public Functions</p>
<dl class="function">
-<dt id="_CPPv3N5arrow12ArrayBuilder5childEi">
-<span id="_CPPv2N5arrow12ArrayBuilder5childEi"></span><span id="arrow::ArrayBuilder::child__i"></span><span class="target" id="classarrow_1_1_array_builder_1aad4a1ed2c24204b1cc21e44ab0ad444b"></span><a class="reference internal" href="#_CPPv3N5arrow12ArrayBuilderE" title="arrow::ArrayBuilder">ArrayBuilder</a> *<code class="descname">child</code><span class="sig-paren">(</span>int <em>i</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv3N5arrow12ArrayBuilder5childEi" t [...]
+<dt id="_CPPv4N5arrow12ArrayBuilder5childEi">
+<span id="_CPPv3N5arrow12ArrayBuilder5childEi"></span><span id="_CPPv2N5arrow12ArrayBuilder5childEi"></span><span id="arrow::ArrayBuilder::child__i"></span><span class="target" id="classarrow_1_1_array_builder_1aad4a1ed2c24204b1cc21e44ab0ad444b"></span><a class="reference internal" href="#_CPPv4N5arrow12ArrayBuilderE" title="arrow::ArrayBuilder">ArrayBuilder</a> *<code class="descname">child</code><span class="sig-paren">(</span>int <em>i</em><span class="sig-paren">)</span><a class="hea [...]
<dd><p>For nested types. </p>
<p>Since the objects are owned by this class instance, we skip shared pointers and just return a raw pointer </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3N5arrow12ArrayBuilder6ResizeE7int64_t">
-<span id="_CPPv2N5arrow12ArrayBuilder6ResizeE7int64_t"></span><span id="arrow::ArrayBuilder::Resize__int64_t"></span><span class="target" id="classarrow_1_1_array_builder_1a994d873bec453c33fbaeb995442d520b"></span><em class="property">virtual</em> <a class="reference internal" href="support.html#_CPPv3N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descname">Resize</code><span class="sig-paren">(</span>int64_t <em>capacity</em><span class="sig-paren">)</span><a class="head [...]
+<dt id="_CPPv4N5arrow12ArrayBuilder6ResizeE7int64_t">
+<span id="_CPPv3N5arrow12ArrayBuilder6ResizeE7int64_t"></span><span id="_CPPv2N5arrow12ArrayBuilder6ResizeE7int64_t"></span><span id="arrow::ArrayBuilder::Resize__int64_t"></span><span class="target" id="classarrow_1_1_array_builder_1a994d873bec453c33fbaeb995442d520b"></span><em class="property">virtual</em> <a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descname">Resize</code><span class="sig-paren">(</span>int64_t < [...]
<dd><p>Ensure that enough memory has been allocated to fit the indicated number of total elements in the builder, including any that have already been appended. </p>
<p>Does not account for reallocations that may be due to variable size data, like binary values. To make space for incremental appends, use Reserve instead.</p>
<p><dl class="docutils">
@@ -223,8 +231,8 @@
</dd></dl>
<dl class="function">
-<dt id="_CPPv3N5arrow12ArrayBuilder7ReserveE7int64_t">
-<span id="_CPPv2N5arrow12ArrayBuilder7ReserveE7int64_t"></span><span id="arrow::ArrayBuilder::Reserve__int64_t"></span><span class="target" id="classarrow_1_1_array_builder_1afe8448fda39a8529a119bde5ba7ba119"></span><a class="reference internal" href="support.html#_CPPv3N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descname">Reserve</code><span class="sig-paren">(</span>int64_t <em>additional_capacity</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv [...]
+<dt id="_CPPv4N5arrow12ArrayBuilder7ReserveE7int64_t">
+<span id="_CPPv3N5arrow12ArrayBuilder7ReserveE7int64_t"></span><span id="_CPPv2N5arrow12ArrayBuilder7ReserveE7int64_t"></span><span id="arrow::ArrayBuilder::Reserve__int64_t"></span><span class="target" id="classarrow_1_1_array_builder_1afe8448fda39a8529a119bde5ba7ba119"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descname">Reserve</code><span class="sig-paren">(</span>int64_t <em>additional_capacity</em><sp [...]
<dd><p>Ensure that there is enough space allocated to add the indicated number of elements without any further calls to Resize. </p>
<p>The memory allocated is rounded up to the next highest power of 2 similar to memory allocations in STL containers like std::vector <dl class="docutils">
<dt><strong>Return</strong></dt>
@@ -239,21 +247,21 @@
</dd></dl>
<dl class="function">
-<dt id="_CPPv3N5arrow12ArrayBuilder5ResetEv">
-<span id="_CPPv2N5arrow12ArrayBuilder5ResetEv"></span><span id="arrow::ArrayBuilder::Reset"></span><span class="target" id="classarrow_1_1_array_builder_1a71a25653bdf242da1b3a317f4fd49a98"></span><em class="property">virtual</em> void <code class="descname">Reset</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv3N5arrow12ArrayBuilder5ResetEv" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4N5arrow12ArrayBuilder5ResetEv">
+<span id="_CPPv3N5arrow12ArrayBuilder5ResetEv"></span><span id="_CPPv2N5arrow12ArrayBuilder5ResetEv"></span><span id="arrow::ArrayBuilder::Reset"></span><span class="target" id="classarrow_1_1_array_builder_1a71a25653bdf242da1b3a317f4fd49a98"></span><em class="property">virtual</em> void <code class="descname">Reset</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow12ArrayBuilder5ResetEv" title="Permalink to this definition">¶ [...]
<dd><p>Reset the builder. </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3N5arrow12ArrayBuilder7AdvanceE7int64_t">
-<span id="_CPPv2N5arrow12ArrayBuilder7AdvanceE7int64_t"></span><span id="arrow::ArrayBuilder::Advance__int64_t"></span><span class="target" id="classarrow_1_1_array_builder_1a630ea6ee96e26b8f1a2d08b45180fb32"></span><a class="reference internal" href="support.html#_CPPv3N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descname">Advance</code><span class="sig-paren">(</span>int64_t <em>elements</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv3N5arrow12A [...]
+<dt id="_CPPv4N5arrow12ArrayBuilder7AdvanceE7int64_t">
+<span id="_CPPv3N5arrow12ArrayBuilder7AdvanceE7int64_t"></span><span id="_CPPv2N5arrow12ArrayBuilder7AdvanceE7int64_t"></span><span id="arrow::ArrayBuilder::Advance__int64_t"></span><span class="target" id="classarrow_1_1_array_builder_1a630ea6ee96e26b8f1a2d08b45180fb32"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descname">Advance</code><span class="sig-paren">(</span>int64_t <em>elements</em><span class="s [...]
<dd><p>For cases where raw data was memcpy’d into the internal buffers, allows us to advance the length of the builder. </p>
<p>It is your responsibility to use this function responsibly. </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3N5arrow12ArrayBuilder14FinishInternalEPNSt10shared_ptrI9ArrayDataEE">
-<span id="_CPPv2N5arrow12ArrayBuilder14FinishInternalEPNSt10shared_ptrI9ArrayDataEE"></span><span id="arrow::ArrayBuilder::FinishInternal__std::shared_ptr:ArrayData:P"></span><span class="target" id="classarrow_1_1_array_builder_1a0e0aea1c332b472f3671bea9da5ec473"></span><em class="property">virtual</em> <a class="reference internal" href="support.html#_CPPv3N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descname">FinishInternal</code><span class="sig-paren">(</span>std:: [...]
+<dt id="_CPPv4N5arrow12ArrayBuilder14FinishInternalEPNSt10shared_ptrI9ArrayDataEE">
+<span id="_CPPv3N5arrow12ArrayBuilder14FinishInternalEPNSt10shared_ptrI9ArrayDataEE"></span><span id="_CPPv2N5arrow12ArrayBuilder14FinishInternalEPNSt10shared_ptrI9ArrayDataEE"></span><span id="arrow::ArrayBuilder::FinishInternal__std::shared_ptr:ArrayData:P"></span><span class="target" id="classarrow_1_1_array_builder_1a0e0aea1c332b472f3671bea9da5ec473"></span><em class="property">virtual</em> <a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"> [...]
<dd><p>Return result of builder as an internal generic ArrayData object. </p>
<p>Resets builder except for dictionary builder</p>
<p><dl class="docutils">
@@ -269,8 +277,8 @@
</dd></dl>
<dl class="function">
-<dt id="_CPPv3N5arrow12ArrayBuilder6FinishEPNSt10shared_ptrI5ArrayEE">
-<span id="_CPPv2N5arrow12ArrayBuilder6FinishEPNSt10shared_ptrI5ArrayEE"></span><span id="arrow::ArrayBuilder::Finish__std::shared_ptr:Array:P"></span><span class="target" id="classarrow_1_1_array_builder_1a67b2227edb4b51bc44425f1c8a439819"></span><a class="reference internal" href="support.html#_CPPv3N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descname">Finish</code><span class="sig-paren">(</span>std::shared_ptr<<a class="reference internal" href="array.html#_CPPv3 [...]
+<dt id="_CPPv4N5arrow12ArrayBuilder6FinishEPNSt10shared_ptrI5ArrayEE">
+<span id="_CPPv3N5arrow12ArrayBuilder6FinishEPNSt10shared_ptrI5ArrayEE"></span><span id="_CPPv2N5arrow12ArrayBuilder6FinishEPNSt10shared_ptrI5ArrayEE"></span><span id="arrow::ArrayBuilder::Finish__std::shared_ptr:Array:P"></span><span class="target" id="classarrow_1_1_array_builder_1a67b2227edb4b51bc44425f1c8a439819"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descname">Finish</code><span class="sig-paren">( [...]
<dd><p>Return result of builder as an <a class="reference internal" href="array.html#classarrow_1_1_array"><span class="std std-ref">Array</span></a> object. </p>
<p>The builder is reset except for <a class="reference internal" href="#classarrow_1_1_dictionary_builder"><span class="std std-ref">DictionaryBuilder</span></a>.</p>
<p><dl class="docutils">
@@ -291,13 +299,25 @@
<div class="section" id="concrete-builder-subclasses">
<h2>Concrete builder subclasses<a class="headerlink" href="#concrete-builder-subclasses" title="Permalink to this headline">¶</a></h2>
<dl class="class">
-<dt id="_CPPv3N5arrow11NullBuilderE">
-<span id="_CPPv2N5arrow11NullBuilderE"></span><span id="arrow::NullBuilder"></span><span class="target" id="classarrow_1_1_null_builder"></span><em class="property">class </em><code class="descname">NullBuilder</code> : <em class="property">public</em> arrow::<a class="reference internal" href="#_CPPv3N5arrow12ArrayBuilderE" title="arrow::ArrayBuilder">ArrayBuilder</a><a class="headerlink" href="#_CPPv3N5arrow11NullBuilderE" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4N5arrow11NullBuilderE">
+<span id="_CPPv3N5arrow11NullBuilderE"></span><span id="_CPPv2N5arrow11NullBuilderE"></span><span id="arrow::NullBuilder"></span><span class="target" id="classarrow_1_1_null_builder"></span><em class="property">class </em><code class="descname">NullBuilder</code> : <em class="property">public</em> arrow::<a class="reference internal" href="#_CPPv4N5arrow12ArrayBuilderE" title="arrow::ArrayBuilder">ArrayBuilder</a><a class="headerlink" href="#_CPPv4N5arrow11NullBuilderE" title="Permalink [...]
<dd><div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric">Public Functions</p>
<dl class="function">
-<dt id="_CPPv3N5arrow11NullBuilder14FinishInternalEPNSt10shared_ptrI9ArrayDataEE">
-<span id="_CPPv2N5arrow11NullBuilder14FinishInternalEPNSt10shared_ptrI9ArrayDataEE"></span><span id="arrow::NullBuilder::FinishInternal__std::shared_ptr:ArrayData:P"></span><span class="target" id="classarrow_1_1_null_builder_1a11081e4904045bb75039fa6eacbeceed"></span><a class="reference internal" href="support.html#_CPPv3N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descname">FinishInternal</code><span class="sig-paren">(</span>std::shared_ptr<ArrayData> *<em>out< [...]
+<dt id="_CPPv4N5arrow11NullBuilder11AppendNullsE7int64_t">
+<span id="_CPPv3N5arrow11NullBuilder11AppendNullsE7int64_t"></span><span id="_CPPv2N5arrow11NullBuilder11AppendNullsE7int64_t"></span><span id="arrow::NullBuilder::AppendNulls__int64_t"></span><span class="target" id="classarrow_1_1_null_builder_1a977e712f2aab1f2ea41b23bb6a7e57d1"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descname">AppendNulls</code><span class="sig-paren">(</span>int64_t <em>length</em><s [...]
+<dd><p>Append the specified number of null elements. </p>
+</dd></dl>
+
+<dl class="function">
+<dt id="_CPPv4N5arrow11NullBuilder10AppendNullEv">
+<span id="_CPPv3N5arrow11NullBuilder10AppendNullEv"></span><span id="_CPPv2N5arrow11NullBuilder10AppendNullEv"></span><span id="arrow::NullBuilder::AppendNull"></span><span class="target" id="classarrow_1_1_null_builder_1a6a5ef4161e898baa1815824902173f33"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descname">AppendNull</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink [...]
+<dd><p>Append a single null element. </p>
+</dd></dl>
+
+<dl class="function">
+<dt id="_CPPv4N5arrow11NullBuilder14FinishInternalEPNSt10shared_ptrI9ArrayDataEE">
+<span id="_CPPv3N5arrow11NullBuilder14FinishInternalEPNSt10shared_ptrI9ArrayDataEE"></span><span id="_CPPv2N5arrow11NullBuilder14FinishInternalEPNSt10shared_ptrI9ArrayDataEE"></span><span id="arrow::NullBuilder::FinishInternal__std::shared_ptr:ArrayData:P"></span><span class="target" id="classarrow_1_1_null_builder_1a11081e4904045bb75039fa6eacbeceed"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descname">Fini [...]
<dd><p>Return result of builder as an internal generic ArrayData object. </p>
<p>Resets builder except for dictionary builder</p>
<p><dl class="docutils">
@@ -316,31 +336,31 @@
</dd></dl>
<dl class="class">
-<dt id="_CPPv3N5arrow14BooleanBuilderE">
-<span id="_CPPv2N5arrow14BooleanBuilderE"></span><span id="arrow::BooleanBuilder"></span><span class="target" id="classarrow_1_1_boolean_builder"></span><em class="property">class </em><code class="descname">BooleanBuilder</code> : <em class="property">public</em> arrow::<a class="reference internal" href="#_CPPv3N5arrow12ArrayBuilderE" title="arrow::ArrayBuilder">ArrayBuilder</a><a class="headerlink" href="#_CPPv3N5arrow14BooleanBuilderE" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4N5arrow14BooleanBuilderE">
+<span id="_CPPv3N5arrow14BooleanBuilderE"></span><span id="_CPPv2N5arrow14BooleanBuilderE"></span><span id="arrow::BooleanBuilder"></span><span class="target" id="classarrow_1_1_boolean_builder"></span><em class="property">class </em><code class="descname">BooleanBuilder</code> : <em class="property">public</em> arrow::<a class="reference internal" href="#_CPPv4N5arrow12ArrayBuilderE" title="arrow::ArrayBuilder">ArrayBuilder</a><a class="headerlink" href="#_CPPv4N5arrow14BooleanBuilderE" [...]
<dd><div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric">Public Functions</p>
<dl class="function">
-<dt id="_CPPv3N5arrow14BooleanBuilder11AppendNullsEPK7uint8_t7int64_t">
-<span id="_CPPv2N5arrow14BooleanBuilder11AppendNullsEPK7uint8_t7int64_t"></span><span id="arrow::BooleanBuilder::AppendNulls__uint8_tCP.int64_t"></span><span class="target" id="classarrow_1_1_boolean_builder_1af1bd3dfcd96b7490e019e0ca5aa76d16"></span><a class="reference internal" href="support.html#_CPPv3N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descname">AppendNulls</code><span class="sig-paren">(</span><em class="property">const</em> uint8_t *<em>valid_bytes</em>, [...]
+<dt id="_CPPv4N5arrow14BooleanBuilder11AppendNullsE7int64_t">
+<span id="_CPPv3N5arrow14BooleanBuilder11AppendNullsE7int64_t"></span><span id="_CPPv2N5arrow14BooleanBuilder11AppendNullsE7int64_t"></span><span id="arrow::BooleanBuilder::AppendNulls__int64_t"></span><span class="target" id="classarrow_1_1_boolean_builder_1ad18854ba0c4abb244245cf5279214775"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descname">AppendNulls</code><span class="sig-paren">(</span>int64_t <em>l [...]
<dd><p>Write nulls as uint8_t* (0 value indicates null) into pre-allocated memory. </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3N5arrow14BooleanBuilder6AppendEKb">
-<span id="_CPPv2N5arrow14BooleanBuilder6AppendEKb"></span><span id="arrow::BooleanBuilder::Append__bC"></span><span class="target" id="classarrow_1_1_boolean_builder_1a8780642eb6e5a4a45e31222e78c1cc09"></span><a class="reference internal" href="support.html#_CPPv3N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descname">Append</code><span class="sig-paren">(</span><em class="property">const</em> bool <em>val</em><span class="sig-paren">)</span><a class="headerlink" href="# [...]
+<dt id="_CPPv4N5arrow14BooleanBuilder6AppendEKb">
+<span id="_CPPv3N5arrow14BooleanBuilder6AppendEKb"></span><span id="_CPPv2N5arrow14BooleanBuilder6AppendEKb"></span><span id="arrow::BooleanBuilder::Append__bC"></span><span class="target" id="classarrow_1_1_boolean_builder_1a8780642eb6e5a4a45e31222e78c1cc09"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descname">Append</code><span class="sig-paren">(</span><em class="property">const</em> bool <em>val</em><sp [...]
<dd><p>Scalar append. </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3N5arrow14BooleanBuilder12UnsafeAppendEKb">
-<span id="_CPPv2N5arrow14BooleanBuilder12UnsafeAppendEKb"></span><span id="arrow::BooleanBuilder::UnsafeAppend__bC"></span><span class="target" id="classarrow_1_1_boolean_builder_1a3695606656e7e71457473c59d1cee0a8"></span>void <code class="descname">UnsafeAppend</code><span class="sig-paren">(</span><em class="property">const</em> bool <em>val</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv3N5arrow14BooleanBuilder12UnsafeAppendEKb" title="Permalink to this definiti [...]
+<dt id="_CPPv4N5arrow14BooleanBuilder12UnsafeAppendEKb">
+<span id="_CPPv3N5arrow14BooleanBuilder12UnsafeAppendEKb"></span><span id="_CPPv2N5arrow14BooleanBuilder12UnsafeAppendEKb"></span><span id="arrow::BooleanBuilder::UnsafeAppend__bC"></span><span class="target" id="classarrow_1_1_boolean_builder_1a3695606656e7e71457473c59d1cee0a8"></span>void <code class="descname">UnsafeAppend</code><span class="sig-paren">(</span><em class="property">const</em> bool <em>val</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow14B [...]
<dd><p>Scalar append, without checking for capacity. </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3N5arrow14BooleanBuilder12AppendValuesEPK7uint8_t7int64_tPK7uint8_t">
-<span id="_CPPv2N5arrow14BooleanBuilder12AppendValuesEPK7uint8_t7int64_tPK7uint8_t"></span><span id="arrow::BooleanBuilder::AppendValues__uint8_tCP.int64_t.uint8_tCP"></span><span class="target" id="classarrow_1_1_boolean_builder_1a60382b2dd40f2d0e66b7ac318fe1d71d"></span><a class="reference internal" href="support.html#_CPPv3N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descname">AppendValues</code><span class="sig-paren">(</span><em class="property">const</em> uint8_t [...]
+<dt id="_CPPv4N5arrow14BooleanBuilder12AppendValuesEPK7uint8_t7int64_tPK7uint8_t">
+<span id="_CPPv3N5arrow14BooleanBuilder12AppendValuesEPK7uint8_t7int64_tPK7uint8_t"></span><span id="_CPPv2N5arrow14BooleanBuilder12AppendValuesEPK7uint8_t7int64_tPK7uint8_t"></span><span id="arrow::BooleanBuilder::AppendValues__uint8_tCP.int64_t.uint8_tCP"></span><span class="target" id="classarrow_1_1_boolean_builder_1a60382b2dd40f2d0e66b7ac318fe1d71d"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descname"> [...]
<dd><p>Append a sequence of elements in one shot. </p>
<p><dl class="docutils">
<dt><strong>Return</strong></dt>
@@ -357,8 +377,8 @@
</dd></dl>
<dl class="function">
-<dt id="_CPPv3N5arrow14BooleanBuilder12AppendValuesEPK7uint8_t7int64_tRKNSt6vectorIbEE">
-<span id="_CPPv2N5arrow14BooleanBuilder12AppendValuesEPK7uint8_t7int64_tRKNSt6vectorIbEE"></span><span id="arrow::BooleanBuilder::AppendValues__uint8_tCP.int64_t.std::vector:b:CR"></span><span class="target" id="classarrow_1_1_boolean_builder_1ab257c69eaabe3d00eafae7a598f83e91"></span><a class="reference internal" href="support.html#_CPPv3N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descname">AppendValues</code><span class="sig-paren">(</span><em class="property">const< [...]
+<dt id="_CPPv4N5arrow14BooleanBuilder12AppendValuesEPK7uint8_t7int64_tRKNSt6vectorIbEE">
+<span id="_CPPv3N5arrow14BooleanBuilder12AppendValuesEPK7uint8_t7int64_tRKNSt6vectorIbEE"></span><span id="_CPPv2N5arrow14BooleanBuilder12AppendValuesEPK7uint8_t7int64_tRKNSt6vectorIbEE"></span><span id="arrow::BooleanBuilder::AppendValues__uint8_tCP.int64_t.std::vector:b:CR"></span><span class="target" id="classarrow_1_1_boolean_builder_1ab257c69eaabe3d00eafae7a598f83e91"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status">Status</a> <cod [...]
<dd><p>Append a sequence of elements in one shot. </p>
<p><dl class="docutils">
<dt><strong>Return</strong></dt>
@@ -375,8 +395,8 @@
</dd></dl>
<dl class="function">
-<dt id="_CPPv3N5arrow14BooleanBuilder12AppendValuesERKNSt6vectorI7uint8_tEERKNSt6vectorIbEE">
-<span id="_CPPv2N5arrow14BooleanBuilder12AppendValuesERKNSt6vectorI7uint8_tEERKNSt6vectorIbEE"></span><span id="arrow::BooleanBuilder::AppendValues__std::vector:uint8_t:CR.std::vector:b:CR"></span><span class="target" id="classarrow_1_1_boolean_builder_1a1cfd3c422525a51a4b1b9fa45ab773be"></span><a class="reference internal" href="support.html#_CPPv3N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descname">AppendValues</code><span class="sig-paren">(</span><em class="proper [...]
+<dt id="_CPPv4N5arrow14BooleanBuilder12AppendValuesERKNSt6vectorI7uint8_tEERKNSt6vectorIbEE">
+<span id="_CPPv3N5arrow14BooleanBuilder12AppendValuesERKNSt6vectorI7uint8_tEERKNSt6vectorIbEE"></span><span id="_CPPv2N5arrow14BooleanBuilder12AppendValuesERKNSt6vectorI7uint8_tEERKNSt6vectorIbEE"></span><span id="arrow::BooleanBuilder::AppendValues__std::vector:uint8_t:CR.std::vector:b:CR"></span><span class="target" id="classarrow_1_1_boolean_builder_1a1cfd3c422525a51a4b1b9fa45ab773be"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"> [...]
<dd><p>Append a sequence of elements in one shot. </p>
<p><dl class="docutils">
<dt><strong>Return</strong></dt>
@@ -392,8 +412,8 @@
</dd></dl>
<dl class="function">
-<dt id="_CPPv3N5arrow14BooleanBuilder12AppendValuesERKNSt6vectorI7uint8_tEE">
-<span id="_CPPv2N5arrow14BooleanBuilder12AppendValuesERKNSt6vectorI7uint8_tEE"></span><span id="arrow::BooleanBuilder::AppendValues__std::vector:uint8_t:CR"></span><span class="target" id="classarrow_1_1_boolean_builder_1a2e10c5bbd21da120a3c343519977b4c1"></span><a class="reference internal" href="support.html#_CPPv3N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descname">AppendValues</code><span class="sig-paren">(</span><em class="property">const</em> std::vector<uin [...]
+<dt id="_CPPv4N5arrow14BooleanBuilder12AppendValuesERKNSt6vectorI7uint8_tEE">
+<span id="_CPPv3N5arrow14BooleanBuilder12AppendValuesERKNSt6vectorI7uint8_tEE"></span><span id="_CPPv2N5arrow14BooleanBuilder12AppendValuesERKNSt6vectorI7uint8_tEE"></span><span id="arrow::BooleanBuilder::AppendValues__std::vector:uint8_t:CR"></span><span class="target" id="classarrow_1_1_boolean_builder_1a2e10c5bbd21da120a3c343519977b4c1"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descname">AppendValues</c [...]
<dd><p>Append a sequence of elements in one shot. </p>
<p><dl class="docutils">
<dt><strong>Return</strong></dt>
@@ -408,8 +428,8 @@
</dd></dl>
<dl class="function">
-<dt id="_CPPv3N5arrow14BooleanBuilder12AppendValuesERKNSt6vectorIbEERKNSt6vectorIbEE">
-<span id="_CPPv2N5arrow14BooleanBuilder12AppendValuesERKNSt6vectorIbEERKNSt6vectorIbEE"></span><span id="arrow::BooleanBuilder::AppendValues__std::vector:b:CR.std::vector:b:CR"></span><span class="target" id="classarrow_1_1_boolean_builder_1ac6075414fa190df919ec081884771acc"></span><a class="reference internal" href="support.html#_CPPv3N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descname">AppendValues</code><span class="sig-paren">(</span><em class="property">const</em [...]
+<dt id="_CPPv4N5arrow14BooleanBuilder12AppendValuesERKNSt6vectorIbEERKNSt6vectorIbEE">
+<span id="_CPPv3N5arrow14BooleanBuilder12AppendValuesERKNSt6vectorIbEERKNSt6vectorIbEE"></span><span id="_CPPv2N5arrow14BooleanBuilder12AppendValuesERKNSt6vectorIbEERKNSt6vectorIbEE"></span><span id="arrow::BooleanBuilder::AppendValues__std::vector:b:CR.std::vector:b:CR"></span><span class="target" id="classarrow_1_1_boolean_builder_1ac6075414fa190df919ec081884771acc"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status">Status</a> <code cla [...]
<dd><p>Append a sequence of elements in one shot. </p>
<p><dl class="docutils">
<dt><strong>Return</strong></dt>
@@ -425,8 +445,8 @@
</dd></dl>
<dl class="function">
-<dt id="_CPPv3N5arrow14BooleanBuilder12AppendValuesERKNSt6vectorIbEE">
-<span id="_CPPv2N5arrow14BooleanBuilder12AppendValuesERKNSt6vectorIbEE"></span><span id="arrow::BooleanBuilder::AppendValues__std::vector:b:CR"></span><span class="target" id="classarrow_1_1_boolean_builder_1a54d7f7893e1f9b4ea55172a9af4f1bb3"></span><a class="reference internal" href="support.html#_CPPv3N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descname">AppendValues</code><span class="sig-paren">(</span><em class="property">const</em> std::vector<bool> &<e [...]
+<dt id="_CPPv4N5arrow14BooleanBuilder12AppendValuesERKNSt6vectorIbEE">
+<span id="_CPPv3N5arrow14BooleanBuilder12AppendValuesERKNSt6vectorIbEE"></span><span id="_CPPv2N5arrow14BooleanBuilder12AppendValuesERKNSt6vectorIbEE"></span><span id="arrow::BooleanBuilder::AppendValues__std::vector:b:CR"></span><span class="target" id="classarrow_1_1_boolean_builder_1a54d7f7893e1f9b4ea55172a9af4f1bb3"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descname">AppendValues</code><span class="sig [...]
<dd><p>Append a sequence of elements in one shot. </p>
<p><dl class="docutils">
<dt><strong>Return</strong></dt>
@@ -441,8 +461,8 @@
</dd></dl>
<dl class="function">
-<dt id="_CPPv3N5arrow14BooleanBuilder12AppendValuesE10ValuesIter10ValuesIter">
-<span id="_CPPv2N5arrow14BooleanBuilder12AppendValuesE10ValuesIter10ValuesIter"></span><span id="arrow::BooleanBuilder::AppendValues__ValuesIter.ValuesIter"></span><em class="property">template </em><<em class="property">typename</em> ValuesIter><br /><span class="target" id="classarrow_1_1_boolean_builder_1ae2a6d1b574abe92480d25c9736c51e69"></span><a class="reference internal" href="support.html#_CPPv3N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descname">AppendV [...]
+<dt id="_CPPv4N5arrow14BooleanBuilder12AppendValuesE10ValuesIter10ValuesIter">
+<span id="_CPPv3N5arrow14BooleanBuilder12AppendValuesE10ValuesIter10ValuesIter"></span><span id="_CPPv2N5arrow14BooleanBuilder12AppendValuesE10ValuesIter10ValuesIter"></span><span id="arrow::BooleanBuilder::AppendValues__ValuesIter.ValuesIter"></span><em class="property">template </em><<em class="property">typename</em> ValuesIter><br /><span class="target" id="classarrow_1_1_boolean_builder_1ae2a6d1b574abe92480d25c9736c51e69"></span><a class="reference internal" href="support.html [...]
<dd><p>Append a sequence of elements in one shot. </p>
<p><dl class="docutils">
<dt><strong>Return</strong></dt>
@@ -458,8 +478,8 @@
</dd></dl>
<dl class="function">
-<dt id="_CPPv3N5arrow14BooleanBuilder12AppendValuesE10ValuesIter10ValuesIter9ValidIter">
-<span id="_CPPv2N5arrow14BooleanBuilder12AppendValuesE10ValuesIter10ValuesIter9ValidIter"></span><span id="arrow::BooleanBuilder::AppendValues__ValuesIter.ValuesIter.ValidIter"></span><em class="property">template </em><<em class="property">typename</em> ValuesIter, <em class="property">typename</em> ValidIter><br /><span class="target" id="classarrow_1_1_boolean_builder_1a3e15348c55cf27f1f47d632facc88117"></span>std::enable_if<!std::is_pointer<ValidIter>::value, <a class= [...]
+<dt id="_CPPv4N5arrow14BooleanBuilder12AppendValuesE10ValuesIter10ValuesIter9ValidIter">
+<span id="_CPPv3N5arrow14BooleanBuilder12AppendValuesE10ValuesIter10ValuesIter9ValidIter"></span><span id="_CPPv2N5arrow14BooleanBuilder12AppendValuesE10ValuesIter10ValuesIter9ValidIter"></span><span id="arrow::BooleanBuilder::AppendValues__ValuesIter.ValuesIter.ValidIter"></span><em class="property">template </em><<em class="property">typename</em> ValuesIter, <em class="property">typename</em> ValidIter><br /><span class="target" id="classarrow_1_1_boolean_builder_1a3e15348c55cf2 [...]
<dd><p>Append a sequence of elements in one shot, with a specified nullmap. </p>
<p><dl class="docutils">
<dt><strong>Return</strong></dt>
@@ -476,8 +496,8 @@
</dd></dl>
<dl class="function">
-<dt id="_CPPv3N5arrow14BooleanBuilder14FinishInternalEPNSt10shared_ptrI9ArrayDataEE">
-<span id="_CPPv2N5arrow14BooleanBuilder14FinishInternalEPNSt10shared_ptrI9ArrayDataEE"></span><span id="arrow::BooleanBuilder::FinishInternal__std::shared_ptr:ArrayData:P"></span><span class="target" id="classarrow_1_1_boolean_builder_1a84e5ee3cc0ae427135093c80b014765c"></span><a class="reference internal" href="support.html#_CPPv3N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descname">FinishInternal</code><span class="sig-paren">(</span>std::shared_ptr<ArrayData> [...]
+<dt id="_CPPv4N5arrow14BooleanBuilder14FinishInternalEPNSt10shared_ptrI9ArrayDataEE">
+<span id="_CPPv3N5arrow14BooleanBuilder14FinishInternalEPNSt10shared_ptrI9ArrayDataEE"></span><span id="_CPPv2N5arrow14BooleanBuilder14FinishInternalEPNSt10shared_ptrI9ArrayDataEE"></span><span id="arrow::BooleanBuilder::FinishInternal__std::shared_ptr:ArrayData:P"></span><span class="target" id="classarrow_1_1_boolean_builder_1a84e5ee3cc0ae427135093c80b014765c"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status">Status</a> <code class="de [...]
<dd><p>Return result of builder as an internal generic ArrayData object. </p>
<p>Resets builder except for dictionary builder</p>
<p><dl class="docutils">
@@ -493,14 +513,14 @@
</dd></dl>
<dl class="function">
-<dt id="_CPPv3N5arrow14BooleanBuilder5ResetEv">
-<span id="_CPPv2N5arrow14BooleanBuilder5ResetEv"></span><span id="arrow::BooleanBuilder::Reset"></span><span class="target" id="classarrow_1_1_boolean_builder_1a5c7274589b0a49432cac36e0badbf742"></span>void <code class="descname">Reset</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv3N5arrow14BooleanBuilder5ResetEv" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4N5arrow14BooleanBuilder5ResetEv">
+<span id="_CPPv3N5arrow14BooleanBuilder5ResetEv"></span><span id="_CPPv2N5arrow14BooleanBuilder5ResetEv"></span><span id="arrow::BooleanBuilder::Reset"></span><span class="target" id="classarrow_1_1_boolean_builder_1a5c7274589b0a49432cac36e0badbf742"></span>void <code class="descname">Reset</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow14BooleanBuilder5ResetEv" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Reset the builder. </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3N5arrow14BooleanBuilder6ResizeE7int64_t">
-<span id="_CPPv2N5arrow14BooleanBuilder6ResizeE7int64_t"></span><span id="arrow::BooleanBuilder::Resize__int64_t"></span><span class="target" id="classarrow_1_1_boolean_builder_1a4f2626da73f59eb1c0473c7adacdf470"></span><a class="reference internal" href="support.html#_CPPv3N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descname">Resize</code><span class="sig-paren">(</span>int64_t <em>capacity</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv3N5arrow [...]
+<dt id="_CPPv4N5arrow14BooleanBuilder6ResizeE7int64_t">
+<span id="_CPPv3N5arrow14BooleanBuilder6ResizeE7int64_t"></span><span id="_CPPv2N5arrow14BooleanBuilder6ResizeE7int64_t"></span><span id="arrow::BooleanBuilder::Resize__int64_t"></span><span class="target" id="classarrow_1_1_boolean_builder_1a4f2626da73f59eb1c0473c7adacdf470"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descname">Resize</code><span class="sig-paren">(</span>int64_t <em>capacity</em><span clas [...]
<dd><p>Ensure that enough memory has been allocated to fit the indicated number of total elements in the builder, including any that have already been appended. </p>
<p>Does not account for reallocations that may be due to variable size data, like binary values. To make space for incremental appends, use Reserve instead.</p>
<p><dl class="docutils">
@@ -515,31 +535,180 @@
</p>
</dd></dl>
-<dl class="function">
-<dt id="_CPPv3N5arrow12ArrayBuilder7AdvanceEv">
-<span id="_CPPv2N5arrow12ArrayBuilder7AdvanceEv"></span><span id="arrow::ArrayBuilder::Advance"></span><span class="target" id="classarrow_1_1_boolean_builder_1a630ea6ee96e26b8f1a2d08b45180fb32"></span><a class="reference internal" href="support.html#_CPPv3N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descname">Advance</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv3N5arrow12ArrayBuilder7AdvanceEv" title="Permalink [...]
-<dd><p>For cases where raw data was memcpy’d into the internal buffers, allows us to advance the length of the builder. </p>
-<p>It is your responsibility to use this function responsibly. </p>
-</dd></dl>
-
</div>
</dd></dl>
<dl class="class">
-<dt id="_CPPv3N5arrow14NumericBuilderE">
-<span id="_CPPv2N5arrow14NumericBuilderE"></span><span id="arrow::NumericBuilder"></span><span class="target" id="classarrow_1_1_numeric_builder"></span><em class="property">template </em><<em class="property">typename</em> T><br /><em class="property">class </em><code class="descname">NumericBuilder</code> : <em class="property">public</em> arrow::PrimitiveBuilder<T><a class="headerlink" href="#_CPPv3N5arrow14NumericBuilderE" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4N5arrow14NumericBuilderE">
+<span id="_CPPv3N5arrow14NumericBuilderE"></span><span id="_CPPv2N5arrow14NumericBuilderE"></span><span id="arrow::NumericBuilder"></span><span class="target" id="classarrow_1_1_numeric_builder"></span><em class="property">template </em><<em class="property">typename</em> T><br /><em class="property">class </em><code class="descname">NumericBuilder</code> : <em class="property">public</em> arrow::<a class="reference internal" href="#_CPPv4N5arrow12ArrayBuilderE" title="arrow::Array [...]
<dd><p>Base class for all Builders that emit an <a class="reference internal" href="array.html#classarrow_1_1_array"><span class="std std-ref">Array</span></a> of a scalar numerical type. </p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric">Public Functions</p>
<dl class="function">
-<dt id="_CPPv3N5arrow14NumericBuilder6AppendEK10value_type">
-<span id="_CPPv2N5arrow14NumericBuilder6AppendEK10value_type"></span><span id="arrow::NumericBuilder::Append__value_typeC"></span><span class="target" id="classarrow_1_1_numeric_builder_1a1e2842359a508f3d23ba6fc766c7eeb0"></span><a class="reference internal" href="support.html#_CPPv3N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descname">Append</code><span class="sig-paren">(</span><em class="property">const</em> value_type <em>val</em><span class="sig-paren">)</span><a [...]
+<dt id="_CPPv4N5arrow14NumericBuilder6AppendEK10value_type">
+<span id="_CPPv3N5arrow14NumericBuilder6AppendEK10value_type"></span><span id="_CPPv2N5arrow14NumericBuilder6AppendEK10value_type"></span><span id="arrow::NumericBuilder::Append__value_typeC"></span><span class="target" id="classarrow_1_1_numeric_builder_1a1e2842359a508f3d23ba6fc766c7eeb0"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descname">Append</code><span class="sig-paren">(</span><em class="property"> [...]
<dd><p>Append a single scalar and increase the size if necessary. </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3N5arrow14NumericBuilder12UnsafeAppendEK10value_type">
-<span id="_CPPv2N5arrow14NumericBuilder12UnsafeAppendEK10value_type"></span><span id="arrow::NumericBuilder::UnsafeAppend__value_typeC"></span><span class="target" id="classarrow_1_1_numeric_builder_1a7ad22f6fc4114b23bcfb74e61636d911"></span>void <code class="descname">UnsafeAppend</code><span class="sig-paren">(</span><em class="property">const</em> value_type <em>val</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv3N5arrow14NumericBuilder12UnsafeAppendEK10value_ty [...]
+<dt id="_CPPv4N5arrow14NumericBuilder11AppendNullsE7int64_t">
+<span id="_CPPv3N5arrow14NumericBuilder11AppendNullsE7int64_t"></span><span id="_CPPv2N5arrow14NumericBuilder11AppendNullsE7int64_t"></span><span id="arrow::NumericBuilder::AppendNulls__int64_t"></span><span class="target" id="classarrow_1_1_numeric_builder_1a20c2c519623f7657b42949cf65fc2adf"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descname">AppendNulls</code><span class="sig-paren">(</span>int64_t <em>l [...]
+<dd><p>Write nulls as uint8_t* (0 value indicates null) into pre-allocated memory The memory at the corresponding data slot is set to 0 to prevent uninitialized memory access. </p>
+</dd></dl>
+
+<dl class="function">
+<dt id="_CPPv4N5arrow14NumericBuilder10AppendNullEv">
+<span id="_CPPv3N5arrow14NumericBuilder10AppendNullEv"></span><span id="_CPPv2N5arrow14NumericBuilder10AppendNullEv"></span><span id="arrow::NumericBuilder::AppendNull"></span><span class="target" id="classarrow_1_1_numeric_builder_1afc9749db6fb5c9f78d6831c3a607745e"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descname">AppendNull</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class [...]
+<dd><p>Append a single null element. </p>
+</dd></dl>
+
+<dl class="function">
+<dt id="_CPPv4N5arrow14NumericBuilder5ResetEv">
+<span id="_CPPv3N5arrow14NumericBuilder5ResetEv"></span><span id="_CPPv2N5arrow14NumericBuilder5ResetEv"></span><span id="arrow::NumericBuilder::Reset"></span><span class="target" id="classarrow_1_1_numeric_builder_1a7ceb2d5bc1adb0cf2f7cb3912b813e2b"></span>void <code class="descname">Reset</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow14NumericBuilder5ResetEv" title="Permalink to this definition">¶</a><br /></dt>
+<dd><p>Reset the builder. </p>
+</dd></dl>
+
+<dl class="function">
+<dt id="_CPPv4N5arrow14NumericBuilder6ResizeE7int64_t">
+<span id="_CPPv3N5arrow14NumericBuilder6ResizeE7int64_t"></span><span id="_CPPv2N5arrow14NumericBuilder6ResizeE7int64_t"></span><span id="arrow::NumericBuilder::Resize__int64_t"></span><span class="target" id="classarrow_1_1_numeric_builder_1ad006024991f00da4ad8aa2890bdb0c83"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descname">Resize</code><span class="sig-paren">(</span>int64_t <em>capacity</em><span clas [...]
+<dd><p>Ensure that enough memory has been allocated to fit the indicated number of total elements in the builder, including any that have already been appended. </p>
+<p>Does not account for reallocations that may be due to variable size data, like binary values. To make space for incremental appends, use Reserve instead.</p>
+<p><dl class="docutils">
+<dt><strong>Return</strong></dt>
+<dd><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a> </dd>
+<dt><strong>Parameters</strong></dt>
+<dd><ul class="breatheparameterlist first last simple">
+<li><code class="docutils literal notranslate"><span class="pre">capacity</span></code>: the minimum number of total array values to accommodate. Must be greater than the current capacity. </li>
+</ul>
+</dd>
+</dl>
+</p>
+</dd></dl>
+
+<dl class="function">
+<dt id="_CPPv4N5arrow14NumericBuilder12AppendValuesEPK10value_type7int64_tPK7uint8_t">
+<span id="_CPPv3N5arrow14NumericBuilder12AppendValuesEPK10value_type7int64_tPK7uint8_t"></span><span id="_CPPv2N5arrow14NumericBuilder12AppendValuesEPK10value_type7int64_tPK7uint8_t"></span><span id="arrow::NumericBuilder::AppendValues__value_typeCP.int64_t.uint8_tCP"></span><span class="target" id="classarrow_1_1_numeric_builder_1a3915eb06a4672f31eb27423e691cf0a2"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status">Status</a> <code class= [...]
+<dd><p>Append a sequence of elements in one shot. </p>
+<p><dl class="docutils">
+<dt><strong>Return</strong></dt>
+<dd><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a> </dd>
+<dt><strong>Parameters</strong></dt>
+<dd><ul class="breatheparameterlist first last simple">
+<li><code class="docutils literal notranslate"><span class="pre">values</span></code>: a contiguous C array of values </li>
+<li><code class="docutils literal notranslate"><span class="pre">length</span></code>: the number of values to append </li>
+<li><code class="docutils literal notranslate"><span class="pre">valid_bytes</span></code>: an optional sequence of bytes where non-zero indicates a valid (non-null) value </li>
+</ul>
+</dd>
+</dl>
+</p>
+</dd></dl>
+
+<dl class="function">
+<dt id="_CPPv4N5arrow14NumericBuilder12AppendValuesEPK10value_type7int64_tRKNSt6vectorIbEE">
+<span id="_CPPv3N5arrow14NumericBuilder12AppendValuesEPK10value_type7int64_tRKNSt6vectorIbEE"></span><span id="_CPPv2N5arrow14NumericBuilder12AppendValuesEPK10value_type7int64_tRKNSt6vectorIbEE"></span><span id="arrow::NumericBuilder::AppendValues__value_typeCP.int64_t.std::vector:b:CR"></span><span class="target" id="classarrow_1_1_numeric_builder_1a65bb6b23c8af350d196fafb77a7c8dcc"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status">Stat [...]
+<dd><p>Append a sequence of elements in one shot. </p>
+<p><dl class="docutils">
+<dt><strong>Return</strong></dt>
+<dd><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a> </dd>
+<dt><strong>Parameters</strong></dt>
+<dd><ul class="breatheparameterlist first last simple">
+<li><code class="docutils literal notranslate"><span class="pre">values</span></code>: a contiguous C array of values </li>
+<li><code class="docutils literal notranslate"><span class="pre">length</span></code>: the number of values to append </li>
+<li><code class="docutils literal notranslate"><span class="pre">is_valid</span></code>: an std::vector<bool> indicating valid (1) or null (0). Equal in length to values </li>
+</ul>
+</dd>
+</dl>
+</p>
+</dd></dl>
+
+<dl class="function">
+<dt id="_CPPv4N5arrow14NumericBuilder12AppendValuesERKNSt6vectorI10value_typeEERKNSt6vectorIbEE">
+<span id="_CPPv3N5arrow14NumericBuilder12AppendValuesERKNSt6vectorI10value_typeEERKNSt6vectorIbEE"></span><span id="_CPPv2N5arrow14NumericBuilder12AppendValuesERKNSt6vectorI10value_typeEERKNSt6vectorIbEE"></span><span id="arrow::NumericBuilder::AppendValues__std::vector:value_type:CR.std::vector:b:CR"></span><span class="target" id="classarrow_1_1_numeric_builder_1aa1a26f86af18021733b560584e05df3b"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arro [...]
+<dd><p>Append a sequence of elements in one shot. </p>
+<p><dl class="docutils">
+<dt><strong>Return</strong></dt>
+<dd><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a> </dd>
+<dt><strong>Parameters</strong></dt>
+<dd><ul class="breatheparameterlist first last simple">
+<li><code class="docutils literal notranslate"><span class="pre">values</span></code>: a std::vector of values </li>
+<li><code class="docutils literal notranslate"><span class="pre">is_valid</span></code>: an std::vector<bool> indicating valid (1) or null (0). Equal in length to values </li>
+</ul>
+</dd>
+</dl>
+</p>
+</dd></dl>
+
+<dl class="function">
+<dt id="_CPPv4N5arrow14NumericBuilder12AppendValuesERKNSt6vectorI10value_typeEE">
+<span id="_CPPv3N5arrow14NumericBuilder12AppendValuesERKNSt6vectorI10value_typeEE"></span><span id="_CPPv2N5arrow14NumericBuilder12AppendValuesERKNSt6vectorI10value_typeEE"></span><span id="arrow::NumericBuilder::AppendValues__std::vector:value_type:CR"></span><span class="target" id="classarrow_1_1_numeric_builder_1a2ec37ffd870fb48037cb993f16d7209a"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descname">Appe [...]
+<dd><p>Append a sequence of elements in one shot. </p>
+<p><dl class="docutils">
+<dt><strong>Return</strong></dt>
+<dd><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a> </dd>
+<dt><strong>Parameters</strong></dt>
+<dd><ul class="breatheparameterlist first last simple">
+<li><code class="docutils literal notranslate"><span class="pre">values</span></code>: a std::vector of values </li>
+</ul>
+</dd>
+</dl>
+</p>
+</dd></dl>
+
+<dl class="function">
+<dt id="_CPPv4N5arrow14NumericBuilder14FinishInternalEPNSt10shared_ptrI9ArrayDataEE">
+<span id="_CPPv3N5arrow14NumericBuilder14FinishInternalEPNSt10shared_ptrI9ArrayDataEE"></span><span id="_CPPv2N5arrow14NumericBuilder14FinishInternalEPNSt10shared_ptrI9ArrayDataEE"></span><span id="arrow::NumericBuilder::FinishInternal__std::shared_ptr:ArrayData:P"></span><span class="target" id="classarrow_1_1_numeric_builder_1a63949674fe5401e01fd62b012dabe14c"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status">Status</a> <code class="de [...]
+<dd><p>Return result of builder as an internal generic ArrayData object. </p>
+<p>Resets builder except for dictionary builder</p>
+<p><dl class="docutils">
+<dt><strong>Return</strong></dt>
+<dd><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a> </dd>
+<dt><strong>Parameters</strong></dt>
+<dd><ul class="breatheparameterlist first last simple">
+<li><code class="docutils literal notranslate"><span class="pre">out</span></code>: the finalized ArrayData object </li>
+</ul>
+</dd>
+</dl>
+</p>
+</dd></dl>
+
+<dl class="function">
+<dt id="_CPPv4N5arrow14NumericBuilder12AppendValuesE10ValuesIter10ValuesIter">
+<span id="_CPPv3N5arrow14NumericBuilder12AppendValuesE10ValuesIter10ValuesIter"></span><span id="_CPPv2N5arrow14NumericBuilder12AppendValuesE10ValuesIter10ValuesIter"></span><span id="arrow::NumericBuilder::AppendValues__ValuesIter.ValuesIter"></span><em class="property">template </em><<em class="property">typename</em> ValuesIter><br /><span class="target" id="classarrow_1_1_numeric_builder_1a9c3316f90bbf3c02d12bca34739456c5"></span><a class="reference internal" href="support.html [...]
+<dd><p>Append a sequence of elements in one shot. </p>
+<p><dl class="docutils">
+<dt><strong>Return</strong></dt>
+<dd><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a> </dd>
+<dt><strong>Parameters</strong></dt>
+<dd><ul class="breatheparameterlist first last simple">
+<li><code class="docutils literal notranslate"><span class="pre">values_begin</span></code>: InputIterator to the beginning of the values </li>
+<li><code class="docutils literal notranslate"><span class="pre">values_end</span></code>: InputIterator pointing to the end of the values </li>
+</ul>
+</dd>
+</dl>
+</p>
+</dd></dl>
+
+<dl class="function">
+<dt id="_CPPv4N5arrow14NumericBuilder12AppendValuesE10ValuesIter10ValuesIter9ValidIter">
+<span id="_CPPv3N5arrow14NumericBuilder12AppendValuesE10ValuesIter10ValuesIter9ValidIter"></span><span id="_CPPv2N5arrow14NumericBuilder12AppendValuesE10ValuesIter10ValuesIter9ValidIter"></span><span id="arrow::NumericBuilder::AppendValues__ValuesIter.ValuesIter.ValidIter"></span><em class="property">template </em><<em class="property">typename</em> ValuesIter, <em class="property">typename</em> ValidIter><br /><span class="target" id="classarrow_1_1_numeric_builder_1a60372f6f793c3 [...]
+<dd><p>Append a sequence of elements in one shot, with a specified nullmap. </p>
+<p><dl class="docutils">
+<dt><strong>Return</strong></dt>
+<dd><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a> </dd>
+<dt><strong>Parameters</strong></dt>
+<dd><ul class="breatheparameterlist first last simple">
+<li><code class="docutils literal notranslate"><span class="pre">values_begin</span></code>: InputIterator to the beginning of the values </li>
+<li><code class="docutils literal notranslate"><span class="pre">values_end</span></code>: InputIterator pointing to the end of the values </li>
+<li><code class="docutils literal notranslate"><span class="pre">valid_begin</span></code>: InputIterator with elements indication valid(1) or null(0) values. </li>
+</ul>
+</dd>
+</dl>
+</p>
+</dd></dl>
+
+<dl class="function">
+<dt id="_CPPv4N5arrow14NumericBuilder12UnsafeAppendEK10value_type">
+<span id="_CPPv3N5arrow14NumericBuilder12UnsafeAppendEK10value_type"></span><span id="_CPPv2N5arrow14NumericBuilder12UnsafeAppendEK10value_type"></span><span id="arrow::NumericBuilder::UnsafeAppend__value_typeC"></span><span class="target" id="classarrow_1_1_numeric_builder_1a7ad22f6fc4114b23bcfb74e61636d911"></span>void <code class="descname">UnsafeAppend</code><span class="sig-paren">(</span><em class="property">const</em> value_type <em>val</em><span class="sig-paren">)</span><a class [...]
<dd><p>Append a single scalar under the assumption that the underlying <a class="reference internal" href="memory.html#classarrow_1_1_buffer"><span class="std std-ref">Buffer</span></a> is large enough. </p>
<p>This method does not capacity-check; make sure to call Reserve beforehand. </p>
</dd></dl>
@@ -548,28 +717,28 @@
</dd></dl>
<dl class="class">
-<dt id="_CPPv3N5arrow13BinaryBuilderE">
-<span id="_CPPv2N5arrow13BinaryBuilderE"></span><span id="arrow::BinaryBuilder"></span><span class="target" id="classarrow_1_1_binary_builder"></span><em class="property">class </em><code class="descname">BinaryBuilder</code> : <em class="property">public</em> arrow::<a class="reference internal" href="#_CPPv3N5arrow12ArrayBuilderE" title="arrow::ArrayBuilder">ArrayBuilder</a><a class="headerlink" href="#_CPPv3N5arrow13BinaryBuilderE" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4N5arrow13BinaryBuilderE">
+<span id="_CPPv3N5arrow13BinaryBuilderE"></span><span id="_CPPv2N5arrow13BinaryBuilderE"></span><span id="arrow::BinaryBuilder"></span><span class="target" id="classarrow_1_1_binary_builder"></span><em class="property">class </em><code class="descname">BinaryBuilder</code> : <em class="property">public</em> arrow::<a class="reference internal" href="#_CPPv4N5arrow12ArrayBuilderE" title="arrow::ArrayBuilder">ArrayBuilder</a><a class="headerlink" href="#_CPPv4N5arrow13BinaryBuilderE" title [...]
<dd><p>Builder class for variable-length binary data. </p>
<p>Subclassed by <a class="reference internal" href="#classarrow_1_1_string_builder"><span class="std std-ref">arrow::StringBuilder</span></a></p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric">Public Functions</p>
<dl class="function">
-<dt id="_CPPv3N5arrow13BinaryBuilder12UnsafeAppendEPK7uint8_t7int32_t">
-<span id="_CPPv2N5arrow13BinaryBuilder12UnsafeAppendEPK7uint8_t7int32_t"></span><span id="arrow::BinaryBuilder::UnsafeAppend__uint8_tCP.int32_t"></span><span class="target" id="classarrow_1_1_binary_builder_1a2a4a86c28ea71c44823c61f0583b78cd"></span>void <code class="descname">UnsafeAppend</code><span class="sig-paren">(</span><em class="property">const</em> uint8_t *<em>value</em>, int32_t <em>length</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv3N5arrow13BinaryB [...]
+<dt id="_CPPv4N5arrow13BinaryBuilder12UnsafeAppendEPK7uint8_t7int32_t">
+<span id="_CPPv3N5arrow13BinaryBuilder12UnsafeAppendEPK7uint8_t7int32_t"></span><span id="_CPPv2N5arrow13BinaryBuilder12UnsafeAppendEPK7uint8_t7int32_t"></span><span id="arrow::BinaryBuilder::UnsafeAppend__uint8_tCP.int32_t"></span><span class="target" id="classarrow_1_1_binary_builder_1a2a4a86c28ea71c44823c61f0583b78cd"></span>void <code class="descname">UnsafeAppend</code><span class="sig-paren">(</span><em class="property">const</em> uint8_t *<em>value</em>, int32_t <em>length</em><sp [...]
<dd><p>Append without checking capacity. </p>
<p>Offsets and data should have been presized using <a class="reference internal" href="#classarrow_1_1_array_builder_1afe8448fda39a8529a119bde5ba7ba119"><span class="std std-ref">Reserve()</span></a> and <a class="reference internal" href="#classarrow_1_1_binary_builder_1ab5bda581f3a741a34241f9ad0f97c2c6"><span class="std std-ref">ReserveData()</span></a>, respectively. </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3N5arrow13BinaryBuilder5ResetEv">
-<span id="_CPPv2N5arrow13BinaryBuilder5ResetEv"></span><span id="arrow::BinaryBuilder::Reset"></span><span class="target" id="classarrow_1_1_binary_builder_1af827a728ac60d3e3f7bacf961bb40377"></span>void <code class="descname">Reset</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv3N5arrow13BinaryBuilder5ResetEv" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4N5arrow13BinaryBuilder5ResetEv">
+<span id="_CPPv3N5arrow13BinaryBuilder5ResetEv"></span><span id="_CPPv2N5arrow13BinaryBuilder5ResetEv"></span><span id="arrow::BinaryBuilder::Reset"></span><span class="target" id="classarrow_1_1_binary_builder_1af827a728ac60d3e3f7bacf961bb40377"></span>void <code class="descname">Reset</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow13BinaryBuilder5ResetEv" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Reset the builder. </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3N5arrow13BinaryBuilder6ResizeE7int64_t">
-<span id="_CPPv2N5arrow13BinaryBuilder6ResizeE7int64_t"></span><span id="arrow::BinaryBuilder::Resize__int64_t"></span><span class="target" id="classarrow_1_1_binary_builder_1aaa2e0651e2d191fd6248c843f4429a1d"></span><a class="reference internal" href="support.html#_CPPv3N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descname">Resize</code><span class="sig-paren">(</span>int64_t <em>capacity</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv3N5arrow13B [...]
+<dt id="_CPPv4N5arrow13BinaryBuilder6ResizeE7int64_t">
+<span id="_CPPv3N5arrow13BinaryBuilder6ResizeE7int64_t"></span><span id="_CPPv2N5arrow13BinaryBuilder6ResizeE7int64_t"></span><span id="arrow::BinaryBuilder::Resize__int64_t"></span><span class="target" id="classarrow_1_1_binary_builder_1aaa2e0651e2d191fd6248c843f4429a1d"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descname">Resize</code><span class="sig-paren">(</span>int64_t <em>capacity</em><span class="s [...]
<dd><p>Ensure that enough memory has been allocated to fit the indicated number of total elements in the builder, including any that have already been appended. </p>
<p>Does not account for reallocations that may be due to variable size data, like binary values. To make space for incremental appends, use Reserve instead.</p>
<p><dl class="docutils">
@@ -585,14 +754,14 @@
</dd></dl>
<dl class="function">
-<dt id="_CPPv3N5arrow13BinaryBuilder11ReserveDataE7int64_t">
-<span id="_CPPv2N5arrow13BinaryBuilder11ReserveDataE7int64_t"></span><span id="arrow::BinaryBuilder::ReserveData__int64_t"></span><span class="target" id="classarrow_1_1_binary_builder_1ab5bda581f3a741a34241f9ad0f97c2c6"></span><a class="reference internal" href="support.html#_CPPv3N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descname">ReserveData</code><span class="sig-paren">(</span>int64_t <em>elements</em><span class="sig-paren">)</span><a class="headerlink" href="# [...]
+<dt id="_CPPv4N5arrow13BinaryBuilder11ReserveDataE7int64_t">
+<span id="_CPPv3N5arrow13BinaryBuilder11ReserveDataE7int64_t"></span><span id="_CPPv2N5arrow13BinaryBuilder11ReserveDataE7int64_t"></span><span id="arrow::BinaryBuilder::ReserveData__int64_t"></span><span class="target" id="classarrow_1_1_binary_builder_1ab5bda581f3a741a34241f9ad0f97c2c6"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descname">ReserveData</code><span class="sig-paren">(</span>int64_t <em>eleme [...]
<dd><p>Ensures there is enough allocated capacity to append the indicated number of bytes to the value data buffer without additional allocations. </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3N5arrow13BinaryBuilder14FinishInternalEPNSt10shared_ptrI9ArrayDataEE">
-<span id="_CPPv2N5arrow13BinaryBuilder14FinishInternalEPNSt10shared_ptrI9ArrayDataEE"></span><span id="arrow::BinaryBuilder::FinishInternal__std::shared_ptr:ArrayData:P"></span><span class="target" id="classarrow_1_1_binary_builder_1a13caa5ab30a6b60c95bc37c10ec6010b"></span><a class="reference internal" href="support.html#_CPPv3N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descname">FinishInternal</code><span class="sig-paren">(</span>std::shared_ptr<ArrayData> *<e [...]
+<dt id="_CPPv4N5arrow13BinaryBuilder14FinishInternalEPNSt10shared_ptrI9ArrayDataEE">
+<span id="_CPPv3N5arrow13BinaryBuilder14FinishInternalEPNSt10shared_ptrI9ArrayDataEE"></span><span id="_CPPv2N5arrow13BinaryBuilder14FinishInternalEPNSt10shared_ptrI9ArrayDataEE"></span><span id="arrow::BinaryBuilder::FinishInternal__std::shared_ptr:ArrayData:P"></span><span class="target" id="classarrow_1_1_binary_builder_1a13caa5ab30a6b60c95bc37c10ec6010b"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descna [...]
<dd><p>Return result of builder as an internal generic ArrayData object. </p>
<p>Resets builder except for dictionary builder</p>
<p><dl class="docutils">
@@ -608,8 +777,8 @@
</dd></dl>
<dl class="function">
-<dt id="_CPPv3NK5arrow13BinaryBuilder17value_data_lengthEv">
-<span id="_CPPv2NK5arrow13BinaryBuilder17value_data_lengthEv"></span><span id="arrow::BinaryBuilder::value_data_lengthC"></span><span class="target" id="classarrow_1_1_binary_builder_1a1da67af983ae5c78810d48d8d3e92b36"></span>int64_t <code class="descname">value_data_length</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv3NK5arrow13BinaryBuilder17value_data_lengthEv" title="Permalink to this definitio [...]
+<dt id="_CPPv4NK5arrow13BinaryBuilder17value_data_lengthEv">
+<span id="_CPPv3NK5arrow13BinaryBuilder17value_data_lengthEv"></span><span id="_CPPv2NK5arrow13BinaryBuilder17value_data_lengthEv"></span><span id="arrow::BinaryBuilder::value_data_lengthC"></span><span class="target" id="classarrow_1_1_binary_builder_1a1da67af983ae5c78810d48d8d3e92b36"></span>int64_t <code class="descname">value_data_length</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv4NK5arrow13B [...]
<dd><p><dl class="docutils">
<dt><strong>Return</strong></dt>
<dd>size of values buffer so far </dd>
@@ -618,8 +787,8 @@
</dd></dl>
<dl class="function">
-<dt id="_CPPv3NK5arrow13BinaryBuilder19value_data_capacityEv">
-<span id="_CPPv2NK5arrow13BinaryBuilder19value_data_capacityEv"></span><span id="arrow::BinaryBuilder::value_data_capacityC"></span><span class="target" id="classarrow_1_1_binary_builder_1a56180c6e8fec7abd91a16aedd3015412"></span>int64_t <code class="descname">value_data_capacity</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv3NK5arrow13BinaryBuilder19value_data_capacityEv" title="Permalink to this d [...]
+<dt id="_CPPv4NK5arrow13BinaryBuilder19value_data_capacityEv">
+<span id="_CPPv3NK5arrow13BinaryBuilder19value_data_capacityEv"></span><span id="_CPPv2NK5arrow13BinaryBuilder19value_data_capacityEv"></span><span id="arrow::BinaryBuilder::value_data_capacityC"></span><span class="target" id="classarrow_1_1_binary_builder_1a56180c6e8fec7abd91a16aedd3015412"></span>int64_t <code class="descname">value_data_capacity</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv4NK5 [...]
<dd><p><dl class="docutils">
<dt><strong>Return</strong></dt>
<dd>capacity of values buffer </dd>
@@ -628,15 +797,15 @@
</dd></dl>
<dl class="function">
-<dt id="_CPPv3NK5arrow13BinaryBuilder8GetValueE7int64_tP7int32_t">
-<span id="_CPPv2NK5arrow13BinaryBuilder8GetValueE7int64_tP7int32_t"></span><span id="arrow::BinaryBuilder::GetValue__int64_t.int32_tPC"></span><span class="target" id="classarrow_1_1_binary_builder_1abdb85ad459c436c2a91cc709b361c190"></span><em class="property">const</em> uint8_t *<code class="descname">GetValue</code><span class="sig-paren">(</span>int64_t <em>i</em>, int32_t *<em>out_length</em><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href=" [...]
+<dt id="_CPPv4NK5arrow13BinaryBuilder8GetValueE7int64_tP7int32_t">
+<span id="_CPPv3NK5arrow13BinaryBuilder8GetValueE7int64_tP7int32_t"></span><span id="_CPPv2NK5arrow13BinaryBuilder8GetValueE7int64_tP7int32_t"></span><span id="arrow::BinaryBuilder::GetValue__int64_t.int32_tPC"></span><span class="target" id="classarrow_1_1_binary_builder_1abdb85ad459c436c2a91cc709b361c190"></span><em class="property">const</em> uint8_t *<code class="descname">GetValue</code><span class="sig-paren">(</span>int64_t <em>i</em>, int32_t *<em>out_length</em><span class="sig- [...]
<dd><p>Temporary access to a value. </p>
<p>This pointer becomes invalid on the next modifying operation. </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3NK5arrow13BinaryBuilder7GetViewE7int64_t">
-<span id="_CPPv2NK5arrow13BinaryBuilder7GetViewE7int64_t"></span><span id="arrow::BinaryBuilder::GetView__int64_tC"></span><span class="target" id="classarrow_1_1_binary_builder_1ab0583c603e871706e645282b1b34cba2"></span>util::string_view <code class="descname">GetView</code><span class="sig-paren">(</span>int64_t <em>i</em><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv3NK5arrow13BinaryBuilder7GetViewE7int64_t" title="Permalink to this [...]
+<dt id="_CPPv4NK5arrow13BinaryBuilder7GetViewE7int64_t">
+<span id="_CPPv3NK5arrow13BinaryBuilder7GetViewE7int64_t"></span><span id="_CPPv2NK5arrow13BinaryBuilder7GetViewE7int64_t"></span><span id="arrow::BinaryBuilder::GetView__int64_tC"></span><span class="target" id="classarrow_1_1_binary_builder_1ab0583c603e871706e645282b1b34cba2"></span>util::string_view <code class="descname">GetView</code><span class="sig-paren">(</span>int64_t <em>i</em><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv4NK [...]
<dd><p>Temporary access to a value. </p>
<p>This view becomes invalid on the next modifying operation. </p>
</dd></dl>
@@ -645,14 +814,14 @@
</dd></dl>
<dl class="class">
-<dt id="_CPPv3N5arrow13StringBuilderE">
-<span id="_CPPv2N5arrow13StringBuilderE"></span><span id="arrow::StringBuilder"></span><span class="target" id="classarrow_1_1_string_builder"></span><em class="property">class </em><code class="descname">StringBuilder</code> : <em class="property">public</em> arrow::<a class="reference internal" href="#_CPPv3N5arrow13BinaryBuilderE" title="arrow::BinaryBuilder">BinaryBuilder</a><a class="headerlink" href="#_CPPv3N5arrow13StringBuilderE" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4N5arrow13StringBuilderE">
+<span id="_CPPv3N5arrow13StringBuilderE"></span><span id="_CPPv2N5arrow13StringBuilderE"></span><span id="arrow::StringBuilder"></span><span class="target" id="classarrow_1_1_string_builder"></span><em class="property">class </em><code class="descname">StringBuilder</code> : <em class="property">public</em> arrow::<a class="reference internal" href="#_CPPv4N5arrow13BinaryBuilderE" title="arrow::BinaryBuilder">BinaryBuilder</a><a class="headerlink" href="#_CPPv4N5arrow13StringBuilderE" ti [...]
<dd><p>Builder class for UTF8 strings. </p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric">Public Functions</p>
<dl class="function">
-<dt id="_CPPv3N5arrow13StringBuilder12AppendValuesERKNSt6vectorINSt6stringEEEPK7uint8_t">
-<span id="_CPPv2N5arrow13StringBuilder12AppendValuesERKNSt6vectorINSt6stringEEEPK7uint8_t"></span><span id="arrow::StringBuilder::AppendValues__std::vector:ss:CR.uint8_tCP"></span><span class="target" id="classarrow_1_1_string_builder_1aff0989e98519fa20449e857067036709"></span><a class="reference internal" href="support.html#_CPPv3N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descname">AppendValues</code><span class="sig-paren">(</span><em class="property">const</em> std [...]
+<dt id="_CPPv4N5arrow13StringBuilder12AppendValuesERKNSt6vectorINSt6stringEEEPK7uint8_t">
+<span id="_CPPv3N5arrow13StringBuilder12AppendValuesERKNSt6vectorINSt6stringEEEPK7uint8_t"></span><span id="_CPPv2N5arrow13StringBuilder12AppendValuesERKNSt6vectorINSt6stringEEEPK7uint8_t"></span><span id="arrow::StringBuilder::AppendValues__std::vector:ss:CR.uint8_tCP"></span><span class="target" id="classarrow_1_1_string_builder_1aff0989e98519fa20449e857067036709"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status">Status</a> <code class [...]
<dd><p>Append a sequence of strings in one shot. </p>
<p><dl class="docutils">
<dt><strong>Return</strong></dt>
@@ -668,8 +837,8 @@
</dd></dl>
<dl class="function">
-<dt id="_CPPv3N5arrow13StringBuilder12AppendValuesEPPKc7int64_tPK7uint8_t">
-<span id="_CPPv2N5arrow13StringBuilder12AppendValuesEPPKc7int64_tPK7uint8_t"></span><span id="arrow::StringBuilder::AppendValues__cCPP.int64_t.uint8_tCP"></span><span class="target" id="classarrow_1_1_string_builder_1a11e0d3f643266b1d3b4efa0a2a82f7c2"></span><a class="reference internal" href="support.html#_CPPv3N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descname">AppendValues</code><span class="sig-paren">(</span><em class="property">const</em> char **<em>values</em> [...]
+<dt id="_CPPv4N5arrow13StringBuilder12AppendValuesEPPKc7int64_tPK7uint8_t">
+<span id="_CPPv3N5arrow13StringBuilder12AppendValuesEPPKc7int64_tPK7uint8_t"></span><span id="_CPPv2N5arrow13StringBuilder12AppendValuesEPPKc7int64_tPK7uint8_t"></span><span id="arrow::StringBuilder::AppendValues__cCPP.int64_t.uint8_tCP"></span><span class="target" id="classarrow_1_1_string_builder_1a11e0d3f643266b1d3b4efa0a2a82f7c2"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descname">AppendValues</code><s [...]
<dd><p>Append a sequence of nul-terminated strings in one shot. </p>
<p>If one of the values is NULL, it is processed as a null value even if the corresponding valid_bytes entry is 1.</p>
<p><dl class="docutils">
@@ -687,8 +856,8 @@
</dd></dl>
<dl class="function">
-<dt id="_CPPv3N5arrow13BinaryBuilder12UnsafeAppendEv">
-<span id="_CPPv2N5arrow13BinaryBuilder12UnsafeAppendEv"></span><span id="arrow::BinaryBuilder::UnsafeAppend"></span><span class="target" id="classarrow_1_1_string_builder_1a2a4a86c28ea71c44823c61f0583b78cd"></span>void <code class="descname">UnsafeAppend</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv3N5arrow13BinaryBuilder12UnsafeAppendEv" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4N5arrow13BinaryBuilder12UnsafeAppendEv">
+<span id="_CPPv3N5arrow13BinaryBuilder12UnsafeAppendEv"></span><span id="_CPPv2N5arrow13BinaryBuilder12UnsafeAppendEv"></span><span id="arrow::BinaryBuilder::UnsafeAppend"></span><span class="target" id="classarrow_1_1_string_builder_1a2a4a86c28ea71c44823c61f0583b78cd"></span>void <code class="descname">UnsafeAppend</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow13BinaryBuilder12UnsafeAppendEv" title="Permalink to this defi [...]
<dd><p>Append without checking capacity. </p>
<p>Offsets and data should have been presized using <a class="reference internal" href="#classarrow_1_1_array_builder_1afe8448fda39a8529a119bde5ba7ba119"><span class="std std-ref">Reserve()</span></a> and <a class="reference internal" href="#classarrow_1_1_binary_builder_1ab5bda581f3a741a34241f9ad0f97c2c6"><span class="std std-ref">ReserveData()</span></a>, respectively. </p>
</dd></dl>
@@ -697,20 +866,20 @@
</dd></dl>
<dl class="class">
-<dt id="_CPPv3N5arrow22FixedSizeBinaryBuilderE">
-<span id="_CPPv2N5arrow22FixedSizeBinaryBuilderE"></span><span id="arrow::FixedSizeBinaryBuilder"></span><span class="target" id="classarrow_1_1_fixed_size_binary_builder"></span><em class="property">class </em><code class="descname">FixedSizeBinaryBuilder</code> : <em class="property">public</em> arrow::<a class="reference internal" href="#_CPPv3N5arrow12ArrayBuilderE" title="arrow::ArrayBuilder">ArrayBuilder</a><a class="headerlink" href="#_CPPv3N5arrow22FixedSizeBinaryBuilderE" title= [...]
+<dt id="_CPPv4N5arrow22FixedSizeBinaryBuilderE">
+<span id="_CPPv3N5arrow22FixedSizeBinaryBuilderE"></span><span id="_CPPv2N5arrow22FixedSizeBinaryBuilderE"></span><span id="arrow::FixedSizeBinaryBuilder"></span><span class="target" id="classarrow_1_1_fixed_size_binary_builder"></span><em class="property">class </em><code class="descname">FixedSizeBinaryBuilder</code> : <em class="property">public</em> arrow::<a class="reference internal" href="#_CPPv4N5arrow12ArrayBuilderE" title="arrow::ArrayBuilder">ArrayBuilder</a><a class="headerli [...]
<dd><p>Subclassed by <a class="reference internal" href="#classarrow_1_1_decimal128_builder"><span class="std std-ref">arrow::Decimal128Builder</span></a></p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric">Public Functions</p>
<dl class="function">
-<dt id="_CPPv3N5arrow22FixedSizeBinaryBuilder5ResetEv">
-<span id="_CPPv2N5arrow22FixedSizeBinaryBuilder5ResetEv"></span><span id="arrow::FixedSizeBinaryBuilder::Reset"></span><span class="target" id="classarrow_1_1_fixed_size_binary_builder_1af646f4d380162134d7d18ad4af81f056"></span>void <code class="descname">Reset</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv3N5arrow22FixedSizeBinaryBuilder5ResetEv" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4N5arrow22FixedSizeBinaryBuilder5ResetEv">
+<span id="_CPPv3N5arrow22FixedSizeBinaryBuilder5ResetEv"></span><span id="_CPPv2N5arrow22FixedSizeBinaryBuilder5ResetEv"></span><span id="arrow::FixedSizeBinaryBuilder::Reset"></span><span class="target" id="classarrow_1_1_fixed_size_binary_builder_1af646f4d380162134d7d18ad4af81f056"></span>void <code class="descname">Reset</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow22FixedSizeBinaryBuilder5ResetEv" title="Permalink to [...]
<dd><p>Reset the builder. </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3N5arrow22FixedSizeBinaryBuilder6ResizeE7int64_t">
-<span id="_CPPv2N5arrow22FixedSizeBinaryBuilder6ResizeE7int64_t"></span><span id="arrow::FixedSizeBinaryBuilder::Resize__int64_t"></span><span class="target" id="classarrow_1_1_fixed_size_binary_builder_1acab2531151f38e2752dc0d6400a22ec2"></span><a class="reference internal" href="support.html#_CPPv3N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descname">Resize</code><span class="sig-paren">(</span>int64_t <em>capacity</em><span class="sig-paren">)</span><a class="header [...]
+<dt id="_CPPv4N5arrow22FixedSizeBinaryBuilder6ResizeE7int64_t">
+<span id="_CPPv3N5arrow22FixedSizeBinaryBuilder6ResizeE7int64_t"></span><span id="_CPPv2N5arrow22FixedSizeBinaryBuilder6ResizeE7int64_t"></span><span id="arrow::FixedSizeBinaryBuilder::Resize__int64_t"></span><span class="target" id="classarrow_1_1_fixed_size_binary_builder_1acab2531151f38e2752dc0d6400a22ec2"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descname">Resize</code><span class="sig-paren">(</span>i [...]
<dd><p>Ensure that enough memory has been allocated to fit the indicated number of total elements in the builder, including any that have already been appended. </p>
<p>Does not account for reallocations that may be due to variable size data, like binary values. To make space for incremental appends, use Reserve instead.</p>
<p><dl class="docutils">
@@ -726,8 +895,8 @@
</dd></dl>
<dl class="function">
-<dt id="_CPPv3N5arrow22FixedSizeBinaryBuilder14FinishInternalEPNSt10shared_ptrI9ArrayDataEE">
-<span id="_CPPv2N5arrow22FixedSizeBinaryBuilder14FinishInternalEPNSt10shared_ptrI9ArrayDataEE"></span><span id="arrow::FixedSizeBinaryBuilder::FinishInternal__std::shared_ptr:ArrayData:P"></span><span class="target" id="classarrow_1_1_fixed_size_binary_builder_1af4abbc3596d4e7bb4b5bb843f361540e"></span><a class="reference internal" href="support.html#_CPPv3N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descname">FinishInternal</code><span class="sig-paren">(</span>std::sh [...]
+<dt id="_CPPv4N5arrow22FixedSizeBinaryBuilder14FinishInternalEPNSt10shared_ptrI9ArrayDataEE">
+<span id="_CPPv3N5arrow22FixedSizeBinaryBuilder14FinishInternalEPNSt10shared_ptrI9ArrayDataEE"></span><span id="_CPPv2N5arrow22FixedSizeBinaryBuilder14FinishInternalEPNSt10shared_ptrI9ArrayDataEE"></span><span id="arrow::FixedSizeBinaryBuilder::FinishInternal__std::shared_ptr:ArrayData:P"></span><span class="target" id="classarrow_1_1_fixed_size_binary_builder_1af4abbc3596d4e7bb4b5bb843f361540e"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow:: [...]
<dd><p>Return result of builder as an internal generic ArrayData object. </p>
<p>Resets builder except for dictionary builder</p>
<p><dl class="docutils">
@@ -743,8 +912,8 @@
</dd></dl>
<dl class="function">
-<dt id="_CPPv3NK5arrow22FixedSizeBinaryBuilder17value_data_lengthEv">
-<span id="_CPPv2NK5arrow22FixedSizeBinaryBuilder17value_data_lengthEv"></span><span id="arrow::FixedSizeBinaryBuilder::value_data_lengthC"></span><span class="target" id="classarrow_1_1_fixed_size_binary_builder_1a9d4ee907329c71703a139b803a4ba4fe"></span>int64_t <code class="descname">value_data_length</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv3NK5arrow22FixedSizeBinaryBuilder17value_data_length [...]
+<dt id="_CPPv4NK5arrow22FixedSizeBinaryBuilder17value_data_lengthEv">
+<span id="_CPPv3NK5arrow22FixedSizeBinaryBuilder17value_data_lengthEv"></span><span id="_CPPv2NK5arrow22FixedSizeBinaryBuilder17value_data_lengthEv"></span><span id="arrow::FixedSizeBinaryBuilder::value_data_lengthC"></span><span class="target" id="classarrow_1_1_fixed_size_binary_builder_1a9d4ee907329c71703a139b803a4ba4fe"></span>int64_t <code class="descname">value_data_length</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class [...]
<dd><p><dl class="docutils">
<dt><strong>Return</strong></dt>
<dd>size of values buffer so far </dd>
@@ -753,15 +922,15 @@
</dd></dl>
<dl class="function">
-<dt id="_CPPv3NK5arrow22FixedSizeBinaryBuilder8GetValueE7int64_t">
-<span id="_CPPv2NK5arrow22FixedSizeBinaryBuilder8GetValueE7int64_t"></span><span id="arrow::FixedSizeBinaryBuilder::GetValue__int64_tC"></span><span class="target" id="classarrow_1_1_fixed_size_binary_builder_1ac232789ccc1f36f3d847e6736e78fa9d"></span><em class="property">const</em> uint8_t *<code class="descname">GetValue</code><span class="sig-paren">(</span>int64_t <em>i</em><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv3NK5arrow22Fi [...]
+<dt id="_CPPv4NK5arrow22FixedSizeBinaryBuilder8GetValueE7int64_t">
+<span id="_CPPv3NK5arrow22FixedSizeBinaryBuilder8GetValueE7int64_t"></span><span id="_CPPv2NK5arrow22FixedSizeBinaryBuilder8GetValueE7int64_t"></span><span id="arrow::FixedSizeBinaryBuilder::GetValue__int64_tC"></span><span class="target" id="classarrow_1_1_fixed_size_binary_builder_1ac232789ccc1f36f3d847e6736e78fa9d"></span><em class="property">const</em> uint8_t *<code class="descname">GetValue</code><span class="sig-paren">(</span>int64_t <em>i</em><span class="sig-paren">)</span> <em [...]
<dd><p>Temporary access to a value. </p>
<p>This pointer becomes invalid on the next modifying operation. </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3NK5arrow22FixedSizeBinaryBuilder7GetViewE7int64_t">
-<span id="_CPPv2NK5arrow22FixedSizeBinaryBuilder7GetViewE7int64_t"></span><span id="arrow::FixedSizeBinaryBuilder::GetView__int64_tC"></span><span class="target" id="classarrow_1_1_fixed_size_binary_builder_1aa44ba82709b2beff369bf0b34bce1f6b"></span>util::string_view <code class="descname">GetView</code><span class="sig-paren">(</span>int64_t <em>i</em><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv3NK5arrow22FixedSizeBinaryBuilder7GetVi [...]
+<dt id="_CPPv4NK5arrow22FixedSizeBinaryBuilder7GetViewE7int64_t">
+<span id="_CPPv3NK5arrow22FixedSizeBinaryBuilder7GetViewE7int64_t"></span><span id="_CPPv2NK5arrow22FixedSizeBinaryBuilder7GetViewE7int64_t"></span><span id="arrow::FixedSizeBinaryBuilder::GetView__int64_tC"></span><span class="target" id="classarrow_1_1_fixed_size_binary_builder_1aa44ba82709b2beff369bf0b34bce1f6b"></span>util::string_view <code class="descname">GetView</code><span class="sig-paren">(</span>int64_t <em>i</em><span class="sig-paren">)</span> <em class="property">const</em [...]
<dd><p>Temporary access to a value. </p>
<p>This view becomes invalid on the next modifying operation. </p>
</dd></dl>
@@ -770,13 +939,13 @@
</dd></dl>
<dl class="class">
-<dt id="_CPPv3N5arrow17Decimal128BuilderE">
-<span id="_CPPv2N5arrow17Decimal128BuilderE"></span><span id="arrow::Decimal128Builder"></span><span class="target" id="classarrow_1_1_decimal128_builder"></span><em class="property">class </em><code class="descname">Decimal128Builder</code> : <em class="property">public</em> arrow::<a class="reference internal" href="#_CPPv3N5arrow22FixedSizeBinaryBuilderE" title="arrow::FixedSizeBinaryBuilder">FixedSizeBinaryBuilder</a><a class="headerlink" href="#_CPPv3N5arrow17Decimal128BuilderE" tit [...]
+<dt id="_CPPv4N5arrow17Decimal128BuilderE">
+<span id="_CPPv3N5arrow17Decimal128BuilderE"></span><span id="_CPPv2N5arrow17Decimal128BuilderE"></span><span id="arrow::Decimal128Builder"></span><span class="target" id="classarrow_1_1_decimal128_builder"></span><em class="property">class </em><code class="descname">Decimal128Builder</code> : <em class="property">public</em> arrow::<a class="reference internal" href="#_CPPv4N5arrow22FixedSizeBinaryBuilderE" title="arrow::FixedSizeBinaryBuilder">FixedSizeBinaryBuilder</a><a class="heade [...]
<dd><div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric">Public Functions</p>
<dl class="function">
-<dt id="_CPPv3N5arrow17Decimal128Builder14FinishInternalEPNSt10shared_ptrI9ArrayDataEE">
-<span id="_CPPv2N5arrow17Decimal128Builder14FinishInternalEPNSt10shared_ptrI9ArrayDataEE"></span><span id="arrow::Decimal128Builder::FinishInternal__std::shared_ptr:ArrayData:P"></span><span class="target" id="classarrow_1_1_decimal128_builder_1a1024061ca0b17d1af0967f008ec47313"></span><a class="reference internal" href="support.html#_CPPv3N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descname">FinishInternal</code><span class="sig-paren">(</span>std::shared_ptr<Array [...]
+<dt id="_CPPv4N5arrow17Decimal128Builder14FinishInternalEPNSt10shared_ptrI9ArrayDataEE">
+<span id="_CPPv3N5arrow17Decimal128Builder14FinishInternalEPNSt10shared_ptrI9ArrayDataEE"></span><span id="_CPPv2N5arrow17Decimal128Builder14FinishInternalEPNSt10shared_ptrI9ArrayDataEE"></span><span id="arrow::Decimal128Builder::FinishInternal__std::shared_ptr:ArrayData:P"></span><span class="target" id="classarrow_1_1_decimal128_builder_1a1024061ca0b17d1af0967f008ec47313"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status">Status</a> <co [...]
<dd><p>Return result of builder as an internal generic ArrayData object. </p>
<p>Resets builder except for dictionary builder</p>
<p><dl class="docutils">
@@ -795,22 +964,22 @@
</dd></dl>
<dl class="class">
-<dt id="_CPPv3N5arrow11ListBuilderE">
-<span id="_CPPv2N5arrow11ListBuilderE"></span><span id="arrow::ListBuilder"></span><span class="target" id="classarrow_1_1_list_builder"></span><em class="property">class </em><code class="descname">ListBuilder</code> : <em class="property">public</em> arrow::<a class="reference internal" href="#_CPPv3N5arrow12ArrayBuilderE" title="arrow::ArrayBuilder">ArrayBuilder</a><a class="headerlink" href="#_CPPv3N5arrow11ListBuilderE" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4N5arrow11ListBuilderE">
+<span id="_CPPv3N5arrow11ListBuilderE"></span><span id="_CPPv2N5arrow11ListBuilderE"></span><span id="arrow::ListBuilder"></span><span class="target" id="classarrow_1_1_list_builder"></span><em class="property">class </em><code class="descname">ListBuilder</code> : <em class="property">public</em> arrow::<a class="reference internal" href="#_CPPv4N5arrow12ArrayBuilderE" title="arrow::ArrayBuilder">ArrayBuilder</a><a class="headerlink" href="#_CPPv4N5arrow11ListBuilderE" title="Permalink [...]
<dd><p>Builder class for variable-length list array value types. </p>
<p>To use this class, you must append values to the child array builder and use the Append function to delimit each distinct list value (once the values have been appended to the child array) or use the bulk API to append a sequence of offests and null values.</p>
<p>A note on types. Per arrow/type.h all types in the c++ implementation are logical so even though this class always builds list array, this can represent multiple different logical types. If no logical type is provided at construction time, the class defaults to List<T> where t is taken from the value_builder/values that the object is constructed with. </p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric">Public Functions</p>
<dl class="function">
-<dt id="_CPPv3N5arrow11ListBuilder11ListBuilderEP10MemoryPoolRNSt10shared_ptrI12ArrayBuilderEERKNSt10shared_ptrI8DataTypeEE">
-<span id="_CPPv2N5arrow11ListBuilder11ListBuilderEP10MemoryPoolRNSt10shared_ptrI12ArrayBuilderEERKNSt10shared_ptrI8DataTypeEE"></span><span id="arrow::ListBuilder::ListBuilder__MemoryPoolP.std::shared_ptr:ArrayBuilder:CR.std::shared_ptr:DataType:CR"></span><span class="target" id="classarrow_1_1_list_builder_1ac8f300486c5cc1de1e599a66b6d6a433"></span><code class="descname">ListBuilder</code><span class="sig-paren">(</span><a class="reference internal" href="memory.html#_CPPv3N5arrow10Mem [...]
+<dt id="_CPPv4N5arrow11ListBuilder11ListBuilderEP10MemoryPoolRKNSt10shared_ptrI12ArrayBuilderEERKNSt10shared_ptrI8DataTypeEE">
+<span id="_CPPv3N5arrow11ListBuilder11ListBuilderEP10MemoryPoolRKNSt10shared_ptrI12ArrayBuilderEERKNSt10shared_ptrI8DataTypeEE"></span><span id="_CPPv2N5arrow11ListBuilder11ListBuilderEP10MemoryPoolRKNSt10shared_ptrI12ArrayBuilderEERKNSt10shared_ptrI8DataTypeEE"></span><span id="arrow::ListBuilder::ListBuilder__MemoryPoolP.std::shared_ptr:ArrayBuilder:CR.std::shared_ptr:DataType:CR"></span><span class="target" id="classarrow_1_1_list_builder_1ac8f300486c5cc1de1e599a66b6d6a433"></span><co [...]
<dd><p>Use this constructor to incrementally build the value array along with offsets and null bitmap. </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3N5arrow11ListBuilder6ResizeE7int64_t">
-<span id="_CPPv2N5arrow11ListBuilder6ResizeE7int64_t"></span><span id="arrow::ListBuilder::Resize__int64_t"></span><span class="target" id="classarrow_1_1_list_builder_1ab8375a47aa4807f377d40f1559159da0"></span><a class="reference internal" href="support.html#_CPPv3N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descname">Resize</code><span class="sig-paren">(</span>int64_t <em>capacity</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv3N5arrow11ListBui [...]
+<dt id="_CPPv4N5arrow11ListBuilder6ResizeE7int64_t">
+<span id="_CPPv3N5arrow11ListBuilder6ResizeE7int64_t"></span><span id="_CPPv2N5arrow11ListBuilder6ResizeE7int64_t"></span><span id="arrow::ListBuilder::Resize__int64_t"></span><span class="target" id="classarrow_1_1_list_builder_1ab8375a47aa4807f377d40f1559159da0"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descname">Resize</code><span class="sig-paren">(</span>int64_t <em>capacity</em><span class="sig-paren [...]
<dd><p>Ensure that enough memory has been allocated to fit the indicated number of total elements in the builder, including any that have already been appended. </p>
<p>Does not account for reallocations that may be due to variable size data, like binary values. To make space for incremental appends, use Reserve instead.</p>
<p><dl class="docutils">
@@ -826,14 +995,14 @@
</dd></dl>
<dl class="function">
-<dt id="_CPPv3N5arrow11ListBuilder5ResetEv">
-<span id="_CPPv2N5arrow11ListBuilder5ResetEv"></span><span id="arrow::ListBuilder::Reset"></span><span class="target" id="classarrow_1_1_list_builder_1a3e3902824cff65392d1e698906f4066e"></span>void <code class="descname">Reset</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv3N5arrow11ListBuilder5ResetEv" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4N5arrow11ListBuilder5ResetEv">
+<span id="_CPPv3N5arrow11ListBuilder5ResetEv"></span><span id="_CPPv2N5arrow11ListBuilder5ResetEv"></span><span id="arrow::ListBuilder::Reset"></span><span class="target" id="classarrow_1_1_list_builder_1a3e3902824cff65392d1e698906f4066e"></span>void <code class="descname">Reset</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow11ListBuilder5ResetEv" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Reset the builder. </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3N5arrow11ListBuilder14FinishInternalEPNSt10shared_ptrI9ArrayDataEE">
-<span id="_CPPv2N5arrow11ListBuilder14FinishInternalEPNSt10shared_ptrI9ArrayDataEE"></span><span id="arrow::ListBuilder::FinishInternal__std::shared_ptr:ArrayData:P"></span><span class="target" id="classarrow_1_1_list_builder_1af7d5bfe8d46e7447e963c9f56b11b52f"></span><a class="reference internal" href="support.html#_CPPv3N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descname">FinishInternal</code><span class="sig-paren">(</span>std::shared_ptr<ArrayData> *<em>out< [...]
+<dt id="_CPPv4N5arrow11ListBuilder14FinishInternalEPNSt10shared_ptrI9ArrayDataEE">
+<span id="_CPPv3N5arrow11ListBuilder14FinishInternalEPNSt10shared_ptrI9ArrayDataEE"></span><span id="_CPPv2N5arrow11ListBuilder14FinishInternalEPNSt10shared_ptrI9ArrayDataEE"></span><span id="arrow::ListBuilder::FinishInternal__std::shared_ptr:ArrayData:P"></span><span class="target" id="classarrow_1_1_list_builder_1af7d5bfe8d46e7447e963c9f56b11b52f"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descname">Fini [...]
<dd><p>Return result of builder as an internal generic ArrayData object. </p>
<p>Resets builder except for dictionary builder</p>
<p><dl class="docutils">
@@ -849,15 +1018,15 @@
</dd></dl>
<dl class="function">
-<dt id="_CPPv3N5arrow11ListBuilder12AppendValuesEPK7int32_t7int64_tPK7uint8_t">
-<span id="_CPPv2N5arrow11ListBuilder12AppendValuesEPK7int32_t7int64_tPK7uint8_t"></span><span id="arrow::ListBuilder::AppendValues__int32_tCP.int64_t.uint8_tCP"></span><span class="target" id="classarrow_1_1_list_builder_1ade9b040bfb960fd7362828bbc02c3814"></span><a class="reference internal" href="support.html#_CPPv3N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descname">AppendValues</code><span class="sig-paren">(</span><em class="property">const</em> int32_t *<em>offs [...]
+<dt id="_CPPv4N5arrow11ListBuilder12AppendValuesEPK7int32_t7int64_tPK7uint8_t">
+<span id="_CPPv3N5arrow11ListBuilder12AppendValuesEPK7int32_t7int64_tPK7uint8_t"></span><span id="_CPPv2N5arrow11ListBuilder12AppendValuesEPK7int32_t7int64_tPK7uint8_t"></span><span id="arrow::ListBuilder::AppendValues__int32_tCP.int64_t.uint8_tCP"></span><span class="target" id="classarrow_1_1_list_builder_1ade9b040bfb960fd7362828bbc02c3814"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descname">AppendValues [...]
<dd><p>Vector append. </p>
<p>If passed, valid_bytes is of equal length to values, and any zero byte will be considered as a null for that slot </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3N5arrow11ListBuilder6AppendEb">
-<span id="_CPPv2N5arrow11ListBuilder6AppendEb"></span><span id="arrow::ListBuilder::Append__b"></span><span class="target" id="classarrow_1_1_list_builder_1a5c8704db1b7749f4a61c5d2632c57d12"></span><a class="reference internal" href="support.html#_CPPv3N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descname">Append</code><span class="sig-paren">(</span>bool <em>is_valid</em> = true<span class="sig-paren">)</span><a class="headerlink" href="#_CPPv3N5arrow11ListBuilder6Appe [...]
+<dt id="_CPPv4N5arrow11ListBuilder6AppendEb">
+<span id="_CPPv3N5arrow11ListBuilder6AppendEb"></span><span id="_CPPv2N5arrow11ListBuilder6AppendEb"></span><span id="arrow::ListBuilder::Append__b"></span><span class="target" id="classarrow_1_1_list_builder_1a5c8704db1b7749f4a61c5d2632c57d12"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descname">Append</code><span class="sig-paren">(</span>bool <em>is_valid</em> = true<span class="sig-paren">)</span><a cla [...]
<dd><p>Start a new variable-length list slot. </p>
<p>This function should be called before beginning to append elements to the value builder </p>
</dd></dl>
@@ -866,15 +1035,15 @@
</dd></dl>
<dl class="class">
-<dt id="_CPPv3N5arrow13StructBuilderE">
-<span id="_CPPv2N5arrow13StructBuilderE"></span><span id="arrow::StructBuilder"></span><span class="target" id="classarrow_1_1_struct_builder"></span><em class="property">class </em><code class="descname">StructBuilder</code> : <em class="property">public</em> arrow::<a class="reference internal" href="#_CPPv3N5arrow12ArrayBuilderE" title="arrow::ArrayBuilder">ArrayBuilder</a><a class="headerlink" href="#_CPPv3N5arrow13StructBuilderE" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4N5arrow13StructBuilderE">
+<span id="_CPPv3N5arrow13StructBuilderE"></span><span id="_CPPv2N5arrow13StructBuilderE"></span><span id="arrow::StructBuilder"></span><span class="target" id="classarrow_1_1_struct_builder"></span><em class="property">class </em><code class="descname">StructBuilder</code> : <em class="property">public</em> arrow::<a class="reference internal" href="#_CPPv4N5arrow12ArrayBuilderE" title="arrow::ArrayBuilder">ArrayBuilder</a><a class="headerlink" href="#_CPPv4N5arrow13StructBuilderE" title [...]
<dd><p>Append, Resize and Reserve methods are acting on <a class="reference internal" href="#classarrow_1_1_struct_builder"><span class="std std-ref">StructBuilder</span></a>. </p>
<p>Please make sure all these methods of all child-builders’ are consistently called to maintain data-structure consistency. </p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric">Public Functions</p>
<dl class="function">
-<dt id="_CPPv3N5arrow13StructBuilder14FinishInternalEPNSt10shared_ptrI9ArrayDataEE">
-<span id="_CPPv2N5arrow13StructBuilder14FinishInternalEPNSt10shared_ptrI9ArrayDataEE"></span><span id="arrow::StructBuilder::FinishInternal__std::shared_ptr:ArrayData:P"></span><span class="target" id="classarrow_1_1_struct_builder_1afd9ece86557f3fec253e10a2edbd4840"></span><a class="reference internal" href="support.html#_CPPv3N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descname">FinishInternal</code><span class="sig-paren">(</span>std::shared_ptr<ArrayData> *<e [...]
+<dt id="_CPPv4N5arrow13StructBuilder14FinishInternalEPNSt10shared_ptrI9ArrayDataEE">
+<span id="_CPPv3N5arrow13StructBuilder14FinishInternalEPNSt10shared_ptrI9ArrayDataEE"></span><span id="_CPPv2N5arrow13StructBuilder14FinishInternalEPNSt10shared_ptrI9ArrayDataEE"></span><span id="arrow::StructBuilder::FinishInternal__std::shared_ptr:ArrayData:P"></span><span class="target" id="classarrow_1_1_struct_builder_1afd9ece86557f3fec253e10a2edbd4840"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descna [...]
<dd><p>Return result of builder as an internal generic ArrayData object. </p>
<p>Resets builder except for dictionary builder</p>
<p><dl class="docutils">
@@ -890,21 +1059,21 @@
</dd></dl>
<dl class="function">
-<dt id="_CPPv3N5arrow13StructBuilder12AppendValuesE7int64_tPK7uint8_t">
-<span id="_CPPv2N5arrow13StructBuilder12AppendValuesE7int64_tPK7uint8_t"></span><span id="arrow::StructBuilder::AppendValues__int64_t.uint8_tCP"></span><span class="target" id="classarrow_1_1_struct_builder_1ab9839275df1391fdafde9a4cb1398e0b"></span><a class="reference internal" href="support.html#_CPPv3N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descname">AppendValues</code><span class="sig-paren">(</span>int64_t <em>length</em>, <em class="property">const</em> uint8_ [...]
+<dt id="_CPPv4N5arrow13StructBuilder12AppendValuesE7int64_tPK7uint8_t">
+<span id="_CPPv3N5arrow13StructBuilder12AppendValuesE7int64_tPK7uint8_t"></span><span id="_CPPv2N5arrow13StructBuilder12AppendValuesE7int64_tPK7uint8_t"></span><span id="arrow::StructBuilder::AppendValues__int64_t.uint8_tCP"></span><span class="target" id="classarrow_1_1_struct_builder_1ab9839275df1391fdafde9a4cb1398e0b"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descname">AppendValues</code><span class="si [...]
<dd><p>Null bitmap is of equal length to every child field, and any zero byte will be considered as a null for that field, but users must using app- end methods or advance methods of the child builders’ independently to insert data. </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3N5arrow13StructBuilder6AppendEb">
-<span id="_CPPv2N5arrow13StructBuilder6AppendEb"></span><span id="arrow::StructBuilder::Append__b"></span><span class="target" id="classarrow_1_1_struct_builder_1a772833e76ddabfe510acf04279673867"></span><a class="reference internal" href="support.html#_CPPv3N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descname">Append</code><span class="sig-paren">(</span>bool <em>is_valid</em> = true<span class="sig-paren">)</span><a class="headerlink" href="#_CPPv3N5arrow13StructBuil [...]
+<dt id="_CPPv4N5arrow13StructBuilder6AppendEb">
+<span id="_CPPv3N5arrow13StructBuilder6AppendEb"></span><span id="_CPPv2N5arrow13StructBuilder6AppendEb"></span><span id="arrow::StructBuilder::Append__b"></span><span class="target" id="classarrow_1_1_struct_builder_1a772833e76ddabfe510acf04279673867"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descname">Append</code><span class="sig-paren">(</span>bool <em>is_valid</em> = true<span class="sig-paren">)</spa [...]
<dd><p>Append an element to the Struct. </p>
<p>All child-builders’ Append method must be called independently to maintain data-structure consistency. </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3N5arrow13StructBuilder5ResetEv">
-<span id="_CPPv2N5arrow13StructBuilder5ResetEv"></span><span id="arrow::StructBuilder::Reset"></span><span class="target" id="classarrow_1_1_struct_builder_1a361986b08279c6cb0ed7ec337e096767"></span>void <code class="descname">Reset</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv3N5arrow13StructBuilder5ResetEv" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4N5arrow13StructBuilder5ResetEv">
+<span id="_CPPv3N5arrow13StructBuilder5ResetEv"></span><span id="_CPPv2N5arrow13StructBuilder5ResetEv"></span><span id="arrow::StructBuilder::Reset"></span><span class="target" id="classarrow_1_1_struct_builder_1a361986b08279c6cb0ed7ec337e096767"></span>void <code class="descname">Reset</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow13StructBuilder5ResetEv" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Reset the builder. </p>
</dd></dl>
@@ -912,52 +1081,52 @@
</dd></dl>
<dl class="class">
-<dt id="_CPPv3N5arrow17DictionaryBuilderE">
-<span id="_CPPv2N5arrow17DictionaryBuilderE"></span><span id="arrow::DictionaryBuilder"></span><span class="target" id="classarrow_1_1_dictionary_builder"></span><em class="property">template </em><typename <em>T</em>><br /><em class="property">class </em><code class="descname">DictionaryBuilder</code> : <em class="property">public</em> arrow::<a class="reference internal" href="#_CPPv3N5arrow12ArrayBuilderE" title="arrow::ArrayBuilder">ArrayBuilder</a><a class="headerlink" href="# [...]
+<dt id="_CPPv4N5arrow17DictionaryBuilderE">
+<span id="_CPPv3N5arrow17DictionaryBuilderE"></span><span id="_CPPv2N5arrow17DictionaryBuilderE"></span><span id="arrow::DictionaryBuilder"></span><span class="target" id="classarrow_1_1_dictionary_builder"></span><em class="property">template </em><typename <em>T</em>><br /><em class="property">class </em><code class="descname">DictionaryBuilder</code> : <em class="property">public</em> arrow::<a class="reference internal" href="#_CPPv4N5arrow12ArrayBuilderE" title="arrow::ArrayBu [...]
<dd><p><a class="reference internal" href="array.html#classarrow_1_1_array"><span class="std std-ref">Array</span></a> builder for created encoded <a class="reference internal" href="array.html#classarrow_1_1_dictionary_array"><span class="std std-ref">DictionaryArray</span></a> from dense array. </p>
<p>Unlike other builders, dictionary builder does not completely reset the state on Finish calls. The arrays built after the initial Finish call will reuse the previously created encoding and build a delta dictionary when new terms occur.</p>
<p>data </p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric">Public Functions</p>
<dl class="function">
-<dt id="_CPPv3N5arrow17DictionaryBuilder6AppendERK6Scalar">
-<span id="_CPPv2N5arrow17DictionaryBuilder6AppendERK6Scalar"></span><span id="arrow::DictionaryBuilder::Append__ScalarCR"></span><span class="target" id="classarrow_1_1_dictionary_builder_1a37f90cda182952ce1d75897da2627eef"></span><a class="reference internal" href="support.html#_CPPv3N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descname">Append</code><span class="sig-paren">(</span><em class="property">const</em> Scalar &<em>value</em><span class="sig-paren">)</spa [...]
+<dt id="_CPPv4N5arrow17DictionaryBuilder6AppendERK6Scalar">
+<span id="_CPPv3N5arrow17DictionaryBuilder6AppendERK6Scalar"></span><span id="_CPPv2N5arrow17DictionaryBuilder6AppendERK6Scalar"></span><span id="arrow::DictionaryBuilder::Append__ScalarCR"></span><span class="target" id="classarrow_1_1_dictionary_builder_1a37f90cda182952ce1d75897da2627eef"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descname">Append</code><span class="sig-paren">(</span><em class="property" [...]
<dd><p>Append a scalar value. </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3N5arrow17DictionaryBuilder6AppendENSt9enable_ifINSt10is_base_ofI19FixedSizeBinaryType2T1E5valueEPK7uint8_tE4typeE">
-<span id="_CPPv2N5arrow17DictionaryBuilder6AppendENSt9enable_ifINSt10is_base_ofI19FixedSizeBinaryType2T1E5valueEPK7uint8_tE4typeE"></span><span id="arrow::DictionaryBuilder::Append__std::enable_if:std::is_base_of:FixedSizeBinaryType.T1:::value.uint8_tCP:::type"></span><em class="property">template </em><<em class="property">typename</em> T1 = T><br /><span class="target" id="classarrow_1_1_dictionary_builder_1adf4e20217353fb246aa54ead52f45e20"></span><a class="reference internal" h [...]
+<dt id="_CPPv4N5arrow17DictionaryBuilder6AppendENSt9enable_ifINSt10is_base_ofI19FixedSizeBinaryType2T1E5valueEPK7uint8_tE4typeE">
+<span id="_CPPv3N5arrow17DictionaryBuilder6AppendENSt9enable_ifINSt10is_base_ofI19FixedSizeBinaryType2T1E5valueEPK7uint8_tE4typeE"></span><span id="_CPPv2N5arrow17DictionaryBuilder6AppendENSt9enable_ifINSt10is_base_ofI19FixedSizeBinaryType2T1E5valueEPK7uint8_tE4typeE"></span><span id="arrow::DictionaryBuilder::Append__std::enable_if:std::is_base_of:FixedSizeBinaryType.T1:::value.uint8_tCP:::type"></span><em class="property">template </em><<em class="property">typename</em> T1 = T>< [...]
<dd><p>Append a fixed-width string (only for <a class="reference internal" href="datatype.html#classarrow_1_1_fixed_size_binary_type"><span class="std std-ref">FixedSizeBinaryType</span></a>) </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3N5arrow17DictionaryBuilder6AppendENSt9enable_ifINSt10is_base_ofI19FixedSizeBinaryType2T1E5valueEPKcE4typeE">
-<span id="_CPPv2N5arrow17DictionaryBuilder6AppendENSt9enable_ifINSt10is_base_ofI19FixedSizeBinaryType2T1E5valueEPKcE4typeE"></span><span id="arrow::DictionaryBuilder::Append__std::enable_if:std::is_base_of:FixedSizeBinaryType.T1:::value.cCP:::type"></span><em class="property">template </em><<em class="property">typename</em> T1 = T><br /><span class="target" id="classarrow_1_1_dictionary_builder_1a730d2bab01899f4a92d1b0343dbebfea"></span><a class="reference internal" href="support. [...]
+<dt id="_CPPv4N5arrow17DictionaryBuilder6AppendENSt9enable_ifINSt10is_base_ofI19FixedSizeBinaryType2T1E5valueEPKcE4typeE">
+<span id="_CPPv3N5arrow17DictionaryBuilder6AppendENSt9enable_ifINSt10is_base_ofI19FixedSizeBinaryType2T1E5valueEPKcE4typeE"></span><span id="_CPPv2N5arrow17DictionaryBuilder6AppendENSt9enable_ifINSt10is_base_ofI19FixedSizeBinaryType2T1E5valueEPKcE4typeE"></span><span id="arrow::DictionaryBuilder::Append__std::enable_if:std::is_base_of:FixedSizeBinaryType.T1:::value.cCP:::type"></span><em class="property">template </em><<em class="property">typename</em> T1 = T><br /><span class="ta [...]
<dd><p>Append a fixed-width string (only for <a class="reference internal" href="datatype.html#classarrow_1_1_fixed_size_binary_type"><span class="std std-ref">FixedSizeBinaryType</span></a>) </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3N5arrow17DictionaryBuilder10AppendNullEv">
-<span id="_CPPv2N5arrow17DictionaryBuilder10AppendNullEv"></span><span id="arrow::DictionaryBuilder::AppendNull"></span><span class="target" id="classarrow_1_1_dictionary_builder_1afc3e884264e3facf466b6c4a8da88877"></span><a class="reference internal" href="support.html#_CPPv3N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descname">AppendNull</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv3N5arrow17DictionaryBuilder [...]
+<dt id="_CPPv4N5arrow17DictionaryBuilder10AppendNullEv">
+<span id="_CPPv3N5arrow17DictionaryBuilder10AppendNullEv"></span><span id="_CPPv2N5arrow17DictionaryBuilder10AppendNullEv"></span><span id="arrow::DictionaryBuilder::AppendNull"></span><span class="target" id="classarrow_1_1_dictionary_builder_1afc3e884264e3facf466b6c4a8da88877"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descname">AppendNull</code><span class="sig-paren">(</span><span class="sig-paren">)</s [...]
<dd><p>Append a scalar null value. </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3N5arrow17DictionaryBuilder11AppendArrayERK5Array">
-<span id="_CPPv2N5arrow17DictionaryBuilder11AppendArrayERK5Array"></span><span id="arrow::DictionaryBuilder::AppendArray__ArrayCR"></span><span class="target" id="classarrow_1_1_dictionary_builder_1aecd4f63447712177fe79282d334297a6"></span><a class="reference internal" href="support.html#_CPPv3N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descname">AppendArray</code><span class="sig-paren">(</span><em class="property">const</em> <a class="reference internal" href="array. [...]
+<dt id="_CPPv4N5arrow17DictionaryBuilder11AppendArrayERK5Array">
+<span id="_CPPv3N5arrow17DictionaryBuilder11AppendArrayERK5Array"></span><span id="_CPPv2N5arrow17DictionaryBuilder11AppendArrayERK5Array"></span><span id="arrow::DictionaryBuilder::AppendArray__ArrayCR"></span><span class="target" id="classarrow_1_1_dictionary_builder_1aecd4f63447712177fe79282d334297a6"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descname">AppendArray</code><span class="sig-paren">(</span>< [...]
<dd><p>Append a whole dense array to the builder. </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3N5arrow17DictionaryBuilder5ResetEv">
-<span id="_CPPv2N5arrow17DictionaryBuilder5ResetEv"></span><span id="arrow::DictionaryBuilder::Reset"></span><span class="target" id="classarrow_1_1_dictionary_builder_1a2cbdefd5caf33e3cd47d2c346fffcebf"></span>void <code class="descname">Reset</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv3N5arrow17DictionaryBuilder5ResetEv" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4N5arrow17DictionaryBuilder5ResetEv">
+<span id="_CPPv3N5arrow17DictionaryBuilder5ResetEv"></span><span id="_CPPv2N5arrow17DictionaryBuilder5ResetEv"></span><span id="arrow::DictionaryBuilder::Reset"></span><span class="target" id="classarrow_1_1_dictionary_builder_1a2cbdefd5caf33e3cd47d2c346fffcebf"></span>void <code class="descname">Reset</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow17DictionaryBuilder5ResetEv" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Reset the builder. </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3N5arrow17DictionaryBuilder6ResizeE7int64_t">
-<span id="_CPPv2N5arrow17DictionaryBuilder6ResizeE7int64_t"></span><span id="arrow::DictionaryBuilder::Resize__int64_t"></span><span class="target" id="classarrow_1_1_dictionary_builder_1aaf40b947da00bcfc658919908781443b"></span><a class="reference internal" href="support.html#_CPPv3N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descname">Resize</code><span class="sig-paren">(</span>int64_t <em>capacity</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPP [...]
+<dt id="_CPPv4N5arrow17DictionaryBuilder6ResizeE7int64_t">
+<span id="_CPPv3N5arrow17DictionaryBuilder6ResizeE7int64_t"></span><span id="_CPPv2N5arrow17DictionaryBuilder6ResizeE7int64_t"></span><span id="arrow::DictionaryBuilder::Resize__int64_t"></span><span class="target" id="classarrow_1_1_dictionary_builder_1aaf40b947da00bcfc658919908781443b"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descname">Resize</code><span class="sig-paren">(</span>int64_t <em>capacity</e [...]
<dd><p>Ensure that enough memory has been allocated to fit the indicated number of total elements in the builder, including any that have already been appended. </p>
<p>Does not account for reallocations that may be due to variable size data, like binary values. To make space for incremental appends, use Reserve instead.</p>
<p><dl class="docutils">
@@ -973,8 +1142,8 @@
</dd></dl>
<dl class="function">
-<dt id="_CPPv3N5arrow17DictionaryBuilder14FinishInternalEPNSt10shared_ptrI9ArrayDataEE">
-<span id="_CPPv2N5arrow17DictionaryBuilder14FinishInternalEPNSt10shared_ptrI9ArrayDataEE"></span><span id="arrow::DictionaryBuilder::FinishInternal__std::shared_ptr:ArrayData:P"></span><span class="target" id="classarrow_1_1_dictionary_builder_1a15a93f49f6f6214007a4372230c27878"></span><a class="reference internal" href="support.html#_CPPv3N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descname">FinishInternal</code><span class="sig-paren">(</span>std::shared_ptr<Array [...]
+<dt id="_CPPv4N5arrow17DictionaryBuilder14FinishInternalEPNSt10shared_ptrI9ArrayDataEE">
+<span id="_CPPv3N5arrow17DictionaryBuilder14FinishInternalEPNSt10shared_ptrI9ArrayDataEE"></span><span id="_CPPv2N5arrow17DictionaryBuilder14FinishInternalEPNSt10shared_ptrI9ArrayDataEE"></span><span id="arrow::DictionaryBuilder::FinishInternal__std::shared_ptr:ArrayData:P"></span><span class="target" id="classarrow_1_1_dictionary_builder_1a15a93f49f6f6214007a4372230c27878"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status">Status</a> <co [...]
<dd><p>Return result of builder as an internal generic ArrayData object. </p>
<p>Resets builder except for dictionary builder</p>
<p><dl class="docutils">
@@ -990,8 +1159,8 @@
</dd></dl>
<dl class="function">
-<dt id="_CPPv3N5arrow17DictionaryBuilder17is_building_deltaEv">
-<span id="_CPPv2N5arrow17DictionaryBuilder17is_building_deltaEv"></span><span id="arrow::DictionaryBuilder::is_building_delta"></span><span class="target" id="classarrow_1_1_dictionary_builder_1ac744127417c10a27a10bb0b300cb109c"></span>bool <code class="descname">is_building_delta</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv3N5arrow17DictionaryBuilder17is_building_deltaEv" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4N5arrow17DictionaryBuilder17is_building_deltaEv">
+<span id="_CPPv3N5arrow17DictionaryBuilder17is_building_deltaEv"></span><span id="_CPPv2N5arrow17DictionaryBuilder17is_building_deltaEv"></span><span id="arrow::DictionaryBuilder::is_building_delta"></span><span class="target" id="classarrow_1_1_dictionary_builder_1ac744127417c10a27a10bb0b300cb109c"></span>bool <code class="descname">is_building_delta</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow17DictionaryBuilder17is_bu [...]
<dd><p>is the dictionary builder in the delta building mode </p>
</dd></dl>
@@ -1012,7 +1181,7 @@
<a href="table.html" class="btn btn-neutral float-right" title="Two-dimensional Datasets" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
- <a href="array.html" class="btn btn-neutral" title="Arrays" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+ <a href="array.html" class="btn btn-neutral float-left" title="Arrays" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
@@ -1038,26 +1207,16 @@
-
-
-
-
- <script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
- <script type="text/javascript" src="../../_static/jquery.js"></script>
- <script type="text/javascript" src="../../_static/underscore.js"></script>
- <script type="text/javascript" src="../../_static/doctools.js"></script>
- <script type="text/javascript" src="../../_static/language_data.js"></script>
-
-
-
-
- <script type="text/javascript" src="../../_static/js/theme.js"></script>
-
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
+
+
+
+
+
<script async src="https://www.googletagmanager.com/gtag/js?id=UA-107500873-1"></script>
<script>
window.dataLayer = window.dataLayer || [];
diff --git a/docs/cpp/api/cuda.html b/docs/cpp/api/cuda.html
new file mode 100644
index 0000000..12f4427
--- /dev/null
+++ b/docs/cpp/api/cuda.html
@@ -0,0 +1,763 @@
+
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+ <meta charset="utf-8">
+
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>CUDA support — Apache Arrow v0.13.0</title>
+
+
+
+
+
+
+
+
+ <script type="text/javascript" src="../../_static/js/modernizr.min.js"></script>
+
+
+ <script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
+ <script type="text/javascript" src="../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../_static/doctools.js"></script>
+ <script type="text/javascript" src="../../_static/language_data.js"></script>
+
+ <script type="text/javascript" src="../../_static/js/theme.js"></script>
+
+
+
+
+ <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
+ <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
+ <link rel="index" title="Index" href="../../genindex.html" />
+ <link rel="search" title="Search" href="../../search.html" />
+ <link rel="next" title="Python bindings" href="../../python/index.html" />
+ <link rel="prev" title="Utilities" href="utilities.html" />
+</head>
+
+<body class="wy-body-for-nav">
+
+
+ <div class="wy-grid-for-nav">
+
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+ <div class="wy-side-scroll">
+ <div class="wy-side-nav-search" >
+
+
+
+ <a href="../../index.html" class="icon icon-home"> Apache Arrow
+
+
+
+ </a>
+
+
+
+
+ <div class="version">
+ 0.13.0
+ </div>
+
+
+
+
+<div role="search">
+ <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</div>
+
+
+ </div>
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+
+
+
+
+ <p class="caption"><span class="caption-text">Arrow Columnar Format</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../format/README.html">Arrow specification documents</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../format/Guidelines.html">Implementation guidelines</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../format/Layout.html">Physical memory layout</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../format/Metadata.html">Metadata: Logical types, schemas, data headers</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../format/IPC.html">Interprocess messaging / communication (IPC)</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Arrow Libraries</span></p>
+<ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="../index.html">C++ Implementation</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="../getting_started.html">Getting Started</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../examples/index.html">Examples</a></li>
+<li class="toctree-l2 current"><a class="reference internal" href="../api.html">API Reference</a><ul class="current">
+<li class="toctree-l3"><a class="reference internal" href="support.html">Programming Support</a></li>
+<li class="toctree-l3"><a class="reference internal" href="memory.html">Memory (management)</a></li>
+<li class="toctree-l3"><a class="reference internal" href="datatype.html">Data Types</a></li>
+<li class="toctree-l3"><a class="reference internal" href="array.html">Arrays</a></li>
+<li class="toctree-l3"><a class="reference internal" href="builder.html">Array Builders</a></li>
+<li class="toctree-l3"><a class="reference internal" href="table.html">Two-dimensional Datasets</a></li>
+<li class="toctree-l3"><a class="reference internal" href="utilities.html">Utilities</a></li>
+<li class="toctree-l3 current"><a class="current reference internal" href="#">CUDA support</a><ul>
+<li class="toctree-l4"><a class="reference internal" href="#cuda-contexts">CUDA Contexts</a></li>
+<li class="toctree-l4"><a class="reference internal" href="#device-and-host-buffers">Device and Host Buffers</a></li>
+<li class="toctree-l4"><a class="reference internal" href="#device-memory-input-output">Device Memory Input / Output</a></li>
+<li class="toctree-l4"><a class="reference internal" href="#cuda-ipc">CUDA IPC</a></li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="../../python/index.html">Python bindings</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Development and Contributing</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../developers/contributing.html">Contribution Guidelines</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../developers/cpp.html">C++ Development</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../developers/python.html">Python Development</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../developers/integration.html">Integration Testing</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../developers/documentation.html">Building the Documentation</a></li>
+</ul>
+
+
+
+ </div>
+ </div>
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" aria-label="top navigation">
+
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../../index.html">Apache Arrow</a>
+
+ </nav>
+
+
+ <div class="wy-nav-content">
+
+ <div class="rst-content">
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<div role="navigation" aria-label="breadcrumbs navigation">
+
+ <ul class="wy-breadcrumbs">
+
+ <li><a href="../../index.html">Docs</a> »</li>
+
+ <li><a href="../index.html">C++ Implementation</a> »</li>
+
+ <li><a href="../api.html">API Reference</a> »</li>
+
+ <li>CUDA support</li>
+
+
+ <li class="wy-breadcrumbs-aside">
+
+
+ <a href="../../_sources/cpp/api/cuda.rst.txt" rel="nofollow"> View page source</a>
+
+
+ </li>
+
+ </ul>
+
+
+ <hr/>
+</div>
+ <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+ <div itemprop="articleBody">
+
+ <div class="section" id="cuda-support">
+<h1>CUDA support<a class="headerlink" href="#cuda-support" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="cuda-contexts">
+<h2>CUDA Contexts<a class="headerlink" href="#cuda-contexts" title="Permalink to this headline">¶</a></h2>
+<dl class="class">
+<dt id="_CPPv4N5arrow4cuda17CudaDeviceManagerE">
+<span id="_CPPv3N5arrow4cuda17CudaDeviceManagerE"></span><span id="_CPPv2N5arrow4cuda17CudaDeviceManagerE"></span><span id="arrow::cuda::CudaDeviceManager"></span><span class="target" id="classarrow_1_1cuda_1_1_cuda_device_manager"></span><em class="property">class </em><code class="descname">CudaDeviceManager</code><a class="headerlink" href="#_CPPv4N5arrow4cuda17CudaDeviceManagerE" title="Permalink to this definition">¶</a><br /></dt>
+<dd><div class="breathe-sectiondef docutils container">
+<p class="breathe-sectiondef-title rubric">Public Functions</p>
+<dl class="function">
+<dt id="_CPPv4N5arrow4cuda17CudaDeviceManager10GetContextEiPNSt10shared_ptrI11CudaContextEE">
+<span id="_CPPv3N5arrow4cuda17CudaDeviceManager10GetContextEiPNSt10shared_ptrI11CudaContextEE"></span><span id="_CPPv2N5arrow4cuda17CudaDeviceManager10GetContextEiPNSt10shared_ptrI11CudaContextEE"></span><span id="arrow::cuda::CudaDeviceManager::GetContext__i.std::shared_ptr:CudaContext:P"></span><span class="target" id="classarrow_1_1cuda_1_1_cuda_device_manager_1adc1ff0b5f95c10dd495cd05360c04a0e"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arro [...]
+<dd><p>Get the CUDA driver context for a particular device. </p>
+<p><dl class="docutils">
+<dt><strong>Parameters</strong></dt>
+<dd><ul class="breatheparameterlist first last simple">
+<li><code class="docutils literal notranslate"><span class="pre">device_number</span></code>: the CUDA device </li>
+<li><code class="docutils literal notranslate"><span class="pre">out</span></code>: cached context </li>
+</ul>
+</dd>
+</dl>
+</p>
+</dd></dl>
+
+<dl class="function">
+<dt id="_CPPv4N5arrow4cuda17CudaDeviceManager16GetSharedContextEiPvPNSt10shared_ptrI11CudaContextEE">
+<span id="_CPPv3N5arrow4cuda17CudaDeviceManager16GetSharedContextEiPvPNSt10shared_ptrI11CudaContextEE"></span><span id="_CPPv2N5arrow4cuda17CudaDeviceManager16GetSharedContextEiPvPNSt10shared_ptrI11CudaContextEE"></span><span id="arrow::cuda::CudaDeviceManager::GetSharedContext__i.voidP.std::shared_ptr:CudaContext:P"></span><span class="target" id="classarrow_1_1cuda_1_1_cuda_device_manager_1ae5f94e2ba45981c752842ef5c3d96237"></span><a class="reference internal" href="support.html#_CPPv4 [...]
+<dd><p>Get the shared CUDA driver context for a particular device. </p>
+<p><dl class="docutils">
+<dt><strong>Parameters</strong></dt>
+<dd><ul class="breatheparameterlist first last simple">
+<li><code class="docutils literal notranslate"><span class="pre">device_number</span></code>: the CUDA device </li>
+<li><code class="docutils literal notranslate"><span class="pre">handle</span></code>: CUDA context handler created by another library </li>
+<li><code class="docutils literal notranslate"><span class="pre">out</span></code>: shared context </li>
+</ul>
+</dd>
+</dl>
+</p>
+</dd></dl>
+
+<dl class="function">
+<dt id="_CPPv4N5arrow4cuda17CudaDeviceManager12AllocateHostEi7int64_tPNSt10shared_ptrI14CudaHostBufferEE">
+<span id="_CPPv3N5arrow4cuda17CudaDeviceManager12AllocateHostEi7int64_tPNSt10shared_ptrI14CudaHostBufferEE"></span><span id="_CPPv2N5arrow4cuda17CudaDeviceManager12AllocateHostEi7int64_tPNSt10shared_ptrI14CudaHostBufferEE"></span><span id="arrow::cuda::CudaDeviceManager::AllocateHost__i.int64_t.std::shared_ptr:CudaHostBuffer:P"></span><span class="target" id="classarrow_1_1cuda_1_1_cuda_device_manager_1ad59e2b01a763993fc028a1856f40c6f2"></span><a class="reference internal" href="support. [...]
+<dd><p>Allocate host memory with fast access to given GPU device. </p>
+<p><dl class="docutils">
+<dt><strong>Parameters</strong></dt>
+<dd><ul class="breatheparameterlist first last simple">
+<li><code class="docutils literal notranslate"><span class="pre">device_number</span></code>: the CUDA device </li>
+<li><code class="docutils literal notranslate"><span class="pre">nbytes</span></code>: number of bytes </li>
+<li><code class="docutils literal notranslate"><span class="pre">out</span></code>: the allocated buffer </li>
+</ul>
+</dd>
+</dl>
+</p>
+</dd></dl>
+
+</div>
+</dd></dl>
+
+<dl class="class">
+<dt id="_CPPv4N5arrow4cuda11CudaContextE">
+<span id="_CPPv3N5arrow4cuda11CudaContextE"></span><span id="_CPPv2N5arrow4cuda11CudaContextE"></span><span id="arrow::cuda::CudaContext"></span><span class="target" id="classarrow_1_1cuda_1_1_cuda_context"></span><em class="property">class </em><code class="descname">CudaContext</code> : <em class="property">public</em> std::enable_shared_from_this<<a class="reference internal" href="#_CPPv4N5arrow4cuda11CudaContextE" title="arrow::cuda::CudaContext">CudaContext</a>><a class="head [...]
+<dd><p>Friendlier interface to the CUDA driver API. </p>
+<div class="breathe-sectiondef docutils container">
+<p class="breathe-sectiondef-title rubric">Public Functions</p>
+<dl class="function">
+<dt id="_CPPv4N5arrow4cuda11CudaContext8AllocateE7int64_tPNSt10shared_ptrI10CudaBufferEE">
+<span id="_CPPv3N5arrow4cuda11CudaContext8AllocateE7int64_tPNSt10shared_ptrI10CudaBufferEE"></span><span id="_CPPv2N5arrow4cuda11CudaContext8AllocateE7int64_tPNSt10shared_ptrI10CudaBufferEE"></span><span id="arrow::cuda::CudaContext::Allocate__int64_t.std::shared_ptr:CudaBuffer:P"></span><span class="target" id="classarrow_1_1cuda_1_1_cuda_context_1ae1f7fd73ef674ac0a670467d72cc28e5"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status">Statu [...]
+<dd><p>Allocate CUDA memory on GPU device for this context. </p>
+<p><dl class="docutils">
+<dt><strong>Return</strong></dt>
+<dd><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a> </dd>
+<dt><strong>Parameters</strong></dt>
+<dd><ul class="breatheparameterlist first last simple">
+<li><code class="docutils literal notranslate"><span class="pre">nbytes</span></code>: number of bytes </li>
+<li><code class="docutils literal notranslate"><span class="pre">out</span></code>: the allocated buffer </li>
+</ul>
+</dd>
+</dl>
+</p>
+</dd></dl>
+
+<dl class="function">
+<dt id="_CPPv4N5arrow4cuda11CudaContext4ViewEP7uint8_t7int64_tPNSt10shared_ptrI10CudaBufferEE">
+<span id="_CPPv3N5arrow4cuda11CudaContext4ViewEP7uint8_t7int64_tPNSt10shared_ptrI10CudaBufferEE"></span><span id="_CPPv2N5arrow4cuda11CudaContext4ViewEP7uint8_t7int64_tPNSt10shared_ptrI10CudaBufferEE"></span><span id="arrow::cuda::CudaContext::View__uint8_tP.int64_t.std::shared_ptr:CudaBuffer:P"></span><span class="target" id="classarrow_1_1cuda_1_1_cuda_context_1a20f0a6eaa90944b58a99f9bccd52497d"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow [...]
+<dd><p>Create a view of CUDA memory on GPU device of this context. </p>
+<p><dl class="docutils">
+<dt><strong>Return</strong></dt>
+<dd><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a></dd>
+<dt><strong>Note</strong></dt>
+<dd>The caller is responsible for allocating and freeing the memory as well as ensuring that the memory belongs to the CUDA context that this <a class="reference internal" href="#classarrow_1_1cuda_1_1_cuda_context"><span class="std std-ref">CudaContext</span></a> instance holds. </dd>
+<dt><strong>Parameters</strong></dt>
+<dd><ul class="breatheparameterlist first last simple">
+<li><code class="docutils literal notranslate"><span class="pre">data</span></code>: the starting device address </li>
+<li><code class="docutils literal notranslate"><span class="pre">nbytes</span></code>: number of bytes </li>
+<li><code class="docutils literal notranslate"><span class="pre">out</span></code>: the view buffer </li>
+</ul>
+</dd>
+</dl>
+</p>
+</dd></dl>
+
+<dl class="function">
+<dt id="_CPPv4N5arrow4cuda11CudaContext13OpenIpcBufferERK16CudaIpcMemHandlePNSt10shared_ptrI10CudaBufferEE">
+<span id="_CPPv3N5arrow4cuda11CudaContext13OpenIpcBufferERK16CudaIpcMemHandlePNSt10shared_ptrI10CudaBufferEE"></span><span id="_CPPv2N5arrow4cuda11CudaContext13OpenIpcBufferERK16CudaIpcMemHandlePNSt10shared_ptrI10CudaBufferEE"></span><span id="arrow::cuda::CudaContext::OpenIpcBuffer__CudaIpcMemHandleCR.std::shared_ptr:CudaBuffer:P"></span><span class="target" id="classarrow_1_1cuda_1_1_cuda_context_1a71525204ccd5e3a30f8456b6ca29dc38"></span><a class="reference internal" href="support.htm [...]
+<dd><p>Open existing CUDA IPC memory handle. </p>
+<p><dl class="docutils">
+<dt><strong>Return</strong></dt>
+<dd><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a> </dd>
+<dt><strong>Parameters</strong></dt>
+<dd><ul class="breatheparameterlist first last simple">
+<li><code class="docutils literal notranslate"><span class="pre">ipc_handle</span></code>: opaque pointer to CUipcMemHandle (driver API) </li>
+<li><code class="docutils literal notranslate"><span class="pre">out</span></code>: a <a class="reference internal" href="#classarrow_1_1cuda_1_1_cuda_buffer"><span class="std std-ref">CudaBuffer</span></a> referencing the IPC segment </li>
+</ul>
+</dd>
+</dl>
+</p>
+</dd></dl>
+
+<dl class="function">
+<dt id="_CPPv4N5arrow4cuda11CudaContext14CloseIpcBufferEP10CudaBuffer">
+<span id="_CPPv3N5arrow4cuda11CudaContext14CloseIpcBufferEP10CudaBuffer"></span><span id="_CPPv2N5arrow4cuda11CudaContext14CloseIpcBufferEP10CudaBuffer"></span><span id="arrow::cuda::CudaContext::CloseIpcBuffer__CudaBufferP"></span><span class="target" id="classarrow_1_1cuda_1_1_cuda_context_1a3228bd973c2da795b1b916f81d3bd164"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descname">CloseIpcBuffer</code><span c [...]
+<dd><p>Close memory mapped with IPC buffer. </p>
+<p><dl class="docutils">
+<dt><strong>Return</strong></dt>
+<dd><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a> </dd>
+<dt><strong>Parameters</strong></dt>
+<dd><ul class="breatheparameterlist first last simple">
+<li><code class="docutils literal notranslate"><span class="pre">buffer</span></code>: a <a class="reference internal" href="#classarrow_1_1cuda_1_1_cuda_buffer"><span class="std std-ref">CudaBuffer</span></a> referencing </li>
+</ul>
+</dd>
+</dl>
+</p>
+</dd></dl>
+
+<dl class="function">
+<dt id="_CPPv4N5arrow4cuda11CudaContext11SynchronizeEv">
+<span id="_CPPv3N5arrow4cuda11CudaContext11SynchronizeEv"></span><span id="_CPPv2N5arrow4cuda11CudaContext11SynchronizeEv"></span><span id="arrow::cuda::CudaContext::Synchronize__void"></span><span class="target" id="classarrow_1_1cuda_1_1_cuda_context_1a80b22b35b08acac1c0a7b796932612c0"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descname">Synchronize</code><span class="sig-paren">(</span>void<span class="s [...]
+<dd><p>Block until the all device tasks are completed. </p>
+</dd></dl>
+
+<dl class="function">
+<dt id="_CPPv4NK5arrow4cuda11CudaContext6handleEv">
+<span id="_CPPv3NK5arrow4cuda11CudaContext6handleEv"></span><span id="_CPPv2NK5arrow4cuda11CudaContext6handleEv"></span><span id="arrow::cuda::CudaContext::handleC"></span><span class="target" id="classarrow_1_1cuda_1_1_cuda_context_1a6e96e4e5ef6abaecf3448d0f9563b34c"></span>void *<code class="descname">handle</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv4NK5arrow4cuda11CudaContext6handleEv" title= [...]
+<dd><p>Expose CUDA context handle to other libraries. </p>
+</dd></dl>
+
+<dl class="function">
+<dt id="_CPPv4NK5arrow4cuda11CudaContext13device_numberEv">
+<span id="_CPPv3NK5arrow4cuda11CudaContext13device_numberEv"></span><span id="_CPPv2NK5arrow4cuda11CudaContext13device_numberEv"></span><span id="arrow::cuda::CudaContext::device_numberC"></span><span class="target" id="classarrow_1_1cuda_1_1_cuda_context_1ab5427be57b455cffa58b353ad8d6fdbf"></span>int <code class="descname">device_number</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv4NK5arrow4cuda11 [...]
+<dd><p>Return device number. </p>
+</dd></dl>
+
+<dl class="function">
+<dt id="_CPPv4N5arrow4cuda11CudaContext16GetDeviceAddressEP7uint8_tPP7uint8_t">
+<span id="_CPPv3N5arrow4cuda11CudaContext16GetDeviceAddressEP7uint8_tPP7uint8_t"></span><span id="_CPPv2N5arrow4cuda11CudaContext16GetDeviceAddressEP7uint8_tPP7uint8_t"></span><span id="arrow::cuda::CudaContext::GetDeviceAddress__uint8_tP.uint8_tPP"></span><span class="target" id="classarrow_1_1cuda_1_1_cuda_context_1a700f8db21b0cd27376b57792aa78d9f7"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descname">Get [...]
+<dd><p>Return the device address that is reachable from kernels running in the context. </p>
+<p><p>The device address is defined as a memory address accessible by device. While it is often a device memory address, it can be also a host memory address, for instance, when the memory is allocated as host memory (using cudaMallocHost or cudaHostAlloc) or as managed memory (using cudaMallocManaged) or the host memory is page-locked (using cudaHostRegister). </p>
+<dl class="docutils">
+<dt><strong>Return</strong></dt>
+<dd><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a></dd>
+<dt><strong>Parameters</strong></dt>
+<dd><ul class="breatheparameterlist first last simple">
+<li><code class="docutils literal notranslate"><span class="pre">addr</span></code>: device or host memory address </li>
+<li><code class="docutils literal notranslate"><span class="pre">devaddr</span></code>: the device address </li>
+</ul>
+</dd>
+</dl>
+</p>
+</dd></dl>
+
+</div>
+</dd></dl>
+
+</div>
+<div class="section" id="device-and-host-buffers">
+<h2>Device and Host Buffers<a class="headerlink" href="#device-and-host-buffers" title="Permalink to this headline">¶</a></h2>
+<dl class="class">
+<dt id="_CPPv4N5arrow4cuda10CudaBufferE">
+<span id="_CPPv3N5arrow4cuda10CudaBufferE"></span><span id="_CPPv2N5arrow4cuda10CudaBufferE"></span><span id="arrow::cuda::CudaBuffer"></span><span class="target" id="classarrow_1_1cuda_1_1_cuda_buffer"></span><em class="property">class </em><code class="descname">CudaBuffer</code> : <em class="property">public</em> arrow::<a class="reference internal" href="memory.html#_CPPv4N5arrow6BufferE" title="arrow::Buffer">Buffer</a><a class="headerlink" href="#_CPPv4N5arrow4cuda10CudaBufferE" ti [...]
+<dd><p>An Arrow buffer located on a GPU device. </p>
+<p>Be careful using this in any Arrow code which may not be GPU-aware </p>
+<div class="breathe-sectiondef docutils container">
+<p class="breathe-sectiondef-title rubric">Public Functions</p>
+<dl class="function">
+<dt id="_CPPv4NK5arrow4cuda10CudaBuffer10CopyToHostEK7int64_tK7int64_tPv">
+<span id="_CPPv3NK5arrow4cuda10CudaBuffer10CopyToHostEK7int64_tK7int64_tPv"></span><span id="_CPPv2NK5arrow4cuda10CudaBuffer10CopyToHostEK7int64_tK7int64_tPv"></span><span id="arrow::cuda::CudaBuffer::CopyToHost__int64_tC.int64_tC.voidPC"></span><span class="target" id="classarrow_1_1cuda_1_1_cuda_buffer_1a68ec37adb9fc33fb2dbc93b8591eb80b"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descname">CopyToHost</cod [...]
+<dd><p>Copy memory from GPU device to CPU host. </p>
+<p><dl class="docutils">
+<dt><strong>Return</strong></dt>
+<dd><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a> </dd>
+<dt><strong>Parameters</strong></dt>
+<dd><ul class="breatheparameterlist first last simple">
+<li><code class="docutils literal notranslate"><span class="pre">position</span></code>: start position inside buffer to copy bytes from </li>
+<li><code class="docutils literal notranslate"><span class="pre">nbytes</span></code>: number of bytes to copy </li>
+<li><code class="docutils literal notranslate"><span class="pre">out</span></code>: start address of the host memory area to copy to </li>
+</ul>
+</dd>
+</dl>
+</p>
+</dd></dl>
+
+<dl class="function">
+<dt id="_CPPv4N5arrow4cuda10CudaBuffer12CopyFromHostEK7int64_tPKv7int64_t">
+<span id="_CPPv3N5arrow4cuda10CudaBuffer12CopyFromHostEK7int64_tPKv7int64_t"></span><span id="_CPPv2N5arrow4cuda10CudaBuffer12CopyFromHostEK7int64_tPKv7int64_t"></span><span id="arrow::cuda::CudaBuffer::CopyFromHost__int64_tC.voidCP.int64_t"></span><span class="target" id="classarrow_1_1cuda_1_1_cuda_buffer_1a941397f8ec48d7578669dea25c601559"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descname">CopyFromHost [...]
+<dd><p>Copy memory to device at position. </p>
+<p><dl class="docutils">
+<dt><strong>Return</strong></dt>
+<dd><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a> </dd>
+<dt><strong>Parameters</strong></dt>
+<dd><ul class="breatheparameterlist first last simple">
+<li><code class="docutils literal notranslate"><span class="pre">position</span></code>: start position to copy bytes to </li>
+<li><code class="docutils literal notranslate"><span class="pre">data</span></code>: the host data to copy </li>
+<li><code class="docutils literal notranslate"><span class="pre">nbytes</span></code>: number of bytes to copy </li>
+</ul>
+</dd>
+</dl>
+</p>
+</dd></dl>
+
+<dl class="function">
+<dt id="_CPPv4N5arrow4cuda10CudaBuffer14CopyFromDeviceEK7int64_tPKv7int64_t">
+<span id="_CPPv3N5arrow4cuda10CudaBuffer14CopyFromDeviceEK7int64_tPKv7int64_t"></span><span id="_CPPv2N5arrow4cuda10CudaBuffer14CopyFromDeviceEK7int64_tPKv7int64_t"></span><span id="arrow::cuda::CudaBuffer::CopyFromDevice__int64_tC.voidCP.int64_t"></span><span class="target" id="classarrow_1_1cuda_1_1_cuda_buffer_1a41dfd69a882ea4fb138d8b25cc495cfe"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descname">CopyFr [...]
+<dd><p>Copy memory from device to device at position. </p>
+<p><dl class="docutils">
+<dt><strong>Return</strong></dt>
+<dd><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a></dd>
+<dt><strong>Note</strong></dt>
+<dd>It is assumed that both source and destination device memories have been allocated within the same context. </dd>
+<dt><strong>Parameters</strong></dt>
+<dd><ul class="breatheparameterlist first last simple">
+<li><code class="docutils literal notranslate"><span class="pre">position</span></code>: start position inside buffer to copy bytes to </li>
+<li><code class="docutils literal notranslate"><span class="pre">data</span></code>: start address of the device memory area to copy from </li>
+<li><code class="docutils literal notranslate"><span class="pre">nbytes</span></code>: number of bytes to copy </li>
+</ul>
+</dd>
+</dl>
+</p>
+</dd></dl>
+
+<dl class="function">
+<dt id="_CPPv4N5arrow4cuda10CudaBuffer21CopyFromAnotherDeviceERKNSt10shared_ptrI11CudaContextEEK7int64_tPKv7int64_t">
+<span id="_CPPv3N5arrow4cuda10CudaBuffer21CopyFromAnotherDeviceERKNSt10shared_ptrI11CudaContextEEK7int64_tPKv7int64_t"></span><span id="_CPPv2N5arrow4cuda10CudaBuffer21CopyFromAnotherDeviceERKNSt10shared_ptrI11CudaContextEEK7int64_tPKv7int64_t"></span><span id="arrow::cuda::CudaBuffer::CopyFromAnotherDevice__std::shared_ptr:CudaContext:CR.int64_tC.voidCP.int64_t"></span><span class="target" id="classarrow_1_1cuda_1_1_cuda_buffer_1ad6338774ba17d06ccd9423e5dd4e61e9"></span><a class="refere [...]
+<dd><p>Copy memory from another device to device at position. </p>
+<p><dl class="docutils">
+<dt><strong>Return</strong></dt>
+<dd><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a> </dd>
+<dt><strong>Parameters</strong></dt>
+<dd><ul class="breatheparameterlist first last simple">
+<li><code class="docutils literal notranslate"><span class="pre">src_ctx</span></code>: context of the source device memory </li>
+<li><code class="docutils literal notranslate"><span class="pre">position</span></code>: start position inside buffer to copy bytes to </li>
+<li><code class="docutils literal notranslate"><span class="pre">data</span></code>: start address of the another device memory area to copy from </li>
+<li><code class="docutils literal notranslate"><span class="pre">nbytes</span></code>: number of bytes to copy </li>
+</ul>
+</dd>
+</dl>
+</p>
+</dd></dl>
+
+<dl class="function">
+<dt id="_CPPv4N5arrow4cuda10CudaBuffer12ExportForIpcEPNSt10shared_ptrI16CudaIpcMemHandleEE">
+<span id="_CPPv3N5arrow4cuda10CudaBuffer12ExportForIpcEPNSt10shared_ptrI16CudaIpcMemHandleEE"></span><span id="_CPPv2N5arrow4cuda10CudaBuffer12ExportForIpcEPNSt10shared_ptrI16CudaIpcMemHandleEE"></span><span id="arrow::cuda::CudaBuffer::ExportForIpc__std::shared_ptr:CudaIpcMemHandle:P"></span><span class="target" id="classarrow_1_1cuda_1_1_cuda_buffer_1a490dee9e96f32075c8c04f5119e4ed7b"></span><em class="property">virtual</em> <a class="reference internal" href="support.html#_CPPv4N5arro [...]
+<dd><p>Expose this device buffer as IPC memory which can be used in other processes. </p>
+<p><dl class="docutils">
+<dt><strong>Return</strong></dt>
+<dd><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a></dd>
+<dt><strong>Note</strong></dt>
+<dd>After calling this function, this device memory will not be freed when the <a class="reference internal" href="#classarrow_1_1cuda_1_1_cuda_buffer"><span class="std std-ref">CudaBuffer</span></a> is destructed </dd>
+<dt><strong>Parameters</strong></dt>
+<dd><ul class="breatheparameterlist first last simple">
+<li><code class="docutils literal notranslate"><span class="pre">handle</span></code>: the exported IPC handle </li>
+</ul>
+</dd>
+</dl>
+</p>
+</dd></dl>
+
+</div>
+<div class="breathe-sectiondef docutils container">
+<p class="breathe-sectiondef-title rubric">Public Static Functions</p>
+<dl class="function">
+<dt id="_CPPv4N5arrow4cuda10CudaBuffer10FromBufferENSt10shared_ptrI6BufferEEPNSt10shared_ptrI10CudaBufferEE">
+<span id="_CPPv3N5arrow4cuda10CudaBuffer10FromBufferENSt10shared_ptrI6BufferEEPNSt10shared_ptrI10CudaBufferEE"></span><span id="_CPPv2N5arrow4cuda10CudaBuffer10FromBufferENSt10shared_ptrI6BufferEEPNSt10shared_ptrI10CudaBufferEE"></span><span id="arrow::cuda::CudaBuffer::FromBuffer__std::shared_ptr:Buffer:.std::shared_ptr:CudaBuffer:P"></span><span class="target" id="classarrow_1_1cuda_1_1_cuda_buffer_1a46b8a71ae7a4274269775c2297a7e335"></span><em class="property">static</em> <a class="re [...]
+<dd><p>Convert back generic buffer into <a class="reference internal" href="#classarrow_1_1cuda_1_1_cuda_buffer"><span class="std std-ref">CudaBuffer</span></a>. </p>
+<p><dl class="docutils">
+<dt><strong>Return</strong></dt>
+<dd><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a></dd>
+<dt><strong>Note</strong></dt>
+<dd>This function returns an error if the buffer isn’t backed by GPU memory </dd>
+<dt><strong>Parameters</strong></dt>
+<dd><ul class="breatheparameterlist first last simple">
+<li><code class="docutils literal notranslate"><span class="pre">buffer</span></code>: buffer to convert </li>
+<li><code class="docutils literal notranslate"><span class="pre">out</span></code>: conversion result </li>
+</ul>
+</dd>
+</dl>
+</p>
+</dd></dl>
+
+</div>
+</dd></dl>
+
+<dl class="function">
+<dt id="_CPPv4N5arrow4cuda22AllocateCudaHostBufferEiK7int64_tPNSt10shared_ptrI14CudaHostBufferEE">
+<span id="_CPPv3N5arrow4cuda22AllocateCudaHostBufferEiK7int64_tPNSt10shared_ptrI14CudaHostBufferEE"></span><span id="_CPPv2N5arrow4cuda22AllocateCudaHostBufferEiK7int64_tPNSt10shared_ptrI14CudaHostBufferEE"></span><span id="arrow::cuda::AllocateCudaHostBuffer__i.int64_tC.std::shared_ptr:CudaHostBuffer:P"></span><span class="target" id="namespacearrow_1_1cuda_1a0fe5b064c963ebdedd2b06325ee2a223"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::St [...]
+<dd><p>Allocate CUDA-accessible memory on CPU host. </p>
+<p><dl class="docutils">
+<dt><strong>Return</strong></dt>
+<dd><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a> </dd>
+<dt><strong>Parameters</strong></dt>
+<dd><ul class="breatheparameterlist first last simple">
+<li><code class="docutils literal notranslate"><span class="pre">device_number</span></code>: device to expose host memory </li>
+<li><code class="docutils literal notranslate"><span class="pre">size</span></code>: number of bytes </li>
+<li><code class="docutils literal notranslate"><span class="pre">out</span></code>: the allocated buffer </li>
+</ul>
+</dd>
+</dl>
+</p>
+</dd></dl>
+
+<dl class="class">
+<dt id="_CPPv4N5arrow4cuda14CudaHostBufferE">
+<span id="_CPPv3N5arrow4cuda14CudaHostBufferE"></span><span id="_CPPv2N5arrow4cuda14CudaHostBufferE"></span><span id="arrow::cuda::CudaHostBuffer"></span><span class="target" id="classarrow_1_1cuda_1_1_cuda_host_buffer"></span><em class="property">class </em><code class="descname">CudaHostBuffer</code> : <em class="property">public</em> arrow::<a class="reference internal" href="memory.html#_CPPv4N5arrow13MutableBufferE" title="arrow::MutableBuffer">MutableBuffer</a><a class="headerlink" [...]
+<dd><p>Device-accessible CPU memory created using cudaHostAlloc. </p>
+</dd></dl>
+
+</div>
+<div class="section" id="device-memory-input-output">
+<h2>Device Memory Input / Output<a class="headerlink" href="#device-memory-input-output" title="Permalink to this headline">¶</a></h2>
+<dl class="class">
+<dt id="_CPPv4N5arrow4cuda16CudaBufferReaderE">
+<span id="_CPPv3N5arrow4cuda16CudaBufferReaderE"></span><span id="_CPPv2N5arrow4cuda16CudaBufferReaderE"></span><span id="arrow::cuda::CudaBufferReader"></span><span class="target" id="classarrow_1_1cuda_1_1_cuda_buffer_reader"></span><em class="property">class </em><code class="descname">CudaBufferReader</code> : <em class="property">public</em> arrow::io::BufferReader<a class="headerlink" href="#_CPPv4N5arrow4cuda16CudaBufferReaderE" title="Permalink to this definition">¶</a><br /></dt>
+<dd><p>File interface for zero-copy read from CUDA buffers. </p>
+<p>Note: Reads return pointers to device memory. This means you must be careful using this interface with any Arrow code which may expect to be able to do anything other than pointer arithmetic on the returned buffers </p>
+<div class="breathe-sectiondef docutils container">
+<p class="breathe-sectiondef-title rubric">Public Functions</p>
+<dl class="function">
+<dt id="_CPPv4N5arrow4cuda16CudaBufferReader4ReadE7int64_tP7int64_tPv">
+<span id="_CPPv3N5arrow4cuda16CudaBufferReader4ReadE7int64_tP7int64_tPv"></span><span id="_CPPv2N5arrow4cuda16CudaBufferReader4ReadE7int64_tP7int64_tPv"></span><span id="arrow::cuda::CudaBufferReader::Read__int64_t.int64_tP.voidP"></span><span class="target" id="classarrow_1_1cuda_1_1_cuda_buffer_reader_1a28ca1a848fe1a21fe238da5f26c79b3f"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descname">Read</code><span [...]
+<dd><p>Read bytes into pre-allocated host memory. </p>
+<p><dl class="docutils">
+<dt><strong>Parameters</strong></dt>
+<dd><ul class="breatheparameterlist first last simple">
+<li><code class="docutils literal notranslate"><span class="pre">nbytes</span></code>: number of bytes to read </li>
+<li><code class="docutils literal notranslate"><span class="pre">bytes_read</span></code>: actual number of bytes read </li>
+<li><code class="docutils literal notranslate"><span class="pre">buffer</span></code>: pre-allocated memory to write into </li>
+</ul>
+</dd>
+</dl>
+</p>
+</dd></dl>
+
+<dl class="function">
+<dt id="_CPPv4N5arrow4cuda16CudaBufferReader4ReadE7int64_tPNSt10shared_ptrI6BufferEE">
+<span id="_CPPv3N5arrow4cuda16CudaBufferReader4ReadE7int64_tPNSt10shared_ptrI6BufferEE"></span><span id="_CPPv2N5arrow4cuda16CudaBufferReader4ReadE7int64_tPNSt10shared_ptrI6BufferEE"></span><span id="arrow::cuda::CudaBufferReader::Read__int64_t.std::shared_ptr:Buffer:P"></span><span class="target" id="classarrow_1_1cuda_1_1_cuda_buffer_reader_1a642245662eec968a269c7601ec51d54d"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status">Status</a> [...]
+<dd><p>Zero-copy read from device memory. </p>
+<p><dl class="docutils">
+<dt><strong>Return</strong></dt>
+<dd><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a> </dd>
+<dt><strong>Parameters</strong></dt>
+<dd><ul class="breatheparameterlist first last simple">
+<li><code class="docutils literal notranslate"><span class="pre">nbytes</span></code>: number of bytes to read </li>
+<li><code class="docutils literal notranslate"><span class="pre">out</span></code>: a <a class="reference internal" href="memory.html#classarrow_1_1_buffer"><span class="std std-ref">Buffer</span></a> referencing device memory </li>
+</ul>
+</dd>
+</dl>
+</p>
+</dd></dl>
+
+</div>
+</dd></dl>
+
+<dl class="class">
+<dt id="_CPPv4N5arrow4cuda16CudaBufferWriterE">
+<span id="_CPPv3N5arrow4cuda16CudaBufferWriterE"></span><span id="_CPPv2N5arrow4cuda16CudaBufferWriterE"></span><span id="arrow::cuda::CudaBufferWriter"></span><span class="target" id="classarrow_1_1cuda_1_1_cuda_buffer_writer"></span><em class="property">class </em><code class="descname">CudaBufferWriter</code> : <em class="property">public</em> arrow::io::WritableFile<a class="headerlink" href="#_CPPv4N5arrow4cuda16CudaBufferWriterE" title="Permalink to this definition">¶</a><br /></dt>
+<dd><p>File interface for writing to CUDA buffers, with optional buffering. </p>
+<div class="breathe-sectiondef docutils container">
+<p class="breathe-sectiondef-title rubric">Public Functions</p>
+<dl class="function">
+<dt id="_CPPv4N5arrow4cuda16CudaBufferWriter5CloseEv">
+<span id="_CPPv3N5arrow4cuda16CudaBufferWriter5CloseEv"></span><span id="_CPPv2N5arrow4cuda16CudaBufferWriter5CloseEv"></span><span id="arrow::cuda::CudaBufferWriter::Close"></span><span class="target" id="classarrow_1_1cuda_1_1_cuda_buffer_writer_1a0ea8c0db5348cb6c7a95581545708106"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descname">Close</code><span class="sig-paren">(</span><span class="sig-paren">)</sp [...]
+<dd><p>Close writer and flush buffered bytes to GPU. </p>
+</dd></dl>
+
+<dl class="function">
+<dt id="_CPPv4N5arrow4cuda16CudaBufferWriter5FlushEv">
+<span id="_CPPv3N5arrow4cuda16CudaBufferWriter5FlushEv"></span><span id="_CPPv2N5arrow4cuda16CudaBufferWriter5FlushEv"></span><span id="arrow::cuda::CudaBufferWriter::Flush"></span><span class="target" id="classarrow_1_1cuda_1_1_cuda_buffer_writer_1a5b1378916dcf383f54bbe22ae6519119"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descname">Flush</code><span class="sig-paren">(</span><span class="sig-paren">)</sp [...]
+<dd><p>Flush buffered bytes to GPU. </p>
+</dd></dl>
+
+<dl class="function">
+<dt id="_CPPv4N5arrow4cuda16CudaBufferWriter13SetBufferSizeEK7int64_t">
+<span id="_CPPv3N5arrow4cuda16CudaBufferWriter13SetBufferSizeEK7int64_t"></span><span id="_CPPv2N5arrow4cuda16CudaBufferWriter13SetBufferSizeEK7int64_t"></span><span id="arrow::cuda::CudaBufferWriter::SetBufferSize__int64_tC"></span><span class="target" id="classarrow_1_1cuda_1_1_cuda_buffer_writer_1afe2b3f481f6dc35d292b2b808f5c4aae"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descname">SetBufferSize</code>< [...]
+<dd><p>Set CPU buffer size to limit calls to cudaMemcpy. </p>
+<p><p>By default writes are unbuffered </p>
+<dl class="docutils">
+<dt><strong>Return</strong></dt>
+<dd><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a></dd>
+<dt><strong>Parameters</strong></dt>
+<dd><ul class="breatheparameterlist first last simple">
+<li><code class="docutils literal notranslate"><span class="pre">buffer_size</span></code>: the size of CPU buffer to allocate </li>
+</ul>
+</dd>
+</dl>
+</p>
+</dd></dl>
+
+<dl class="function">
+<dt id="_CPPv4NK5arrow4cuda16CudaBufferWriter11buffer_sizeEv">
+<span id="_CPPv3NK5arrow4cuda16CudaBufferWriter11buffer_sizeEv"></span><span id="_CPPv2NK5arrow4cuda16CudaBufferWriter11buffer_sizeEv"></span><span id="arrow::cuda::CudaBufferWriter::buffer_sizeC"></span><span class="target" id="classarrow_1_1cuda_1_1_cuda_buffer_writer_1a2a552698ce0327a211d7cc21ba44a7b6"></span>int64_t <code class="descname">buffer_size</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPP [...]
+<dd><p>Returns size of host (CPU) buffer, 0 for unbuffered. </p>
+</dd></dl>
+
+<dl class="function">
+<dt id="_CPPv4NK5arrow4cuda16CudaBufferWriter18num_bytes_bufferedEv">
+<span id="_CPPv3NK5arrow4cuda16CudaBufferWriter18num_bytes_bufferedEv"></span><span id="_CPPv2NK5arrow4cuda16CudaBufferWriter18num_bytes_bufferedEv"></span><span id="arrow::cuda::CudaBufferWriter::num_bytes_bufferedC"></span><span class="target" id="classarrow_1_1cuda_1_1_cuda_buffer_writer_1aab6152a10e047d397137b5021e9a7292"></span>int64_t <code class="descname">num_bytes_buffered</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a cl [...]
+<dd><p>Returns number of bytes buffered on host. </p>
+</dd></dl>
+
+</div>
+</dd></dl>
+
+</div>
+<div class="section" id="cuda-ipc">
+<h2>CUDA IPC<a class="headerlink" href="#cuda-ipc" title="Permalink to this headline">¶</a></h2>
+<dl class="class">
+<dt id="_CPPv4N5arrow4cuda16CudaIpcMemHandleE">
+<span id="_CPPv3N5arrow4cuda16CudaIpcMemHandleE"></span><span id="_CPPv2N5arrow4cuda16CudaIpcMemHandleE"></span><span id="arrow::cuda::CudaIpcMemHandle"></span><span class="target" id="classarrow_1_1cuda_1_1_cuda_ipc_mem_handle"></span><em class="property">class </em><code class="descname">CudaIpcMemHandle</code><a class="headerlink" href="#_CPPv4N5arrow4cuda16CudaIpcMemHandleE" title="Permalink to this definition">¶</a><br /></dt>
+<dd><div class="breathe-sectiondef docutils container">
+<p class="breathe-sectiondef-title rubric">Public Functions</p>
+<dl class="function">
+<dt id="_CPPv4NK5arrow4cuda16CudaIpcMemHandle9SerializeEP10MemoryPoolPNSt10shared_ptrI6BufferEE">
+<span id="_CPPv3NK5arrow4cuda16CudaIpcMemHandle9SerializeEP10MemoryPoolPNSt10shared_ptrI6BufferEE"></span><span id="_CPPv2NK5arrow4cuda16CudaIpcMemHandle9SerializeEP10MemoryPoolPNSt10shared_ptrI6BufferEE"></span><span id="arrow::cuda::CudaIpcMemHandle::Serialize__MemoryPoolP.std::shared_ptr:Buffer:PC"></span><span class="target" id="classarrow_1_1cuda_1_1_cuda_ipc_mem_handle_1a4a5321e616e9126b4772dc82f04d81bd"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" [...]
+<dd><p>Write <a class="reference internal" href="#classarrow_1_1cuda_1_1_cuda_ipc_mem_handle"><span class="std std-ref">CudaIpcMemHandle</span></a> to a <a class="reference internal" href="memory.html#classarrow_1_1_buffer"><span class="std std-ref">Buffer</span></a>. </p>
+<p><dl class="docutils">
+<dt><strong>Return</strong></dt>
+<dd><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a> </dd>
+<dt><strong>Parameters</strong></dt>
+<dd><ul class="breatheparameterlist first last simple">
+<li><code class="docutils literal notranslate"><span class="pre">pool</span></code>: a <a class="reference internal" href="memory.html#classarrow_1_1_memory_pool"><span class="std std-ref">MemoryPool</span></a> to allocate memory from </li>
+<li><code class="docutils literal notranslate"><span class="pre">out</span></code>: the serialized buffer </li>
+</ul>
+</dd>
+</dl>
+</p>
+</dd></dl>
+
+</div>
+<div class="breathe-sectiondef docutils container">
+<p class="breathe-sectiondef-title rubric">Public Static Functions</p>
+<dl class="function">
+<dt id="_CPPv4N5arrow4cuda16CudaIpcMemHandle10FromBufferEPKvPNSt10shared_ptrI16CudaIpcMemHandleEE">
+<span id="_CPPv3N5arrow4cuda16CudaIpcMemHandle10FromBufferEPKvPNSt10shared_ptrI16CudaIpcMemHandleEE"></span><span id="_CPPv2N5arrow4cuda16CudaIpcMemHandle10FromBufferEPKvPNSt10shared_ptrI16CudaIpcMemHandleEE"></span><span id="arrow::cuda::CudaIpcMemHandle::FromBuffer__voidCP.std::shared_ptr:CudaIpcMemHandle:P"></span><span class="target" id="classarrow_1_1cuda_1_1_cuda_ipc_mem_handle_1aa139381de991e30041375e211e1e5790"></span><em class="property">static</em> <a class="reference internal" [...]
+<dd><p>Create <a class="reference internal" href="#classarrow_1_1cuda_1_1_cuda_ipc_mem_handle"><span class="std std-ref">CudaIpcMemHandle</span></a> from opaque buffer (e.g. </p>
+<p>from another process) <dl class="docutils">
+<dt><strong>Return</strong></dt>
+<dd><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a> </dd>
+<dt><strong>Parameters</strong></dt>
+<dd><ul class="breatheparameterlist first last simple">
+<li><code class="docutils literal notranslate"><span class="pre">opaque_handle</span></code>: a CUipcMemHandle as a const void* </li>
+<li><code class="docutils literal notranslate"><span class="pre">handle</span></code>: the <a class="reference internal" href="#classarrow_1_1cuda_1_1_cuda_ipc_mem_handle"><span class="std std-ref">CudaIpcMemHandle</span></a> instance </li>
+</ul>
+</dd>
+</dl>
+</p>
+</dd></dl>
+
+</div>
+</dd></dl>
+
+<dl class="function">
+<dt id="_CPPv4N5arrow4cuda20SerializeRecordBatchERK11RecordBatchP11CudaContextPNSt10shared_ptrI10CudaBufferEE">
+<span id="_CPPv3N5arrow4cuda20SerializeRecordBatchERK11RecordBatchP11CudaContextPNSt10shared_ptrI10CudaBufferEE"></span><span id="_CPPv2N5arrow4cuda20SerializeRecordBatchERK11RecordBatchP11CudaContextPNSt10shared_ptrI10CudaBufferEE"></span><span id="arrow::cuda::SerializeRecordBatch__RecordBatchCR.CudaContextP.std::shared_ptr:CudaBuffer:P"></span><span class="target" id="namespacearrow_1_1cuda_1a10e8fc4657cd1bc1226be86f8207a33a"></span><a class="reference internal" href="support.html#_CP [...]
+<dd><p>Write record batch message to GPU device memory. </p>
+<p><dl class="docutils">
+<dt><strong>Return</strong></dt>
+<dd><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a> </dd>
+<dt><strong>Parameters</strong></dt>
+<dd><ul class="breatheparameterlist first last simple">
+<li><code class="docutils literal notranslate"><span class="pre">batch</span></code>: record batch to write </li>
+<li><code class="docutils literal notranslate"><span class="pre">ctx</span></code>: <a class="reference internal" href="#classarrow_1_1cuda_1_1_cuda_context"><span class="std std-ref">CudaContext</span></a> to allocate device memory from </li>
+<li><code class="docutils literal notranslate"><span class="pre">out</span></code>: the returned device buffer which contains the record batch message </li>
+</ul>
+</dd>
+</dl>
+</p>
+</dd></dl>
+
+<dl class="function">
+<dt id="_CPPv4N5arrow4cuda15ReadRecordBatchERKNSt10shared_ptrI6SchemaEERKNSt10shared_ptrI10CudaBufferEEP10MemoryPoolPNSt10shared_ptrI11RecordBatchEE">
+<span id="_CPPv3N5arrow4cuda15ReadRecordBatchERKNSt10shared_ptrI6SchemaEERKNSt10shared_ptrI10CudaBufferEEP10MemoryPoolPNSt10shared_ptrI11RecordBatchEE"></span><span id="_CPPv2N5arrow4cuda15ReadRecordBatchERKNSt10shared_ptrI6SchemaEERKNSt10shared_ptrI10CudaBufferEEP10MemoryPoolPNSt10shared_ptrI11RecordBatchEE"></span><span id="arrow::cuda::ReadRecordBatch__std::shared_ptr:Schema:CR.std::shared_ptr:CudaBuffer:CR.MemoryPoolP.std::shared_ptr:RecordBatch:P"></span><span class="target" id="nam [...]
+<dd><p>ReadRecordBatch specialized to handle metadata on CUDA device. </p>
+<p><dl class="docutils">
+<dt><strong>Parameters</strong></dt>
+<dd><ul class="breatheparameterlist first last simple">
+<li><code class="docutils literal notranslate"><span class="pre">schema</span></code>: the <a class="reference internal" href="datatype.html#classarrow_1_1_schema"><span class="std std-ref">Schema</span></a> for the record batch </li>
+<li><code class="docutils literal notranslate"><span class="pre">buffer</span></code>: a <a class="reference internal" href="#classarrow_1_1cuda_1_1_cuda_buffer"><span class="std std-ref">CudaBuffer</span></a> containing the complete IPC message </li>
+<li><code class="docutils literal notranslate"><span class="pre">pool</span></code>: a <a class="reference internal" href="memory.html#classarrow_1_1_memory_pool"><span class="std std-ref">MemoryPool</span></a> to use for allocating space for the metadata </li>
+<li><code class="docutils literal notranslate"><span class="pre">out</span></code>: the reconstructed <a class="reference internal" href="table.html#classarrow_1_1_record_batch"><span class="std std-ref">RecordBatch</span></a>, with device pointers </li>
+</ul>
+</dd>
+</dl>
+</p>
+</dd></dl>
+
+</div>
+</div>
+
+
+ </div>
+
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="../../python/index.html" class="btn btn-neutral float-right" title="Python bindings" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="utilities.html" class="btn btn-neutral float-left" title="Utilities" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <p>
+ © Copyright 2016-2018 Apache Software Foundation
+
+ </p>
+ </div>
+ Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+</footer>
+
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+
+
+ <script type="text/javascript">
+ jQuery(function () {
+ SphinxRtdTheme.Navigation.enable(true);
+ });
+ </script>
+
+
+
+
+
+<script async src="https://www.googletagmanager.com/gtag/js?id=UA-107500873-1"></script>
+<script>
+ window.dataLayer = window.dataLayer || [];
+ function gtag(){dataLayer.push(arguments);}
+ gtag('js', new Date());
+
+ gtag('config', 'UA-107500873-1');
+</script>
+
+
+</body>
+</html>
\ No newline at end of file
diff --git a/docs/cpp/api/datatype.html b/docs/cpp/api/datatype.html
index eb22569..82379ea 100644
--- a/docs/cpp/api/datatype.html
+++ b/docs/cpp/api/datatype.html
@@ -9,7 +9,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Data Types — Apache Arrow v0.12.1.dev0+g8ca41384b.d20190120</title>
+ <title>Data Types — Apache Arrow v0.13.0</title>
@@ -18,34 +18,36 @@
-
-
+ <script type="text/javascript" src="../../_static/js/modernizr.min.js"></script>
+ <script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
+ <script type="text/javascript" src="../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../_static/doctools.js"></script>
+ <script type="text/javascript" src="../../_static/language_data.js"></script>
+
+ <script type="text/javascript" src="../../_static/js/theme.js"></script>
-
+
+
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<link rel="index" title="Index" href="../../genindex.html" />
<link rel="search" title="Search" href="../../search.html" />
<link rel="next" title="Arrays" href="array.html" />
<link rel="prev" title="Memory (management)" href="memory.html" />
-
-
- <script src="../../_static/js/modernizr.min.js"></script>
-
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
-
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
- <div class="wy-side-nav-search">
+ <div class="wy-side-nav-search" >
@@ -59,7 +61,7 @@
<div class="version">
- 0.12.1.dev0+g8ca41384b.d20190120
+ 0.13.0
</div>
@@ -83,7 +85,7 @@
- <p class="caption"><span class="caption-text">Memory Format</span></p>
+ <p class="caption"><span class="caption-text">Arrow Columnar Format</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../format/README.html">Arrow specification documents</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../format/Guidelines.html">Implementation guidelines</a></li>
@@ -91,11 +93,11 @@
<li class="toctree-l1"><a class="reference internal" href="../../format/Metadata.html">Metadata: Logical types, schemas, data headers</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../format/IPC.html">Interprocess messaging / communication (IPC)</a></li>
</ul>
-<p class="caption"><span class="caption-text">Languages</span></p>
+<p class="caption"><span class="caption-text">Arrow Libraries</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="../index.html">C++ Implementation</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="../getting_started.html">Getting Started</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../examples.html">Examples</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../examples/index.html">Examples</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="../api.html">API Reference</a><ul class="current">
<li class="toctree-l3"><a class="reference internal" href="support.html">Programming Support</a></li>
<li class="toctree-l3"><a class="reference internal" href="memory.html">Memory (management)</a></li>
@@ -108,15 +110,21 @@
<li class="toctree-l3"><a class="reference internal" href="array.html">Arrays</a></li>
<li class="toctree-l3"><a class="reference internal" href="builder.html">Array Builders</a></li>
<li class="toctree-l3"><a class="reference internal" href="table.html">Two-dimensional Datasets</a></li>
+<li class="toctree-l3"><a class="reference internal" href="utilities.html">Utilities</a></li>
+<li class="toctree-l3"><a class="reference internal" href="cuda.html">CUDA support</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../python/index.html">Python bindings</a></li>
</ul>
-<p class="caption"><span class="caption-text">Other Topics</span></p>
+<p class="caption"><span class="caption-text">Development and Contributing</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../../building.html">Building the Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../developers/contributing.html">Contribution Guidelines</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../developers/cpp.html">C++ Development</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../developers/python.html">Python Development</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../developers/integration.html">Integration Testing</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../developers/documentation.html">Building the Documentation</a></li>
</ul>
@@ -188,213 +196,219 @@
<div class="section" id="data-types">
<h1>Data Types<a class="headerlink" href="#data-types" title="Permalink to this headline">¶</a></h1>
<dl class="type">
-<dt id="_CPPv3N5arrow4Type4typeE">
-<span id="_CPPv2N5arrow4Type4typeE"></span><span id="arrow::Type::type"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44"></span><em class="property">enum </em><code class="descclassname">arrow::Type<code class="descclassname">::</code></code><code class="descname">type</code><a class="headerlink" href="#_CPPv3N5arrow4Type4typeE" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4N5arrow4Type4typeE">
+<span id="_CPPv3N5arrow4Type4typeE"></span><span id="_CPPv2N5arrow4Type4typeE"></span><span id="arrow::Type::type"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44"></span><em class="property">enum </em><code class="descclassname">arrow::Type<code class="descclassname">::</code></code><code class="descname">type</code><a class="headerlink" href="#_CPPv4N5arrow4Type4typeE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Main data type enumeration. </p>
<p>This enumeration provides a quick way to interrogate the category of a <a class="reference internal" href="#classarrow_1_1_data_type"><span class="std std-ref">DataType</span></a> instance. </p>
<p><em>Values:</em></p>
<dl class="enumerator">
-<dt id="_CPPv3N5arrow4Type2NAE">
-<span id="_CPPv2N5arrow4Type2NAE"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44af46d8600b17dd993097e0875a46e0b15"></span><code class="descname">NA</code><a class="headerlink" href="#_CPPv3N5arrow4Type2NAE" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4N5arrow4Type2NAE">
+<span id="_CPPv3N5arrow4Type2NAE"></span><span id="_CPPv2N5arrow4Type2NAE"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44af46d8600b17dd993097e0875a46e0b15"></span><code class="descname">NA</code><a class="headerlink" href="#_CPPv4N5arrow4Type2NAE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>A NULL type having no physical storage. </p>
</dd></dl>
<dl class="enumerator">
-<dt id="_CPPv3N5arrow4Type4BOOLE">
-<span id="_CPPv2N5arrow4Type4BOOLE"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44ae4bb4146eedf3fb5a517780000001b30"></span><code class="descname">BOOL</code><a class="headerlink" href="#_CPPv3N5arrow4Type4BOOLE" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4N5arrow4Type4BOOLE">
+<span id="_CPPv3N5arrow4Type4BOOLE"></span><span id="_CPPv2N5arrow4Type4BOOLE"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44ae4bb4146eedf3fb5a517780000001b30"></span><code class="descname">BOOL</code><a class="headerlink" href="#_CPPv4N5arrow4Type4BOOLE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Boolean as 1 bit, LSB bit-packed ordering. </p>
</dd></dl>
<dl class="enumerator">
-<dt id="_CPPv3N5arrow4Type5UINT8E">
-<span id="_CPPv2N5arrow4Type5UINT8E"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44ab8f52afb784526f800c91de101673b42"></span><code class="descname">UINT8</code><a class="headerlink" href="#_CPPv3N5arrow4Type5UINT8E" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4N5arrow4Type5UINT8E">
+<span id="_CPPv3N5arrow4Type5UINT8E"></span><span id="_CPPv2N5arrow4Type5UINT8E"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44ab8f52afb784526f800c91de101673b42"></span><code class="descname">UINT8</code><a class="headerlink" href="#_CPPv4N5arrow4Type5UINT8E" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Unsigned 8-bit little-endian integer. </p>
</dd></dl>
<dl class="enumerator">
-<dt id="_CPPv3N5arrow4Type4INT8E">
-<span id="_CPPv2N5arrow4Type4INT8E"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44adf9f694eb598f6f8cac8bed3da547d65"></span><code class="descname">INT8</code><a class="headerlink" href="#_CPPv3N5arrow4Type4INT8E" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4N5arrow4Type4INT8E">
+<span id="_CPPv3N5arrow4Type4INT8E"></span><span id="_CPPv2N5arrow4Type4INT8E"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44adf9f694eb598f6f8cac8bed3da547d65"></span><code class="descname">INT8</code><a class="headerlink" href="#_CPPv4N5arrow4Type4INT8E" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Signed 8-bit little-endian integer. </p>
</dd></dl>
<dl class="enumerator">
-<dt id="_CPPv3N5arrow4Type6UINT16E">
-<span id="_CPPv2N5arrow4Type6UINT16E"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44a87c4272d67d3a84ed9ce6c6a9a4a6772"></span><code class="descname">UINT16</code><a class="headerlink" href="#_CPPv3N5arrow4Type6UINT16E" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4N5arrow4Type6UINT16E">
+<span id="_CPPv3N5arrow4Type6UINT16E"></span><span id="_CPPv2N5arrow4Type6UINT16E"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44a87c4272d67d3a84ed9ce6c6a9a4a6772"></span><code class="descname">UINT16</code><a class="headerlink" href="#_CPPv4N5arrow4Type6UINT16E" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Unsigned 16-bit little-endian integer. </p>
</dd></dl>
<dl class="enumerator">
-<dt id="_CPPv3N5arrow4Type5INT16E">
-<span id="_CPPv2N5arrow4Type5INT16E"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44a36b3753b92501b60b2740b29d6e17696"></span><code class="descname">INT16</code><a class="headerlink" href="#_CPPv3N5arrow4Type5INT16E" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4N5arrow4Type5INT16E">
+<span id="_CPPv3N5arrow4Type5INT16E"></span><span id="_CPPv2N5arrow4Type5INT16E"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44a36b3753b92501b60b2740b29d6e17696"></span><code class="descname">INT16</code><a class="headerlink" href="#_CPPv4N5arrow4Type5INT16E" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Signed 16-bit little-endian integer. </p>
</dd></dl>
<dl class="enumerator">
-<dt id="_CPPv3N5arrow4Type6UINT32E">
-<span id="_CPPv2N5arrow4Type6UINT32E"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44a89620afd46abf8f99b057bd3587a78f0"></span><code class="descname">UINT32</code><a class="headerlink" href="#_CPPv3N5arrow4Type6UINT32E" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4N5arrow4Type6UINT32E">
+<span id="_CPPv3N5arrow4Type6UINT32E"></span><span id="_CPPv2N5arrow4Type6UINT32E"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44a89620afd46abf8f99b057bd3587a78f0"></span><code class="descname">UINT32</code><a class="headerlink" href="#_CPPv4N5arrow4Type6UINT32E" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Unsigned 32-bit little-endian integer. </p>
</dd></dl>
<dl class="enumerator">
-<dt id="_CPPv3N5arrow4Type5INT32E">
-<span id="_CPPv2N5arrow4Type5INT32E"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44af8005f162bc422abcee7f1197bf04cf8"></span><code class="descname">INT32</code><a class="headerlink" href="#_CPPv3N5arrow4Type5INT32E" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4N5arrow4Type5INT32E">
+<span id="_CPPv3N5arrow4Type5INT32E"></span><span id="_CPPv2N5arrow4Type5INT32E"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44af8005f162bc422abcee7f1197bf04cf8"></span><code class="descname">INT32</code><a class="headerlink" href="#_CPPv4N5arrow4Type5INT32E" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Signed 32-bit little-endian integer. </p>
</dd></dl>
<dl class="enumerator">
-<dt id="_CPPv3N5arrow4Type6UINT64E">
-<span id="_CPPv2N5arrow4Type6UINT64E"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44af1096e3ebb2d7a678fc6ddac24bf7639"></span><code class="descname">UINT64</code><a class="headerlink" href="#_CPPv3N5arrow4Type6UINT64E" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4N5arrow4Type6UINT64E">
+<span id="_CPPv3N5arrow4Type6UINT64E"></span><span id="_CPPv2N5arrow4Type6UINT64E"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44af1096e3ebb2d7a678fc6ddac24bf7639"></span><code class="descname">UINT64</code><a class="headerlink" href="#_CPPv4N5arrow4Type6UINT64E" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Unsigned 64-bit little-endian integer. </p>
</dd></dl>
<dl class="enumerator">
-<dt id="_CPPv3N5arrow4Type5INT64E">
-<span id="_CPPv2N5arrow4Type5INT64E"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44af38ec7ec303572a87b11fd48876bc1d0"></span><code class="descname">INT64</code><a class="headerlink" href="#_CPPv3N5arrow4Type5INT64E" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4N5arrow4Type5INT64E">
+<span id="_CPPv3N5arrow4Type5INT64E"></span><span id="_CPPv2N5arrow4Type5INT64E"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44af38ec7ec303572a87b11fd48876bc1d0"></span><code class="descname">INT64</code><a class="headerlink" href="#_CPPv4N5arrow4Type5INT64E" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Signed 64-bit little-endian integer. </p>
</dd></dl>
<dl class="enumerator">
-<dt id="_CPPv3N5arrow4Type10HALF_FLOATE">
-<span id="_CPPv2N5arrow4Type10HALF_FLOATE"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44af6ebd198668f2a6c2d79c549f599e896"></span><code class="descname">HALF_FLOAT</code><a class="headerlink" href="#_CPPv3N5arrow4Type10HALF_FLOATE" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4N5arrow4Type10HALF_FLOATE">
+<span id="_CPPv3N5arrow4Type10HALF_FLOATE"></span><span id="_CPPv2N5arrow4Type10HALF_FLOATE"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44af6ebd198668f2a6c2d79c549f599e896"></span><code class="descname">HALF_FLOAT</code><a class="headerlink" href="#_CPPv4N5arrow4Type10HALF_FLOATE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>2-byte floating point value </p>
</dd></dl>
<dl class="enumerator">
-<dt id="_CPPv3N5arrow4Type5FLOATE">
-<span id="_CPPv2N5arrow4Type5FLOATE"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44a57c54c2b9d1630bc8c99b5fec4c93e58"></span><code class="descname">FLOAT</code><a class="headerlink" href="#_CPPv3N5arrow4Type5FLOATE" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4N5arrow4Type5FLOATE">
+<span id="_CPPv3N5arrow4Type5FLOATE"></span><span id="_CPPv2N5arrow4Type5FLOATE"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44a57c54c2b9d1630bc8c99b5fec4c93e58"></span><code class="descname">FLOAT</code><a class="headerlink" href="#_CPPv4N5arrow4Type5FLOATE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>4-byte floating point value </p>
</dd></dl>
<dl class="enumerator">
-<dt id="_CPPv3N5arrow4Type6DOUBLEE">
-<span id="_CPPv2N5arrow4Type6DOUBLEE"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44a75397800ad025678ff7803b543d4a183"></span><code class="descname">DOUBLE</code><a class="headerlink" href="#_CPPv3N5arrow4Type6DOUBLEE" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4N5arrow4Type6DOUBLEE">
+<span id="_CPPv3N5arrow4Type6DOUBLEE"></span><span id="_CPPv2N5arrow4Type6DOUBLEE"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44a75397800ad025678ff7803b543d4a183"></span><code class="descname">DOUBLE</code><a class="headerlink" href="#_CPPv4N5arrow4Type6DOUBLEE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>8-byte floating point value </p>
</dd></dl>
<dl class="enumerator">
-<dt id="_CPPv3N5arrow4Type6STRINGE">
-<span id="_CPPv2N5arrow4Type6STRINGE"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44a864933bd7cdfa63ea75498c34db6545f"></span><code class="descname">STRING</code><a class="headerlink" href="#_CPPv3N5arrow4Type6STRINGE" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4N5arrow4Type6STRINGE">
+<span id="_CPPv3N5arrow4Type6STRINGE"></span><span id="_CPPv2N5arrow4Type6STRINGE"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44a864933bd7cdfa63ea75498c34db6545f"></span><code class="descname">STRING</code><a class="headerlink" href="#_CPPv4N5arrow4Type6STRINGE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>UTF8 variable-length string as List<Char> </p>
</dd></dl>
<dl class="enumerator">
-<dt id="_CPPv3N5arrow4Type6BINARYE">
-<span id="_CPPv2N5arrow4Type6BINARYE"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44a442cc62761c7e5a83d26da4d3ed2fe01"></span><code class="descname">BINARY</code><a class="headerlink" href="#_CPPv3N5arrow4Type6BINARYE" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4N5arrow4Type6BINARYE">
+<span id="_CPPv3N5arrow4Type6BINARYE"></span><span id="_CPPv2N5arrow4Type6BINARYE"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44a442cc62761c7e5a83d26da4d3ed2fe01"></span><code class="descname">BINARY</code><a class="headerlink" href="#_CPPv4N5arrow4Type6BINARYE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Variable-length bytes (no guarantee of UTF8-ness) </p>
</dd></dl>
<dl class="enumerator">
-<dt id="_CPPv3N5arrow4Type17FIXED_SIZE_BINARYE">
-<span id="_CPPv2N5arrow4Type17FIXED_SIZE_BINARYE"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44a1b3f48148c5ff94c039d09ff689da179"></span><code class="descname">FIXED_SIZE_BINARY</code><a class="headerlink" href="#_CPPv3N5arrow4Type17FIXED_SIZE_BINARYE" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4N5arrow4Type17FIXED_SIZE_BINARYE">
+<span id="_CPPv3N5arrow4Type17FIXED_SIZE_BINARYE"></span><span id="_CPPv2N5arrow4Type17FIXED_SIZE_BINARYE"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44a1b3f48148c5ff94c039d09ff689da179"></span><code class="descname">FIXED_SIZE_BINARY</code><a class="headerlink" href="#_CPPv4N5arrow4Type17FIXED_SIZE_BINARYE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Fixed-size binary. Each value occupies the same number of bytes. </p>
</dd></dl>
<dl class="enumerator">
-<dt id="_CPPv3N5arrow4Type6DATE32E">
-<span id="_CPPv2N5arrow4Type6DATE32E"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44a4351aedceb3d92f82cf7ae504476ef30"></span><code class="descname">DATE32</code><a class="headerlink" href="#_CPPv3N5arrow4Type6DATE32E" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4N5arrow4Type6DATE32E">
+<span id="_CPPv3N5arrow4Type6DATE32E"></span><span id="_CPPv2N5arrow4Type6DATE32E"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44a4351aedceb3d92f82cf7ae504476ef30"></span><code class="descname">DATE32</code><a class="headerlink" href="#_CPPv4N5arrow4Type6DATE32E" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>int32_t days since the UNIX epoch </p>
</dd></dl>
<dl class="enumerator">
-<dt id="_CPPv3N5arrow4Type6DATE64E">
-<span id="_CPPv2N5arrow4Type6DATE64E"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44a17325202e90c23cd194b1698eea87a38"></span><code class="descname">DATE64</code><a class="headerlink" href="#_CPPv3N5arrow4Type6DATE64E" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4N5arrow4Type6DATE64E">
+<span id="_CPPv3N5arrow4Type6DATE64E"></span><span id="_CPPv2N5arrow4Type6DATE64E"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44a17325202e90c23cd194b1698eea87a38"></span><code class="descname">DATE64</code><a class="headerlink" href="#_CPPv4N5arrow4Type6DATE64E" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>int64_t milliseconds since the UNIX epoch </p>
</dd></dl>
<dl class="enumerator">
-<dt id="_CPPv3N5arrow4Type9TIMESTAMPE">
-<span id="_CPPv2N5arrow4Type9TIMESTAMPE"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44a1e41dddee4a6410c4d6fe164b36a230e"></span><code class="descname">TIMESTAMP</code><a class="headerlink" href="#_CPPv3N5arrow4Type9TIMESTAMPE" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4N5arrow4Type9TIMESTAMPE">
+<span id="_CPPv3N5arrow4Type9TIMESTAMPE"></span><span id="_CPPv2N5arrow4Type9TIMESTAMPE"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44a1e41dddee4a6410c4d6fe164b36a230e"></span><code class="descname">TIMESTAMP</code><a class="headerlink" href="#_CPPv4N5arrow4Type9TIMESTAMPE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Exact timestamp encoded with int64 since UNIX epoch Default unit millisecond. </p>
</dd></dl>
<dl class="enumerator">
-<dt id="_CPPv3N5arrow4Type6TIME32E">
-<span id="_CPPv2N5arrow4Type6TIME32E"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44a73fb0fcd2b5d9a4c6071574c73cdf3c5"></span><code class="descname">TIME32</code><a class="headerlink" href="#_CPPv3N5arrow4Type6TIME32E" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4N5arrow4Type6TIME32E">
+<span id="_CPPv3N5arrow4Type6TIME32E"></span><span id="_CPPv2N5arrow4Type6TIME32E"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44a73fb0fcd2b5d9a4c6071574c73cdf3c5"></span><code class="descname">TIME32</code><a class="headerlink" href="#_CPPv4N5arrow4Type6TIME32E" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Time as signed 32-bit integer, representing either seconds or milliseconds since midnight. </p>
</dd></dl>
<dl class="enumerator">
-<dt id="_CPPv3N5arrow4Type6TIME64E">
-<span id="_CPPv2N5arrow4Type6TIME64E"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44ab960cffd22f54b634d9f055f7568d321"></span><code class="descname">TIME64</code><a class="headerlink" href="#_CPPv3N5arrow4Type6TIME64E" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4N5arrow4Type6TIME64E">
+<span id="_CPPv3N5arrow4Type6TIME64E"></span><span id="_CPPv2N5arrow4Type6TIME64E"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44ab960cffd22f54b634d9f055f7568d321"></span><code class="descname">TIME64</code><a class="headerlink" href="#_CPPv4N5arrow4Type6TIME64E" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Time as signed 64-bit integer, representing either microseconds or nanoseconds since midnight. </p>
</dd></dl>
<dl class="enumerator">
-<dt id="_CPPv3N5arrow4Type8INTERVALE">
-<span id="_CPPv2N5arrow4Type8INTERVALE"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44aaa546143f5b445f6478b7e157546ec3f"></span><code class="descname">INTERVAL</code><a class="headerlink" href="#_CPPv3N5arrow4Type8INTERVALE" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4N5arrow4Type8INTERVALE">
+<span id="_CPPv3N5arrow4Type8INTERVALE"></span><span id="_CPPv2N5arrow4Type8INTERVALE"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44aaa546143f5b445f6478b7e157546ec3f"></span><code class="descname">INTERVAL</code><a class="headerlink" href="#_CPPv4N5arrow4Type8INTERVALE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>YEAR_MONTH or DAY_TIME interval in SQL style. </p>
</dd></dl>
<dl class="enumerator">
-<dt id="_CPPv3N5arrow4Type7DECIMALE">
-<span id="_CPPv2N5arrow4Type7DECIMALE"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44a014fe7104b592dbd7c70e4e861774a63"></span><code class="descname">DECIMAL</code><a class="headerlink" href="#_CPPv3N5arrow4Type7DECIMALE" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4N5arrow4Type7DECIMALE">
+<span id="_CPPv3N5arrow4Type7DECIMALE"></span><span id="_CPPv2N5arrow4Type7DECIMALE"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44a014fe7104b592dbd7c70e4e861774a63"></span><code class="descname">DECIMAL</code><a class="headerlink" href="#_CPPv4N5arrow4Type7DECIMALE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Precision- and scale-based decimal type. </p>
<p>Storage type depends on the parameters. </p>
</dd></dl>
<dl class="enumerator">
-<dt id="_CPPv3N5arrow4Type4LISTE">
-<span id="_CPPv2N5arrow4Type4LISTE"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44ad074f9c02567b5945293b9114f84f210"></span><code class="descname">LIST</code><a class="headerlink" href="#_CPPv3N5arrow4Type4LISTE" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4N5arrow4Type4LISTE">
+<span id="_CPPv3N5arrow4Type4LISTE"></span><span id="_CPPv2N5arrow4Type4LISTE"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44ad074f9c02567b5945293b9114f84f210"></span><code class="descname">LIST</code><a class="headerlink" href="#_CPPv4N5arrow4Type4LISTE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>A list of some logical data type. </p>
</dd></dl>
<dl class="enumerator">
-<dt id="_CPPv3N5arrow4Type6STRUCTE">
-<span id="_CPPv2N5arrow4Type6STRUCTE"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44aaa028b35c4e6a047c0e510ef1b0389ef"></span><code class="descname">STRUCT</code><a class="headerlink" href="#_CPPv3N5arrow4Type6STRUCTE" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4N5arrow4Type6STRUCTE">
+<span id="_CPPv3N5arrow4Type6STRUCTE"></span><span id="_CPPv2N5arrow4Type6STRUCTE"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44aaa028b35c4e6a047c0e510ef1b0389ef"></span><code class="descname">STRUCT</code><a class="headerlink" href="#_CPPv4N5arrow4Type6STRUCTE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Struct of logical types. </p>
</dd></dl>
<dl class="enumerator">
-<dt id="_CPPv3N5arrow4Type5UNIONE">
-<span id="_CPPv2N5arrow4Type5UNIONE"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44a2fa6d3a8e3947b7d0024304bfb8b5fad"></span><code class="descname">UNION</code><a class="headerlink" href="#_CPPv3N5arrow4Type5UNIONE" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4N5arrow4Type5UNIONE">
+<span id="_CPPv3N5arrow4Type5UNIONE"></span><span id="_CPPv2N5arrow4Type5UNIONE"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44a2fa6d3a8e3947b7d0024304bfb8b5fad"></span><code class="descname">UNION</code><a class="headerlink" href="#_CPPv4N5arrow4Type5UNIONE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Unions of logical types. </p>
</dd></dl>
<dl class="enumerator">
-<dt id="_CPPv3N5arrow4Type10DICTIONARYE">
-<span id="_CPPv2N5arrow4Type10DICTIONARYE"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44a3c38b5820a3de12d71713473550c6280"></span><code class="descname">DICTIONARY</code><a class="headerlink" href="#_CPPv3N5arrow4Type10DICTIONARYE" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4N5arrow4Type10DICTIONARYE">
+<span id="_CPPv3N5arrow4Type10DICTIONARYE"></span><span id="_CPPv2N5arrow4Type10DICTIONARYE"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44a3c38b5820a3de12d71713473550c6280"></span><code class="descname">DICTIONARY</code><a class="headerlink" href="#_CPPv4N5arrow4Type10DICTIONARYE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Dictionary aka Category type. </p>
</dd></dl>
<dl class="enumerator">
-<dt id="_CPPv3N5arrow4Type3MAPE">
-<span id="_CPPv2N5arrow4Type3MAPE"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44a51838b04a2cdc2db91890e4c70f45e61"></span><code class="descname">MAP</code><a class="headerlink" href="#_CPPv3N5arrow4Type3MAPE" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4N5arrow4Type3MAPE">
+<span id="_CPPv3N5arrow4Type3MAPE"></span><span id="_CPPv2N5arrow4Type3MAPE"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44a51838b04a2cdc2db91890e4c70f45e61"></span><code class="descname">MAP</code><a class="headerlink" href="#_CPPv4N5arrow4Type3MAPE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Map, a repeated struct logical type. </p>
</dd></dl>
+<dl class="enumerator">
+<dt id="_CPPv4N5arrow4Type9EXTENSIONE">
+<span id="_CPPv3N5arrow4Type9EXTENSIONE"></span><span id="_CPPv2N5arrow4Type9EXTENSIONE"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44af62348e1483c0b1a1536853e35588dad"></span><code class="descname">EXTENSION</code><a class="headerlink" href="#_CPPv4N5arrow4Type9EXTENSIONE" title="Permalink to this definition">¶</a><br /></dt>
+<dd><p>Custom data type, implemented by user. </p>
+</dd></dl>
+
</dd></dl>
<dl class="class">
-<dt id="_CPPv3N5arrow8DataTypeE">
-<span id="_CPPv2N5arrow8DataTypeE"></span><span id="arrow::DataType"></span><span class="target" id="classarrow_1_1_data_type"></span><em class="property">class </em><code class="descname">DataType</code><a class="headerlink" href="#_CPPv3N5arrow8DataTypeE" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4N5arrow8DataTypeE">
+<span id="_CPPv3N5arrow8DataTypeE"></span><span id="_CPPv2N5arrow8DataTypeE"></span><span id="arrow::DataType"></span><span class="target" id="classarrow_1_1_data_type"></span><em class="property">class </em><code class="descname">DataType</code><a class="headerlink" href="#_CPPv4N5arrow8DataTypeE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Base class for all data types. </p>
<p>Data types in this library are all <em>logical</em>. They can be expressed as either a primitive physical type (bytes or bits of some fixed size), a nested type consisting of other data types, or another data type (e.g. a timestamp encoded as an int64).</p>
<p>Simple datatypes may be entirely described by their <a class="reference internal" href="#structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44"><span class="std std-ref">Type::type</span></a> id, but complex datatypes are usually parametric. </p>
-<p>Subclassed by <a class="reference internal" href="#classarrow_1_1_binary_type"><span class="std std-ref">arrow::BinaryType</span></a>, arrow::FixedWidthType, arrow::NestedType, <a class="reference internal" href="#classarrow_1_1_null_type"><span class="std std-ref">arrow::NullType</span></a></p>
+<p>Subclassed by <a class="reference internal" href="#classarrow_1_1_binary_type"><span class="std std-ref">arrow::BinaryType</span></a>, arrow::ExtensionType, arrow::FixedWidthType, arrow::NestedType, <a class="reference internal" href="#classarrow_1_1_null_type"><span class="std std-ref">arrow::NullType</span></a></p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric">Public Functions</p>
<dl class="function">
-<dt id="_CPPv3NK5arrow8DataType6EqualsERK8DataType">
-<span id="_CPPv2NK5arrow8DataType6EqualsERK8DataType"></span><span id="arrow::DataType::Equals__DataTypeCRC"></span><span class="target" id="classarrow_1_1_data_type_1a8921a70e560f973dbc79069b015a32b4"></span><em class="property">virtual</em> bool <code class="descname">Equals</code><span class="sig-paren">(</span><em class="property">const</em> <a class="reference internal" href="#_CPPv3N5arrow8DataTypeE" title="arrow::DataType">DataType</a> &<em>other</em><span class="sig-paren">)< [...]
+<dt id="_CPPv4NK5arrow8DataType6EqualsERK8DataTypeb">
+<span id="_CPPv3NK5arrow8DataType6EqualsERK8DataTypeb"></span><span id="_CPPv2NK5arrow8DataType6EqualsERK8DataTypeb"></span><span id="arrow::DataType::Equals__DataTypeCR.bC"></span><span class="target" id="classarrow_1_1_data_type_1aa8b49cabebeb3ed6acc7a673baa307ab"></span>bool <code class="descname">Equals</code><span class="sig-paren">(</span><em class="property">const</em> <a class="reference internal" href="#_CPPv4N5arrow8DataTypeE" title="arrow::DataType">DataType</a> &<em>other [...]
<dd><p>Return whether the types are equal. </p>
<p>Types that are logically convertible from one to another (e.g. List<UInt8> and Binary) are NOT equal. </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3NK5arrow8DataType6EqualsERKNSt10shared_ptrI8DataTypeEE">
-<span id="_CPPv2NK5arrow8DataType6EqualsERKNSt10shared_ptrI8DataTypeEE"></span><span id="arrow::DataType::Equals__std::shared_ptr:DataType:CRC"></span><span class="target" id="classarrow_1_1_data_type_1ae974f4c707ef998d25368d278818af6b"></span>bool <code class="descname">Equals</code><span class="sig-paren">(</span><em class="property">const</em> std::shared_ptr<<a class="reference internal" href="#_CPPv3N5arrow8DataTypeE" title="arrow::DataType">DataType</a>> &<em>other</em><s [...]
+<dt id="_CPPv4NK5arrow8DataType6EqualsERKNSt10shared_ptrI8DataTypeEE">
+<span id="_CPPv3NK5arrow8DataType6EqualsERKNSt10shared_ptrI8DataTypeEE"></span><span id="_CPPv2NK5arrow8DataType6EqualsERKNSt10shared_ptrI8DataTypeEE"></span><span id="arrow::DataType::Equals__std::shared_ptr:DataType:CRC"></span><span class="target" id="classarrow_1_1_data_type_1ae974f4c707ef998d25368d278818af6b"></span>bool <code class="descname">Equals</code><span class="sig-paren">(</span><em class="property">const</em> std::shared_ptr<<a class="reference internal" href="#_CPPv4N5 [...]
<dd><p>Return whether the types are equal. </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3NK5arrow8DataType8ToStringEv">
-<span id="_CPPv2NK5arrow8DataType8ToStringEv"></span><span id="arrow::DataType::ToStringC"></span><span class="target" id="classarrow_1_1_data_type_1a944727354fb11138ebd46368319598f2"></span><em class="property">virtual</em> std::string <code class="descname">ToString</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em> = 0<a class="headerlink" href="#_CPPv3NK5arrow8DataType8ToStringEv" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4NK5arrow8DataType8ToStringEv">
+<span id="_CPPv3NK5arrow8DataType8ToStringEv"></span><span id="_CPPv2NK5arrow8DataType8ToStringEv"></span><span id="arrow::DataType::ToStringC"></span><span class="target" id="classarrow_1_1_data_type_1a944727354fb11138ebd46368319598f2"></span><em class="property">virtual</em> std::string <code class="descname">ToString</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em> = 0<a class="headerlink" href="#_CPPv4NK5arrow8DataType8ToStringEv" [...]
<dd><p>A string representation of the type, including any children. </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3NK5arrow8DataType4nameEv">
-<span id="_CPPv2NK5arrow8DataType4nameEv"></span><span id="arrow::DataType::nameC"></span><span class="target" id="classarrow_1_1_data_type_1a94985d12273f5dd353d6142921299d4d"></span><em class="property">virtual</em> std::string <code class="descname">name</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em> = 0<a class="headerlink" href="#_CPPv3NK5arrow8DataType4nameEv" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4NK5arrow8DataType4nameEv">
+<span id="_CPPv3NK5arrow8DataType4nameEv"></span><span id="_CPPv2NK5arrow8DataType4nameEv"></span><span id="arrow::DataType::nameC"></span><span class="target" id="classarrow_1_1_data_type_1a94985d12273f5dd353d6142921299d4d"></span><em class="property">virtual</em> std::string <code class="descname">name</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em> = 0<a class="headerlink" href="#_CPPv4NK5arrow8DataType4nameEv" title="Permalink to [...]
<dd><p>A string name of the type, omitting any child fields. </p>
<p><dl class="docutils">
<dt><strong>Note</strong></dt>
@@ -406,8 +420,8 @@
</dd></dl>
<dl class="function">
-<dt id="_CPPv3NK5arrow8DataType2idEv">
-<span id="_CPPv2NK5arrow8DataType2idEv"></span><span id="arrow::DataType::idC"></span><span class="target" id="classarrow_1_1_data_type_1a5ec6a1c93420c68e9c8065d4a56ad645"></span>Type::<a class="reference internal" href="#_CPPv3N5arrow4Type4typeE" title="arrow::Type::type">type</a> <code class="descname">id</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv3NK5arrow8DataType2idEv" title="Permalink to th [...]
+<dt id="_CPPv4NK5arrow8DataType2idEv">
+<span id="_CPPv3NK5arrow8DataType2idEv"></span><span id="_CPPv2NK5arrow8DataType2idEv"></span><span id="arrow::DataType::idC"></span><span class="target" id="classarrow_1_1_data_type_1a5ec6a1c93420c68e9c8065d4a56ad645"></span>Type::<a class="reference internal" href="#_CPPv4N5arrow4Type4typeE" title="arrow::Type::type">type</a> <code class="descname">id</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv [...]
<dd><p>Return the type category. </p>
</dd></dl>
@@ -419,178 +433,178 @@
<p>These functions are recommended for creating data types. They may return
new objects or existing singletons, depending on the type requested.</p>
<dl class="function">
-<dt id="_CPPv3N5arrow17fixed_size_binaryE7int32_t">
-<span id="_CPPv2N5arrow17fixed_size_binaryE7int32_t"></span><span id="arrow::fixed_size_binary__int32_t"></span><span class="target" id="group__type-factories_1gacaf5c20d8caef81e01621a3cad7cc9c2"></span>std::shared_ptr<<a class="reference internal" href="#_CPPv3N5arrow8DataTypeE" title="arrow::DataType">DataType</a>> <code class="descclassname">arrow<code class="descclassname">::</code></code><code class="descname">fixed_size_binary</code><span class="sig-paren">(</span>int32_t <em [...]
+<dt id="_CPPv4N5arrow17fixed_size_binaryE7int32_t">
+<span id="_CPPv3N5arrow17fixed_size_binaryE7int32_t"></span><span id="_CPPv2N5arrow17fixed_size_binaryE7int32_t"></span><span id="arrow::fixed_size_binary__int32_t"></span><span class="target" id="group__type-factories_1gacaf5c20d8caef81e01621a3cad7cc9c2"></span>std::shared_ptr<<a class="reference internal" href="#_CPPv4N5arrow8DataTypeE" title="arrow::DataType">DataType</a>> <code class="descclassname">arrow<code class="descclassname">::</code></code><code class="descname">fixed_s [...]
<dd><p>Create a <a class="reference internal" href="#classarrow_1_1_fixed_size_binary_type"><span class="std std-ref">FixedSizeBinaryType</span></a> instance. </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3N5arrow7decimalE7int32_t7int32_t">
-<span id="_CPPv2N5arrow7decimalE7int32_t7int32_t"></span><span id="arrow::decimal__int32_t.int32_t"></span><span class="target" id="group__type-factories_1ga3390964f23814ab08c9604158f727883"></span>std::shared_ptr<<a class="reference internal" href="#_CPPv3N5arrow8DataTypeE" title="arrow::DataType">DataType</a>> <code class="descclassname">arrow<code class="descclassname">::</code></code><code class="descname">decimal</code><span class="sig-paren">(</span>int32_t <em>precision</em> [...]
+<dt id="_CPPv4N5arrow7decimalE7int32_t7int32_t">
+<span id="_CPPv3N5arrow7decimalE7int32_t7int32_t"></span><span id="_CPPv2N5arrow7decimalE7int32_t7int32_t"></span><span id="arrow::decimal__int32_t.int32_t"></span><span class="target" id="group__type-factories_1ga3390964f23814ab08c9604158f727883"></span>std::shared_ptr<<a class="reference internal" href="#_CPPv4N5arrow8DataTypeE" title="arrow::DataType">DataType</a>> <code class="descclassname">arrow<code class="descclassname">::</code></code><code class="descname">decimal</code>< [...]
<dd><p>Create a <a class="reference internal" href="#classarrow_1_1_decimal128_type"><span class="std std-ref">Decimal128Type</span></a> instance. </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3N5arrow4listERKNSt10shared_ptrI5FieldEE">
-<span id="_CPPv2N5arrow4listERKNSt10shared_ptrI5FieldEE"></span><span id="arrow::list__std::shared_ptr:Field:CR"></span><span class="target" id="group__type-factories_1ga20e7157554937088556275ed4b6485d3"></span>std::shared_ptr<<a class="reference internal" href="#_CPPv3N5arrow8DataTypeE" title="arrow::DataType">DataType</a>> <code class="descclassname">arrow<code class="descclassname">::</code></code><code class="descname">list</code><span class="sig-paren">(</span><em class="prope [...]
+<dt id="_CPPv4N5arrow4listERKNSt10shared_ptrI5FieldEE">
+<span id="_CPPv3N5arrow4listERKNSt10shared_ptrI5FieldEE"></span><span id="_CPPv2N5arrow4listERKNSt10shared_ptrI5FieldEE"></span><span id="arrow::list__std::shared_ptr:Field:CR"></span><span class="target" id="group__type-factories_1ga20e7157554937088556275ed4b6485d3"></span>std::shared_ptr<<a class="reference internal" href="#_CPPv4N5arrow8DataTypeE" title="arrow::DataType">DataType</a>> <code class="descclassname">arrow<code class="descclassname">::</code></code><code class="descn [...]
<dd><p>Create a <a class="reference internal" href="#classarrow_1_1_list_type"><span class="std std-ref">ListType</span></a> instance from its child <a class="reference internal" href="#classarrow_1_1_field"><span class="std std-ref">Field</span></a> type. </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3N5arrow4listERKNSt10shared_ptrI8DataTypeEE">
-<span id="_CPPv2N5arrow4listERKNSt10shared_ptrI8DataTypeEE"></span><span id="arrow::list__std::shared_ptr:DataType:CR"></span><span class="target" id="group__type-factories_1ga1bf7acea41aa557cf249bc91b50c8044"></span>std::shared_ptr<<a class="reference internal" href="#_CPPv3N5arrow8DataTypeE" title="arrow::DataType">DataType</a>> <code class="descclassname">arrow<code class="descclassname">::</code></code><code class="descname">list</code><span class="sig-paren">(</span><em class= [...]
+<dt id="_CPPv4N5arrow4listERKNSt10shared_ptrI8DataTypeEE">
+<span id="_CPPv3N5arrow4listERKNSt10shared_ptrI8DataTypeEE"></span><span id="_CPPv2N5arrow4listERKNSt10shared_ptrI8DataTypeEE"></span><span id="arrow::list__std::shared_ptr:DataType:CR"></span><span class="target" id="group__type-factories_1ga1bf7acea41aa557cf249bc91b50c8044"></span>std::shared_ptr<<a class="reference internal" href="#_CPPv4N5arrow8DataTypeE" title="arrow::DataType">DataType</a>> <code class="descclassname">arrow<code class="descclassname">::</code></code><code cla [...]
<dd><p>Create a <a class="reference internal" href="#classarrow_1_1_list_type"><span class="std std-ref">ListType</span></a> instance from its child <a class="reference internal" href="#classarrow_1_1_data_type"><span class="std std-ref">DataType</span></a>. </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3N5arrow9timestampEN8TimeUnit4typeE">
-<span id="_CPPv2N5arrow9timestampEN8TimeUnit4typeE"></span><span id="arrow::timestamp__TimeUnit::type"></span><span class="target" id="group__type-factories_1ga862528838ca7d12e13c09edc02bb6151"></span>std::shared_ptr<<a class="reference internal" href="#_CPPv3N5arrow8DataTypeE" title="arrow::DataType">DataType</a>> <code class="descclassname">arrow<code class="descclassname">::</code></code><code class="descname">timestamp</code><span class="sig-paren">(</span>TimeUnit::<a class="r [...]
+<dt id="_CPPv4N5arrow9timestampEN8TimeUnit4typeE">
+<span id="_CPPv3N5arrow9timestampEN8TimeUnit4typeE"></span><span id="_CPPv2N5arrow9timestampEN8TimeUnit4typeE"></span><span id="arrow::timestamp__TimeUnit::type"></span><span class="target" id="group__type-factories_1ga862528838ca7d12e13c09edc02bb6151"></span>std::shared_ptr<<a class="reference internal" href="#_CPPv4N5arrow8DataTypeE" title="arrow::DataType">DataType</a>> <code class="descclassname">arrow<code class="descclassname">::</code></code><code class="descname">timestamp< [...]
<dd><p>Create a <a class="reference internal" href="#classarrow_1_1_timestamp_type"><span class="std std-ref">TimestampType</span></a> instance from its unit. </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3N5arrow9timestampEN8TimeUnit4typeERKNSt6stringE">
-<span id="_CPPv2N5arrow9timestampEN8TimeUnit4typeERKNSt6stringE"></span><span id="arrow::timestamp__TimeUnit::type.ssCR"></span><span class="target" id="group__type-factories_1ga58fe6ad4ca179979515028f11d8abbca"></span>std::shared_ptr<<a class="reference internal" href="#_CPPv3N5arrow8DataTypeE" title="arrow::DataType">DataType</a>> <code class="descclassname">arrow<code class="descclassname">::</code></code><code class="descname">timestamp</code><span class="sig-paren">(</span>Tim [...]
+<dt id="_CPPv4N5arrow9timestampEN8TimeUnit4typeERKNSt6stringE">
+<span id="_CPPv3N5arrow9timestampEN8TimeUnit4typeERKNSt6stringE"></span><span id="_CPPv2N5arrow9timestampEN8TimeUnit4typeERKNSt6stringE"></span><span id="arrow::timestamp__TimeUnit::type.ssCR"></span><span class="target" id="group__type-factories_1ga58fe6ad4ca179979515028f11d8abbca"></span>std::shared_ptr<<a class="reference internal" href="#_CPPv4N5arrow8DataTypeE" title="arrow::DataType">DataType</a>> <code class="descclassname">arrow<code class="descclassname">::</code></code><c [...]
<dd><p>Create a <a class="reference internal" href="#classarrow_1_1_timestamp_type"><span class="std std-ref">TimestampType</span></a> instance from its unit and timezone. </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3N5arrow6time32EN8TimeUnit4typeE">
-<span id="_CPPv2N5arrow6time32EN8TimeUnit4typeE"></span><span id="arrow::time32__TimeUnit::type"></span><span class="target" id="group__type-factories_1gae2e76c6504af1c30799b5b4d7e737305"></span>std::shared_ptr<<a class="reference internal" href="#_CPPv3N5arrow8DataTypeE" title="arrow::DataType">DataType</a>> <code class="descclassname">arrow<code class="descclassname">::</code></code><code class="descname">time32</code><span class="sig-paren">(</span>TimeUnit::<a class="reference [...]
+<dt id="_CPPv4N5arrow6time32EN8TimeUnit4typeE">
+<span id="_CPPv3N5arrow6time32EN8TimeUnit4typeE"></span><span id="_CPPv2N5arrow6time32EN8TimeUnit4typeE"></span><span id="arrow::time32__TimeUnit::type"></span><span class="target" id="group__type-factories_1gae2e76c6504af1c30799b5b4d7e737305"></span>std::shared_ptr<<a class="reference internal" href="#_CPPv4N5arrow8DataTypeE" title="arrow::DataType">DataType</a>> <code class="descclassname">arrow<code class="descclassname">::</code></code><code class="descname">time32</code><span [...]
<dd><p>Create a 32-bit time type instance. </p>
<p>Unit can be either SECOND or MILLI </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3N5arrow6time64EN8TimeUnit4typeE">
-<span id="_CPPv2N5arrow6time64EN8TimeUnit4typeE"></span><span id="arrow::time64__TimeUnit::type"></span><span class="target" id="group__type-factories_1ga7f6f30b7153111da33e446965b5531e3"></span>std::shared_ptr<<a class="reference internal" href="#_CPPv3N5arrow8DataTypeE" title="arrow::DataType">DataType</a>> <code class="descclassname">arrow<code class="descclassname">::</code></code><code class="descname">time64</code><span class="sig-paren">(</span>TimeUnit::<a class="reference [...]
+<dt id="_CPPv4N5arrow6time64EN8TimeUnit4typeE">
+<span id="_CPPv3N5arrow6time64EN8TimeUnit4typeE"></span><span id="_CPPv2N5arrow6time64EN8TimeUnit4typeE"></span><span id="arrow::time64__TimeUnit::type"></span><span class="target" id="group__type-factories_1ga7f6f30b7153111da33e446965b5531e3"></span>std::shared_ptr<<a class="reference internal" href="#_CPPv4N5arrow8DataTypeE" title="arrow::DataType">DataType</a>> <code class="descclassname">arrow<code class="descclassname">::</code></code><code class="descname">time64</code><span [...]
<dd><p>Create a 64-bit time type instance. </p>
<p>Unit can be either MICRO or NANO </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3N5arrow7struct_ERKNSt6vectorINSt10shared_ptrI5FieldEEEE">
-<span id="_CPPv2N5arrow7struct_ERKNSt6vectorINSt10shared_ptrI5FieldEEEE"></span><span id="arrow::struct___std::vector:std::shared_ptr:Field::CR"></span><span class="target" id="group__type-factories_1gafa9f64b1f9435636482c7cc65ec47ecd"></span>std::shared_ptr<<a class="reference internal" href="#_CPPv3N5arrow8DataTypeE" title="arrow::DataType">DataType</a>> <code class="descclassname">arrow<code class="descclassname">::</code></code><code class="descname">struct_</code><span class=" [...]
+<dt id="_CPPv4N5arrow7struct_ERKNSt6vectorINSt10shared_ptrI5FieldEEEE">
+<span id="_CPPv3N5arrow7struct_ERKNSt6vectorINSt10shared_ptrI5FieldEEEE"></span><span id="_CPPv2N5arrow7struct_ERKNSt6vectorINSt10shared_ptrI5FieldEEEE"></span><span id="arrow::struct___std::vector:std::shared_ptr:Field::CR"></span><span class="target" id="group__type-factories_1gafa9f64b1f9435636482c7cc65ec47ecd"></span>std::shared_ptr<<a class="reference internal" href="#_CPPv4N5arrow8DataTypeE" title="arrow::DataType">DataType</a>> <code class="descclassname">arrow<code class="d [...]
<dd><p>Create a <a class="reference internal" href="#classarrow_1_1_struct_type"><span class="std std-ref">StructType</span></a> instance. </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3N5arrow6union_ERKNSt6vectorINSt10shared_ptrI5FieldEEEERKNSt6vectorI7uint8_tEEN9UnionMode4typeE">
-<span id="_CPPv2N5arrow6union_ERKNSt6vectorINSt10shared_ptrI5FieldEEEERKNSt6vectorI7uint8_tEEN9UnionMode4typeE"></span><span id="arrow::union___std::vector:std::shared_ptr:Field::CR.std::vector:uint8_t:CR.UnionMode::type"></span><span class="target" id="group__type-factories_1ga9382fd7f6d95d6ee274d344d3d26470e"></span>std::shared_ptr<<a class="reference internal" href="#_CPPv3N5arrow8DataTypeE" title="arrow::DataType">DataType</a>> <code class="descclassname">arrow<code class="desc [...]
+<dt id="_CPPv4N5arrow6union_ERKNSt6vectorINSt10shared_ptrI5FieldEEEERKNSt6vectorI7uint8_tEEN9UnionMode4typeE">
+<span id="_CPPv3N5arrow6union_ERKNSt6vectorINSt10shared_ptrI5FieldEEEERKNSt6vectorI7uint8_tEEN9UnionMode4typeE"></span><span id="_CPPv2N5arrow6union_ERKNSt6vectorINSt10shared_ptrI5FieldEEEERKNSt6vectorI7uint8_tEEN9UnionMode4typeE"></span><span id="arrow::union___std::vector:std::shared_ptr:Field::CR.std::vector:uint8_t:CR.UnionMode::type"></span><span class="target" id="group__type-factories_1ga9382fd7f6d95d6ee274d344d3d26470e"></span>std::shared_ptr<<a class="reference internal" href [...]
<dd><p>Create a <a class="reference internal" href="#classarrow_1_1_union_type"><span class="std std-ref">UnionType</span></a> instance. </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3N5arrow6union_ERKNSt6vectorINSt10shared_ptrI5ArrayEEEEN9UnionMode4typeE">
-<span id="_CPPv2N5arrow6union_ERKNSt6vectorINSt10shared_ptrI5ArrayEEEEN9UnionMode4typeE"></span><span id="arrow::union___std::vector:std::shared_ptr:Array::CR.UnionMode::type"></span><span class="target" id="group__type-factories_1gabe1ec5ec1af98b0dc19aee59fdaa442a"></span>std::shared_ptr<<a class="reference internal" href="#_CPPv3N5arrow8DataTypeE" title="arrow::DataType">DataType</a>> <code class="descclassname">arrow<code class="descclassname">::</code></code><code class="descna [...]
+<dt id="_CPPv4N5arrow6union_ERKNSt6vectorINSt10shared_ptrI5ArrayEEEEN9UnionMode4typeE">
+<span id="_CPPv3N5arrow6union_ERKNSt6vectorINSt10shared_ptrI5ArrayEEEEN9UnionMode4typeE"></span><span id="_CPPv2N5arrow6union_ERKNSt6vectorINSt10shared_ptrI5ArrayEEEEN9UnionMode4typeE"></span><span id="arrow::union___std::vector:std::shared_ptr:Array::CR.UnionMode::type"></span><span class="target" id="group__type-factories_1gabe1ec5ec1af98b0dc19aee59fdaa442a"></span>std::shared_ptr<<a class="reference internal" href="#_CPPv4N5arrow8DataTypeE" title="arrow::DataType">DataType</a>> [...]
<dd><p>Create a <a class="reference internal" href="#classarrow_1_1_union_type"><span class="std std-ref">UnionType</span></a> instance. </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3N5arrow10dictionaryERKNSt10shared_ptrI8DataTypeEERKNSt10shared_ptrI5ArrayEEb">
-<span id="_CPPv2N5arrow10dictionaryERKNSt10shared_ptrI8DataTypeEERKNSt10shared_ptrI5ArrayEEb"></span><span id="arrow::dictionary__std::shared_ptr:DataType:CR.std::shared_ptr:Array:CR.b"></span><span class="target" id="group__type-factories_1ga60af355046f03b01c4fcbc6fcaed4ea1"></span>std::shared_ptr<<a class="reference internal" href="#_CPPv3N5arrow8DataTypeE" title="arrow::DataType">DataType</a>> <code class="descclassname">arrow<code class="descclassname">::</code></code><code cla [...]
+<dt id="_CPPv4N5arrow10dictionaryERKNSt10shared_ptrI8DataTypeEERKNSt10shared_ptrI5ArrayEEb">
+<span id="_CPPv3N5arrow10dictionaryERKNSt10shared_ptrI8DataTypeEERKNSt10shared_ptrI5ArrayEEb"></span><span id="_CPPv2N5arrow10dictionaryERKNSt10shared_ptrI8DataTypeEERKNSt10shared_ptrI5ArrayEEb"></span><span id="arrow::dictionary__std::shared_ptr:DataType:CR.std::shared_ptr:Array:CR.b"></span><span class="target" id="group__type-factories_1ga60af355046f03b01c4fcbc6fcaed4ea1"></span>std::shared_ptr<<a class="reference internal" href="#_CPPv4N5arrow8DataTypeE" title="arrow::DataType">Da [...]
<dd><p>Create a <a class="reference internal" href="#classarrow_1_1_dictionary_type"><span class="std std-ref">DictionaryType</span></a> instance. </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3N5arrow4nullEv">
-<span id="_CPPv2N5arrow4nullEv"></span><span id="arrow::null"></span><span class="target" id="group__type-factories_1gaf642d53dac1a6b6b686fb5984d33bc9a"></span>std::shared_ptr<<a class="reference internal" href="#_CPPv3N5arrow8DataTypeE" title="arrow::DataType">DataType</a>> <code class="descclassname">arrow<code class="descclassname">::</code></code><code class="descname">null</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv3 [...]
+<dt id="_CPPv4N5arrow4nullEv">
+<span id="_CPPv3N5arrow4nullEv"></span><span id="_CPPv2N5arrow4nullEv"></span><span id="arrow::null"></span><span class="target" id="group__type-factories_1gaf642d53dac1a6b6b686fb5984d33bc9a"></span>std::shared_ptr<<a class="reference internal" href="#_CPPv4N5arrow8DataTypeE" title="arrow::DataType">DataType</a>> <code class="descclassname">arrow<code class="descclassname">::</code></code><code class="descname">null</code><span class="sig-paren">(</span><span class="sig-paren">)</s [...]
<dd><p>Return a <a class="reference internal" href="#classarrow_1_1_null_type"><span class="std std-ref">NullType</span></a> instance. </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3N5arrow7booleanEv">
-<span id="_CPPv2N5arrow7booleanEv"></span><span id="arrow::boolean"></span><span class="target" id="group__type-factories_1ga1e585e8f1c25a9751ac9381a274df057"></span>std::shared_ptr<<a class="reference internal" href="#_CPPv3N5arrow8DataTypeE" title="arrow::DataType">DataType</a>> <code class="descclassname">arrow<code class="descclassname">::</code></code><code class="descname">boolean</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href [...]
+<dt id="_CPPv4N5arrow7booleanEv">
+<span id="_CPPv3N5arrow7booleanEv"></span><span id="_CPPv2N5arrow7booleanEv"></span><span id="arrow::boolean"></span><span class="target" id="group__type-factories_1ga1e585e8f1c25a9751ac9381a274df057"></span>std::shared_ptr<<a class="reference internal" href="#_CPPv4N5arrow8DataTypeE" title="arrow::DataType">DataType</a>> <code class="descclassname">arrow<code class="descclassname">::</code></code><code class="descname">boolean</code><span class="sig-paren">(</span><span class="sig [...]
<dd><p>Return a <a class="reference internal" href="#classarrow_1_1_boolean_type"><span class="std std-ref">BooleanType</span></a> instance. </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3N5arrow4int8Ev">
-<span id="_CPPv2N5arrow4int8Ev"></span><span id="arrow::int8"></span><span class="target" id="group__type-factories_1ga9c09bf26bc03f0fb0c84a0277215dd67"></span>std::shared_ptr<<a class="reference internal" href="#_CPPv3N5arrow8DataTypeE" title="arrow::DataType">DataType</a>> <code class="descclassname">arrow<code class="descclassname">::</code></code><code class="descname">int8</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv3 [...]
+<dt id="_CPPv4N5arrow4int8Ev">
+<span id="_CPPv3N5arrow4int8Ev"></span><span id="_CPPv2N5arrow4int8Ev"></span><span id="arrow::int8"></span><span class="target" id="group__type-factories_1ga9c09bf26bc03f0fb0c84a0277215dd67"></span>std::shared_ptr<<a class="reference internal" href="#_CPPv4N5arrow8DataTypeE" title="arrow::DataType">DataType</a>> <code class="descclassname">arrow<code class="descclassname">::</code></code><code class="descname">int8</code><span class="sig-paren">(</span><span class="sig-paren">)</s [...]
<dd><p>Return a <a class="reference internal" href="#classarrow_1_1_int8_type"><span class="std std-ref">Int8Type</span></a> instance. </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3N5arrow5int16Ev">
-<span id="_CPPv2N5arrow5int16Ev"></span><span id="arrow::int16"></span><span class="target" id="group__type-factories_1ga034c5c703e15039fe76af412d349734d"></span>std::shared_ptr<<a class="reference internal" href="#_CPPv3N5arrow8DataTypeE" title="arrow::DataType">DataType</a>> <code class="descclassname">arrow<code class="descclassname">::</code></code><code class="descname">int16</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CP [...]
+<dt id="_CPPv4N5arrow5int16Ev">
+<span id="_CPPv3N5arrow5int16Ev"></span><span id="_CPPv2N5arrow5int16Ev"></span><span id="arrow::int16"></span><span class="target" id="group__type-factories_1ga034c5c703e15039fe76af412d349734d"></span>std::shared_ptr<<a class="reference internal" href="#_CPPv4N5arrow8DataTypeE" title="arrow::DataType">DataType</a>> <code class="descclassname">arrow<code class="descclassname">::</code></code><code class="descname">int16</code><span class="sig-paren">(</span><span class="sig-paren"> [...]
<dd><p>Return a <a class="reference internal" href="#classarrow_1_1_int16_type"><span class="std std-ref">Int16Type</span></a> instance. </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3N5arrow5int32Ev">
-<span id="_CPPv2N5arrow5int32Ev"></span><span id="arrow::int32"></span><span class="target" id="group__type-factories_1ga86f6bfe394347f77befa2143297ad541"></span>std::shared_ptr<<a class="reference internal" href="#_CPPv3N5arrow8DataTypeE" title="arrow::DataType">DataType</a>> <code class="descclassname">arrow<code class="descclassname">::</code></code><code class="descname">int32</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CP [...]
+<dt id="_CPPv4N5arrow5int32Ev">
+<span id="_CPPv3N5arrow5int32Ev"></span><span id="_CPPv2N5arrow5int32Ev"></span><span id="arrow::int32"></span><span class="target" id="group__type-factories_1ga86f6bfe394347f77befa2143297ad541"></span>std::shared_ptr<<a class="reference internal" href="#_CPPv4N5arrow8DataTypeE" title="arrow::DataType">DataType</a>> <code class="descclassname">arrow<code class="descclassname">::</code></code><code class="descname">int32</code><span class="sig-paren">(</span><span class="sig-paren"> [...]
<dd><p>Return a <a class="reference internal" href="#classarrow_1_1_int32_type"><span class="std std-ref">Int32Type</span></a> instance. </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3N5arrow5int64Ev">
-<span id="_CPPv2N5arrow5int64Ev"></span><span id="arrow::int64"></span><span class="target" id="group__type-factories_1ga733b16be653069b8d926529662e34e79"></span>std::shared_ptr<<a class="reference internal" href="#_CPPv3N5arrow8DataTypeE" title="arrow::DataType">DataType</a>> <code class="descclassname">arrow<code class="descclassname">::</code></code><code class="descname">int64</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CP [...]
+<dt id="_CPPv4N5arrow5int64Ev">
+<span id="_CPPv3N5arrow5int64Ev"></span><span id="_CPPv2N5arrow5int64Ev"></span><span id="arrow::int64"></span><span class="target" id="group__type-factories_1ga733b16be653069b8d926529662e34e79"></span>std::shared_ptr<<a class="reference internal" href="#_CPPv4N5arrow8DataTypeE" title="arrow::DataType">DataType</a>> <code class="descclassname">arrow<code class="descclassname">::</code></code><code class="descname">int64</code><span class="sig-paren">(</span><span class="sig-paren"> [...]
<dd><p>Return a <a class="reference internal" href="#classarrow_1_1_int64_type"><span class="std std-ref">Int64Type</span></a> instance. </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3N5arrow5uint8Ev">
-<span id="_CPPv2N5arrow5uint8Ev"></span><span id="arrow::uint8"></span><span class="target" id="group__type-factories_1ga4891a423be213550cc24e8ebe830673f"></span>std::shared_ptr<<a class="reference internal" href="#_CPPv3N5arrow8DataTypeE" title="arrow::DataType">DataType</a>> <code class="descclassname">arrow<code class="descclassname">::</code></code><code class="descname">uint8</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CP [...]
+<dt id="_CPPv4N5arrow5uint8Ev">
+<span id="_CPPv3N5arrow5uint8Ev"></span><span id="_CPPv2N5arrow5uint8Ev"></span><span id="arrow::uint8"></span><span class="target" id="group__type-factories_1ga4891a423be213550cc24e8ebe830673f"></span>std::shared_ptr<<a class="reference internal" href="#_CPPv4N5arrow8DataTypeE" title="arrow::DataType">DataType</a>> <code class="descclassname">arrow<code class="descclassname">::</code></code><code class="descname">uint8</code><span class="sig-paren">(</span><span class="sig-paren"> [...]
<dd><p>Return a <a class="reference internal" href="#classarrow_1_1_u_int8_type"><span class="std std-ref">UInt8Type</span></a> instance. </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3N5arrow6uint16Ev">
-<span id="_CPPv2N5arrow6uint16Ev"></span><span id="arrow::uint16"></span><span class="target" id="group__type-factories_1ga9f1e44bc2ab9b465b6e7b601eb48f0a0"></span>std::shared_ptr<<a class="reference internal" href="#_CPPv3N5arrow8DataTypeE" title="arrow::DataType">DataType</a>> <code class="descclassname">arrow<code class="descclassname">::</code></code><code class="descname">uint16</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="# [...]
+<dt id="_CPPv4N5arrow6uint16Ev">
+<span id="_CPPv3N5arrow6uint16Ev"></span><span id="_CPPv2N5arrow6uint16Ev"></span><span id="arrow::uint16"></span><span class="target" id="group__type-factories_1ga9f1e44bc2ab9b465b6e7b601eb48f0a0"></span>std::shared_ptr<<a class="reference internal" href="#_CPPv4N5arrow8DataTypeE" title="arrow::DataType">DataType</a>> <code class="descclassname">arrow<code class="descclassname">::</code></code><code class="descname">uint16</code><span class="sig-paren">(</span><span class="sig-par [...]
<dd><p>Return a <a class="reference internal" href="#classarrow_1_1_u_int16_type"><span class="std std-ref">UInt16Type</span></a> instance. </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3N5arrow6uint32Ev">
-<span id="_CPPv2N5arrow6uint32Ev"></span><span id="arrow::uint32"></span><span class="target" id="group__type-factories_1gae80e510cfb2931ac18c73cba0be6d894"></span>std::shared_ptr<<a class="reference internal" href="#_CPPv3N5arrow8DataTypeE" title="arrow::DataType">DataType</a>> <code class="descclassname">arrow<code class="descclassname">::</code></code><code class="descname">uint32</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="# [...]
+<dt id="_CPPv4N5arrow6uint32Ev">
+<span id="_CPPv3N5arrow6uint32Ev"></span><span id="_CPPv2N5arrow6uint32Ev"></span><span id="arrow::uint32"></span><span class="target" id="group__type-factories_1gae80e510cfb2931ac18c73cba0be6d894"></span>std::shared_ptr<<a class="reference internal" href="#_CPPv4N5arrow8DataTypeE" title="arrow::DataType">DataType</a>> <code class="descclassname">arrow<code class="descclassname">::</code></code><code class="descname">uint32</code><span class="sig-paren">(</span><span class="sig-par [...]
<dd><p>Return a <a class="reference internal" href="#classarrow_1_1_u_int32_type"><span class="std std-ref">UInt32Type</span></a> instance. </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3N5arrow6uint64Ev">
-<span id="_CPPv2N5arrow6uint64Ev"></span><span id="arrow::uint64"></span><span class="target" id="group__type-factories_1gae548d03275f4afaa97a269774ce6930c"></span>std::shared_ptr<<a class="reference internal" href="#_CPPv3N5arrow8DataTypeE" title="arrow::DataType">DataType</a>> <code class="descclassname">arrow<code class="descclassname">::</code></code><code class="descname">uint64</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="# [...]
+<dt id="_CPPv4N5arrow6uint64Ev">
+<span id="_CPPv3N5arrow6uint64Ev"></span><span id="_CPPv2N5arrow6uint64Ev"></span><span id="arrow::uint64"></span><span class="target" id="group__type-factories_1gae548d03275f4afaa97a269774ce6930c"></span>std::shared_ptr<<a class="reference internal" href="#_CPPv4N5arrow8DataTypeE" title="arrow::DataType">DataType</a>> <code class="descclassname">arrow<code class="descclassname">::</code></code><code class="descname">uint64</code><span class="sig-paren">(</span><span class="sig-par [...]
<dd><p>Return a <a class="reference internal" href="#classarrow_1_1_u_int64_type"><span class="std std-ref">UInt64Type</span></a> instance. </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3N5arrow7float16Ev">
-<span id="_CPPv2N5arrow7float16Ev"></span><span id="arrow::float16"></span><span class="target" id="group__type-factories_1ga4fac9b6739876df09be8b82d70b26734"></span>std::shared_ptr<<a class="reference internal" href="#_CPPv3N5arrow8DataTypeE" title="arrow::DataType">DataType</a>> <code class="descclassname">arrow<code class="descclassname">::</code></code><code class="descname">float16</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href [...]
+<dt id="_CPPv4N5arrow7float16Ev">
+<span id="_CPPv3N5arrow7float16Ev"></span><span id="_CPPv2N5arrow7float16Ev"></span><span id="arrow::float16"></span><span class="target" id="group__type-factories_1ga4fac9b6739876df09be8b82d70b26734"></span>std::shared_ptr<<a class="reference internal" href="#_CPPv4N5arrow8DataTypeE" title="arrow::DataType">DataType</a>> <code class="descclassname">arrow<code class="descclassname">::</code></code><code class="descname">float16</code><span class="sig-paren">(</span><span class="sig [...]
<dd><p>Return a <a class="reference internal" href="#classarrow_1_1_half_float_type"><span class="std std-ref">HalfFloatType</span></a> instance. </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3N5arrow7float32Ev">
-<span id="_CPPv2N5arrow7float32Ev"></span><span id="arrow::float32"></span><span class="target" id="group__type-factories_1ga48fca9d26feda61c8255ec3c44a2078c"></span>std::shared_ptr<<a class="reference internal" href="#_CPPv3N5arrow8DataTypeE" title="arrow::DataType">DataType</a>> <code class="descclassname">arrow<code class="descclassname">::</code></code><code class="descname">float32</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href [...]
+<dt id="_CPPv4N5arrow7float32Ev">
+<span id="_CPPv3N5arrow7float32Ev"></span><span id="_CPPv2N5arrow7float32Ev"></span><span id="arrow::float32"></span><span class="target" id="group__type-factories_1ga48fca9d26feda61c8255ec3c44a2078c"></span>std::shared_ptr<<a class="reference internal" href="#_CPPv4N5arrow8DataTypeE" title="arrow::DataType">DataType</a>> <code class="descclassname">arrow<code class="descclassname">::</code></code><code class="descname">float32</code><span class="sig-paren">(</span><span class="sig [...]
<dd><p>Return a <a class="reference internal" href="#classarrow_1_1_float_type"><span class="std std-ref">FloatType</span></a> instance. </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3N5arrow7float64Ev">
-<span id="_CPPv2N5arrow7float64Ev"></span><span id="arrow::float64"></span><span class="target" id="group__type-factories_1gab6f514320a9b037ab161fa97db73b970"></span>std::shared_ptr<<a class="reference internal" href="#_CPPv3N5arrow8DataTypeE" title="arrow::DataType">DataType</a>> <code class="descclassname">arrow<code class="descclassname">::</code></code><code class="descname">float64</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href [...]
+<dt id="_CPPv4N5arrow7float64Ev">
+<span id="_CPPv3N5arrow7float64Ev"></span><span id="_CPPv2N5arrow7float64Ev"></span><span id="arrow::float64"></span><span class="target" id="group__type-factories_1gab6f514320a9b037ab161fa97db73b970"></span>std::shared_ptr<<a class="reference internal" href="#_CPPv4N5arrow8DataTypeE" title="arrow::DataType">DataType</a>> <code class="descclassname">arrow<code class="descclassname">::</code></code><code class="descname">float64</code><span class="sig-paren">(</span><span class="sig [...]
<dd><p>Return a <a class="reference internal" href="#classarrow_1_1_double_type"><span class="std std-ref">DoubleType</span></a> instance. </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3N5arrow4utf8Ev">
-<span id="_CPPv2N5arrow4utf8Ev"></span><span id="arrow::utf8"></span><span class="target" id="group__type-factories_1ga63178820a26f6ecb894ad35963ca981a"></span>std::shared_ptr<<a class="reference internal" href="#_CPPv3N5arrow8DataTypeE" title="arrow::DataType">DataType</a>> <code class="descclassname">arrow<code class="descclassname">::</code></code><code class="descname">utf8</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv3 [...]
+<dt id="_CPPv4N5arrow4utf8Ev">
+<span id="_CPPv3N5arrow4utf8Ev"></span><span id="_CPPv2N5arrow4utf8Ev"></span><span id="arrow::utf8"></span><span class="target" id="group__type-factories_1ga63178820a26f6ecb894ad35963ca981a"></span>std::shared_ptr<<a class="reference internal" href="#_CPPv4N5arrow8DataTypeE" title="arrow::DataType">DataType</a>> <code class="descclassname">arrow<code class="descclassname">::</code></code><code class="descname">utf8</code><span class="sig-paren">(</span><span class="sig-paren">)</s [...]
<dd><p>Return a <a class="reference internal" href="#classarrow_1_1_string_type"><span class="std std-ref">StringType</span></a> instance. </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3N5arrow6binaryEv">
-<span id="_CPPv2N5arrow6binaryEv"></span><span id="arrow::binary"></span><span class="target" id="group__type-factories_1ga66c3979f26a439e78d048bbac84a9232"></span>std::shared_ptr<<a class="reference internal" href="#_CPPv3N5arrow8DataTypeE" title="arrow::DataType">DataType</a>> <code class="descclassname">arrow<code class="descclassname">::</code></code><code class="descname">binary</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="# [...]
+<dt id="_CPPv4N5arrow6binaryEv">
+<span id="_CPPv3N5arrow6binaryEv"></span><span id="_CPPv2N5arrow6binaryEv"></span><span id="arrow::binary"></span><span class="target" id="group__type-factories_1ga66c3979f26a439e78d048bbac84a9232"></span>std::shared_ptr<<a class="reference internal" href="#_CPPv4N5arrow8DataTypeE" title="arrow::DataType">DataType</a>> <code class="descclassname">arrow<code class="descclassname">::</code></code><code class="descname">binary</code><span class="sig-paren">(</span><span class="sig-par [...]
<dd><p>Return a <a class="reference internal" href="#classarrow_1_1_binary_type"><span class="std std-ref">BinaryType</span></a> instance. </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3N5arrow6date32Ev">
-<span id="_CPPv2N5arrow6date32Ev"></span><span id="arrow::date32"></span><span class="target" id="group__type-factories_1gac15fddc26c629cd5a2cb67f432739e8e"></span>std::shared_ptr<<a class="reference internal" href="#_CPPv3N5arrow8DataTypeE" title="arrow::DataType">DataType</a>> <code class="descclassname">arrow<code class="descclassname">::</code></code><code class="descname">date32</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="# [...]
+<dt id="_CPPv4N5arrow6date32Ev">
+<span id="_CPPv3N5arrow6date32Ev"></span><span id="_CPPv2N5arrow6date32Ev"></span><span id="arrow::date32"></span><span class="target" id="group__type-factories_1gac15fddc26c629cd5a2cb67f432739e8e"></span>std::shared_ptr<<a class="reference internal" href="#_CPPv4N5arrow8DataTypeE" title="arrow::DataType">DataType</a>> <code class="descclassname">arrow<code class="descclassname">::</code></code><code class="descname">date32</code><span class="sig-paren">(</span><span class="sig-par [...]
<dd><p>Return a <a class="reference internal" href="#classarrow_1_1_date32_type"><span class="std std-ref">Date32Type</span></a> instance. </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3N5arrow6date64Ev">
-<span id="_CPPv2N5arrow6date64Ev"></span><span id="arrow::date64"></span><span class="target" id="group__type-factories_1ga540dd093466c265aa411a65f29e950b2"></span>std::shared_ptr<<a class="reference internal" href="#_CPPv3N5arrow8DataTypeE" title="arrow::DataType">DataType</a>> <code class="descclassname">arrow<code class="descclassname">::</code></code><code class="descname">date64</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="# [...]
+<dt id="_CPPv4N5arrow6date64Ev">
+<span id="_CPPv3N5arrow6date64Ev"></span><span id="_CPPv2N5arrow6date64Ev"></span><span id="arrow::date64"></span><span class="target" id="group__type-factories_1ga540dd093466c265aa411a65f29e950b2"></span>std::shared_ptr<<a class="reference internal" href="#_CPPv4N5arrow8DataTypeE" title="arrow::DataType">DataType</a>> <code class="descclassname">arrow<code class="descclassname">::</code></code><code class="descname">date64</code><span class="sig-paren">(</span><span class="sig-par [...]
<dd><p>Return a <a class="reference internal" href="#classarrow_1_1_date64_type"><span class="std std-ref">Date64Type</span></a> instance. </p>
</dd></dl>
@@ -600,20 +614,20 @@ new objects or existing singletons, depending on the type requested.</p>
<div class="section" id="primitive">
<h3>Primitive<a class="headerlink" href="#primitive" title="Permalink to this headline">¶</a></h3>
<dl class="class">
-<dt id="_CPPv3N5arrow8NullTypeE">
-<span id="_CPPv2N5arrow8NullTypeE"></span><span id="arrow::NullType"></span><span class="target" id="classarrow_1_1_null_type"></span><em class="property">class </em><code class="descname">NullType</code> : <em class="property">public</em> arrow::<a class="reference internal" href="#_CPPv3N5arrow8DataTypeE" title="arrow::DataType">DataType</a>, <em class="property">public</em> arrow::NoExtraMeta<a class="headerlink" href="#_CPPv3N5arrow8NullTypeE" title="Permalink to this definition">¶</ [...]
+<dt id="_CPPv4N5arrow8NullTypeE">
+<span id="_CPPv3N5arrow8NullTypeE"></span><span id="_CPPv2N5arrow8NullTypeE"></span><span id="arrow::NullType"></span><span class="target" id="classarrow_1_1_null_type"></span><em class="property">class </em><code class="descname">NullType</code> : <em class="property">public</em> arrow::<a class="reference internal" href="#_CPPv4N5arrow8DataTypeE" title="arrow::DataType">DataType</a>, <em class="property">public</em> arrow::NoExtraMeta<a class="headerlink" href="#_CPPv4N5arrow8NullTypeE [...]
<dd><p>Concrete type class for always-null data. </p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric">Public Functions</p>
<dl class="function">
-<dt id="_CPPv3NK5arrow8NullType8ToStringEv">
-<span id="_CPPv2NK5arrow8NullType8ToStringEv"></span><span id="arrow::NullType::ToStringC"></span><span class="target" id="classarrow_1_1_null_type_1a0e3d2d63dfe4ab9a2edca2bf35250b29"></span>std::string <code class="descname">ToString</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv3NK5arrow8NullType8ToStringEv" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4NK5arrow8NullType8ToStringEv">
+<span id="_CPPv3NK5arrow8NullType8ToStringEv"></span><span id="_CPPv2NK5arrow8NullType8ToStringEv"></span><span id="arrow::NullType::ToStringC"></span><span class="target" id="classarrow_1_1_null_type_1a0e3d2d63dfe4ab9a2edca2bf35250b29"></span>std::string <code class="descname">ToString</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv4NK5arrow8NullType8ToStringEv" title="Permalink to this definition"> [...]
<dd><p>A string representation of the type, including any children. </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3NK5arrow8NullType4nameEv">
-<span id="_CPPv2NK5arrow8NullType4nameEv"></span><span id="arrow::NullType::nameC"></span><span class="target" id="classarrow_1_1_null_type_1a656232cfad677aebb79f3147b0acdfb2"></span>std::string <code class="descname">name</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv3NK5arrow8NullType4nameEv" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4NK5arrow8NullType4nameEv">
+<span id="_CPPv3NK5arrow8NullType4nameEv"></span><span id="_CPPv2NK5arrow8NullType4nameEv"></span><span id="arrow::NullType::nameC"></span><span class="target" id="classarrow_1_1_null_type_1a656232cfad677aebb79f3147b0acdfb2"></span>std::string <code class="descname">name</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv4NK5arrow8NullType4nameEv" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>A string name of the type, omitting any child fields. </p>
<p><dl class="docutils">
<dt><strong>Note</strong></dt>
@@ -628,20 +642,20 @@ new objects or existing singletons, depending on the type requested.</p>
</dd></dl>
<dl class="class">
-<dt id="_CPPv3N5arrow11BooleanTypeE">
-<span id="_CPPv2N5arrow11BooleanTypeE"></span><span id="arrow::BooleanType"></span><span class="target" id="classarrow_1_1_boolean_type"></span><em class="property">class </em><code class="descname">BooleanType</code> : <em class="property">public</em> arrow::FixedWidthType, <em class="property">public</em> arrow::NoExtraMeta<a class="headerlink" href="#_CPPv3N5arrow11BooleanTypeE" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4N5arrow11BooleanTypeE">
+<span id="_CPPv3N5arrow11BooleanTypeE"></span><span id="_CPPv2N5arrow11BooleanTypeE"></span><span id="arrow::BooleanType"></span><span class="target" id="classarrow_1_1_boolean_type"></span><em class="property">class </em><code class="descname">BooleanType</code> : <em class="property">public</em> arrow::FixedWidthType, <em class="property">public</em> arrow::NoExtraMeta<a class="headerlink" href="#_CPPv4N5arrow11BooleanTypeE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Concrete type class for boolean data. </p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric">Public Functions</p>
<dl class="function">
-<dt id="_CPPv3NK5arrow11BooleanType8ToStringEv">
-<span id="_CPPv2NK5arrow11BooleanType8ToStringEv"></span><span id="arrow::BooleanType::ToStringC"></span><span class="target" id="classarrow_1_1_boolean_type_1a333759730914e53c6b201303e7560d67"></span>std::string <code class="descname">ToString</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv3NK5arrow11BooleanType8ToStringEv" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4NK5arrow11BooleanType8ToStringEv">
+<span id="_CPPv3NK5arrow11BooleanType8ToStringEv"></span><span id="_CPPv2NK5arrow11BooleanType8ToStringEv"></span><span id="arrow::BooleanType::ToStringC"></span><span class="target" id="classarrow_1_1_boolean_type_1a333759730914e53c6b201303e7560d67"></span>std::string <code class="descname">ToString</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv4NK5arrow11BooleanType8ToStringEv" title="Permalink to [...]
<dd><p>A string representation of the type, including any children. </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3NK5arrow11BooleanType4nameEv">
-<span id="_CPPv2NK5arrow11BooleanType4nameEv"></span><span id="arrow::BooleanType::nameC"></span><span class="target" id="classarrow_1_1_boolean_type_1acedbda0c2af8b37046cc475a44b8fe3b"></span>std::string <code class="descname">name</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv3NK5arrow11BooleanType4nameEv" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4NK5arrow11BooleanType4nameEv">
+<span id="_CPPv3NK5arrow11BooleanType4nameEv"></span><span id="_CPPv2NK5arrow11BooleanType4nameEv"></span><span id="arrow::BooleanType::nameC"></span><span class="target" id="classarrow_1_1_boolean_type_1acedbda0c2af8b37046cc475a44b8fe3b"></span>std::string <code class="descname">name</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv4NK5arrow11BooleanType4nameEv" title="Permalink to this definition">¶< [...]
<dd><p>A string name of the type, omitting any child fields. </p>
<p><dl class="docutils">
<dt><strong>Note</strong></dt>
@@ -656,14 +670,14 @@ new objects or existing singletons, depending on the type requested.</p>
</dd></dl>
<dl class="class">
-<dt id="_CPPv3N5arrow8Int8TypeE">
-<span id="_CPPv2N5arrow8Int8TypeE"></span><span id="arrow::Int8Type"></span><span class="target" id="classarrow_1_1_int8_type"></span><em class="property">class </em><code class="descname">Int8Type</code> : <em class="property">public</em> arrow::detail::IntegerTypeImpl<<a class="reference internal" href="#_CPPv3N5arrow8Int8TypeE" title="arrow::Int8Type">Int8Type</a>, Type::<a class="reference internal" href="#_CPPv3N5arrow4Type4INT8E" title="arrow::Type::INT8">INT8</a>, int8_t><a [...]
+<dt id="_CPPv4N5arrow8Int8TypeE">
+<span id="_CPPv3N5arrow8Int8TypeE"></span><span id="_CPPv2N5arrow8Int8TypeE"></span><span id="arrow::Int8Type"></span><span class="target" id="classarrow_1_1_int8_type"></span><em class="property">class </em><code class="descname">Int8Type</code> : <em class="property">public</em> arrow::detail::IntegerTypeImpl<<a class="reference internal" href="#_CPPv4N5arrow8Int8TypeE" title="arrow::Int8Type">Int8Type</a>, Type::<a class="reference internal" href="#_CPPv4N5arrow4Type4INT8E" title=" [...]
<dd><p>Concrete type class for signed 8-bit integer data. </p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric">Public Functions</p>
<dl class="function">
-<dt id="_CPPv3NK5arrow8Int8Type4nameEv">
-<span id="_CPPv2NK5arrow8Int8Type4nameEv"></span><span id="arrow::Int8Type::nameC"></span><span class="target" id="classarrow_1_1_int8_type_1a64523102f018c4e33dd855e00951f14f"></span>std::string <code class="descname">name</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv3NK5arrow8Int8Type4nameEv" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4NK5arrow8Int8Type4nameEv">
+<span id="_CPPv3NK5arrow8Int8Type4nameEv"></span><span id="_CPPv2NK5arrow8Int8Type4nameEv"></span><span id="arrow::Int8Type::nameC"></span><span class="target" id="classarrow_1_1_int8_type_1a64523102f018c4e33dd855e00951f14f"></span>std::string <code class="descname">name</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv4NK5arrow8Int8Type4nameEv" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>A string name of the type, omitting any child fields. </p>
<p><dl class="docutils">
<dt><strong>Note</strong></dt>
@@ -678,14 +692,14 @@ new objects or existing singletons, depending on the type requested.</p>
</dd></dl>
<dl class="class">
-<dt id="_CPPv3N5arrow9Int16TypeE">
-<span id="_CPPv2N5arrow9Int16TypeE"></span><span id="arrow::Int16Type"></span><span class="target" id="classarrow_1_1_int16_type"></span><em class="property">class </em><code class="descname">Int16Type</code> : <em class="property">public</em> arrow::detail::IntegerTypeImpl<<a class="reference internal" href="#_CPPv3N5arrow9Int16TypeE" title="arrow::Int16Type">Int16Type</a>, Type::<a class="reference internal" href="#_CPPv3N5arrow4Type5INT16E" title="arrow::Type::INT16">INT16</a>, int [...]
+<dt id="_CPPv4N5arrow9Int16TypeE">
+<span id="_CPPv3N5arrow9Int16TypeE"></span><span id="_CPPv2N5arrow9Int16TypeE"></span><span id="arrow::Int16Type"></span><span class="target" id="classarrow_1_1_int16_type"></span><em class="property">class </em><code class="descname">Int16Type</code> : <em class="property">public</em> arrow::detail::IntegerTypeImpl<<a class="reference internal" href="#_CPPv4N5arrow9Int16TypeE" title="arrow::Int16Type">Int16Type</a>, Type::<a class="reference internal" href="#_CPPv4N5arrow4Type5INT16E [...]
<dd><p>Concrete type class for signed 16-bit integer data. </p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric">Public Functions</p>
<dl class="function">
-<dt id="_CPPv3NK5arrow9Int16Type4nameEv">
-<span id="_CPPv2NK5arrow9Int16Type4nameEv"></span><span id="arrow::Int16Type::nameC"></span><span class="target" id="classarrow_1_1_int16_type_1a4fa0ae88c35e20ee007c1eac2b42bd52"></span>std::string <code class="descname">name</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv3NK5arrow9Int16Type4nameEv" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4NK5arrow9Int16Type4nameEv">
+<span id="_CPPv3NK5arrow9Int16Type4nameEv"></span><span id="_CPPv2NK5arrow9Int16Type4nameEv"></span><span id="arrow::Int16Type::nameC"></span><span class="target" id="classarrow_1_1_int16_type_1a4fa0ae88c35e20ee007c1eac2b42bd52"></span>std::string <code class="descname">name</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv4NK5arrow9Int16Type4nameEv" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>A string name of the type, omitting any child fields. </p>
<p><dl class="docutils">
<dt><strong>Note</strong></dt>
@@ -700,14 +714,14 @@ new objects or existing singletons, depending on the type requested.</p>
</dd></dl>
<dl class="class">
-<dt id="_CPPv3N5arrow9Int32TypeE">
-<span id="_CPPv2N5arrow9Int32TypeE"></span><span id="arrow::Int32Type"></span><span class="target" id="classarrow_1_1_int32_type"></span><em class="property">class </em><code class="descname">Int32Type</code> : <em class="property">public</em> arrow::detail::IntegerTypeImpl<<a class="reference internal" href="#_CPPv3N5arrow9Int32TypeE" title="arrow::Int32Type">Int32Type</a>, Type::<a class="reference internal" href="#_CPPv3N5arrow4Type5INT32E" title="arrow::Type::INT32">INT32</a>, int [...]
+<dt id="_CPPv4N5arrow9Int32TypeE">
+<span id="_CPPv3N5arrow9Int32TypeE"></span><span id="_CPPv2N5arrow9Int32TypeE"></span><span id="arrow::Int32Type"></span><span class="target" id="classarrow_1_1_int32_type"></span><em class="property">class </em><code class="descname">Int32Type</code> : <em class="property">public</em> arrow::detail::IntegerTypeImpl<<a class="reference internal" href="#_CPPv4N5arrow9Int32TypeE" title="arrow::Int32Type">Int32Type</a>, Type::<a class="reference internal" href="#_CPPv4N5arrow4Type5INT32E [...]
<dd><p>Concrete type class for signed 32-bit integer data. </p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric">Public Functions</p>
<dl class="function">
-<dt id="_CPPv3NK5arrow9Int32Type4nameEv">
-<span id="_CPPv2NK5arrow9Int32Type4nameEv"></span><span id="arrow::Int32Type::nameC"></span><span class="target" id="classarrow_1_1_int32_type_1a3e81d450a3667605e9ac2e375fe27256"></span>std::string <code class="descname">name</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv3NK5arrow9Int32Type4nameEv" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4NK5arrow9Int32Type4nameEv">
+<span id="_CPPv3NK5arrow9Int32Type4nameEv"></span><span id="_CPPv2NK5arrow9Int32Type4nameEv"></span><span id="arrow::Int32Type::nameC"></span><span class="target" id="classarrow_1_1_int32_type_1a3e81d450a3667605e9ac2e375fe27256"></span>std::string <code class="descname">name</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv4NK5arrow9Int32Type4nameEv" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>A string name of the type, omitting any child fields. </p>
<p><dl class="docutils">
<dt><strong>Note</strong></dt>
@@ -722,14 +736,14 @@ new objects or existing singletons, depending on the type requested.</p>
</dd></dl>
<dl class="class">
-<dt id="_CPPv3N5arrow9Int64TypeE">
-<span id="_CPPv2N5arrow9Int64TypeE"></span><span id="arrow::Int64Type"></span><span class="target" id="classarrow_1_1_int64_type"></span><em class="property">class </em><code class="descname">Int64Type</code> : <em class="property">public</em> arrow::detail::IntegerTypeImpl<<a class="reference internal" href="#_CPPv3N5arrow9Int64TypeE" title="arrow::Int64Type">Int64Type</a>, Type::<a class="reference internal" href="#_CPPv3N5arrow4Type5INT64E" title="arrow::Type::INT64">INT64</a>, int [...]
+<dt id="_CPPv4N5arrow9Int64TypeE">
+<span id="_CPPv3N5arrow9Int64TypeE"></span><span id="_CPPv2N5arrow9Int64TypeE"></span><span id="arrow::Int64Type"></span><span class="target" id="classarrow_1_1_int64_type"></span><em class="property">class </em><code class="descname">Int64Type</code> : <em class="property">public</em> arrow::detail::IntegerTypeImpl<<a class="reference internal" href="#_CPPv4N5arrow9Int64TypeE" title="arrow::Int64Type">Int64Type</a>, Type::<a class="reference internal" href="#_CPPv4N5arrow4Type5INT64E [...]
<dd><p>Concrete type class for signed 64-bit integer data. </p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric">Public Functions</p>
<dl class="function">
-<dt id="_CPPv3NK5arrow9Int64Type4nameEv">
-<span id="_CPPv2NK5arrow9Int64Type4nameEv"></span><span id="arrow::Int64Type::nameC"></span><span class="target" id="classarrow_1_1_int64_type_1a3feadbb1be919553e5dc3c4d042eb66b"></span>std::string <code class="descname">name</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv3NK5arrow9Int64Type4nameEv" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4NK5arrow9Int64Type4nameEv">
+<span id="_CPPv3NK5arrow9Int64Type4nameEv"></span><span id="_CPPv2NK5arrow9Int64Type4nameEv"></span><span id="arrow::Int64Type::nameC"></span><span class="target" id="classarrow_1_1_int64_type_1a3feadbb1be919553e5dc3c4d042eb66b"></span>std::string <code class="descname">name</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv4NK5arrow9Int64Type4nameEv" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>A string name of the type, omitting any child fields. </p>
<p><dl class="docutils">
<dt><strong>Note</strong></dt>
@@ -744,14 +758,14 @@ new objects or existing singletons, depending on the type requested.</p>
</dd></dl>
<dl class="class">
-<dt id="_CPPv3N5arrow9UInt8TypeE">
-<span id="_CPPv2N5arrow9UInt8TypeE"></span><span id="arrow::UInt8Type"></span><span class="target" id="classarrow_1_1_u_int8_type"></span><em class="property">class </em><code class="descname">UInt8Type</code> : <em class="property">public</em> arrow::detail::IntegerTypeImpl<<a class="reference internal" href="#_CPPv3N5arrow9UInt8TypeE" title="arrow::UInt8Type">UInt8Type</a>, Type::<a class="reference internal" href="#_CPPv3N5arrow4Type5UINT8E" title="arrow::Type::UINT8">UINT8</a>, ui [...]
+<dt id="_CPPv4N5arrow9UInt8TypeE">
+<span id="_CPPv3N5arrow9UInt8TypeE"></span><span id="_CPPv2N5arrow9UInt8TypeE"></span><span id="arrow::UInt8Type"></span><span class="target" id="classarrow_1_1_u_int8_type"></span><em class="property">class </em><code class="descname">UInt8Type</code> : <em class="property">public</em> arrow::detail::IntegerTypeImpl<<a class="reference internal" href="#_CPPv4N5arrow9UInt8TypeE" title="arrow::UInt8Type">UInt8Type</a>, Type::<a class="reference internal" href="#_CPPv4N5arrow4Type5UINT8 [...]
<dd><p>Concrete type class for unsigned 8-bit integer data. </p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric">Public Functions</p>
<dl class="function">
-<dt id="_CPPv3NK5arrow9UInt8Type4nameEv">
-<span id="_CPPv2NK5arrow9UInt8Type4nameEv"></span><span id="arrow::UInt8Type::nameC"></span><span class="target" id="classarrow_1_1_u_int8_type_1ab10fbfb837fe182ca0189765b013de09"></span>std::string <code class="descname">name</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv3NK5arrow9UInt8Type4nameEv" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4NK5arrow9UInt8Type4nameEv">
+<span id="_CPPv3NK5arrow9UInt8Type4nameEv"></span><span id="_CPPv2NK5arrow9UInt8Type4nameEv"></span><span id="arrow::UInt8Type::nameC"></span><span class="target" id="classarrow_1_1_u_int8_type_1ab10fbfb837fe182ca0189765b013de09"></span>std::string <code class="descname">name</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv4NK5arrow9UInt8Type4nameEv" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>A string name of the type, omitting any child fields. </p>
<p><dl class="docutils">
<dt><strong>Note</strong></dt>
@@ -766,14 +780,14 @@ new objects or existing singletons, depending on the type requested.</p>
</dd></dl>
<dl class="class">
-<dt id="_CPPv3N5arrow10UInt16TypeE">
-<span id="_CPPv2N5arrow10UInt16TypeE"></span><span id="arrow::UInt16Type"></span><span class="target" id="classarrow_1_1_u_int16_type"></span><em class="property">class </em><code class="descname">UInt16Type</code> : <em class="property">public</em> arrow::detail::IntegerTypeImpl<<a class="reference internal" href="#_CPPv3N5arrow10UInt16TypeE" title="arrow::UInt16Type">UInt16Type</a>, Type::<a class="reference internal" href="#_CPPv3N5arrow4Type6UINT16E" title="arrow::Type::UINT16">UI [...]
+<dt id="_CPPv4N5arrow10UInt16TypeE">
+<span id="_CPPv3N5arrow10UInt16TypeE"></span><span id="_CPPv2N5arrow10UInt16TypeE"></span><span id="arrow::UInt16Type"></span><span class="target" id="classarrow_1_1_u_int16_type"></span><em class="property">class </em><code class="descname">UInt16Type</code> : <em class="property">public</em> arrow::detail::IntegerTypeImpl<<a class="reference internal" href="#_CPPv4N5arrow10UInt16TypeE" title="arrow::UInt16Type">UInt16Type</a>, Type::<a class="reference internal" href="#_CPPv4N5arrow [...]
<dd><p>Concrete type class for unsigned 16-bit integer data. </p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric">Public Functions</p>
<dl class="function">
-<dt id="_CPPv3NK5arrow10UInt16Type4nameEv">
-<span id="_CPPv2NK5arrow10UInt16Type4nameEv"></span><span id="arrow::UInt16Type::nameC"></span><span class="target" id="classarrow_1_1_u_int16_type_1ac0d0b0576ac723ce83867fc959faba91"></span>std::string <code class="descname">name</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv3NK5arrow10UInt16Type4nameEv" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4NK5arrow10UInt16Type4nameEv">
+<span id="_CPPv3NK5arrow10UInt16Type4nameEv"></span><span id="_CPPv2NK5arrow10UInt16Type4nameEv"></span><span id="arrow::UInt16Type::nameC"></span><span class="target" id="classarrow_1_1_u_int16_type_1ac0d0b0576ac723ce83867fc959faba91"></span>std::string <code class="descname">name</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv4NK5arrow10UInt16Type4nameEv" title="Permalink to this definition">¶</a>< [...]
<dd><p>A string name of the type, omitting any child fields. </p>
<p><dl class="docutils">
<dt><strong>Note</strong></dt>
@@ -788,14 +802,14 @@ new objects or existing singletons, depending on the type requested.</p>
</dd></dl>
<dl class="class">
-<dt id="_CPPv3N5arrow10UInt32TypeE">
-<span id="_CPPv2N5arrow10UInt32TypeE"></span><span id="arrow::UInt32Type"></span><span class="target" id="classarrow_1_1_u_int32_type"></span><em class="property">class </em><code class="descname">UInt32Type</code> : <em class="property">public</em> arrow::detail::IntegerTypeImpl<<a class="reference internal" href="#_CPPv3N5arrow10UInt32TypeE" title="arrow::UInt32Type">UInt32Type</a>, Type::<a class="reference internal" href="#_CPPv3N5arrow4Type6UINT32E" title="arrow::Type::UINT32">UI [...]
+<dt id="_CPPv4N5arrow10UInt32TypeE">
+<span id="_CPPv3N5arrow10UInt32TypeE"></span><span id="_CPPv2N5arrow10UInt32TypeE"></span><span id="arrow::UInt32Type"></span><span class="target" id="classarrow_1_1_u_int32_type"></span><em class="property">class </em><code class="descname">UInt32Type</code> : <em class="property">public</em> arrow::detail::IntegerTypeImpl<<a class="reference internal" href="#_CPPv4N5arrow10UInt32TypeE" title="arrow::UInt32Type">UInt32Type</a>, Type::<a class="reference internal" href="#_CPPv4N5arrow [...]
<dd><p>Concrete type class for unsigned 32-bit integer data. </p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric">Public Functions</p>
<dl class="function">
-<dt id="_CPPv3NK5arrow10UInt32Type4nameEv">
-<span id="_CPPv2NK5arrow10UInt32Type4nameEv"></span><span id="arrow::UInt32Type::nameC"></span><span class="target" id="classarrow_1_1_u_int32_type_1ae3b0c563274e9d75001ecdce5c20cd24"></span>std::string <code class="descname">name</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv3NK5arrow10UInt32Type4nameEv" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4NK5arrow10UInt32Type4nameEv">
+<span id="_CPPv3NK5arrow10UInt32Type4nameEv"></span><span id="_CPPv2NK5arrow10UInt32Type4nameEv"></span><span id="arrow::UInt32Type::nameC"></span><span class="target" id="classarrow_1_1_u_int32_type_1ae3b0c563274e9d75001ecdce5c20cd24"></span>std::string <code class="descname">name</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv4NK5arrow10UInt32Type4nameEv" title="Permalink to this definition">¶</a>< [...]
<dd><p>A string name of the type, omitting any child fields. </p>
<p><dl class="docutils">
<dt><strong>Note</strong></dt>
@@ -810,14 +824,14 @@ new objects or existing singletons, depending on the type requested.</p>
</dd></dl>
<dl class="class">
-<dt id="_CPPv3N5arrow10UInt64TypeE">
-<span id="_CPPv2N5arrow10UInt64TypeE"></span><span id="arrow::UInt64Type"></span><span class="target" id="classarrow_1_1_u_int64_type"></span><em class="property">class </em><code class="descname">UInt64Type</code> : <em class="property">public</em> arrow::detail::IntegerTypeImpl<<a class="reference internal" href="#_CPPv3N5arrow10UInt64TypeE" title="arrow::UInt64Type">UInt64Type</a>, Type::<a class="reference internal" href="#_CPPv3N5arrow4Type6UINT64E" title="arrow::Type::UINT64">UI [...]
+<dt id="_CPPv4N5arrow10UInt64TypeE">
+<span id="_CPPv3N5arrow10UInt64TypeE"></span><span id="_CPPv2N5arrow10UInt64TypeE"></span><span id="arrow::UInt64Type"></span><span class="target" id="classarrow_1_1_u_int64_type"></span><em class="property">class </em><code class="descname">UInt64Type</code> : <em class="property">public</em> arrow::detail::IntegerTypeImpl<<a class="reference internal" href="#_CPPv4N5arrow10UInt64TypeE" title="arrow::UInt64Type">UInt64Type</a>, Type::<a class="reference internal" href="#_CPPv4N5arrow [...]
<dd><p>Concrete type class for unsigned 64-bit integer data. </p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric">Public Functions</p>
<dl class="function">
-<dt id="_CPPv3NK5arrow10UInt64Type4nameEv">
-<span id="_CPPv2NK5arrow10UInt64Type4nameEv"></span><span id="arrow::UInt64Type::nameC"></span><span class="target" id="classarrow_1_1_u_int64_type_1aa82cb17b8c28a1839c5517169e0d68b5"></span>std::string <code class="descname">name</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv3NK5arrow10UInt64Type4nameEv" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4NK5arrow10UInt64Type4nameEv">
+<span id="_CPPv3NK5arrow10UInt64Type4nameEv"></span><span id="_CPPv2NK5arrow10UInt64Type4nameEv"></span><span id="arrow::UInt64Type::nameC"></span><span class="target" id="classarrow_1_1_u_int64_type_1aa82cb17b8c28a1839c5517169e0d68b5"></span>std::string <code class="descname">name</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv4NK5arrow10UInt64Type4nameEv" title="Permalink to this definition">¶</a>< [...]
<dd><p>A string name of the type, omitting any child fields. </p>
<p><dl class="docutils">
<dt><strong>Note</strong></dt>
@@ -832,14 +846,14 @@ new objects or existing singletons, depending on the type requested.</p>
</dd></dl>
<dl class="class">
-<dt id="_CPPv3N5arrow13HalfFloatTypeE">
-<span id="_CPPv2N5arrow13HalfFloatTypeE"></span><span id="arrow::HalfFloatType"></span><span class="target" id="classarrow_1_1_half_float_type"></span><em class="property">class </em><code class="descname">HalfFloatType</code> : <em class="property">public</em> arrow::detail::CTypeImpl<<a class="reference internal" href="#_CPPv3N5arrow13HalfFloatTypeE" title="arrow::HalfFloatType">HalfFloatType</a>, FloatingPoint, Type::<a class="reference internal" href="#_CPPv3N5arrow4Type10HALF_FLO [...]
+<dt id="_CPPv4N5arrow13HalfFloatTypeE">
+<span id="_CPPv3N5arrow13HalfFloatTypeE"></span><span id="_CPPv2N5arrow13HalfFloatTypeE"></span><span id="arrow::HalfFloatType"></span><span class="target" id="classarrow_1_1_half_float_type"></span><em class="property">class </em><code class="descname">HalfFloatType</code> : <em class="property">public</em> arrow::detail::CTypeImpl<<a class="reference internal" href="#_CPPv4N5arrow13HalfFloatTypeE" title="arrow::HalfFloatType">HalfFloatType</a>, FloatingPoint, Type::<a class="referen [...]
<dd><p>Concrete type class for 16-bit floating-point data. </p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric">Public Functions</p>
<dl class="function">
-<dt id="_CPPv3NK5arrow13HalfFloatType4nameEv">
-<span id="_CPPv2NK5arrow13HalfFloatType4nameEv"></span><span id="arrow::HalfFloatType::nameC"></span><span class="target" id="classarrow_1_1_half_float_type_1a01f51ed7d5bc4bce7b604a80d011a742"></span>std::string <code class="descname">name</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv3NK5arrow13HalfFloatType4nameEv" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4NK5arrow13HalfFloatType4nameEv">
+<span id="_CPPv3NK5arrow13HalfFloatType4nameEv"></span><span id="_CPPv2NK5arrow13HalfFloatType4nameEv"></span><span id="arrow::HalfFloatType::nameC"></span><span class="target" id="classarrow_1_1_half_float_type_1a01f51ed7d5bc4bce7b604a80d011a742"></span>std::string <code class="descname">name</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv4NK5arrow13HalfFloatType4nameEv" title="Permalink to this def [...]
<dd><p>A string name of the type, omitting any child fields. </p>
<p><dl class="docutils">
<dt><strong>Note</strong></dt>
@@ -854,14 +868,14 @@ new objects or existing singletons, depending on the type requested.</p>
</dd></dl>
<dl class="class">
-<dt id="_CPPv3N5arrow9FloatTypeE">
-<span id="_CPPv2N5arrow9FloatTypeE"></span><span id="arrow::FloatType"></span><span class="target" id="classarrow_1_1_float_type"></span><em class="property">class </em><code class="descname">FloatType</code> : <em class="property">public</em> arrow::detail::CTypeImpl<<a class="reference internal" href="#_CPPv3N5arrow9FloatTypeE" title="arrow::FloatType">FloatType</a>, FloatingPoint, Type::<a class="reference internal" href="#_CPPv3N5arrow4Type5FLOATE" title="arrow::Type::FLOAT">FLOAT [...]
+<dt id="_CPPv4N5arrow9FloatTypeE">
+<span id="_CPPv3N5arrow9FloatTypeE"></span><span id="_CPPv2N5arrow9FloatTypeE"></span><span id="arrow::FloatType"></span><span class="target" id="classarrow_1_1_float_type"></span><em class="property">class </em><code class="descname">FloatType</code> : <em class="property">public</em> arrow::detail::CTypeImpl<<a class="reference internal" href="#_CPPv4N5arrow9FloatTypeE" title="arrow::FloatType">FloatType</a>, FloatingPoint, Type::<a class="reference internal" href="#_CPPv4N5arrow4Ty [...]
<dd><p>Concrete type class for 32-bit floating-point data (C “float”) </p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric">Public Functions</p>
<dl class="function">
-<dt id="_CPPv3NK5arrow9FloatType4nameEv">
-<span id="_CPPv2NK5arrow9FloatType4nameEv"></span><span id="arrow::FloatType::nameC"></span><span class="target" id="classarrow_1_1_float_type_1a7f4f1dc23a47224373466077d141cf25"></span>std::string <code class="descname">name</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv3NK5arrow9FloatType4nameEv" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4NK5arrow9FloatType4nameEv">
+<span id="_CPPv3NK5arrow9FloatType4nameEv"></span><span id="_CPPv2NK5arrow9FloatType4nameEv"></span><span id="arrow::FloatType::nameC"></span><span class="target" id="classarrow_1_1_float_type_1a7f4f1dc23a47224373466077d141cf25"></span>std::string <code class="descname">name</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv4NK5arrow9FloatType4nameEv" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>A string name of the type, omitting any child fields. </p>
<p><dl class="docutils">
<dt><strong>Note</strong></dt>
@@ -876,14 +890,14 @@ new objects or existing singletons, depending on the type requested.</p>
</dd></dl>
<dl class="class">
-<dt id="_CPPv3N5arrow10DoubleTypeE">
-<span id="_CPPv2N5arrow10DoubleTypeE"></span><span id="arrow::DoubleType"></span><span class="target" id="classarrow_1_1_double_type"></span><em class="property">class </em><code class="descname">DoubleType</code> : <em class="property">public</em> arrow::detail::CTypeImpl<<a class="reference internal" href="#_CPPv3N5arrow10DoubleTypeE" title="arrow::DoubleType">DoubleType</a>, FloatingPoint, Type::<a class="reference internal" href="#_CPPv3N5arrow4Type6DOUBLEE" title="arrow::Type::DO [...]
+<dt id="_CPPv4N5arrow10DoubleTypeE">
+<span id="_CPPv3N5arrow10DoubleTypeE"></span><span id="_CPPv2N5arrow10DoubleTypeE"></span><span id="arrow::DoubleType"></span><span class="target" id="classarrow_1_1_double_type"></span><em class="property">class </em><code class="descname">DoubleType</code> : <em class="property">public</em> arrow::detail::CTypeImpl<<a class="reference internal" href="#_CPPv4N5arrow10DoubleTypeE" title="arrow::DoubleType">DoubleType</a>, FloatingPoint, Type::<a class="reference internal" href="#_CPPv [...]
<dd><p>Concrete type class for 64-bit floating-point data (C “double”) </p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric">Public Functions</p>
<dl class="function">
-<dt id="_CPPv3NK5arrow10DoubleType4nameEv">
-<span id="_CPPv2NK5arrow10DoubleType4nameEv"></span><span id="arrow::DoubleType::nameC"></span><span class="target" id="classarrow_1_1_double_type_1a2ae00dcf3116eddf0b03bd0bf9b71d10"></span>std::string <code class="descname">name</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv3NK5arrow10DoubleType4nameEv" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4NK5arrow10DoubleType4nameEv">
+<span id="_CPPv3NK5arrow10DoubleType4nameEv"></span><span id="_CPPv2NK5arrow10DoubleType4nameEv"></span><span id="arrow::DoubleType::nameC"></span><span class="target" id="classarrow_1_1_double_type_1a2ae00dcf3116eddf0b03bd0bf9b71d10"></span>std::string <code class="descname">name</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv4NK5arrow10DoubleType4nameEv" title="Permalink to this definition">¶</a><b [...]
<dd><p>A string name of the type, omitting any child fields. </p>
<p><dl class="docutils">
<dt><strong>Note</strong></dt>
@@ -901,47 +915,47 @@ new objects or existing singletons, depending on the type requested.</p>
<div class="section" id="time-related">
<h3>Time-related<a class="headerlink" href="#time-related" title="Permalink to this headline">¶</a></h3>
<dl class="type">
-<dt id="_CPPv3N5arrow8TimeUnit4typeE">
-<span id="_CPPv2N5arrow8TimeUnit4typeE"></span><span id="arrow::TimeUnit::type"></span><span class="target" id="structarrow_1_1_time_unit_1a561ef51c3755bd873f8f86f5bc4ec1ff"></span><em class="property">enum </em><code class="descclassname">arrow::TimeUnit<code class="descclassname">::</code></code><code class="descname">type</code><a class="headerlink" href="#_CPPv3N5arrow8TimeUnit4typeE" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4N5arrow8TimeUnit4typeE">
+<span id="_CPPv3N5arrow8TimeUnit4typeE"></span><span id="_CPPv2N5arrow8TimeUnit4typeE"></span><span id="arrow::TimeUnit::type"></span><span class="target" id="structarrow_1_1_time_unit_1a561ef51c3755bd873f8f86f5bc4ec1ff"></span><em class="property">enum </em><code class="descclassname">arrow::TimeUnit<code class="descclassname">::</code></code><code class="descname">type</code><a class="headerlink" href="#_CPPv4N5arrow8TimeUnit4typeE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>The unit for a time or timestamp <a class="reference internal" href="#classarrow_1_1_data_type"><span class="std std-ref">DataType</span></a>. </p>
<p><em>Values:</em></p>
<dl class="enumerator">
-<dt id="_CPPv3N5arrow8TimeUnit6SECONDE">
-<span id="_CPPv2N5arrow8TimeUnit6SECONDE"></span><span class="target" id="structarrow_1_1_time_unit_1a561ef51c3755bd873f8f86f5bc4ec1ffa1c81ae790d85d35422c1757e0b20be7a"></span><code class="descname">SECOND</code> = 0<a class="headerlink" href="#_CPPv3N5arrow8TimeUnit6SECONDE" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4N5arrow8TimeUnit6SECONDE">
+<span id="_CPPv3N5arrow8TimeUnit6SECONDE"></span><span id="_CPPv2N5arrow8TimeUnit6SECONDE"></span><span class="target" id="structarrow_1_1_time_unit_1a561ef51c3755bd873f8f86f5bc4ec1ffa1c81ae790d85d35422c1757e0b20be7a"></span><code class="descname">SECOND</code> = 0<a class="headerlink" href="#_CPPv4N5arrow8TimeUnit6SECONDE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>
<dl class="enumerator">
-<dt id="_CPPv3N5arrow8TimeUnit5MILLIE">
-<span id="_CPPv2N5arrow8TimeUnit5MILLIE"></span><span class="target" id="structarrow_1_1_time_unit_1a561ef51c3755bd873f8f86f5bc4ec1ffadc3335445f7fa1b26f9c78754a1f217b"></span><code class="descname">MILLI</code> = 1<a class="headerlink" href="#_CPPv3N5arrow8TimeUnit5MILLIE" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4N5arrow8TimeUnit5MILLIE">
+<span id="_CPPv3N5arrow8TimeUnit5MILLIE"></span><span id="_CPPv2N5arrow8TimeUnit5MILLIE"></span><span class="target" id="structarrow_1_1_time_unit_1a561ef51c3755bd873f8f86f5bc4ec1ffadc3335445f7fa1b26f9c78754a1f217b"></span><code class="descname">MILLI</code> = 1<a class="headerlink" href="#_CPPv4N5arrow8TimeUnit5MILLIE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>
<dl class="enumerator">
-<dt id="_CPPv3N5arrow8TimeUnit5MICROE">
-<span id="_CPPv2N5arrow8TimeUnit5MICROE"></span><span class="target" id="structarrow_1_1_time_unit_1a561ef51c3755bd873f8f86f5bc4ec1ffaf8ce7e9dc4001c956488dd701d567cb1"></span><code class="descname">MICRO</code> = 2<a class="headerlink" href="#_CPPv3N5arrow8TimeUnit5MICROE" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4N5arrow8TimeUnit5MICROE">
+<span id="_CPPv3N5arrow8TimeUnit5MICROE"></span><span id="_CPPv2N5arrow8TimeUnit5MICROE"></span><span class="target" id="structarrow_1_1_time_unit_1a561ef51c3755bd873f8f86f5bc4ec1ffaf8ce7e9dc4001c956488dd701d567cb1"></span><code class="descname">MICRO</code> = 2<a class="headerlink" href="#_CPPv4N5arrow8TimeUnit5MICROE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>
<dl class="enumerator">
-<dt id="_CPPv3N5arrow8TimeUnit4NANOE">
-<span id="_CPPv2N5arrow8TimeUnit4NANOE"></span><span class="target" id="structarrow_1_1_time_unit_1a561ef51c3755bd873f8f86f5bc4ec1ffa88a677627c74df18d59f1aa6cd1c88d5"></span><code class="descname">NANO</code> = 3<a class="headerlink" href="#_CPPv3N5arrow8TimeUnit4NANOE" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4N5arrow8TimeUnit4NANOE">
+<span id="_CPPv3N5arrow8TimeUnit4NANOE"></span><span id="_CPPv2N5arrow8TimeUnit4NANOE"></span><span class="target" id="structarrow_1_1_time_unit_1a561ef51c3755bd873f8f86f5bc4ec1ffa88a677627c74df18d59f1aa6cd1c88d5"></span><code class="descname">NANO</code> = 3<a class="headerlink" href="#_CPPv4N5arrow8TimeUnit4NANOE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
-<dt id="_CPPv3N5arrow10Date32TypeE">
-<span id="_CPPv2N5arrow10Date32TypeE"></span><span id="arrow::Date32Type"></span><span class="target" id="classarrow_1_1_date32_type"></span><em class="property">class </em><code class="descname">Date32Type</code> : <em class="property">public</em> arrow::DateType<a class="headerlink" href="#_CPPv3N5arrow10Date32TypeE" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4N5arrow10Date32TypeE">
+<span id="_CPPv3N5arrow10Date32TypeE"></span><span id="_CPPv2N5arrow10Date32TypeE"></span><span id="arrow::Date32Type"></span><span class="target" id="classarrow_1_1_date32_type"></span><em class="property">class </em><code class="descname">Date32Type</code> : <em class="property">public</em> arrow::DateType<a class="headerlink" href="#_CPPv4N5arrow10Date32TypeE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Concrete type class for 32-bit date data (as number of days since UNIX epoch) </p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric">Public Functions</p>
<dl class="function">
-<dt id="_CPPv3NK5arrow10Date32Type8ToStringEv">
-<span id="_CPPv2NK5arrow10Date32Type8ToStringEv"></span><span id="arrow::Date32Type::ToStringC"></span><span class="target" id="classarrow_1_1_date32_type_1ae770c74ead8fcb6dc4ffd3c6139414a0"></span>std::string <code class="descname">ToString</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv3NK5arrow10Date32Type8ToStringEv" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4NK5arrow10Date32Type8ToStringEv">
+<span id="_CPPv3NK5arrow10Date32Type8ToStringEv"></span><span id="_CPPv2NK5arrow10Date32Type8ToStringEv"></span><span id="arrow::Date32Type::ToStringC"></span><span class="target" id="classarrow_1_1_date32_type_1ae770c74ead8fcb6dc4ffd3c6139414a0"></span>std::string <code class="descname">ToString</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv4NK5arrow10Date32Type8ToStringEv" title="Permalink to this [...]
<dd><p>A string representation of the type, including any children. </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3NK5arrow10Date32Type4nameEv">
-<span id="_CPPv2NK5arrow10Date32Type4nameEv"></span><span id="arrow::Date32Type::nameC"></span><span class="target" id="classarrow_1_1_date32_type_1a67136dde9b0df81a730d9f8aaeea3d10"></span>std::string <code class="descname">name</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv3NK5arrow10Date32Type4nameEv" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4NK5arrow10Date32Type4nameEv">
+<span id="_CPPv3NK5arrow10Date32Type4nameEv"></span><span id="_CPPv2NK5arrow10Date32Type4nameEv"></span><span id="arrow::Date32Type::nameC"></span><span class="target" id="classarrow_1_1_date32_type_1a67136dde9b0df81a730d9f8aaeea3d10"></span>std::string <code class="descname">name</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv4NK5arrow10Date32Type4nameEv" title="Permalink to this definition">¶</a><b [...]
<dd><p>A string name of the type, omitting any child fields. </p>
<p><dl class="docutils">
<dt><strong>Note</strong></dt>
@@ -956,20 +970,20 @@ new objects or existing singletons, depending on the type requested.</p>
</dd></dl>
<dl class="class">
-<dt id="_CPPv3N5arrow10Date64TypeE">
-<span id="_CPPv2N5arrow10Date64TypeE"></span><span id="arrow::Date64Type"></span><span class="target" id="classarrow_1_1_date64_type"></span><em class="property">class </em><code class="descname">Date64Type</code> : <em class="property">public</em> arrow::DateType<a class="headerlink" href="#_CPPv3N5arrow10Date64TypeE" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4N5arrow10Date64TypeE">
+<span id="_CPPv3N5arrow10Date64TypeE"></span><span id="_CPPv2N5arrow10Date64TypeE"></span><span id="arrow::Date64Type"></span><span class="target" id="classarrow_1_1_date64_type"></span><em class="property">class </em><code class="descname">Date64Type</code> : <em class="property">public</em> arrow::DateType<a class="headerlink" href="#_CPPv4N5arrow10Date64TypeE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Concrete type class for 64-bit date data (as number of milliseconds since UNIX epoch) </p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric">Public Functions</p>
<dl class="function">
-<dt id="_CPPv3NK5arrow10Date64Type8ToStringEv">
-<span id="_CPPv2NK5arrow10Date64Type8ToStringEv"></span><span id="arrow::Date64Type::ToStringC"></span><span class="target" id="classarrow_1_1_date64_type_1a7a144a28610069b35fa14424a8e5097c"></span>std::string <code class="descname">ToString</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv3NK5arrow10Date64Type8ToStringEv" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4NK5arrow10Date64Type8ToStringEv">
+<span id="_CPPv3NK5arrow10Date64Type8ToStringEv"></span><span id="_CPPv2NK5arrow10Date64Type8ToStringEv"></span><span id="arrow::Date64Type::ToStringC"></span><span class="target" id="classarrow_1_1_date64_type_1a7a144a28610069b35fa14424a8e5097c"></span>std::string <code class="descname">ToString</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv4NK5arrow10Date64Type8ToStringEv" title="Permalink to this [...]
<dd><p>A string representation of the type, including any children. </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3NK5arrow10Date64Type4nameEv">
-<span id="_CPPv2NK5arrow10Date64Type4nameEv"></span><span id="arrow::Date64Type::nameC"></span><span class="target" id="classarrow_1_1_date64_type_1a48afc838a3ac17c2ae579da3b6387f48"></span>std::string <code class="descname">name</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv3NK5arrow10Date64Type4nameEv" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4NK5arrow10Date64Type4nameEv">
+<span id="_CPPv3NK5arrow10Date64Type4nameEv"></span><span id="_CPPv2NK5arrow10Date64Type4nameEv"></span><span id="arrow::Date64Type::nameC"></span><span class="target" id="classarrow_1_1_date64_type_1a48afc838a3ac17c2ae579da3b6387f48"></span>std::string <code class="descname">name</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv4NK5arrow10Date64Type4nameEv" title="Permalink to this definition">¶</a><b [...]
<dd><p>A string name of the type, omitting any child fields. </p>
<p><dl class="docutils">
<dt><strong>Note</strong></dt>
@@ -984,19 +998,19 @@ new objects or existing singletons, depending on the type requested.</p>
</dd></dl>
<dl class="class">
-<dt id="_CPPv3N5arrow10Time32TypeE">
-<span id="_CPPv2N5arrow10Time32TypeE"></span><span id="arrow::Time32Type"></span><span class="target" id="classarrow_1_1_time32_type"></span><em class="property">class </em><code class="descname">Time32Type</code> : <em class="property">public</em> arrow::TimeType<a class="headerlink" href="#_CPPv3N5arrow10Time32TypeE" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4N5arrow10Time32TypeE">
+<span id="_CPPv3N5arrow10Time32TypeE"></span><span id="_CPPv2N5arrow10Time32TypeE"></span><span id="arrow::Time32Type"></span><span class="target" id="classarrow_1_1_time32_type"></span><em class="property">class </em><code class="descname">Time32Type</code> : <em class="property">public</em> arrow::TimeType<a class="headerlink" href="#_CPPv4N5arrow10Time32TypeE" title="Permalink to this definition">¶</a><br /></dt>
<dd><div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric">Public Functions</p>
<dl class="function">
-<dt id="_CPPv3NK5arrow10Time32Type8ToStringEv">
-<span id="_CPPv2NK5arrow10Time32Type8ToStringEv"></span><span id="arrow::Time32Type::ToStringC"></span><span class="target" id="classarrow_1_1_time32_type_1af48861ed2f03de2ab932f5b4c987f4a7"></span>std::string <code class="descname">ToString</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv3NK5arrow10Time32Type8ToStringEv" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4NK5arrow10Time32Type8ToStringEv">
+<span id="_CPPv3NK5arrow10Time32Type8ToStringEv"></span><span id="_CPPv2NK5arrow10Time32Type8ToStringEv"></span><span id="arrow::Time32Type::ToStringC"></span><span class="target" id="classarrow_1_1_time32_type_1af48861ed2f03de2ab932f5b4c987f4a7"></span>std::string <code class="descname">ToString</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv4NK5arrow10Time32Type8ToStringEv" title="Permalink to this [...]
<dd><p>A string representation of the type, including any children. </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3NK5arrow10Time32Type4nameEv">
-<span id="_CPPv2NK5arrow10Time32Type4nameEv"></span><span id="arrow::Time32Type::nameC"></span><span class="target" id="classarrow_1_1_time32_type_1a7ad35f94f66f2e2f6c718328d0b1e928"></span>std::string <code class="descname">name</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv3NK5arrow10Time32Type4nameEv" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4NK5arrow10Time32Type4nameEv">
+<span id="_CPPv3NK5arrow10Time32Type4nameEv"></span><span id="_CPPv2NK5arrow10Time32Type4nameEv"></span><span id="arrow::Time32Type::nameC"></span><span class="target" id="classarrow_1_1_time32_type_1a7ad35f94f66f2e2f6c718328d0b1e928"></span>std::string <code class="descname">name</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv4NK5arrow10Time32Type4nameEv" title="Permalink to this definition">¶</a><b [...]
<dd><p>A string name of the type, omitting any child fields. </p>
<p><dl class="docutils">
<dt><strong>Note</strong></dt>
@@ -1011,19 +1025,19 @@ new objects or existing singletons, depending on the type requested.</p>
</dd></dl>
<dl class="class">
-<dt id="_CPPv3N5arrow10Time64TypeE">
-<span id="_CPPv2N5arrow10Time64TypeE"></span><span id="arrow::Time64Type"></span><span class="target" id="classarrow_1_1_time64_type"></span><em class="property">class </em><code class="descname">Time64Type</code> : <em class="property">public</em> arrow::TimeType<a class="headerlink" href="#_CPPv3N5arrow10Time64TypeE" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4N5arrow10Time64TypeE">
+<span id="_CPPv3N5arrow10Time64TypeE"></span><span id="_CPPv2N5arrow10Time64TypeE"></span><span id="arrow::Time64Type"></span><span class="target" id="classarrow_1_1_time64_type"></span><em class="property">class </em><code class="descname">Time64Type</code> : <em class="property">public</em> arrow::TimeType<a class="headerlink" href="#_CPPv4N5arrow10Time64TypeE" title="Permalink to this definition">¶</a><br /></dt>
<dd><div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric">Public Functions</p>
<dl class="function">
-<dt id="_CPPv3NK5arrow10Time64Type8ToStringEv">
-<span id="_CPPv2NK5arrow10Time64Type8ToStringEv"></span><span id="arrow::Time64Type::ToStringC"></span><span class="target" id="classarrow_1_1_time64_type_1a8c985ae014e16d79323c0a8899851091"></span>std::string <code class="descname">ToString</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv3NK5arrow10Time64Type8ToStringEv" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4NK5arrow10Time64Type8ToStringEv">
+<span id="_CPPv3NK5arrow10Time64Type8ToStringEv"></span><span id="_CPPv2NK5arrow10Time64Type8ToStringEv"></span><span id="arrow::Time64Type::ToStringC"></span><span class="target" id="classarrow_1_1_time64_type_1a8c985ae014e16d79323c0a8899851091"></span>std::string <code class="descname">ToString</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv4NK5arrow10Time64Type8ToStringEv" title="Permalink to this [...]
<dd><p>A string representation of the type, including any children. </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3NK5arrow10Time64Type4nameEv">
-<span id="_CPPv2NK5arrow10Time64Type4nameEv"></span><span id="arrow::Time64Type::nameC"></span><span class="target" id="classarrow_1_1_time64_type_1abba4ccc76c566ee3f61997f78660dd79"></span>std::string <code class="descname">name</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv3NK5arrow10Time64Type4nameEv" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4NK5arrow10Time64Type4nameEv">
+<span id="_CPPv3NK5arrow10Time64Type4nameEv"></span><span id="_CPPv2NK5arrow10Time64Type4nameEv"></span><span id="arrow::Time64Type::nameC"></span><span class="target" id="classarrow_1_1_time64_type_1abba4ccc76c566ee3f61997f78660dd79"></span>std::string <code class="descname">name</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv4NK5arrow10Time64Type4nameEv" title="Permalink to this definition">¶</a><b [...]
<dd><p>A string name of the type, omitting any child fields. </p>
<p><dl class="docutils">
<dt><strong>Note</strong></dt>
@@ -1038,19 +1052,19 @@ new objects or existing singletons, depending on the type requested.</p>
</dd></dl>
<dl class="class">
-<dt id="_CPPv3N5arrow13TimestampTypeE">
-<span id="_CPPv2N5arrow13TimestampTypeE"></span><span id="arrow::TimestampType"></span><span class="target" id="classarrow_1_1_timestamp_type"></span><em class="property">class </em><code class="descname">TimestampType</code> : <em class="property">public</em> arrow::FixedWidthType, <em class="property">public</em> arrow::ParametricType<a class="headerlink" href="#_CPPv3N5arrow13TimestampTypeE" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4N5arrow13TimestampTypeE">
+<span id="_CPPv3N5arrow13TimestampTypeE"></span><span id="_CPPv2N5arrow13TimestampTypeE"></span><span id="arrow::TimestampType"></span><span class="target" id="classarrow_1_1_timestamp_type"></span><em class="property">class </em><code class="descname">TimestampType</code> : <em class="property">public</em> arrow::FixedWidthType, <em class="property">public</em> arrow::ParametricType<a class="headerlink" href="#_CPPv4N5arrow13TimestampTypeE" title="Permalink to this definition">¶</a><br /></dt>
<dd><div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric">Public Functions</p>
<dl class="function">
-<dt id="_CPPv3NK5arrow13TimestampType8ToStringEv">
-<span id="_CPPv2NK5arrow13TimestampType8ToStringEv"></span><span id="arrow::TimestampType::ToStringC"></span><span class="target" id="classarrow_1_1_timestamp_type_1ae220b66f0778f17a26bb757e46a7e1a9"></span>std::string <code class="descname">ToString</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv3NK5arrow13TimestampType8ToStringEv" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4NK5arrow13TimestampType8ToStringEv">
+<span id="_CPPv3NK5arrow13TimestampType8ToStringEv"></span><span id="_CPPv2NK5arrow13TimestampType8ToStringEv"></span><span id="arrow::TimestampType::ToStringC"></span><span class="target" id="classarrow_1_1_timestamp_type_1ae220b66f0778f17a26bb757e46a7e1a9"></span>std::string <code class="descname">ToString</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv4NK5arrow13TimestampType8ToStringEv" title="Pe [...]
<dd><p>A string representation of the type, including any children. </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3NK5arrow13TimestampType4nameEv">
-<span id="_CPPv2NK5arrow13TimestampType4nameEv"></span><span id="arrow::TimestampType::nameC"></span><span class="target" id="classarrow_1_1_timestamp_type_1acdca1b7fb9a7d6532dcbbfb6dee2172b"></span>std::string <code class="descname">name</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv3NK5arrow13TimestampType4nameEv" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4NK5arrow13TimestampType4nameEv">
+<span id="_CPPv3NK5arrow13TimestampType4nameEv"></span><span id="_CPPv2NK5arrow13TimestampType4nameEv"></span><span id="arrow::TimestampType::nameC"></span><span class="target" id="classarrow_1_1_timestamp_type_1acdca1b7fb9a7d6532dcbbfb6dee2172b"></span>std::string <code class="descname">name</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv4NK5arrow13TimestampType4nameEv" title="Permalink to this defi [...]
<dd><p>A string name of the type, omitting any child fields. </p>
<p><dl class="docutils">
<dt><strong>Note</strong></dt>
@@ -1068,21 +1082,21 @@ new objects or existing singletons, depending on the type requested.</p>
<div class="section" id="binary-like">
<h3>Binary-like<a class="headerlink" href="#binary-like" title="Permalink to this headline">¶</a></h3>
<dl class="class">
-<dt id="_CPPv3N5arrow10BinaryTypeE">
-<span id="_CPPv2N5arrow10BinaryTypeE"></span><span id="arrow::BinaryType"></span><span class="target" id="classarrow_1_1_binary_type"></span><em class="property">class </em><code class="descname">BinaryType</code> : <em class="property">public</em> arrow::<a class="reference internal" href="#_CPPv3N5arrow8DataTypeE" title="arrow::DataType">DataType</a>, <em class="property">public</em> arrow::NoExtraMeta<a class="headerlink" href="#_CPPv3N5arrow10BinaryTypeE" title="Permalink to this def [...]
+<dt id="_CPPv4N5arrow10BinaryTypeE">
+<span id="_CPPv3N5arrow10BinaryTypeE"></span><span id="_CPPv2N5arrow10BinaryTypeE"></span><span id="arrow::BinaryType"></span><span class="target" id="classarrow_1_1_binary_type"></span><em class="property">class </em><code class="descname">BinaryType</code> : <em class="property">public</em> arrow::<a class="reference internal" href="#_CPPv4N5arrow8DataTypeE" title="arrow::DataType">DataType</a>, <em class="property">public</em> arrow::NoExtraMeta<a class="headerlink" href="#_CPPv4N5arr [...]
<dd><p>Concrete type class for variable-size binary data. </p>
<p>Subclassed by <a class="reference internal" href="#classarrow_1_1_string_type"><span class="std std-ref">arrow::StringType</span></a></p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric">Public Functions</p>
<dl class="function">
-<dt id="_CPPv3NK5arrow10BinaryType8ToStringEv">
-<span id="_CPPv2NK5arrow10BinaryType8ToStringEv"></span><span id="arrow::BinaryType::ToStringC"></span><span class="target" id="classarrow_1_1_binary_type_1af5d9c85c40f4c48adce11196aaa4c0c8"></span>std::string <code class="descname">ToString</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv3NK5arrow10BinaryType8ToStringEv" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4NK5arrow10BinaryType8ToStringEv">
+<span id="_CPPv3NK5arrow10BinaryType8ToStringEv"></span><span id="_CPPv2NK5arrow10BinaryType8ToStringEv"></span><span id="arrow::BinaryType::ToStringC"></span><span class="target" id="classarrow_1_1_binary_type_1af5d9c85c40f4c48adce11196aaa4c0c8"></span>std::string <code class="descname">ToString</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv4NK5arrow10BinaryType8ToStringEv" title="Permalink to this [...]
<dd><p>A string representation of the type, including any children. </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3NK5arrow10BinaryType4nameEv">
-<span id="_CPPv2NK5arrow10BinaryType4nameEv"></span><span id="arrow::BinaryType::nameC"></span><span class="target" id="classarrow_1_1_binary_type_1a4c345ca9ef34a6099b29c3e694bedae3"></span>std::string <code class="descname">name</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv3NK5arrow10BinaryType4nameEv" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4NK5arrow10BinaryType4nameEv">
+<span id="_CPPv3NK5arrow10BinaryType4nameEv"></span><span id="_CPPv2NK5arrow10BinaryType4nameEv"></span><span id="arrow::BinaryType::nameC"></span><span class="target" id="classarrow_1_1_binary_type_1a4c345ca9ef34a6099b29c3e694bedae3"></span>std::string <code class="descname">name</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv4NK5arrow10BinaryType4nameEv" title="Permalink to this definition">¶</a><b [...]
<dd><p>A string name of the type, omitting any child fields. </p>
<p><dl class="docutils">
<dt><strong>Note</strong></dt>
@@ -1097,20 +1111,20 @@ new objects or existing singletons, depending on the type requested.</p>
</dd></dl>
<dl class="class">
-<dt id="_CPPv3N5arrow10StringTypeE">
-<span id="_CPPv2N5arrow10StringTypeE"></span><span id="arrow::StringType"></span><span class="target" id="classarrow_1_1_string_type"></span><em class="property">class </em><code class="descname">StringType</code> : <em class="property">public</em> arrow::<a class="reference internal" href="#_CPPv3N5arrow10BinaryTypeE" title="arrow::BinaryType">BinaryType</a><a class="headerlink" href="#_CPPv3N5arrow10StringTypeE" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4N5arrow10StringTypeE">
+<span id="_CPPv3N5arrow10StringTypeE"></span><span id="_CPPv2N5arrow10StringTypeE"></span><span id="arrow::StringType"></span><span class="target" id="classarrow_1_1_string_type"></span><em class="property">class </em><code class="descname">StringType</code> : <em class="property">public</em> arrow::<a class="reference internal" href="#_CPPv4N5arrow10BinaryTypeE" title="arrow::BinaryType">BinaryType</a><a class="headerlink" href="#_CPPv4N5arrow10StringTypeE" title="Permalink to this defi [...]
<dd><p>Concrete type class for variable-size string data, utf8-encoded. </p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric">Public Functions</p>
<dl class="function">
-<dt id="_CPPv3NK5arrow10StringType8ToStringEv">
-<span id="_CPPv2NK5arrow10StringType8ToStringEv"></span><span id="arrow::StringType::ToStringC"></span><span class="target" id="classarrow_1_1_string_type_1a9ad23b52d91b108a0598f1ca40b88538"></span>std::string <code class="descname">ToString</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv3NK5arrow10StringType8ToStringEv" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4NK5arrow10StringType8ToStringEv">
+<span id="_CPPv3NK5arrow10StringType8ToStringEv"></span><span id="_CPPv2NK5arrow10StringType8ToStringEv"></span><span id="arrow::StringType::ToStringC"></span><span class="target" id="classarrow_1_1_string_type_1a9ad23b52d91b108a0598f1ca40b88538"></span>std::string <code class="descname">ToString</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv4NK5arrow10StringType8ToStringEv" title="Permalink to this [...]
<dd><p>A string representation of the type, including any children. </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3NK5arrow10StringType4nameEv">
-<span id="_CPPv2NK5arrow10StringType4nameEv"></span><span id="arrow::StringType::nameC"></span><span class="target" id="classarrow_1_1_string_type_1ac286b24f3c2b3eeaf1e7d897ecd7a8d1"></span>std::string <code class="descname">name</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv3NK5arrow10StringType4nameEv" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4NK5arrow10StringType4nameEv">
+<span id="_CPPv3NK5arrow10StringType4nameEv"></span><span id="_CPPv2NK5arrow10StringType4nameEv"></span><span id="arrow::StringType::nameC"></span><span class="target" id="classarrow_1_1_string_type_1ac286b24f3c2b3eeaf1e7d897ecd7a8d1"></span>std::string <code class="descname">name</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv4NK5arrow10StringType4nameEv" title="Permalink to this definition">¶</a><b [...]
<dd><p>A string name of the type, omitting any child fields. </p>
<p><dl class="docutils">
<dt><strong>Note</strong></dt>
@@ -1125,21 +1139,21 @@ new objects or existing singletons, depending on the type requested.</p>
</dd></dl>
<dl class="class">
-<dt id="_CPPv3N5arrow19FixedSizeBinaryTypeE">
-<span id="_CPPv2N5arrow19FixedSizeBinaryTypeE"></span><span id="arrow::FixedSizeBinaryType"></span><span class="target" id="classarrow_1_1_fixed_size_binary_type"></span><em class="property">class </em><code class="descname">FixedSizeBinaryType</code> : <em class="property">public</em> arrow::FixedWidthType, <em class="property">public</em> arrow::ParametricType<a class="headerlink" href="#_CPPv3N5arrow19FixedSizeBinaryTypeE" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4N5arrow19FixedSizeBinaryTypeE">
+<span id="_CPPv3N5arrow19FixedSizeBinaryTypeE"></span><span id="_CPPv2N5arrow19FixedSizeBinaryTypeE"></span><span id="arrow::FixedSizeBinaryType"></span><span class="target" id="classarrow_1_1_fixed_size_binary_type"></span><em class="property">class </em><code class="descname">FixedSizeBinaryType</code> : <em class="property">public</em> arrow::FixedWidthType, <em class="property">public</em> arrow::ParametricType<a class="headerlink" href="#_CPPv4N5arrow19FixedSizeBinaryTypeE" title="P [...]
<dd><p>Concrete type class for fixed-size binary data. </p>
<p>Subclassed by arrow::DecimalType</p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric">Public Functions</p>
<dl class="function">
-<dt id="_CPPv3NK5arrow19FixedSizeBinaryType8ToStringEv">
-<span id="_CPPv2NK5arrow19FixedSizeBinaryType8ToStringEv"></span><span id="arrow::FixedSizeBinaryType::ToStringC"></span><span class="target" id="classarrow_1_1_fixed_size_binary_type_1a470c5c8c75c6480ff99c8abd16e375a2"></span>std::string <code class="descname">ToString</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv3NK5arrow19FixedSizeBinaryType8ToStringEv" title="Permalink to this definition">¶</a> [...]
+<dt id="_CPPv4NK5arrow19FixedSizeBinaryType8ToStringEv">
+<span id="_CPPv3NK5arrow19FixedSizeBinaryType8ToStringEv"></span><span id="_CPPv2NK5arrow19FixedSizeBinaryType8ToStringEv"></span><span id="arrow::FixedSizeBinaryType::ToStringC"></span><span class="target" id="classarrow_1_1_fixed_size_binary_type_1a470c5c8c75c6480ff99c8abd16e375a2"></span>std::string <code class="descname">ToString</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv4NK5arrow19FixedSize [...]
<dd><p>A string representation of the type, including any children. </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3NK5arrow19FixedSizeBinaryType4nameEv">
-<span id="_CPPv2NK5arrow19FixedSizeBinaryType4nameEv"></span><span id="arrow::FixedSizeBinaryType::nameC"></span><span class="target" id="classarrow_1_1_fixed_size_binary_type_1af533276c83d45b5cefa826a169bef6c7"></span>std::string <code class="descname">name</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv3NK5arrow19FixedSizeBinaryType4nameEv" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4NK5arrow19FixedSizeBinaryType4nameEv">
+<span id="_CPPv3NK5arrow19FixedSizeBinaryType4nameEv"></span><span id="_CPPv2NK5arrow19FixedSizeBinaryType4nameEv"></span><span id="arrow::FixedSizeBinaryType::nameC"></span><span class="target" id="classarrow_1_1_fixed_size_binary_type_1af533276c83d45b5cefa826a169bef6c7"></span>std::string <code class="descname">name</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv4NK5arrow19FixedSizeBinaryType4nameE [...]
<dd><p>A string name of the type, omitting any child fields. </p>
<p><dl class="docutils">
<dt><strong>Note</strong></dt>
@@ -1154,20 +1168,20 @@ new objects or existing singletons, depending on the type requested.</p>
</dd></dl>
<dl class="class">
-<dt id="_CPPv3N5arrow14Decimal128TypeE">
-<span id="_CPPv2N5arrow14Decimal128TypeE"></span><span id="arrow::Decimal128Type"></span><span class="target" id="classarrow_1_1_decimal128_type"></span><em class="property">class </em><code class="descname">Decimal128Type</code> : <em class="property">public</em> arrow::DecimalType<a class="headerlink" href="#_CPPv3N5arrow14Decimal128TypeE" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4N5arrow14Decimal128TypeE">
+<span id="_CPPv3N5arrow14Decimal128TypeE"></span><span id="_CPPv2N5arrow14Decimal128TypeE"></span><span id="arrow::Decimal128Type"></span><span class="target" id="classarrow_1_1_decimal128_type"></span><em class="property">class </em><code class="descname">Decimal128Type</code> : <em class="property">public</em> arrow::DecimalType<a class="headerlink" href="#_CPPv4N5arrow14Decimal128TypeE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Concrete type class for 128-bit decimal data. </p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric">Public Functions</p>
<dl class="function">
-<dt id="_CPPv3NK5arrow14Decimal128Type8ToStringEv">
-<span id="_CPPv2NK5arrow14Decimal128Type8ToStringEv"></span><span id="arrow::Decimal128Type::ToStringC"></span><span class="target" id="classarrow_1_1_decimal128_type_1aa18803bc8d4540498e2bc697353daa96"></span>std::string <code class="descname">ToString</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv3NK5arrow14Decimal128Type8ToStringEv" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4NK5arrow14Decimal128Type8ToStringEv">
+<span id="_CPPv3NK5arrow14Decimal128Type8ToStringEv"></span><span id="_CPPv2NK5arrow14Decimal128Type8ToStringEv"></span><span id="arrow::Decimal128Type::ToStringC"></span><span class="target" id="classarrow_1_1_decimal128_type_1aa18803bc8d4540498e2bc697353daa96"></span>std::string <code class="descname">ToString</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv4NK5arrow14Decimal128Type8ToStringEv" titl [...]
<dd><p>A string representation of the type, including any children. </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3NK5arrow14Decimal128Type4nameEv">
-<span id="_CPPv2NK5arrow14Decimal128Type4nameEv"></span><span id="arrow::Decimal128Type::nameC"></span><span class="target" id="classarrow_1_1_decimal128_type_1a369b5ae40c271133e15571f9c6198170"></span>std::string <code class="descname">name</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv3NK5arrow14Decimal128Type4nameEv" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4NK5arrow14Decimal128Type4nameEv">
+<span id="_CPPv3NK5arrow14Decimal128Type4nameEv"></span><span id="_CPPv2NK5arrow14Decimal128Type4nameEv"></span><span id="arrow::Decimal128Type::nameC"></span><span class="target" id="classarrow_1_1_decimal128_type_1a369b5ae40c271133e15571f9c6198170"></span>std::string <code class="descname">name</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv4NK5arrow14Decimal128Type4nameEv" title="Permalink to this [...]
<dd><p>A string name of the type, omitting any child fields. </p>
<p><dl class="docutils">
<dt><strong>Note</strong></dt>
@@ -1185,21 +1199,21 @@ new objects or existing singletons, depending on the type requested.</p>
<div class="section" id="nested">
<h3>Nested<a class="headerlink" href="#nested" title="Permalink to this headline">¶</a></h3>
<dl class="class">
-<dt id="_CPPv3N5arrow8ListTypeE">
-<span id="_CPPv2N5arrow8ListTypeE"></span><span id="arrow::ListType"></span><span class="target" id="classarrow_1_1_list_type"></span><em class="property">class </em><code class="descname">ListType</code> : <em class="property">public</em> arrow::NestedType<a class="headerlink" href="#_CPPv3N5arrow8ListTypeE" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4N5arrow8ListTypeE">
+<span id="_CPPv3N5arrow8ListTypeE"></span><span id="_CPPv2N5arrow8ListTypeE"></span><span id="arrow::ListType"></span><span class="target" id="classarrow_1_1_list_type"></span><em class="property">class </em><code class="descname">ListType</code> : <em class="property">public</em> arrow::NestedType<a class="headerlink" href="#_CPPv4N5arrow8ListTypeE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Concrete type class for list data. </p>
<p>List data is nested data where each value is a variable number of child items. Lists can be recursively nested, for example list(list(int32)). </p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric">Public Functions</p>
<dl class="function">
-<dt id="_CPPv3NK5arrow8ListType8ToStringEv">
-<span id="_CPPv2NK5arrow8ListType8ToStringEv"></span><span id="arrow::ListType::ToStringC"></span><span class="target" id="classarrow_1_1_list_type_1a652c8b1865ebc3e4c606cb169b5fdd01"></span>std::string <code class="descname">ToString</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv3NK5arrow8ListType8ToStringEv" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4NK5arrow8ListType8ToStringEv">
+<span id="_CPPv3NK5arrow8ListType8ToStringEv"></span><span id="_CPPv2NK5arrow8ListType8ToStringEv"></span><span id="arrow::ListType::ToStringC"></span><span class="target" id="classarrow_1_1_list_type_1a652c8b1865ebc3e4c606cb169b5fdd01"></span>std::string <code class="descname">ToString</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv4NK5arrow8ListType8ToStringEv" title="Permalink to this definition"> [...]
<dd><p>A string representation of the type, including any children. </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3NK5arrow8ListType4nameEv">
-<span id="_CPPv2NK5arrow8ListType4nameEv"></span><span id="arrow::ListType::nameC"></span><span class="target" id="classarrow_1_1_list_type_1a6320a08c4881865abcac2fdeab4fb0a2"></span>std::string <code class="descname">name</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv3NK5arrow8ListType4nameEv" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4NK5arrow8ListType4nameEv">
+<span id="_CPPv3NK5arrow8ListType4nameEv"></span><span id="_CPPv2NK5arrow8ListType4nameEv"></span><span id="arrow::ListType::nameC"></span><span class="target" id="classarrow_1_1_list_type_1a6320a08c4881865abcac2fdeab4fb0a2"></span>std::string <code class="descname">name</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv4NK5arrow8ListType4nameEv" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>A string name of the type, omitting any child fields. </p>
<p><dl class="docutils">
<dt><strong>Note</strong></dt>
@@ -1214,20 +1228,20 @@ new objects or existing singletons, depending on the type requested.</p>
</dd></dl>
<dl class="class">
-<dt id="_CPPv3N5arrow10StructTypeE">
-<span id="_CPPv2N5arrow10StructTypeE"></span><span id="arrow::StructType"></span><span class="target" id="classarrow_1_1_struct_type"></span><em class="property">class </em><code class="descname">StructType</code> : <em class="property">public</em> arrow::NestedType<a class="headerlink" href="#_CPPv3N5arrow10StructTypeE" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4N5arrow10StructTypeE">
+<span id="_CPPv3N5arrow10StructTypeE"></span><span id="_CPPv2N5arrow10StructTypeE"></span><span id="arrow::StructType"></span><span class="target" id="classarrow_1_1_struct_type"></span><em class="property">class </em><code class="descname">StructType</code> : <em class="property">public</em> arrow::NestedType<a class="headerlink" href="#_CPPv4N5arrow10StructTypeE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Concrete type class for struct data. </p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric">Public Functions</p>
<dl class="function">
-<dt id="_CPPv3NK5arrow10StructType8ToStringEv">
-<span id="_CPPv2NK5arrow10StructType8ToStringEv"></span><span id="arrow::StructType::ToStringC"></span><span class="target" id="classarrow_1_1_struct_type_1a61ef958c691895c85bf1f3d297b14351"></span>std::string <code class="descname">ToString</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv3NK5arrow10StructType8ToStringEv" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4NK5arrow10StructType8ToStringEv">
+<span id="_CPPv3NK5arrow10StructType8ToStringEv"></span><span id="_CPPv2NK5arrow10StructType8ToStringEv"></span><span id="arrow::StructType::ToStringC"></span><span class="target" id="classarrow_1_1_struct_type_1a61ef958c691895c85bf1f3d297b14351"></span>std::string <code class="descname">ToString</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv4NK5arrow10StructType8ToStringEv" title="Permalink to this [...]
<dd><p>A string representation of the type, including any children. </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3NK5arrow10StructType4nameEv">
-<span id="_CPPv2NK5arrow10StructType4nameEv"></span><span id="arrow::StructType::nameC"></span><span class="target" id="classarrow_1_1_struct_type_1a5a6f3d58e837712a49e507925e2b40ec"></span>std::string <code class="descname">name</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv3NK5arrow10StructType4nameEv" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4NK5arrow10StructType4nameEv">
+<span id="_CPPv3NK5arrow10StructType4nameEv"></span><span id="_CPPv2NK5arrow10StructType4nameEv"></span><span id="arrow::StructType::nameC"></span><span class="target" id="classarrow_1_1_struct_type_1a5a6f3d58e837712a49e507925e2b40ec"></span>std::string <code class="descname">name</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv4NK5arrow10StructType4nameEv" title="Permalink to this definition">¶</a><b [...]
<dd><p>A string name of the type, omitting any child fields. </p>
<p><dl class="docutils">
<dt><strong>Note</strong></dt>
@@ -1239,35 +1253,47 @@ new objects or existing singletons, depending on the type requested.</p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3NK5arrow10StructType14GetFieldByNameERKNSt6stringE">
-<span id="_CPPv2NK5arrow10StructType14GetFieldByNameERKNSt6stringE"></span><span id="arrow::StructType::GetFieldByName__ssCRC"></span><span class="target" id="classarrow_1_1_struct_type_1a949bf4c4d7333dbb148fa2af3541f066"></span>std::shared_ptr<<a class="reference internal" href="#_CPPv3N5arrow5FieldE" title="arrow::Field">Field</a>> <code class="descname">GetFieldByName</code><span class="sig-paren">(</span><em class="property">const</em> std::string &<em>name</em><span class= [...]
+<dt id="_CPPv4NK5arrow10StructType14GetFieldByNameERKNSt6stringE">
+<span id="_CPPv3NK5arrow10StructType14GetFieldByNameERKNSt6stringE"></span><span id="_CPPv2NK5arrow10StructType14GetFieldByNameERKNSt6stringE"></span><span id="arrow::StructType::GetFieldByName__ssCRC"></span><span class="target" id="classarrow_1_1_struct_type_1a949bf4c4d7333dbb148fa2af3541f066"></span>std::shared_ptr<<a class="reference internal" href="#_CPPv4N5arrow5FieldE" title="arrow::Field">Field</a>> <code class="descname">GetFieldByName</code><span class="sig-paren">(</span [...]
<dd><p>Returns null if name not found. </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3NK5arrow10StructType13GetFieldIndexERKNSt6stringE">
-<span id="_CPPv2NK5arrow10StructType13GetFieldIndexERKNSt6stringE"></span><span id="arrow::StructType::GetFieldIndex__ssCRC"></span><span class="target" id="classarrow_1_1_struct_type_1a341d4fe0dfc1c693c781de79a178f0e5"></span>int <code class="descname">GetFieldIndex</code><span class="sig-paren">(</span><em class="property">const</em> std::string &<em>name</em><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv3NK5arrow10StructType13Get [...]
+<dt id="_CPPv4NK5arrow10StructType18GetAllFieldsByNameERKNSt6stringE">
+<span id="_CPPv3NK5arrow10StructType18GetAllFieldsByNameERKNSt6stringE"></span><span id="_CPPv2NK5arrow10StructType18GetAllFieldsByNameERKNSt6stringE"></span><span id="arrow::StructType::GetAllFieldsByName__ssCRC"></span><span class="target" id="classarrow_1_1_struct_type_1a1bb82c72b691ba80b7e802e028d7fc87"></span>std::vector<std::shared_ptr<<a class="reference internal" href="#_CPPv4N5arrow5FieldE" title="arrow::Field">Field</a>>> <code class="descname">GetAllFieldsByName</c [...]
+<dd><p>Return all fields having this name. </p>
+</dd></dl>
+
+<dl class="function">
+<dt id="_CPPv4NK5arrow10StructType13GetFieldIndexERKNSt6stringE">
+<span id="_CPPv3NK5arrow10StructType13GetFieldIndexERKNSt6stringE"></span><span id="_CPPv2NK5arrow10StructType13GetFieldIndexERKNSt6stringE"></span><span id="arrow::StructType::GetFieldIndex__ssCRC"></span><span class="target" id="classarrow_1_1_struct_type_1a341d4fe0dfc1c693c781de79a178f0e5"></span>int <code class="descname">GetFieldIndex</code><span class="sig-paren">(</span><em class="property">const</em> std::string &<em>name</em><span class="sig-paren">)</span> <em class="proper [...]
<dd><p>Returns -1 if name not found or if there are multiple fields having the same name. </p>
</dd></dl>
+<dl class="function">
+<dt id="_CPPv4NK5arrow10StructType18GetAllFieldIndicesERKNSt6stringE">
+<span id="_CPPv3NK5arrow10StructType18GetAllFieldIndicesERKNSt6stringE"></span><span id="_CPPv2NK5arrow10StructType18GetAllFieldIndicesERKNSt6stringE"></span><span id="arrow::StructType::GetAllFieldIndices__ssCRC"></span><span class="target" id="classarrow_1_1_struct_type_1a81d2d1599aba5cd3f2c90e8aae1c9f46"></span>std::vector<int> <code class="descname">GetAllFieldIndices</code><span class="sig-paren">(</span><em class="property">const</em> std::string &<em>name</em><span class [...]
+<dd><p>Return the indices of all fields having this name. </p>
+</dd></dl>
+
</div>
</dd></dl>
<dl class="class">
-<dt id="_CPPv3N5arrow9UnionTypeE">
-<span id="_CPPv2N5arrow9UnionTypeE"></span><span id="arrow::UnionType"></span><span class="target" id="classarrow_1_1_union_type"></span><em class="property">class </em><code class="descname">UnionType</code> : <em class="property">public</em> arrow::NestedType<a class="headerlink" href="#_CPPv3N5arrow9UnionTypeE" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4N5arrow9UnionTypeE">
+<span id="_CPPv3N5arrow9UnionTypeE"></span><span id="_CPPv2N5arrow9UnionTypeE"></span><span id="arrow::UnionType"></span><span class="target" id="classarrow_1_1_union_type"></span><em class="property">class </em><code class="descname">UnionType</code> : <em class="property">public</em> arrow::NestedType<a class="headerlink" href="#_CPPv4N5arrow9UnionTypeE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Concrete type class for union data. </p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric">Public Functions</p>
<dl class="function">
-<dt id="_CPPv3NK5arrow9UnionType8ToStringEv">
-<span id="_CPPv2NK5arrow9UnionType8ToStringEv"></span><span id="arrow::UnionType::ToStringC"></span><span class="target" id="classarrow_1_1_union_type_1a54535494e9b2d710c0eb9fcbdde26dcd"></span>std::string <code class="descname">ToString</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv3NK5arrow9UnionType8ToStringEv" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4NK5arrow9UnionType8ToStringEv">
+<span id="_CPPv3NK5arrow9UnionType8ToStringEv"></span><span id="_CPPv2NK5arrow9UnionType8ToStringEv"></span><span id="arrow::UnionType::ToStringC"></span><span class="target" id="classarrow_1_1_union_type_1a54535494e9b2d710c0eb9fcbdde26dcd"></span>std::string <code class="descname">ToString</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv4NK5arrow9UnionType8ToStringEv" title="Permalink to this definit [...]
<dd><p>A string representation of the type, including any children. </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3NK5arrow9UnionType4nameEv">
-<span id="_CPPv2NK5arrow9UnionType4nameEv"></span><span id="arrow::UnionType::nameC"></span><span class="target" id="classarrow_1_1_union_type_1ae1fa65b67319c82d243e9a95de543bdc"></span>std::string <code class="descname">name</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv3NK5arrow9UnionType4nameEv" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4NK5arrow9UnionType4nameEv">
+<span id="_CPPv3NK5arrow9UnionType4nameEv"></span><span id="_CPPv2NK5arrow9UnionType4nameEv"></span><span id="arrow::UnionType::nameC"></span><span class="target" id="classarrow_1_1_union_type_1ae1fa65b67319c82d243e9a95de543bdc"></span>std::string <code class="descname">name</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv4NK5arrow9UnionType4nameEv" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>A string name of the type, omitting any child fields. </p>
<p><dl class="docutils">
<dt><strong>Note</strong></dt>
@@ -1285,20 +1311,20 @@ new objects or existing singletons, depending on the type requested.</p>
<div class="section" id="dictionary-encoded">
<h3>Dictionary-encoded<a class="headerlink" href="#dictionary-encoded" title="Permalink to this headline">¶</a></h3>
<dl class="class">
-<dt id="_CPPv3N5arrow14DictionaryTypeE">
-<span id="_CPPv2N5arrow14DictionaryTypeE"></span><span id="arrow::DictionaryType"></span><span class="target" id="classarrow_1_1_dictionary_type"></span><em class="property">class </em><code class="descname">DictionaryType</code> : <em class="property">public</em> arrow::FixedWidthType<a class="headerlink" href="#_CPPv3N5arrow14DictionaryTypeE" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4N5arrow14DictionaryTypeE">
+<span id="_CPPv3N5arrow14DictionaryTypeE"></span><span id="_CPPv2N5arrow14DictionaryTypeE"></span><span id="arrow::DictionaryType"></span><span class="target" id="classarrow_1_1_dictionary_type"></span><em class="property">class </em><code class="descname">DictionaryType</code> : <em class="property">public</em> arrow::FixedWidthType<a class="headerlink" href="#_CPPv4N5arrow14DictionaryTypeE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Concrete type class for dictionary data. </p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric">Public Functions</p>
<dl class="function">
-<dt id="_CPPv3NK5arrow14DictionaryType8ToStringEv">
-<span id="_CPPv2NK5arrow14DictionaryType8ToStringEv"></span><span id="arrow::DictionaryType::ToStringC"></span><span class="target" id="classarrow_1_1_dictionary_type_1ae315ff7fb07bd9fda3139032244e92d0"></span>std::string <code class="descname">ToString</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv3NK5arrow14DictionaryType8ToStringEv" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4NK5arrow14DictionaryType8ToStringEv">
+<span id="_CPPv3NK5arrow14DictionaryType8ToStringEv"></span><span id="_CPPv2NK5arrow14DictionaryType8ToStringEv"></span><span id="arrow::DictionaryType::ToStringC"></span><span class="target" id="classarrow_1_1_dictionary_type_1ae315ff7fb07bd9fda3139032244e92d0"></span>std::string <code class="descname">ToString</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv4NK5arrow14DictionaryType8ToStringEv" titl [...]
<dd><p>A string representation of the type, including any children. </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3NK5arrow14DictionaryType4nameEv">
-<span id="_CPPv2NK5arrow14DictionaryType4nameEv"></span><span id="arrow::DictionaryType::nameC"></span><span class="target" id="classarrow_1_1_dictionary_type_1a1423be356f4e0c7d28f2c52881decbed"></span>std::string <code class="descname">name</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv3NK5arrow14DictionaryType4nameEv" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4NK5arrow14DictionaryType4nameEv">
+<span id="_CPPv3NK5arrow14DictionaryType4nameEv"></span><span id="_CPPv2NK5arrow14DictionaryType4nameEv"></span><span id="arrow::DictionaryType::nameC"></span><span class="target" id="classarrow_1_1_dictionary_type_1a1423be356f4e0c7d28f2c52881decbed"></span>std::string <code class="descname">name</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv4NK5arrow14DictionaryType4nameEv" title="Permalink to this [...]
<dd><p>A string name of the type, omitting any child fields. </p>
<p><dl class="docutils">
<dt><strong>Note</strong></dt>
@@ -1313,8 +1339,8 @@ new objects or existing singletons, depending on the type requested.</p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric">Public Static Functions</p>
<dl class="function">
-<dt id="_CPPv3N5arrow14DictionaryType5UnifyEP10MemoryPoolRKNSt6vectorIPK8DataTypeEEPNSt10shared_ptrI8DataTypeEEPNSt6vectorINSt6vectorI7int32_tEEEE">
-<span id="_CPPv2N5arrow14DictionaryType5UnifyEP10MemoryPoolRKNSt6vectorIPK8DataTypeEEPNSt10shared_ptrI8DataTypeEEPNSt6vectorINSt6vectorI7int32_tEEEE"></span><span id="arrow::DictionaryType::Unify__MemoryPoolP.std::vector:DataTypeCP:CR.std::shared_ptr:DataType:P.std::vector:std::vector:int32_t::P"></span><span class="target" id="classarrow_1_1_dictionary_type_1a2bfe17968624fedc6abfbc2ee30415e0"></span><em class="property">static</em> <a class="reference internal" href="support.html#_CPPv3 [...]
+<dt id="_CPPv4N5arrow14DictionaryType5UnifyEP10MemoryPoolRKNSt6vectorIPK8DataTypeEEPNSt10shared_ptrI8DataTypeEEPNSt6vectorINSt6vectorI7int32_tEEEE">
+<span id="_CPPv3N5arrow14DictionaryType5UnifyEP10MemoryPoolRKNSt6vectorIPK8DataTypeEEPNSt10shared_ptrI8DataTypeEEPNSt6vectorINSt6vectorI7int32_tEEEE"></span><span id="_CPPv2N5arrow14DictionaryType5UnifyEP10MemoryPoolRKNSt6vectorIPK8DataTypeEEPNSt10shared_ptrI8DataTypeEEPNSt6vectorINSt6vectorI7int32_tEEEE"></span><span id="arrow::DictionaryType::Unify__MemoryPoolP.std::vector:DataTypeCP:CR.std::shared_ptr:DataType:P.std::vector:std::vector:int32_t::P"></span><span class="target" id="class [...]
<dd><p>Unify several dictionary types. </p>
<p>Compute a resulting dictionary that will allow the union of values of all input dictionary types. The input types must all have the same value type. <dl class="docutils">
<dt><strong>Parameters</strong></dt>
@@ -1337,8 +1363,8 @@ new objects or existing singletons, depending on the type requested.</p>
<div class="section" id="fields-and-schemas">
<h2>Fields and Schemas<a class="headerlink" href="#fields-and-schemas" title="Permalink to this headline">¶</a></h2>
<dl class="function">
-<dt id="_CPPv3N5arrow5fieldERKNSt6stringERKNSt10shared_ptrI8DataTypeEEbRKNSt10shared_ptrIK16KeyValueMetadataEE">
-<span id="_CPPv2N5arrow5fieldERKNSt6stringERKNSt10shared_ptrI8DataTypeEEbRKNSt10shared_ptrIK16KeyValueMetadataEE"></span><span id="arrow::field__ssCR.std::shared_ptr:DataType:CR.b.std::shared_ptr:KeyValueMetadataC:CR"></span><span class="target" id="group__schema-factories_1ga4918ab359f54d2544f8fa29b7ba88efe"></span>std::shared_ptr<<a class="reference internal" href="#_CPPv3N5arrow5FieldE" title="arrow::Field">Field</a>> <code class="descclassname">arrow<code class="descclassname"> [...]
+<dt id="_CPPv4N5arrow5fieldERKNSt6stringERKNSt10shared_ptrI8DataTypeEEbRKNSt10shared_ptrIK16KeyValueMetadataEE">
+<span id="_CPPv3N5arrow5fieldERKNSt6stringERKNSt10shared_ptrI8DataTypeEEbRKNSt10shared_ptrIK16KeyValueMetadataEE"></span><span id="_CPPv2N5arrow5fieldERKNSt6stringERKNSt10shared_ptrI8DataTypeEEbRKNSt10shared_ptrIK16KeyValueMetadataEE"></span><span id="arrow::field__ssCR.std::shared_ptr:DataType:CR.b.std::shared_ptr:KeyValueMetadataC:CR"></span><span class="target" id="group__schema-factories_1ga4918ab359f54d2544f8fa29b7ba88efe"></span>std::shared_ptr<<a class="reference internal" href [...]
<dd><p>Create a <a class="reference internal" href="#classarrow_1_1_field"><span class="std std-ref">Field</span></a> instance. </p>
<p><dl class="docutils">
<dt><strong>Parameters</strong></dt>
@@ -1354,8 +1380,8 @@ new objects or existing singletons, depending on the type requested.</p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3N5arrow6schemaERKNSt6vectorINSt10shared_ptrI5FieldEEEERKNSt10shared_ptrIK16KeyValueMetadataEE">
-<span id="_CPPv2N5arrow6schemaERKNSt6vectorINSt10shared_ptrI5FieldEEEERKNSt10shared_ptrIK16KeyValueMetadataEE"></span><span id="arrow::schema__std::vector:std::shared_ptr:Field::CR.std::shared_ptr:KeyValueMetadataC:CR"></span><span class="target" id="group__schema-factories_1ga97ac72c2a07228577c1d38b7747941a9"></span>std::shared_ptr<<a class="reference internal" href="#_CPPv3N5arrow6SchemaE" title="arrow::Schema">Schema</a>> <code class="descclassname">arrow<code class="descclassna [...]
+<dt id="_CPPv4N5arrow6schemaERKNSt6vectorINSt10shared_ptrI5FieldEEEERKNSt10shared_ptrIK16KeyValueMetadataEE">
+<span id="_CPPv3N5arrow6schemaERKNSt6vectorINSt10shared_ptrI5FieldEEEERKNSt10shared_ptrIK16KeyValueMetadataEE"></span><span id="_CPPv2N5arrow6schemaERKNSt6vectorINSt10shared_ptrI5FieldEEEERKNSt10shared_ptrIK16KeyValueMetadataEE"></span><span id="arrow::schema__std::vector:std::shared_ptr:Field::CR.std::shared_ptr:KeyValueMetadataC:CR"></span><span class="target" id="group__schema-factories_1ga97ac72c2a07228577c1d38b7747941a9"></span>std::shared_ptr<<a class="reference internal" href=" [...]
<dd><p>Create a <a class="reference internal" href="#classarrow_1_1_schema"><span class="std std-ref">Schema</span></a> instance. </p>
<p><dl class="docutils">
<dt><strong>Return</strong></dt>
@@ -1371,8 +1397,8 @@ new objects or existing singletons, depending on the type requested.</p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3N5arrow6schemaERRNSt6vectorINSt10shared_ptrI5FieldEEEERKNSt10shared_ptrIK16KeyValueMetadataEE">
-<span id="_CPPv2N5arrow6schemaERRNSt6vectorINSt10shared_ptrI5FieldEEEERKNSt10shared_ptrIK16KeyValueMetadataEE"></span><span id="arrow::schema__std::vector:std::shared_ptr:Field::RR.std::shared_ptr:KeyValueMetadataC:CR"></span><span class="target" id="group__schema-factories_1ga4bfaca962de2f2069b78b27cdf28bcd6"></span>std::shared_ptr<<a class="reference internal" href="#_CPPv3N5arrow6SchemaE" title="arrow::Schema">Schema</a>> <code class="descclassname">arrow<code class="descclassna [...]
+<dt id="_CPPv4N5arrow6schemaERRNSt6vectorINSt10shared_ptrI5FieldEEEERKNSt10shared_ptrIK16KeyValueMetadataEE">
+<span id="_CPPv3N5arrow6schemaERRNSt6vectorINSt10shared_ptrI5FieldEEEERKNSt10shared_ptrIK16KeyValueMetadataEE"></span><span id="_CPPv2N5arrow6schemaERRNSt6vectorINSt10shared_ptrI5FieldEEEERKNSt10shared_ptrIK16KeyValueMetadataEE"></span><span id="arrow::schema__std::vector:std::shared_ptr:Field::RR.std::shared_ptr:KeyValueMetadataC:CR"></span><span class="target" id="group__schema-factories_1ga4bfaca962de2f2069b78b27cdf28bcd6"></span>std::shared_ptr<<a class="reference internal" href=" [...]
<dd><p>Create a <a class="reference internal" href="#classarrow_1_1_schema"><span class="std std-ref">Schema</span></a> instance. </p>
<p><dl class="docutils">
<dt><strong>Return</strong></dt>
@@ -1388,58 +1414,64 @@ new objects or existing singletons, depending on the type requested.</p>
</dd></dl>
<dl class="class">
-<dt id="_CPPv3N5arrow5FieldE">
-<span id="_CPPv2N5arrow5FieldE"></span><span id="arrow::Field"></span><span class="target" id="classarrow_1_1_field"></span><em class="property">class </em><code class="descname">Field</code><a class="headerlink" href="#_CPPv3N5arrow5FieldE" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4N5arrow5FieldE">
+<span id="_CPPv3N5arrow5FieldE"></span><span id="_CPPv2N5arrow5FieldE"></span><span id="arrow::Field"></span><span class="target" id="classarrow_1_1_field"></span><em class="property">class </em><code class="descname">Field</code><a class="headerlink" href="#_CPPv4N5arrow5FieldE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>The combination of a field name and data type, with optional metadata. </p>
<p>Fields are used to describe the individual constituents of a nested <a class="reference internal" href="#classarrow_1_1_data_type"><span class="std std-ref">DataType</span></a> or a <a class="reference internal" href="#classarrow_1_1_schema"><span class="std std-ref">Schema</span></a>.</p>
<p>A field’s metadata is represented by a KeyValueMetadata instance, which holds arbitrary key-value pairs. </p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric">Public Functions</p>
<dl class="function">
-<dt id="_CPPv3NK5arrow5Field8metadataEv">
-<span id="_CPPv2NK5arrow5Field8metadataEv"></span><span id="arrow::Field::metadataC"></span><span class="target" id="classarrow_1_1_field_1a899a4cef4c13946c9996095ca53e8004"></span>std::shared_ptr<<em class="property">const</em> KeyValueMetadata> <code class="descname">metadata</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv3NK5arrow5Field8metadataEv" title="Permalink to this definition">¶</a>< [...]
+<dt id="_CPPv4NK5arrow5Field8metadataEv">
+<span id="_CPPv3NK5arrow5Field8metadataEv"></span><span id="_CPPv2NK5arrow5Field8metadataEv"></span><span id="arrow::Field::metadataC"></span><span class="target" id="classarrow_1_1_field_1a899a4cef4c13946c9996095ca53e8004"></span>std::shared_ptr<<em class="property">const</em> KeyValueMetadata> <code class="descname">metadata</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv4NK5arrow5Field8metad [...]
<dd><p>Return the field’s attached metadata. </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3NK5arrow5Field11HasMetadataEv">
-<span id="_CPPv2NK5arrow5Field11HasMetadataEv"></span><span id="arrow::Field::HasMetadataC"></span><span class="target" id="classarrow_1_1_field_1ade70dc0d9c4965246815e481a7c2fd42"></span>bool <code class="descname">HasMetadata</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv3NK5arrow5Field11HasMetadataEv" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4NK5arrow5Field11HasMetadataEv">
+<span id="_CPPv3NK5arrow5Field11HasMetadataEv"></span><span id="_CPPv2NK5arrow5Field11HasMetadataEv"></span><span id="arrow::Field::HasMetadataC"></span><span class="target" id="classarrow_1_1_field_1ade70dc0d9c4965246815e481a7c2fd42"></span>bool <code class="descname">HasMetadata</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv4NK5arrow5Field11HasMetadataEv" title="Permalink to this definition">¶</a> [...]
<dd><p>Return whether the field has non-empty metadata. </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3NK5arrow5Field11AddMetadataERKNSt10shared_ptrIK16KeyValueMetadataEE">
-<span id="_CPPv2NK5arrow5Field11AddMetadataERKNSt10shared_ptrIK16KeyValueMetadataEE"></span><span id="arrow::Field::AddMetadata__std::shared_ptr:KeyValueMetadataC:CRC"></span><span class="target" id="classarrow_1_1_field_1a62fecbd06c4ef227ae53c4ea3cbb4616"></span>std::shared_ptr<<a class="reference internal" href="#_CPPv3N5arrow5FieldE" title="arrow::Field">Field</a>> <code class="descname">AddMetadata</code><span class="sig-paren">(</span><em class="property">const</em> std::share [...]
+<dt id="_CPPv4NK5arrow5Field11AddMetadataERKNSt10shared_ptrIK16KeyValueMetadataEE">
+<span id="_CPPv3NK5arrow5Field11AddMetadataERKNSt10shared_ptrIK16KeyValueMetadataEE"></span><span id="_CPPv2NK5arrow5Field11AddMetadataERKNSt10shared_ptrIK16KeyValueMetadataEE"></span><span id="arrow::Field::AddMetadata__std::shared_ptr:KeyValueMetadataC:CRC"></span><span class="target" id="classarrow_1_1_field_1a62fecbd06c4ef227ae53c4ea3cbb4616"></span>std::shared_ptr<<a class="reference internal" href="#_CPPv4N5arrow5FieldE" title="arrow::Field">Field</a>> <code class="descname"> [...]
<dd><p>Return a copy of this field with the given metadata attached to it. </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3NK5arrow5Field14RemoveMetadataEv">
-<span id="_CPPv2NK5arrow5Field14RemoveMetadataEv"></span><span id="arrow::Field::RemoveMetadataC"></span><span class="target" id="classarrow_1_1_field_1ac253b45e669f8b756fb9c15fd26e9dbe"></span>std::shared_ptr<<a class="reference internal" href="#_CPPv3N5arrow5FieldE" title="arrow::Field">Field</a>> <code class="descname">RemoveMetadata</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv3NK5arrow5F [...]
+<dt id="_CPPv4NK5arrow5Field14RemoveMetadataEv">
+<span id="_CPPv3NK5arrow5Field14RemoveMetadataEv"></span><span id="_CPPv2NK5arrow5Field14RemoveMetadataEv"></span><span id="arrow::Field::RemoveMetadataC"></span><span class="target" id="classarrow_1_1_field_1ac253b45e669f8b756fb9c15fd26e9dbe"></span>std::shared_ptr<<a class="reference internal" href="#_CPPv4N5arrow5FieldE" title="arrow::Field">Field</a>> <code class="descname">RemoveMetadata</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property [...]
<dd><p>Return a copy of this field without any metadata attached to it. </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3NK5arrow5Field8ToStringEv">
-<span id="_CPPv2NK5arrow5Field8ToStringEv"></span><span id="arrow::Field::ToStringC"></span><span class="target" id="classarrow_1_1_field_1ad7e8d877d5553e1aa356766b40154b57"></span>std::string <code class="descname">ToString</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv3NK5arrow5Field8ToStringEv" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4NK5arrow5Field8WithTypeERKNSt10shared_ptrI8DataTypeEE">
+<span id="_CPPv3NK5arrow5Field8WithTypeERKNSt10shared_ptrI8DataTypeEE"></span><span id="_CPPv2NK5arrow5Field8WithTypeERKNSt10shared_ptrI8DataTypeEE"></span><span id="arrow::Field::WithType__std::shared_ptr:DataType:CRC"></span><span class="target" id="classarrow_1_1_field_1af0578d97e24865ac8f4e318b26f7803f"></span>std::shared_ptr<<a class="reference internal" href="#_CPPv4N5arrow5FieldE" title="arrow::Field">Field</a>> <code class="descname">WithType</code><span class="sig-paren">( [...]
+<dd><p>Return a copy of this field with the replaced type. </p>
+</dd></dl>
+
+<dl class="function">
+<dt id="_CPPv4NK5arrow5Field8ToStringEv">
+<span id="_CPPv3NK5arrow5Field8ToStringEv"></span><span id="_CPPv2NK5arrow5Field8ToStringEv"></span><span id="arrow::Field::ToStringC"></span><span class="target" id="classarrow_1_1_field_1ad7e8d877d5553e1aa356766b40154b57"></span>std::string <code class="descname">ToString</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv4NK5arrow5Field8ToStringEv" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Return a string representation ot the field. </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3NK5arrow5Field4nameEv">
-<span id="_CPPv2NK5arrow5Field4nameEv"></span><span id="arrow::Field::nameC"></span><span class="target" id="classarrow_1_1_field_1ab023b8e5c6d7deff0af5fc757ecaca89"></span><em class="property">const</em> std::string &<code class="descname">name</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv3NK5arrow5Field4nameEv" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4NK5arrow5Field4nameEv">
+<span id="_CPPv3NK5arrow5Field4nameEv"></span><span id="_CPPv2NK5arrow5Field4nameEv"></span><span id="arrow::Field::nameC"></span><span class="target" id="classarrow_1_1_field_1ab023b8e5c6d7deff0af5fc757ecaca89"></span><em class="property">const</em> std::string &<code class="descname">name</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv4NK5arrow5Field4nameEv" title="Permalink to this definition" [...]
<dd><p>Return the field name. </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3NK5arrow5Field4typeEv">
-<span id="_CPPv2NK5arrow5Field4typeEv"></span><span id="arrow::Field::typeC"></span><span class="target" id="classarrow_1_1_field_1a82421c8ae174cbd0c3ef458cf96def42"></span>std::shared_ptr<<a class="reference internal" href="#_CPPv3N5arrow8DataTypeE" title="arrow::DataType">DataType</a>> <code class="descname">type</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv3NK5arrow5Field4typeEv" title="Pe [...]
+<dt id="_CPPv4NK5arrow5Field4typeEv">
+<span id="_CPPv3NK5arrow5Field4typeEv"></span><span id="_CPPv2NK5arrow5Field4typeEv"></span><span id="arrow::Field::typeC"></span><span class="target" id="classarrow_1_1_field_1a82421c8ae174cbd0c3ef458cf96def42"></span>std::shared_ptr<<a class="reference internal" href="#_CPPv4N5arrow8DataTypeE" title="arrow::DataType">DataType</a>> <code class="descname">type</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" [...]
<dd><p>Return the field data type. </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3NK5arrow5Field8nullableEv">
-<span id="_CPPv2NK5arrow5Field8nullableEv"></span><span id="arrow::Field::nullableC"></span><span class="target" id="classarrow_1_1_field_1aba2045f76a42fe34fd785190af139c25"></span>bool <code class="descname">nullable</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv3NK5arrow5Field8nullableEv" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4NK5arrow5Field8nullableEv">
+<span id="_CPPv3NK5arrow5Field8nullableEv"></span><span id="_CPPv2NK5arrow5Field8nullableEv"></span><span id="arrow::Field::nullableC"></span><span class="target" id="classarrow_1_1_field_1aba2045f76a42fe34fd785190af139c25"></span>bool <code class="descname">nullable</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv4NK5arrow5Field8nullableEv" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Return whether the field is nullable. </p>
</dd></dl>
@@ -1447,38 +1479,50 @@ new objects or existing singletons, depending on the type requested.</p>
</dd></dl>
<dl class="class">
-<dt id="_CPPv3N5arrow6SchemaE">
-<span id="_CPPv2N5arrow6SchemaE"></span><span id="arrow::Schema"></span><span class="target" id="classarrow_1_1_schema"></span><em class="property">class </em><code class="descname">Schema</code><a class="headerlink" href="#_CPPv3N5arrow6SchemaE" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4N5arrow6SchemaE">
+<span id="_CPPv3N5arrow6SchemaE"></span><span id="_CPPv2N5arrow6SchemaE"></span><span id="arrow::Schema"></span><span class="target" id="classarrow_1_1_schema"></span><em class="property">class </em><code class="descname">Schema</code><a class="headerlink" href="#_CPPv4N5arrow6SchemaE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Sequence of <a class="reference internal" href="#classarrow_1_1_field"><span class="std std-ref">arrow::Field</span></a> objects describing the columns of a record batch or table data structure. </p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric">Public Functions</p>
<dl class="function">
-<dt id="_CPPv3NK5arrow6Schema6EqualsERK6Schemab">
-<span id="_CPPv2NK5arrow6Schema6EqualsERK6Schemab"></span><span id="arrow::Schema::Equals__SchemaCR.bC"></span><span class="target" id="classarrow_1_1_schema_1a42fc083647dace5d84af7984e3b623cd"></span>bool <code class="descname">Equals</code><span class="sig-paren">(</span><em class="property">const</em> <a class="reference internal" href="#_CPPv3N5arrow6SchemaE" title="arrow::Schema">Schema</a> &<em>other</em>, bool <em>check_metadata</em> = true<span class="sig-paren">)</span> <em [...]
+<dt id="_CPPv4NK5arrow6Schema6EqualsERK6Schemab">
+<span id="_CPPv3NK5arrow6Schema6EqualsERK6Schemab"></span><span id="_CPPv2NK5arrow6Schema6EqualsERK6Schemab"></span><span id="arrow::Schema::Equals__SchemaCR.bC"></span><span class="target" id="classarrow_1_1_schema_1a42fc083647dace5d84af7984e3b623cd"></span>bool <code class="descname">Equals</code><span class="sig-paren">(</span><em class="property">const</em> <a class="reference internal" href="#_CPPv4N5arrow6SchemaE" title="arrow::Schema">Schema</a> &<em>other</em>, bool <em>check [...]
<dd><p>Returns true if all of the schema fields are equal. </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3NK5arrow6Schema5fieldEi">
-<span id="_CPPv2NK5arrow6Schema5fieldEi"></span><span id="arrow::Schema::field__iC"></span><span class="target" id="classarrow_1_1_schema_1a3d066a04d993a3a15b8ca18d1a5469d3"></span>std::shared_ptr<<a class="reference internal" href="#_CPPv3N5arrow5FieldE" title="arrow::Field">Field</a>> <code class="descname">field</code><span class="sig-paren">(</span>int <em>i</em><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv3NK5arrow6Schema5fi [...]
+<dt id="_CPPv4NK5arrow6Schema5fieldEi">
+<span id="_CPPv3NK5arrow6Schema5fieldEi"></span><span id="_CPPv2NK5arrow6Schema5fieldEi"></span><span id="arrow::Schema::field__iC"></span><span class="target" id="classarrow_1_1_schema_1a3d066a04d993a3a15b8ca18d1a5469d3"></span>std::shared_ptr<<a class="reference internal" href="#_CPPv4N5arrow5FieldE" title="arrow::Field">Field</a>> <code class="descname">field</code><span class="sig-paren">(</span>int <em>i</em><span class="sig-paren">)</span> <em class="property">const</em><a cl [...]
<dd><p>Return the ith schema element. Does not boundscheck. </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3NK5arrow6Schema14GetFieldByNameERKNSt6stringE">
-<span id="_CPPv2NK5arrow6Schema14GetFieldByNameERKNSt6stringE"></span><span id="arrow::Schema::GetFieldByName__ssCRC"></span><span class="target" id="classarrow_1_1_schema_1a73c450d1aa2b373e42e742dd8fcb6ec3"></span>std::shared_ptr<<a class="reference internal" href="#_CPPv3N5arrow5FieldE" title="arrow::Field">Field</a>> <code class="descname">GetFieldByName</code><span class="sig-paren">(</span><em class="property">const</em> std::string &<em>name</em><span class="sig-paren">)< [...]
+<dt id="_CPPv4NK5arrow6Schema14GetFieldByNameERKNSt6stringE">
+<span id="_CPPv3NK5arrow6Schema14GetFieldByNameERKNSt6stringE"></span><span id="_CPPv2NK5arrow6Schema14GetFieldByNameERKNSt6stringE"></span><span id="arrow::Schema::GetFieldByName__ssCRC"></span><span class="target" id="classarrow_1_1_schema_1a73c450d1aa2b373e42e742dd8fcb6ec3"></span>std::shared_ptr<<a class="reference internal" href="#_CPPv4N5arrow5FieldE" title="arrow::Field">Field</a>> <code class="descname">GetFieldByName</code><span class="sig-paren">(</span><em class="propert [...]
<dd><p>Returns null if name not found. </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3NK5arrow6Schema13GetFieldIndexERKNSt6stringE">
-<span id="_CPPv2NK5arrow6Schema13GetFieldIndexERKNSt6stringE"></span><span id="arrow::Schema::GetFieldIndex__ssCRC"></span><span class="target" id="classarrow_1_1_schema_1a1e9ba89aabf743926acccc6a11fd29c1"></span>int64_t <code class="descname">GetFieldIndex</code><span class="sig-paren">(</span><em class="property">const</em> std::string &<em>name</em><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv3NK5arrow6Schema13GetFieldIndexERKNS [...]
+<dt id="_CPPv4NK5arrow6Schema18GetAllFieldsByNameERKNSt6stringE">
+<span id="_CPPv3NK5arrow6Schema18GetAllFieldsByNameERKNSt6stringE"></span><span id="_CPPv2NK5arrow6Schema18GetAllFieldsByNameERKNSt6stringE"></span><span id="arrow::Schema::GetAllFieldsByName__ssCRC"></span><span class="target" id="classarrow_1_1_schema_1adfc28c0c5f3a371e63b2cd137543b8f0"></span>std::vector<std::shared_ptr<<a class="reference internal" href="#_CPPv4N5arrow5FieldE" title="arrow::Field">Field</a>>> <code class="descname">GetAllFieldsByName</code><span class="si [...]
+<dd><p>Return all fields having this name. </p>
+</dd></dl>
+
+<dl class="function">
+<dt id="_CPPv4NK5arrow6Schema13GetFieldIndexERKNSt6stringE">
+<span id="_CPPv3NK5arrow6Schema13GetFieldIndexERKNSt6stringE"></span><span id="_CPPv2NK5arrow6Schema13GetFieldIndexERKNSt6stringE"></span><span id="arrow::Schema::GetFieldIndex__ssCRC"></span><span class="target" id="classarrow_1_1_schema_1a471b18cb74814f4476ec72c72e068e35"></span>int <code class="descname">GetFieldIndex</code><span class="sig-paren">(</span><em class="property">const</em> std::string &<em>name</em><span class="sig-paren">)</span> <em class="property">const</em><a cl [...]
<dd><p>Returns -1 if name not found. </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3NK5arrow6Schema8metadataEv">
-<span id="_CPPv2NK5arrow6Schema8metadataEv"></span><span id="arrow::Schema::metadataC"></span><span class="target" id="classarrow_1_1_schema_1a7cae195f4fb47288e228330f0848fd69"></span>std::shared_ptr<<em class="property">const</em> KeyValueMetadata> <code class="descname">metadata</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv3NK5arrow6Schema8metadataEv" title="Permalink to this definition">¶< [...]
+<dt id="_CPPv4NK5arrow6Schema18GetAllFieldIndicesERKNSt6stringE">
+<span id="_CPPv3NK5arrow6Schema18GetAllFieldIndicesERKNSt6stringE"></span><span id="_CPPv2NK5arrow6Schema18GetAllFieldIndicesERKNSt6stringE"></span><span id="arrow::Schema::GetAllFieldIndices__ssCRC"></span><span class="target" id="classarrow_1_1_schema_1a0a8c63898500ebfac582a7a6dacc3b4e"></span>std::vector<int> <code class="descname">GetAllFieldIndices</code><span class="sig-paren">(</span><em class="property">const</em> std::string &<em>name</em><span class="sig-paren">)</spa [...]
+<dd><p>Return the indices of all fields having this name. </p>
+</dd></dl>
+
+<dl class="function">
+<dt id="_CPPv4NK5arrow6Schema8metadataEv">
+<span id="_CPPv3NK5arrow6Schema8metadataEv"></span><span id="_CPPv2NK5arrow6Schema8metadataEv"></span><span id="arrow::Schema::metadataC"></span><span class="target" id="classarrow_1_1_schema_1a7cae195f4fb47288e228330f0848fd69"></span>std::shared_ptr<<em class="property">const</em> KeyValueMetadata> <code class="descname">metadata</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv4NK5arrow6Schema8 [...]
<dd><p>The custom key-value metadata, if any. </p>
<p><dl class="docutils">
<dt><strong>Return</strong></dt>
@@ -1488,14 +1532,14 @@ new objects or existing singletons, depending on the type requested.</p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3NK5arrow6Schema8ToStringEv">
-<span id="_CPPv2NK5arrow6Schema8ToStringEv"></span><span id="arrow::Schema::ToStringC"></span><span class="target" id="classarrow_1_1_schema_1a36d9ce3094f7ecd593c8d83b897f4572"></span>std::string <code class="descname">ToString</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv3NK5arrow6Schema8ToStringEv" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4NK5arrow6Schema8ToStringEv">
+<span id="_CPPv3NK5arrow6Schema8ToStringEv"></span><span id="_CPPv2NK5arrow6Schema8ToStringEv"></span><span id="arrow::Schema::ToStringC"></span><span class="target" id="classarrow_1_1_schema_1a36d9ce3094f7ecd593c8d83b897f4572"></span>std::string <code class="descname">ToString</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv4NK5arrow6Schema8ToStringEv" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Render a string representation of the schema suitable for debugging. </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3NK5arrow6Schema11AddMetadataERKNSt10shared_ptrIK16KeyValueMetadataEE">
-<span id="_CPPv2NK5arrow6Schema11AddMetadataERKNSt10shared_ptrIK16KeyValueMetadataEE"></span><span id="arrow::Schema::AddMetadata__std::shared_ptr:KeyValueMetadataC:CRC"></span><span class="target" id="classarrow_1_1_schema_1aca11dd1e22abc2baaf6ee96baf9d8c81"></span>std::shared_ptr<<a class="reference internal" href="#_CPPv3N5arrow6SchemaE" title="arrow::Schema">Schema</a>> <code class="descname">AddMetadata</code><span class="sig-paren">(</span><em class="property">const</em> std: [...]
+<dt id="_CPPv4NK5arrow6Schema11AddMetadataERKNSt10shared_ptrIK16KeyValueMetadataEE">
+<span id="_CPPv3NK5arrow6Schema11AddMetadataERKNSt10shared_ptrIK16KeyValueMetadataEE"></span><span id="_CPPv2NK5arrow6Schema11AddMetadataERKNSt10shared_ptrIK16KeyValueMetadataEE"></span><span id="arrow::Schema::AddMetadata__std::shared_ptr:KeyValueMetadataC:CRC"></span><span class="target" id="classarrow_1_1_schema_1aca11dd1e22abc2baaf6ee96baf9d8c81"></span>std::shared_ptr<<a class="reference internal" href="#_CPPv4N5arrow6SchemaE" title="arrow::Schema">Schema</a>> <code class="des [...]
<dd><p>Replace key-value metadata with new metadata. </p>
<p><dl class="docutils">
<dt><strong>Return</strong></dt>
@@ -1510,20 +1554,20 @@ new objects or existing singletons, depending on the type requested.</p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3NK5arrow6Schema14RemoveMetadataEv">
-<span id="_CPPv2NK5arrow6Schema14RemoveMetadataEv"></span><span id="arrow::Schema::RemoveMetadataC"></span><span class="target" id="classarrow_1_1_schema_1a212da457d85a1f6b021ad05638649451"></span>std::shared_ptr<<a class="reference internal" href="#_CPPv3N5arrow6SchemaE" title="arrow::Schema">Schema</a>> <code class="descname">RemoveMetadata</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv3NK5a [...]
+<dt id="_CPPv4NK5arrow6Schema14RemoveMetadataEv">
+<span id="_CPPv3NK5arrow6Schema14RemoveMetadataEv"></span><span id="_CPPv2NK5arrow6Schema14RemoveMetadataEv"></span><span id="arrow::Schema::RemoveMetadataC"></span><span class="target" id="classarrow_1_1_schema_1a212da457d85a1f6b021ad05638649451"></span>std::shared_ptr<<a class="reference internal" href="#_CPPv4N5arrow6SchemaE" title="arrow::Schema">Schema</a>> <code class="descname">RemoveMetadata</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="p [...]
<dd><p>Return copy of <a class="reference internal" href="#classarrow_1_1_schema"><span class="std std-ref">Schema</span></a> without the KeyValueMetadata. </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3NK5arrow6Schema11HasMetadataEv">
-<span id="_CPPv2NK5arrow6Schema11HasMetadataEv"></span><span id="arrow::Schema::HasMetadataC"></span><span class="target" id="classarrow_1_1_schema_1a5be51a6538db0881ef8334c0e7770adf"></span>bool <code class="descname">HasMetadata</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv3NK5arrow6Schema11HasMetadataEv" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4NK5arrow6Schema11HasMetadataEv">
+<span id="_CPPv3NK5arrow6Schema11HasMetadataEv"></span><span id="_CPPv2NK5arrow6Schema11HasMetadataEv"></span><span id="arrow::Schema::HasMetadataC"></span><span class="target" id="classarrow_1_1_schema_1a5be51a6538db0881ef8334c0e7770adf"></span>bool <code class="descname">HasMetadata</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv4NK5arrow6Schema11HasMetadataEv" title="Permalink to this definition"> [...]
<dd><p>Indicates that <a class="reference internal" href="#classarrow_1_1_schema"><span class="std std-ref">Schema</span></a> has non-empty KevValueMetadata. </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3NK5arrow6Schema10num_fieldsEv">
-<span id="_CPPv2NK5arrow6Schema10num_fieldsEv"></span><span id="arrow::Schema::num_fieldsC"></span><span class="target" id="classarrow_1_1_schema_1a3c7796ff608d03d1c004c6604bb09e5c"></span>int <code class="descname">num_fields</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv3NK5arrow6Schema10num_fieldsEv" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4NK5arrow6Schema10num_fieldsEv">
+<span id="_CPPv3NK5arrow6Schema10num_fieldsEv"></span><span id="_CPPv2NK5arrow6Schema10num_fieldsEv"></span><span id="arrow::Schema::num_fieldsC"></span><span class="target" id="classarrow_1_1_schema_1a3c7796ff608d03d1c004c6604bb09e5c"></span>int <code class="descname">num_fields</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv4NK5arrow6Schema10num_fieldsEv" title="Permalink to this definition">¶</a>< [...]
<dd><p>Return the number of fields (columns) in the schema. </p>
</dd></dl>
@@ -1544,7 +1588,7 @@ new objects or existing singletons, depending on the type requested.</p>
<a href="array.html" class="btn btn-neutral float-right" title="Arrays" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
- <a href="memory.html" class="btn btn-neutral" title="Memory (management)" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+ <a href="memory.html" class="btn btn-neutral float-left" title="Memory (management)" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
@@ -1570,26 +1614,16 @@ new objects or existing singletons, depending on the type requested.</p>
-
-
-
-
- <script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
- <script type="text/javascript" src="../../_static/jquery.js"></script>
- <script type="text/javascript" src="../../_static/underscore.js"></script>
- <script type="text/javascript" src="../../_static/doctools.js"></script>
- <script type="text/javascript" src="../../_static/language_data.js"></script>
-
-
-
-
- <script type="text/javascript" src="../../_static/js/theme.js"></script>
-
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
+
+
+
+
+
<script async src="https://www.googletagmanager.com/gtag/js?id=UA-107500873-1"></script>
<script>
window.dataLayer = window.dataLayer || [];
diff --git a/docs/cpp/api/memory.html b/docs/cpp/api/memory.html
index 65eb1ac..c5efc3c 100644
--- a/docs/cpp/api/memory.html
+++ b/docs/cpp/api/memory.html
@@ -9,7 +9,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Memory (management) — Apache Arrow v0.12.1.dev0+g8ca41384b.d20190120</title>
+ <title>Memory (management) — Apache Arrow v0.13.0</title>
@@ -18,34 +18,36 @@
-
-
+ <script type="text/javascript" src="../../_static/js/modernizr.min.js"></script>
+ <script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
+ <script type="text/javascript" src="../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../_static/doctools.js"></script>
+ <script type="text/javascript" src="../../_static/language_data.js"></script>
+
+ <script type="text/javascript" src="../../_static/js/theme.js"></script>
-
+
+
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<link rel="index" title="Index" href="../../genindex.html" />
<link rel="search" title="Search" href="../../search.html" />
<link rel="next" title="Data Types" href="datatype.html" />
<link rel="prev" title="Programming Support" href="support.html" />
-
-
- <script src="../../_static/js/modernizr.min.js"></script>
-
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
-
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
- <div class="wy-side-nav-search">
+ <div class="wy-side-nav-search" >
@@ -59,7 +61,7 @@
<div class="version">
- 0.12.1.dev0+g8ca41384b.d20190120
+ 0.13.0
</div>
@@ -83,7 +85,7 @@
- <p class="caption"><span class="caption-text">Memory Format</span></p>
+ <p class="caption"><span class="caption-text">Arrow Columnar Format</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../format/README.html">Arrow specification documents</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../format/Guidelines.html">Implementation guidelines</a></li>
@@ -91,11 +93,11 @@
<li class="toctree-l1"><a class="reference internal" href="../../format/Metadata.html">Metadata: Logical types, schemas, data headers</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../format/IPC.html">Interprocess messaging / communication (IPC)</a></li>
</ul>
-<p class="caption"><span class="caption-text">Languages</span></p>
+<p class="caption"><span class="caption-text">Arrow Libraries</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="../index.html">C++ Implementation</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="../getting_started.html">Getting Started</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../examples.html">Examples</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../examples/index.html">Examples</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="../api.html">API Reference</a><ul class="current">
<li class="toctree-l3"><a class="reference internal" href="support.html">Programming Support</a></li>
<li class="toctree-l3 current"><a class="current reference internal" href="#">Memory (management)</a><ul>
@@ -111,15 +113,21 @@
<li class="toctree-l3"><a class="reference internal" href="array.html">Arrays</a></li>
<li class="toctree-l3"><a class="reference internal" href="builder.html">Array Builders</a></li>
<li class="toctree-l3"><a class="reference internal" href="table.html">Two-dimensional Datasets</a></li>
+<li class="toctree-l3"><a class="reference internal" href="utilities.html">Utilities</a></li>
+<li class="toctree-l3"><a class="reference internal" href="cuda.html">CUDA support</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../python/index.html">Python bindings</a></li>
</ul>
-<p class="caption"><span class="caption-text">Other Topics</span></p>
+<p class="caption"><span class="caption-text">Development and Contributing</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../../building.html">Building the Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../developers/contributing.html">Contribution Guidelines</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../developers/cpp.html">C++ Development</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../developers/python.html">Python Development</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../developers/integration.html">Integration Testing</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../developers/documentation.html">Building the Documentation</a></li>
</ul>
@@ -193,18 +201,18 @@
<div class="section" id="buffers">
<h2>Buffers<a class="headerlink" href="#buffers" title="Permalink to this headline">¶</a></h2>
<dl class="class">
-<dt id="_CPPv3N5arrow6BufferE">
-<span id="_CPPv2N5arrow6BufferE"></span><span id="arrow::Buffer"></span><span class="target" id="classarrow_1_1_buffer"></span><em class="property">class </em><code class="descname">Buffer</code><a class="headerlink" href="#_CPPv3N5arrow6BufferE" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4N5arrow6BufferE">
+<span id="_CPPv3N5arrow6BufferE"></span><span id="_CPPv2N5arrow6BufferE"></span><span id="arrow::Buffer"></span><span class="target" id="classarrow_1_1_buffer"></span><em class="property">class </em><code class="descname">Buffer</code><a class="headerlink" href="#_CPPv4N5arrow6BufferE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Object containing a pointer to a piece of contiguous memory with a particular size. </p>
<p>Buffers have two related notions of length: size and capacity. Size is the number of bytes that might have valid data. Capacity is the number of bytes that were allocated for the buffer in total.</p>
<p>The <a class="reference internal" href="#classarrow_1_1_buffer"><span class="std std-ref">Buffer</span></a> base class does not own its memory, but subclasses often do.</p>
<p>The following invariant is always true: Size <= Capacity </p>
-<p>Subclassed by arrow::cuda::CudaBuffer, <a class="reference internal" href="#classarrow_1_1_mutable_buffer"><span class="std std-ref">arrow::MutableBuffer</span></a>, arrow::py::NumPyBuffer, arrow::py::PyBuffer, arrow::py::PyForeignBuffer</p>
+<p>Subclassed by <a class="reference internal" href="cuda.html#classarrow_1_1cuda_1_1_cuda_buffer"><span class="std std-ref">arrow::cuda::CudaBuffer</span></a>, <a class="reference internal" href="#classarrow_1_1_mutable_buffer"><span class="std std-ref">arrow::MutableBuffer</span></a>, arrow::py::NumPyBuffer, arrow::py::PyBuffer, arrow::py::PyForeignBuffer</p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric">Public Functions</p>
<dl class="function">
-<dt id="_CPPv3N5arrow6Buffer6BufferEPK7uint8_t7int64_t">
-<span id="_CPPv2N5arrow6Buffer6BufferEPK7uint8_t7int64_t"></span><span id="arrow::Buffer::Buffer__uint8_tCP.int64_t"></span><span class="target" id="classarrow_1_1_buffer_1a801078c559b0c351f1ca5a6b6a04488f"></span><code class="descname">Buffer</code><span class="sig-paren">(</span><em class="property">const</em> uint8_t *<em>data</em>, int64_t <em>size</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv3N5arrow6Buffer6BufferEPK7uint8_t7int64_t" title="Permalink to this [...]
+<dt id="_CPPv4N5arrow6Buffer6BufferEPK7uint8_t7int64_t">
+<span id="_CPPv3N5arrow6Buffer6BufferEPK7uint8_t7int64_t"></span><span id="_CPPv2N5arrow6Buffer6BufferEPK7uint8_t7int64_t"></span><span id="arrow::Buffer::Buffer__uint8_tCP.int64_t"></span><span class="target" id="classarrow_1_1_buffer_1a801078c559b0c351f1ca5a6b6a04488f"></span><code class="descname">Buffer</code><span class="sig-paren">(</span><em class="property">const</em> uint8_t *<em>data</em>, int64_t <em>size</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N [...]
<dd><p>Construct from buffer and size without copying memory. </p>
<p><dl class="docutils">
<dt><strong>Note</strong></dt>
@@ -220,8 +228,8 @@
</dd></dl>
<dl class="function">
-<dt id="_CPPv3N5arrow6Buffer6BufferERKNSt6stringE">
-<span id="_CPPv2N5arrow6Buffer6BufferERKNSt6stringE"></span><span id="arrow::Buffer::Buffer__ssCR"></span><span class="target" id="classarrow_1_1_buffer_1a5dfd60984e0ac8474f20dbd49f628e54"></span><code class="descname">Buffer</code><span class="sig-paren">(</span><em class="property">const</em> std::string &<em>data</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv3N5arrow6Buffer6BufferERKNSt6stringE" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4N5arrow6Buffer6BufferERKNSt6stringE">
+<span id="_CPPv3N5arrow6Buffer6BufferERKNSt6stringE"></span><span id="_CPPv2N5arrow6Buffer6BufferERKNSt6stringE"></span><span id="arrow::Buffer::Buffer__ssCR"></span><span class="target" id="classarrow_1_1_buffer_1a5dfd60984e0ac8474f20dbd49f628e54"></span><code class="descname">Buffer</code><span class="sig-paren">(</span><em class="property">const</em> std::string &<em>data</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6Buffer6BufferERKNSt6stringE" ti [...]
<dd><p>Construct from std::string without copying memory. </p>
<p><dl class="docutils">
<dt><strong>Note</strong></dt>
@@ -236,45 +244,45 @@
</dd></dl>
<dl class="function">
-<dt id="_CPPv3N5arrow6Buffer6BufferERKNSt10shared_ptrI6BufferEEK7int64_tK7int64_t">
-<span id="_CPPv2N5arrow6Buffer6BufferERKNSt10shared_ptrI6BufferEEK7int64_tK7int64_t"></span><span id="arrow::Buffer::Buffer__std::shared_ptr:Buffer:CR.int64_tC.int64_tC"></span><span class="target" id="classarrow_1_1_buffer_1af694696afedb9313cf5dc874ffa9a453"></span><code class="descname">Buffer</code><span class="sig-paren">(</span><em class="property">const</em> std::shared_ptr<<a class="reference internal" href="#_CPPv3N5arrow6Buffer6BufferEPK7uint8_t7int64_t" title="arrow::Buffer: [...]
+<dt id="_CPPv4N5arrow6Buffer6BufferERKNSt10shared_ptrI6BufferEEK7int64_tK7int64_t">
+<span id="_CPPv3N5arrow6Buffer6BufferERKNSt10shared_ptrI6BufferEEK7int64_tK7int64_t"></span><span id="_CPPv2N5arrow6Buffer6BufferERKNSt10shared_ptrI6BufferEEK7int64_tK7int64_t"></span><span id="arrow::Buffer::Buffer__std::shared_ptr:Buffer:CR.int64_tC.int64_tC"></span><span class="target" id="classarrow_1_1_buffer_1af694696afedb9313cf5dc874ffa9a453"></span><code class="descname">Buffer</code><span class="sig-paren">(</span><em class="property">const</em> std::shared_ptr<<a class="refe [...]
<dd><p>An offset into data that is owned by another buffer, but we want to be able to retain a valid pointer to it even after other shared_ptr’s to the parent buffer have been destroyed. </p>
<p>This method makes no assertions about alignment or padding of the buffer but in general we expected buffers to be aligned and padded to 64 bytes. In the future we might add utility methods to help determine if a buffer satisfies this contract. </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3NK5arrow6Buffer6EqualsERK6Buffer7int64_t">
-<span id="_CPPv2NK5arrow6Buffer6EqualsERK6Buffer7int64_t"></span><span id="arrow::Buffer::Equals__BufferCR.int64_tC"></span><span class="target" id="classarrow_1_1_buffer_1a94918db73183b750716a07133dd8384d"></span>bool <code class="descname">Equals</code><span class="sig-paren">(</span><em class="property">const</em> <a class="reference internal" href="#_CPPv3N5arrow6BufferE" title="arrow::Buffer">Buffer</a> &<em>other</em>, int64_t <em>nbytes</em><span class="sig-paren">)</span> <em [...]
+<dt id="_CPPv4NK5arrow6Buffer6EqualsERK6Buffer7int64_t">
+<span id="_CPPv3NK5arrow6Buffer6EqualsERK6Buffer7int64_t"></span><span id="_CPPv2NK5arrow6Buffer6EqualsERK6Buffer7int64_t"></span><span id="arrow::Buffer::Equals__BufferCR.int64_tC"></span><span class="target" id="classarrow_1_1_buffer_1a94918db73183b750716a07133dd8384d"></span>bool <code class="descname">Equals</code><span class="sig-paren">(</span><em class="property">const</em> <a class="reference internal" href="#_CPPv4N5arrow6BufferE" title="arrow::Buffer">Buffer</a> &<em>other< [...]
<dd><p>Return true if both buffers are the same size and contain the same bytes up to the number of compared bytes. </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3NK5arrow6Buffer6EqualsERK6Buffer">
-<span id="_CPPv2NK5arrow6Buffer6EqualsERK6Buffer"></span><span id="arrow::Buffer::Equals__BufferCRC"></span><span class="target" id="classarrow_1_1_buffer_1a0d3d3bd95a3297046a6ab24f5e957bfd"></span>bool <code class="descname">Equals</code><span class="sig-paren">(</span><em class="property">const</em> <a class="reference internal" href="#_CPPv3N5arrow6BufferE" title="arrow::Buffer">Buffer</a> &<em>other</em><span class="sig-paren">)</span> <em class="property">const</em><a class="hea [...]
+<dt id="_CPPv4NK5arrow6Buffer6EqualsERK6Buffer">
+<span id="_CPPv3NK5arrow6Buffer6EqualsERK6Buffer"></span><span id="_CPPv2NK5arrow6Buffer6EqualsERK6Buffer"></span><span id="arrow::Buffer::Equals__BufferCRC"></span><span class="target" id="classarrow_1_1_buffer_1a0d3d3bd95a3297046a6ab24f5e957bfd"></span>bool <code class="descname">Equals</code><span class="sig-paren">(</span><em class="property">const</em> <a class="reference internal" href="#_CPPv4N5arrow6BufferE" title="arrow::Buffer">Buffer</a> &<em>other</em><span class="sig-par [...]
<dd><p>Return true if both buffers are the same size and contain the same bytes. </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3NK5arrow6Buffer4CopyEK7int64_tK7int64_tP10MemoryPoolPNSt10shared_ptrI6BufferEE">
-<span id="_CPPv2NK5arrow6Buffer4CopyEK7int64_tK7int64_tP10MemoryPoolPNSt10shared_ptrI6BufferEE"></span><span id="arrow::Buffer::Copy__int64_tC.int64_tC.MemoryPoolP.std::shared_ptr:Buffer:PC"></span><span class="target" id="classarrow_1_1_buffer_1a7081913a08b88c2ca674c36354d5e171"></span><a class="reference internal" href="support.html#_CPPv3N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descname">Copy</code><span class="sig-paren">(</span><em class="property">const</em> i [...]
+<dt id="_CPPv4NK5arrow6Buffer4CopyEK7int64_tK7int64_tP10MemoryPoolPNSt10shared_ptrI6BufferEE">
+<span id="_CPPv3NK5arrow6Buffer4CopyEK7int64_tK7int64_tP10MemoryPoolPNSt10shared_ptrI6BufferEE"></span><span id="_CPPv2NK5arrow6Buffer4CopyEK7int64_tK7int64_tP10MemoryPoolPNSt10shared_ptrI6BufferEE"></span><span id="arrow::Buffer::Copy__int64_tC.int64_tC.MemoryPoolP.std::shared_ptr:Buffer:PC"></span><span class="target" id="classarrow_1_1_buffer_1a7081913a08b88c2ca674c36354d5e171"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status">Status< [...]
<dd><p>Copy a section of the buffer into a new <a class="reference internal" href="#classarrow_1_1_buffer"><span class="std std-ref">Buffer</span></a>. </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3NK5arrow6Buffer4CopyEK7int64_tK7int64_tPNSt10shared_ptrI6BufferEE">
-<span id="_CPPv2NK5arrow6Buffer4CopyEK7int64_tK7int64_tPNSt10shared_ptrI6BufferEE"></span><span id="arrow::Buffer::Copy__int64_tC.int64_tC.std::shared_ptr:Buffer:PC"></span><span class="target" id="classarrow_1_1_buffer_1adcf891e5c72d591f1c293027dbf7f22a"></span><a class="reference internal" href="support.html#_CPPv3N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descname">Copy</code><span class="sig-paren">(</span><em class="property">const</em> int64_t <em>start</em>, <e [...]
+<dt id="_CPPv4NK5arrow6Buffer4CopyEK7int64_tK7int64_tPNSt10shared_ptrI6BufferEE">
+<span id="_CPPv3NK5arrow6Buffer4CopyEK7int64_tK7int64_tPNSt10shared_ptrI6BufferEE"></span><span id="_CPPv2NK5arrow6Buffer4CopyEK7int64_tK7int64_tPNSt10shared_ptrI6BufferEE"></span><span id="arrow::Buffer::Copy__int64_tC.int64_tC.std::shared_ptr:Buffer:PC"></span><span class="target" id="classarrow_1_1_buffer_1adcf891e5c72d591f1c293027dbf7f22a"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descname">Copy</code> [...]
<dd><p>Copy a section of the buffer using the default memory pool into a new <a class="reference internal" href="#classarrow_1_1_buffer"><span class="std std-ref">Buffer</span></a>. </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3N5arrow6Buffer11ZeroPaddingEv">
-<span id="_CPPv2N5arrow6Buffer11ZeroPaddingEv"></span><span id="arrow::Buffer::ZeroPadding"></span><span class="target" id="classarrow_1_1_buffer_1a885f7b3329f3adb43a826e9403732a15"></span>void <code class="descname">ZeroPadding</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv3N5arrow6Buffer11ZeroPaddingEv" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4N5arrow6Buffer11ZeroPaddingEv">
+<span id="_CPPv3N5arrow6Buffer11ZeroPaddingEv"></span><span id="_CPPv2N5arrow6Buffer11ZeroPaddingEv"></span><span id="arrow::Buffer::ZeroPadding"></span><span class="target" id="classarrow_1_1_buffer_1a885f7b3329f3adb43a826e9403732a15"></span>void <code class="descname">ZeroPadding</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6Buffer11ZeroPaddingEv" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Zero bytes in padding, i.e. bytes between size_ and capacity_. </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3NK5arrow6Buffer8ToStringEv">
-<span id="_CPPv2NK5arrow6Buffer8ToStringEv"></span><span id="arrow::Buffer::ToStringC"></span><span class="target" id="classarrow_1_1_buffer_1a90034bddee753d83af07e97cdd252b8f"></span>std::string <code class="descname">ToString</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv3NK5arrow6Buffer8ToStringEv" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4NK5arrow6Buffer8ToStringEv">
+<span id="_CPPv3NK5arrow6Buffer8ToStringEv"></span><span id="_CPPv2NK5arrow6Buffer8ToStringEv"></span><span id="arrow::Buffer::ToStringC"></span><span class="target" id="classarrow_1_1_buffer_1a90034bddee753d83af07e97cdd252b8f"></span>std::string <code class="descname">ToString</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv4NK5arrow6Buffer8ToStringEv" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Copy buffer contents into a new std::string. </p>
<p><dl class="docutils">
<dt><strong>Return</strong></dt>
@@ -286,27 +294,27 @@
</dd></dl>
<dl class="function">
-<dt id="_CPPv3NK5arrow6Buffer4dataEv">
-<span id="_CPPv2NK5arrow6Buffer4dataEv"></span><span id="arrow::Buffer::dataC"></span><span class="target" id="classarrow_1_1_buffer_1a81c3dd8c11dd804be2ada6df5ce8fad2"></span><em class="property">const</em> uint8_t *<code class="descname">data</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv3NK5arrow6Buffer4dataEv" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4NK5arrow6Buffer4dataEv">
+<span id="_CPPv3NK5arrow6Buffer4dataEv"></span><span id="_CPPv2NK5arrow6Buffer4dataEv"></span><span id="arrow::Buffer::dataC"></span><span class="target" id="classarrow_1_1_buffer_1a81c3dd8c11dd804be2ada6df5ce8fad2"></span><em class="property">const</em> uint8_t *<code class="descname">data</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv4NK5arrow6Buffer4dataEv" title="Permalink to this definition">¶< [...]
<dd><p>Return a pointer to the buffer’s data. </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3N5arrow6Buffer12mutable_dataEv">
-<span id="_CPPv2N5arrow6Buffer12mutable_dataEv"></span><span id="arrow::Buffer::mutable_data"></span><span class="target" id="classarrow_1_1_buffer_1a5a9cb9324d3f7e323eb070b553c925aa"></span>uint8_t *<code class="descname">mutable_data</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv3N5arrow6Buffer12mutable_dataEv" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4N5arrow6Buffer12mutable_dataEv">
+<span id="_CPPv3N5arrow6Buffer12mutable_dataEv"></span><span id="_CPPv2N5arrow6Buffer12mutable_dataEv"></span><span id="arrow::Buffer::mutable_data"></span><span class="target" id="classarrow_1_1_buffer_1a5a9cb9324d3f7e323eb070b553c925aa"></span>uint8_t *<code class="descname">mutable_data</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6Buffer12mutable_dataEv" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Return a writable pointer to the buffer’s data. </p>
<p>The buffer has to be mutable. Otherwise, an assertion may be thrown or a null pointer may be returned. </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3NK5arrow6Buffer4sizeEv">
-<span id="_CPPv2NK5arrow6Buffer4sizeEv"></span><span id="arrow::Buffer::sizeC"></span><span class="target" id="classarrow_1_1_buffer_1a2a49871341c300996a39145d22aa8054"></span>int64_t <code class="descname">size</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv3NK5arrow6Buffer4sizeEv" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4NK5arrow6Buffer4sizeEv">
+<span id="_CPPv3NK5arrow6Buffer4sizeEv"></span><span id="_CPPv2NK5arrow6Buffer4sizeEv"></span><span id="arrow::Buffer::sizeC"></span><span class="target" id="classarrow_1_1_buffer_1a2a49871341c300996a39145d22aa8054"></span>int64_t <code class="descname">size</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv4NK5arrow6Buffer4sizeEv" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Return the buffer’s size in bytes. </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3NK5arrow6Buffer8capacityEv">
-<span id="_CPPv2NK5arrow6Buffer8capacityEv"></span><span id="arrow::Buffer::capacityC"></span><span class="target" id="classarrow_1_1_buffer_1a4c75902129b5f2fb471fd166907361dc"></span>int64_t <code class="descname">capacity</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv3NK5arrow6Buffer8capacityEv" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4NK5arrow6Buffer8capacityEv">
+<span id="_CPPv3NK5arrow6Buffer8capacityEv"></span><span id="_CPPv2NK5arrow6Buffer8capacityEv"></span><span id="arrow::Buffer::capacityC"></span><span class="target" id="classarrow_1_1_buffer_1a4c75902129b5f2fb471fd166907361dc"></span>int64_t <code class="descname">capacity</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv4NK5arrow6Buffer8capacityEv" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Return the buffer’s capacity (number of allocated bytes) </p>
</dd></dl>
@@ -314,8 +322,8 @@
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric">Public Static Functions</p>
<dl class="function">
-<dt id="_CPPv3N5arrow6Buffer10FromStringERKNSt6stringEP10MemoryPoolPNSt10shared_ptrI6BufferEE">
-<span id="_CPPv2N5arrow6Buffer10FromStringERKNSt6stringEP10MemoryPoolPNSt10shared_ptrI6BufferEE"></span><span id="arrow::Buffer::FromString__ssCR.MemoryPoolP.std::shared_ptr:Buffer:P"></span><span class="target" id="classarrow_1_1_buffer_1adeea70eb65ff53f3ec94d3a7b754c7c0"></span><em class="property">static</em> <a class="reference internal" href="support.html#_CPPv3N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descname">FromString</code><span class="sig-paren">(</span>< [...]
+<dt id="_CPPv4N5arrow6Buffer10FromStringERKNSt6stringEP10MemoryPoolPNSt10shared_ptrI6BufferEE">
+<span id="_CPPv3N5arrow6Buffer10FromStringERKNSt6stringEP10MemoryPoolPNSt10shared_ptrI6BufferEE"></span><span id="_CPPv2N5arrow6Buffer10FromStringERKNSt6stringEP10MemoryPoolPNSt10shared_ptrI6BufferEE"></span><span id="arrow::Buffer::FromString__ssCR.MemoryPoolP.std::shared_ptr:Buffer:P"></span><span class="target" id="classarrow_1_1_buffer_1adeea70eb65ff53f3ec94d3a7b754c7c0"></span><em class="property">static</em> <a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" ti [...]
<dd><p>Construct a new buffer that owns its memory from a std::string. </p>
<p><dl class="docutils">
<dt><strong>Return</strong></dt>
@@ -332,14 +340,14 @@
</dd></dl>
<dl class="function">
-<dt id="_CPPv3N5arrow6Buffer10FromStringERKNSt6stringEPNSt10shared_ptrI6BufferEE">
-<span id="_CPPv2N5arrow6Buffer10FromStringERKNSt6stringEPNSt10shared_ptrI6BufferEE"></span><span id="arrow::Buffer::FromString__ssCR.std::shared_ptr:Buffer:P"></span><span class="target" id="classarrow_1_1_buffer_1a65e1ae0e908b997d371fc80ff1cb8f43"></span><em class="property">static</em> <a class="reference internal" href="support.html#_CPPv3N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descname">FromString</code><span class="sig-paren">(</span><em class="property">const [...]
+<dt id="_CPPv4N5arrow6Buffer10FromStringERKNSt6stringEPNSt10shared_ptrI6BufferEE">
+<span id="_CPPv3N5arrow6Buffer10FromStringERKNSt6stringEPNSt10shared_ptrI6BufferEE"></span><span id="_CPPv2N5arrow6Buffer10FromStringERKNSt6stringEPNSt10shared_ptrI6BufferEE"></span><span id="arrow::Buffer::FromString__ssCR.std::shared_ptr:Buffer:P"></span><span class="target" id="classarrow_1_1_buffer_1a65e1ae0e908b997d371fc80ff1cb8f43"></span><em class="property">static</em> <a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status">Status</a> <code c [...]
<dd><p>Construct a new buffer that owns its memory from a std::string using the default memory pool. </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3N5arrow6Buffer10FromStringERRNSt6stringE">
-<span id="_CPPv2N5arrow6Buffer10FromStringERRNSt6stringE"></span><span id="arrow::Buffer::FromString__ssRR"></span><span class="target" id="classarrow_1_1_buffer_1ab80d43f61a9396c2041343cde4255d24"></span><em class="property">static</em> std::shared_ptr<<a class="reference internal" href="#_CPPv3N5arrow6BufferE" title="arrow::Buffer">Buffer</a>> <code class="descname">FromString</code><span class="sig-paren">(</span>std::string &&<em>data</em><span class="sig-paren">)</span [...]
+<dt id="_CPPv4N5arrow6Buffer10FromStringERRNSt6stringE">
+<span id="_CPPv3N5arrow6Buffer10FromStringERRNSt6stringE"></span><span id="_CPPv2N5arrow6Buffer10FromStringERRNSt6stringE"></span><span id="arrow::Buffer::FromString__ssRR"></span><span class="target" id="classarrow_1_1_buffer_1ab80d43f61a9396c2041343cde4255d24"></span><em class="property">static</em> std::shared_ptr<<a class="reference internal" href="#_CPPv4N5arrow6BufferE" title="arrow::Buffer">Buffer</a>> <code class="descname">FromString</code><span class="sig-paren">(</span>s [...]
<dd><p>Construct an immutable buffer that takes ownership of the contents of an std::string. </p>
<p><dl class="docutils">
<dt><strong>Return</strong></dt>
@@ -354,8 +362,8 @@
</dd></dl>
<dl class="function">
-<dt id="_CPPv3N5arrow6Buffer4WrapEPK1T8SizeType">
-<span id="_CPPv2N5arrow6Buffer4WrapEPK1T8SizeType"></span><span id="arrow::Buffer::Wrap__TCP.SizeType"></span><em class="property">template </em><<em class="property">typename</em> T, <em class="property">typename</em> SizeType = int64_t><br /><span class="target" id="classarrow_1_1_buffer_1abd877e4c900427798762d0abaa92b679"></span><em class="property">static</em> std::shared_ptr<<a class="reference internal" href="#_CPPv3N5arrow6BufferE" title="arrow::Buffer">Buffer</a>> <co [...]
+<dt id="_CPPv4N5arrow6Buffer4WrapEPK1T8SizeType">
+<span id="_CPPv3N5arrow6Buffer4WrapEPK1T8SizeType"></span><span id="_CPPv2N5arrow6Buffer4WrapEPK1T8SizeType"></span><span id="arrow::Buffer::Wrap__TCP.SizeType"></span><em class="property">template </em><<em class="property">typename</em> T, <em class="property">typename</em> SizeType = int64_t><br /><span class="target" id="classarrow_1_1_buffer_1abd877e4c900427798762d0abaa92b679"></span><em class="property">static</em> std::shared_ptr<<a class="reference internal" href="#_CPPv [...]
<dd><p>Create buffer referencing typed memory with some length without copying. </p>
<p><dl class="docutils">
<dt><strong>Return</strong></dt>
@@ -371,8 +379,8 @@
</dd></dl>
<dl class="function">
-<dt id="_CPPv3N5arrow6Buffer4WrapERKNSt6vectorI1TEE">
-<span id="_CPPv2N5arrow6Buffer4WrapERKNSt6vectorI1TEE"></span><span id="arrow::Buffer::Wrap__std::vector:T:CR"></span><em class="property">template </em><<em class="property">typename</em> T><br /><span class="target" id="classarrow_1_1_buffer_1a62d1926a69dd12ce6821dd8c96eafea2"></span><em class="property">static</em> std::shared_ptr<<a class="reference internal" href="#_CPPv3N5arrow6BufferE" title="arrow::Buffer">Buffer</a>> <code class="descname">Wrap</code><span class="sig [...]
+<dt id="_CPPv4N5arrow6Buffer4WrapERKNSt6vectorI1TEE">
+<span id="_CPPv3N5arrow6Buffer4WrapERKNSt6vectorI1TEE"></span><span id="_CPPv2N5arrow6Buffer4WrapERKNSt6vectorI1TEE"></span><span id="arrow::Buffer::Wrap__std::vector:T:CR"></span><em class="property">template </em><<em class="property">typename</em> T><br /><span class="target" id="classarrow_1_1_buffer_1a62d1926a69dd12ce6821dd8c96eafea2"></span><em class="property">static</em> std::shared_ptr<<a class="reference internal" href="#_CPPv4N5arrow6BufferE" title="arrow::Buffer">Buf [...]
<dd><p>Create buffer referencing std::vector with some length without copying. </p>
<p><dl class="docutils">
<dt><strong>Return</strong></dt>
@@ -390,16 +398,16 @@
</dd></dl>
<dl class="class">
-<dt id="_CPPv3N5arrow13MutableBufferE">
-<span id="_CPPv2N5arrow13MutableBufferE"></span><span id="arrow::MutableBuffer"></span><span class="target" id="classarrow_1_1_mutable_buffer"></span><em class="property">class </em><code class="descname">MutableBuffer</code> : <em class="property">public</em> arrow::<a class="reference internal" href="#_CPPv3N5arrow6BufferE" title="arrow::Buffer">Buffer</a><a class="headerlink" href="#_CPPv3N5arrow13MutableBufferE" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4N5arrow13MutableBufferE">
+<span id="_CPPv3N5arrow13MutableBufferE"></span><span id="_CPPv2N5arrow13MutableBufferE"></span><span id="arrow::MutableBuffer"></span><span class="target" id="classarrow_1_1_mutable_buffer"></span><em class="property">class </em><code class="descname">MutableBuffer</code> : <em class="property">public</em> arrow::<a class="reference internal" href="#_CPPv4N5arrow6BufferE" title="arrow::Buffer">Buffer</a><a class="headerlink" href="#_CPPv4N5arrow13MutableBufferE" title="Permalink to this [...]
<dd><p>A <a class="reference internal" href="#classarrow_1_1_buffer"><span class="std std-ref">Buffer</span></a> whose contents can be mutated. </p>
<p>May or may not own its data. </p>
-<p>Subclassed by arrow::cuda::CudaHostBuffer, <a class="reference internal" href="#classarrow_1_1_resizable_buffer"><span class="std std-ref">arrow::ResizableBuffer</span></a></p>
+<p>Subclassed by <a class="reference internal" href="cuda.html#classarrow_1_1cuda_1_1_cuda_host_buffer"><span class="std std-ref">arrow::cuda::CudaHostBuffer</span></a>, <a class="reference internal" href="#classarrow_1_1_resizable_buffer"><span class="std std-ref">arrow::ResizableBuffer</span></a></p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric">Public Static Functions</p>
<dl class="function">
-<dt id="_CPPv3N5arrow13MutableBuffer4WrapEP1T8SizeType">
-<span id="_CPPv2N5arrow13MutableBuffer4WrapEP1T8SizeType"></span><span id="arrow::MutableBuffer::Wrap__TP.SizeType"></span><em class="property">template </em><<em class="property">typename</em> T, <em class="property">typename</em> SizeType = int64_t><br /><span class="target" id="classarrow_1_1_mutable_buffer_1ae06e3a980614bc6db4239e337f721b33"></span><em class="property">static</em> std::shared_ptr<<a class="reference internal" href="#_CPPv3N5arrow6BufferE" title="arrow::Buffe [...]
+<dt id="_CPPv4N5arrow13MutableBuffer4WrapEP1T8SizeType">
+<span id="_CPPv3N5arrow13MutableBuffer4WrapEP1T8SizeType"></span><span id="_CPPv2N5arrow13MutableBuffer4WrapEP1T8SizeType"></span><span id="arrow::MutableBuffer::Wrap__TP.SizeType"></span><em class="property">template </em><<em class="property">typename</em> T, <em class="property">typename</em> SizeType = int64_t><br /><span class="target" id="classarrow_1_1_mutable_buffer_1ae06e3a980614bc6db4239e337f721b33"></span><em class="property">static</em> std::shared_ptr<<a class="refe [...]
<dd><p>Create buffer referencing typed memory with some length. </p>
<p><dl class="docutils">
<dt><strong>Return</strong></dt>
@@ -418,20 +426,21 @@
</dd></dl>
<dl class="class">
-<dt id="_CPPv3N5arrow15ResizableBufferE">
-<span id="_CPPv2N5arrow15ResizableBufferE"></span><span id="arrow::ResizableBuffer"></span><span class="target" id="classarrow_1_1_resizable_buffer"></span><em class="property">class </em><code class="descname">ResizableBuffer</code> : <em class="property">public</em> arrow::<a class="reference internal" href="#_CPPv3N5arrow13MutableBufferE" title="arrow::MutableBuffer">MutableBuffer</a><a class="headerlink" href="#_CPPv3N5arrow15ResizableBufferE" title="Permalink to this definition">¶</ [...]
+<dt id="_CPPv4N5arrow15ResizableBufferE">
+<span id="_CPPv3N5arrow15ResizableBufferE"></span><span id="_CPPv2N5arrow15ResizableBufferE"></span><span id="arrow::ResizableBuffer"></span><span class="target" id="classarrow_1_1_resizable_buffer"></span><em class="property">class </em><code class="descname">ResizableBuffer</code> : <em class="property">public</em> arrow::<a class="reference internal" href="#_CPPv4N5arrow13MutableBufferE" title="arrow::MutableBuffer">MutableBuffer</a><a class="headerlink" href="#_CPPv4N5arrow15Resizabl [...]
<dd><p>A mutable buffer that can be resized. </p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric">Public Functions</p>
<dl class="function">
-<dt id="_CPPv3N5arrow15ResizableBuffer6ResizeEK7int64_tb">
-<span id="_CPPv2N5arrow15ResizableBuffer6ResizeEK7int64_tb"></span><span id="arrow::ResizableBuffer::Resize__int64_tC.b"></span><span class="target" id="classarrow_1_1_resizable_buffer_1ac2d6a69440b5f438f1b02c610622d8f2"></span><em class="property">virtual</em> <a class="reference internal" href="support.html#_CPPv3N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descname">Resize</code><span class="sig-paren">(</span><em class="property">const</em> int64_t <em>new_size</em> [...]
+<dt id="_CPPv4N5arrow15ResizableBuffer6ResizeEK7int64_tb">
+<span id="_CPPv3N5arrow15ResizableBuffer6ResizeEK7int64_tb"></span><span id="_CPPv2N5arrow15ResizableBuffer6ResizeEK7int64_tb"></span><span id="arrow::ResizableBuffer::Resize__int64_tC.b"></span><span class="target" id="classarrow_1_1_resizable_buffer_1ac2d6a69440b5f438f1b02c610622d8f2"></span><em class="property">virtual</em> <a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descname">Resize</code><span class="sig-paren [...]
<dd><p>Change buffer reported size to indicated size, allocating memory if necessary. </p>
-<p>This will ensure that the capacity of the buffer is a multiple of 64 bytes as defined in Layout.md. Consider using ZeroPadding afterwards, in case you return buffer to a reader.</p>
+<p>This will ensure that the capacity of the buffer is a multiple of 64 bytes as defined in Layout.md. Consider using ZeroPadding afterwards, to conform to the Arrow layout specification.</p>
<p><dl class="docutils">
<dt><strong>Parameters</strong></dt>
<dd><ul class="breatheparameterlist first last simple">
-<li><code class="docutils literal notranslate"><span class="pre">shrink_to_fit</span></code>: On deactivating this option, the capacity of the <a class="reference internal" href="#classarrow_1_1_buffer"><span class="std std-ref">Buffer</span></a> won’t decrease. </li>
+<li><code class="docutils literal notranslate"><span class="pre">new_size</span></code>: The new size for the buffer. </li>
+<li><code class="docutils literal notranslate"><span class="pre">shrink_to_fit</span></code>: Whether to shrink the capacity if new size < current size </li>
</ul>
</dd>
</dl>
@@ -439,8 +448,8 @@
</dd></dl>
<dl class="function">
-<dt id="_CPPv3N5arrow15ResizableBuffer7ReserveEK7int64_t">
-<span id="_CPPv2N5arrow15ResizableBuffer7ReserveEK7int64_t"></span><span id="arrow::ResizableBuffer::Reserve__int64_tC"></span><span class="target" id="classarrow_1_1_resizable_buffer_1ae3e4b7569105c6cd980ab2d10b5bbf73"></span><em class="property">virtual</em> <a class="reference internal" href="support.html#_CPPv3N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descname">Reserve</code><span class="sig-paren">(</span><em class="property">const</em> int64_t <em>new_capacity< [...]
+<dt id="_CPPv4N5arrow15ResizableBuffer7ReserveEK7int64_t">
+<span id="_CPPv3N5arrow15ResizableBuffer7ReserveEK7int64_t"></span><span id="_CPPv2N5arrow15ResizableBuffer7ReserveEK7int64_t"></span><span id="arrow::ResizableBuffer::Reserve__int64_tC"></span><span class="target" id="classarrow_1_1_resizable_buffer_1ae3e4b7569105c6cd980ab2d10b5bbf73"></span><em class="property">virtual</em> <a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descname">Reserve</code><span class="sig-paren [...]
<dd><p>Ensure that buffer has enough memory allocated to fit the indicated capacity (and meets the 64 byte padding requirement in Layout.md). </p>
<p>It does not change buffer’s reported size and doesn’t zero the padding. </p>
</dd></dl>
@@ -452,36 +461,36 @@
<div class="section" id="memory-pools">
<h2>Memory Pools<a class="headerlink" href="#memory-pools" title="Permalink to this headline">¶</a></h2>
<dl class="function">
-<dt id="_CPPv3N5arrow19default_memory_poolEv">
-<span id="_CPPv2N5arrow19default_memory_poolEv"></span><span id="arrow::default_memory_pool"></span><span class="target" id="namespacearrow_1aebe81d544faaf827b8f32c5a80b99820"></span><a class="reference internal" href="#_CPPv3N5arrow10MemoryPoolE" title="arrow::MemoryPool">MemoryPool</a> *<code class="descclassname">arrow<code class="descclassname">::</code></code><code class="descname">default_memory_pool</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="he [...]
+<dt id="_CPPv4N5arrow19default_memory_poolEv">
+<span id="_CPPv3N5arrow19default_memory_poolEv"></span><span id="_CPPv2N5arrow19default_memory_poolEv"></span><span id="arrow::default_memory_pool"></span><span class="target" id="namespacearrow_1aebe81d544faaf827b8f32c5a80b99820"></span><a class="reference internal" href="#_CPPv4N5arrow10MemoryPoolE" title="arrow::MemoryPool">MemoryPool</a> *<code class="descclassname">arrow<code class="descclassname">::</code></code><code class="descname">default_memory_pool</code><span class="sig-pare [...]
<dd><p>Return the process-wide default memory pool. </p>
</dd></dl>
<dl class="class">
-<dt id="_CPPv3N5arrow10MemoryPoolE">
-<span id="_CPPv2N5arrow10MemoryPoolE"></span><span id="arrow::MemoryPool"></span><span class="target" id="classarrow_1_1_memory_pool"></span><em class="property">class </em><code class="descname">MemoryPool</code><a class="headerlink" href="#_CPPv3N5arrow10MemoryPoolE" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4N5arrow10MemoryPoolE">
+<span id="_CPPv3N5arrow10MemoryPoolE"></span><span id="_CPPv2N5arrow10MemoryPoolE"></span><span id="arrow::MemoryPool"></span><span class="target" id="classarrow_1_1_memory_pool"></span><em class="property">class </em><code class="descname">MemoryPool</code><a class="headerlink" href="#_CPPv4N5arrow10MemoryPoolE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Base class for memory allocation. </p>
<p>Besides tracking the number of allocated bytes, the allocator also should take care of the required 64-byte alignment. </p>
<p>Subclassed by <a class="reference internal" href="#classarrow_1_1_logging_memory_pool"><span class="std std-ref">arrow::LoggingMemoryPool</span></a>, <a class="reference internal" href="#classarrow_1_1_proxy_memory_pool"><span class="std std-ref">arrow::ProxyMemoryPool</span></a>, <a class="reference internal" href="#classarrow_1_1_s_t_l_memory_pool"><span class="std std-ref">arrow::STLMemoryPool< Allocator ></span></a></p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric">Public Functions</p>
<dl class="function">
-<dt id="_CPPv3N5arrow10MemoryPool8AllocateE7int64_tPP7uint8_t">
-<span id="_CPPv2N5arrow10MemoryPool8AllocateE7int64_tPP7uint8_t"></span><span id="arrow::MemoryPool::Allocate__int64_t.uint8_tPP"></span><span class="target" id="classarrow_1_1_memory_pool_1afa452b21a4d401403cc509cc50a384f9"></span><em class="property">virtual</em> <a class="reference internal" href="support.html#_CPPv3N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descname">Allocate</code><span class="sig-paren">(</span>int64_t <em>size</em>, uint8_t **<em>out</em><span [...]
+<dt id="_CPPv4N5arrow10MemoryPool8AllocateE7int64_tPP7uint8_t">
+<span id="_CPPv3N5arrow10MemoryPool8AllocateE7int64_tPP7uint8_t"></span><span id="_CPPv2N5arrow10MemoryPool8AllocateE7int64_tPP7uint8_t"></span><span id="arrow::MemoryPool::Allocate__int64_t.uint8_tPP"></span><span class="target" id="classarrow_1_1_memory_pool_1afa452b21a4d401403cc509cc50a384f9"></span><em class="property">virtual</em> <a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descname">Allocate</code><span class [...]
<dd><p>Allocate a new memory region of at least size bytes. </p>
<p>The allocated region shall be 64-byte aligned. </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3N5arrow10MemoryPool10ReallocateE7int64_t7int64_tPP7uint8_t">
-<span id="_CPPv2N5arrow10MemoryPool10ReallocateE7int64_t7int64_tPP7uint8_t"></span><span id="arrow::MemoryPool::Reallocate__int64_t.int64_t.uint8_tPP"></span><span class="target" id="classarrow_1_1_memory_pool_1af64bda5eccc8fa42ce9ae0aba1ad9077"></span><em class="property">virtual</em> <a class="reference internal" href="support.html#_CPPv3N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descname">Reallocate</code><span class="sig-paren">(</span>int64_t <em>old_size</em>, i [...]
+<dt id="_CPPv4N5arrow10MemoryPool10ReallocateE7int64_t7int64_tPP7uint8_t">
+<span id="_CPPv3N5arrow10MemoryPool10ReallocateE7int64_t7int64_tPP7uint8_t"></span><span id="_CPPv2N5arrow10MemoryPool10ReallocateE7int64_t7int64_tPP7uint8_t"></span><span id="arrow::MemoryPool::Reallocate__int64_t.int64_t.uint8_tPP"></span><span class="target" id="classarrow_1_1_memory_pool_1af64bda5eccc8fa42ce9ae0aba1ad9077"></span><em class="property">virtual</em> <a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status">Status</a> <code class="desc [...]
<dd><p>Resize an already allocated memory section. </p>
<p>As by default most default allocators on a platform don’t support aligned reallocation, this function can involve a copy of the underlying data. </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3N5arrow10MemoryPool4FreeEP7uint8_t7int64_t">
-<span id="_CPPv2N5arrow10MemoryPool4FreeEP7uint8_t7int64_t"></span><span id="arrow::MemoryPool::Free__uint8_tP.int64_t"></span><span class="target" id="classarrow_1_1_memory_pool_1a5a45c822a4ca7b3d8387501acfa69911"></span><em class="property">virtual</em> void <code class="descname">Free</code><span class="sig-paren">(</span>uint8_t *<em>buffer</em>, int64_t <em>size</em><span class="sig-paren">)</span> = 0<a class="headerlink" href="#_CPPv3N5arrow10MemoryPool4FreeEP7uint8_t7int64_t" tit [...]
+<dt id="_CPPv4N5arrow10MemoryPool4FreeEP7uint8_t7int64_t">
+<span id="_CPPv3N5arrow10MemoryPool4FreeEP7uint8_t7int64_t"></span><span id="_CPPv2N5arrow10MemoryPool4FreeEP7uint8_t7int64_t"></span><span id="arrow::MemoryPool::Free__uint8_tP.int64_t"></span><span class="target" id="classarrow_1_1_memory_pool_1a5a45c822a4ca7b3d8387501acfa69911"></span><em class="property">virtual</em> void <code class="descname">Free</code><span class="sig-paren">(</span>uint8_t *<em>buffer</em>, int64_t <em>size</em><span class="sig-paren">)</span> = 0<a class="heade [...]
<dd><p>Free an allocated region. </p>
<p><dl class="docutils">
<dt><strong>Parameters</strong></dt>
@@ -495,14 +504,14 @@
</dd></dl>
<dl class="function">
-<dt id="_CPPv3NK5arrow10MemoryPool15bytes_allocatedEv">
-<span id="_CPPv2NK5arrow10MemoryPool15bytes_allocatedEv"></span><span id="arrow::MemoryPool::bytes_allocatedC"></span><span class="target" id="classarrow_1_1_memory_pool_1abd12cd4bfb8ce8afcfc7a25d0293cd85"></span><em class="property">virtual</em> int64_t <code class="descname">bytes_allocated</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em> = 0<a class="headerlink" href="#_CPPv3NK5arrow10MemoryPool15bytes_allocatedEv" title="Permalink [...]
+<dt id="_CPPv4NK5arrow10MemoryPool15bytes_allocatedEv">
+<span id="_CPPv3NK5arrow10MemoryPool15bytes_allocatedEv"></span><span id="_CPPv2NK5arrow10MemoryPool15bytes_allocatedEv"></span><span id="arrow::MemoryPool::bytes_allocatedC"></span><span class="target" id="classarrow_1_1_memory_pool_1abd12cd4bfb8ce8afcfc7a25d0293cd85"></span><em class="property">virtual</em> int64_t <code class="descname">bytes_allocated</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em> = 0<a class="headerlink" href=" [...]
<dd><p>The number of bytes that were allocated and not yet free’d through this allocator. </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3NK5arrow10MemoryPool10max_memoryEv">
-<span id="_CPPv2NK5arrow10MemoryPool10max_memoryEv"></span><span id="arrow::MemoryPool::max_memoryC"></span><span class="target" id="classarrow_1_1_memory_pool_1a4d1fe541389b4afd4d49d727dc3088f0"></span><em class="property">virtual</em> int64_t <code class="descname">max_memory</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv3NK5arrow10MemoryPool10max_memoryEv" title="Permalink to this definition">¶</ [...]
+<dt id="_CPPv4NK5arrow10MemoryPool10max_memoryEv">
+<span id="_CPPv3NK5arrow10MemoryPool10max_memoryEv"></span><span id="_CPPv2NK5arrow10MemoryPool10max_memoryEv"></span><span id="arrow::MemoryPool::max_memoryC"></span><span class="target" id="classarrow_1_1_memory_pool_1a4d1fe541389b4afd4d49d727dc3088f0"></span><em class="property">virtual</em> int64_t <code class="descname">max_memory</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv4NK5arrow10MemoryP [...]
<dd><p>Return peak memory allocation in this memory pool. </p>
<p><dl class="docutils">
<dt><strong>Return</strong></dt>
@@ -515,8 +524,8 @@
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric">Public Static Functions</p>
<dl class="function">
-<dt id="_CPPv3N5arrow10MemoryPool13CreateDefaultEv">
-<span id="_CPPv2N5arrow10MemoryPool13CreateDefaultEv"></span><span id="arrow::MemoryPool::CreateDefault"></span><span class="target" id="classarrow_1_1_memory_pool_1a844c3276d2f14daf186ceb9585fe3581"></span><em class="property">static</em> std::unique_ptr<<a class="reference internal" href="#_CPPv3N5arrow10MemoryPoolE" title="arrow::MemoryPool">MemoryPool</a>> <code class="descname">CreateDefault</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="header [...]
+<dt id="_CPPv4N5arrow10MemoryPool13CreateDefaultEv">
+<span id="_CPPv3N5arrow10MemoryPool13CreateDefaultEv"></span><span id="_CPPv2N5arrow10MemoryPool13CreateDefaultEv"></span><span id="arrow::MemoryPool::CreateDefault"></span><span class="target" id="classarrow_1_1_memory_pool_1a844c3276d2f14daf186ceb9585fe3581"></span><em class="property">static</em> std::unique_ptr<<a class="reference internal" href="#_CPPv4N5arrow10MemoryPoolE" title="arrow::MemoryPool">MemoryPool</a>> <code class="descname">CreateDefault</code><span class="sig-pa [...]
<dd><p>EXPERIMENTAL. Create a new instance of the default <a class="reference internal" href="#classarrow_1_1_memory_pool"><span class="std std-ref">MemoryPool</span></a>. </p>
</dd></dl>
@@ -524,27 +533,27 @@
</dd></dl>
<dl class="class">
-<dt id="_CPPv3N5arrow17LoggingMemoryPoolE">
-<span id="_CPPv2N5arrow17LoggingMemoryPoolE"></span><span id="arrow::LoggingMemoryPool"></span><span class="target" id="classarrow_1_1_logging_memory_pool"></span><em class="property">class </em><code class="descname">LoggingMemoryPool</code> : <em class="property">public</em> arrow::<a class="reference internal" href="#_CPPv3N5arrow10MemoryPoolE" title="arrow::MemoryPool">MemoryPool</a><a class="headerlink" href="#_CPPv3N5arrow17LoggingMemoryPoolE" title="Permalink to this definition">¶ [...]
+<dt id="_CPPv4N5arrow17LoggingMemoryPoolE">
+<span id="_CPPv3N5arrow17LoggingMemoryPoolE"></span><span id="_CPPv2N5arrow17LoggingMemoryPoolE"></span><span id="arrow::LoggingMemoryPool"></span><span class="target" id="classarrow_1_1_logging_memory_pool"></span><em class="property">class </em><code class="descname">LoggingMemoryPool</code> : <em class="property">public</em> arrow::<a class="reference internal" href="#_CPPv4N5arrow10MemoryPoolE" title="arrow::MemoryPool">MemoryPool</a><a class="headerlink" href="#_CPPv4N5arrow17Loggin [...]
<dd><div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric">Public Functions</p>
<dl class="function">
-<dt id="_CPPv3N5arrow17LoggingMemoryPool8AllocateE7int64_tPP7uint8_t">
-<span id="_CPPv2N5arrow17LoggingMemoryPool8AllocateE7int64_tPP7uint8_t"></span><span id="arrow::LoggingMemoryPool::Allocate__int64_t.uint8_tPP"></span><span class="target" id="classarrow_1_1_logging_memory_pool_1a3eb03f4e10b9fbf1e06fd72d65b6601c"></span><a class="reference internal" href="support.html#_CPPv3N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descname">Allocate</code><span class="sig-paren">(</span>int64_t <em>size</em>, uint8_t **<em>out</em><span class="sig-p [...]
+<dt id="_CPPv4N5arrow17LoggingMemoryPool8AllocateE7int64_tPP7uint8_t">
+<span id="_CPPv3N5arrow17LoggingMemoryPool8AllocateE7int64_tPP7uint8_t"></span><span id="_CPPv2N5arrow17LoggingMemoryPool8AllocateE7int64_tPP7uint8_t"></span><span id="arrow::LoggingMemoryPool::Allocate__int64_t.uint8_tPP"></span><span class="target" id="classarrow_1_1_logging_memory_pool_1a3eb03f4e10b9fbf1e06fd72d65b6601c"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descname">Allocate</code><span class="sig [...]
<dd><p>Allocate a new memory region of at least size bytes. </p>
<p>The allocated region shall be 64-byte aligned. </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3N5arrow17LoggingMemoryPool10ReallocateE7int64_t7int64_tPP7uint8_t">
-<span id="_CPPv2N5arrow17LoggingMemoryPool10ReallocateE7int64_t7int64_tPP7uint8_t"></span><span id="arrow::LoggingMemoryPool::Reallocate__int64_t.int64_t.uint8_tPP"></span><span class="target" id="classarrow_1_1_logging_memory_pool_1a3e548a7bc1d434fa30fbe1e43be52a3b"></span><a class="reference internal" href="support.html#_CPPv3N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descname">Reallocate</code><span class="sig-paren">(</span>int64_t <em>old_size</em>, int64_t <em>n [...]
+<dt id="_CPPv4N5arrow17LoggingMemoryPool10ReallocateE7int64_t7int64_tPP7uint8_t">
+<span id="_CPPv3N5arrow17LoggingMemoryPool10ReallocateE7int64_t7int64_tPP7uint8_t"></span><span id="_CPPv2N5arrow17LoggingMemoryPool10ReallocateE7int64_t7int64_tPP7uint8_t"></span><span id="arrow::LoggingMemoryPool::Reallocate__int64_t.int64_t.uint8_tPP"></span><span class="target" id="classarrow_1_1_logging_memory_pool_1a3e548a7bc1d434fa30fbe1e43be52a3b"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descname" [...]
<dd><p>Resize an already allocated memory section. </p>
<p>As by default most default allocators on a platform don’t support aligned reallocation, this function can involve a copy of the underlying data. </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3N5arrow17LoggingMemoryPool4FreeEP7uint8_t7int64_t">
-<span id="_CPPv2N5arrow17LoggingMemoryPool4FreeEP7uint8_t7int64_t"></span><span id="arrow::LoggingMemoryPool::Free__uint8_tP.int64_t"></span><span class="target" id="classarrow_1_1_logging_memory_pool_1ac68ae6be2a6b8c2c44e0ad6d0c2b0cc8"></span>void <code class="descname">Free</code><span class="sig-paren">(</span>uint8_t *<em>buffer</em>, int64_t <em>size</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv3N5arrow17LoggingMemoryPool4FreeEP7uint8_t7int64_t" title="Perma [...]
+<dt id="_CPPv4N5arrow17LoggingMemoryPool4FreeEP7uint8_t7int64_t">
+<span id="_CPPv3N5arrow17LoggingMemoryPool4FreeEP7uint8_t7int64_t"></span><span id="_CPPv2N5arrow17LoggingMemoryPool4FreeEP7uint8_t7int64_t"></span><span id="arrow::LoggingMemoryPool::Free__uint8_tP.int64_t"></span><span class="target" id="classarrow_1_1_logging_memory_pool_1ac68ae6be2a6b8c2c44e0ad6d0c2b0cc8"></span>void <code class="descname">Free</code><span class="sig-paren">(</span>uint8_t *<em>buffer</em>, int64_t <em>size</em><span class="sig-paren">)</span><a class="headerlink" hr [...]
<dd><p>Free an allocated region. </p>
<p><dl class="docutils">
<dt><strong>Parameters</strong></dt>
@@ -558,14 +567,14 @@
</dd></dl>
<dl class="function">
-<dt id="_CPPv3NK5arrow17LoggingMemoryPool15bytes_allocatedEv">
-<span id="_CPPv2NK5arrow17LoggingMemoryPool15bytes_allocatedEv"></span><span id="arrow::LoggingMemoryPool::bytes_allocatedC"></span><span class="target" id="classarrow_1_1_logging_memory_pool_1aa5a4ee8ec0299fea7125d89dc8553a46"></span>int64_t <code class="descname">bytes_allocated</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv3NK5arrow17LoggingMemoryPool15bytes_allocatedEv" title="Permalink to this [...]
+<dt id="_CPPv4NK5arrow17LoggingMemoryPool15bytes_allocatedEv">
+<span id="_CPPv3NK5arrow17LoggingMemoryPool15bytes_allocatedEv"></span><span id="_CPPv2NK5arrow17LoggingMemoryPool15bytes_allocatedEv"></span><span id="arrow::LoggingMemoryPool::bytes_allocatedC"></span><span class="target" id="classarrow_1_1_logging_memory_pool_1aa5a4ee8ec0299fea7125d89dc8553a46"></span>int64_t <code class="descname">bytes_allocated</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv4NK [...]
<dd><p>The number of bytes that were allocated and not yet free’d through this allocator. </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3NK5arrow17LoggingMemoryPool10max_memoryEv">
-<span id="_CPPv2NK5arrow17LoggingMemoryPool10max_memoryEv"></span><span id="arrow::LoggingMemoryPool::max_memoryC"></span><span class="target" id="classarrow_1_1_logging_memory_pool_1af41a546412c98aa4439b53ec4df257bf"></span>int64_t <code class="descname">max_memory</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv3NK5arrow17LoggingMemoryPool10max_memoryEv" title="Permalink to this definition">¶</a><br [...]
+<dt id="_CPPv4NK5arrow17LoggingMemoryPool10max_memoryEv">
+<span id="_CPPv3NK5arrow17LoggingMemoryPool10max_memoryEv"></span><span id="_CPPv2NK5arrow17LoggingMemoryPool10max_memoryEv"></span><span id="arrow::LoggingMemoryPool::max_memoryC"></span><span class="target" id="classarrow_1_1_logging_memory_pool_1af41a546412c98aa4439b53ec4df257bf"></span>int64_t <code class="descname">max_memory</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv4NK5arrow17LoggingMemor [...]
<dd><p>Return peak memory allocation in this memory pool. </p>
<p><dl class="docutils">
<dt><strong>Return</strong></dt>
@@ -578,29 +587,29 @@
</dd></dl>
<dl class="class">
-<dt id="_CPPv3N5arrow15ProxyMemoryPoolE">
-<span id="_CPPv2N5arrow15ProxyMemoryPoolE"></span><span id="arrow::ProxyMemoryPool"></span><span class="target" id="classarrow_1_1_proxy_memory_pool"></span><em class="property">class </em><code class="descname">ProxyMemoryPool</code> : <em class="property">public</em> arrow::<a class="reference internal" href="#_CPPv3N5arrow10MemoryPoolE" title="arrow::MemoryPool">MemoryPool</a><a class="headerlink" href="#_CPPv3N5arrow15ProxyMemoryPoolE" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4N5arrow15ProxyMemoryPoolE">
+<span id="_CPPv3N5arrow15ProxyMemoryPoolE"></span><span id="_CPPv2N5arrow15ProxyMemoryPoolE"></span><span id="arrow::ProxyMemoryPool"></span><span class="target" id="classarrow_1_1_proxy_memory_pool"></span><em class="property">class </em><code class="descname">ProxyMemoryPool</code> : <em class="property">public</em> arrow::<a class="reference internal" href="#_CPPv4N5arrow10MemoryPoolE" title="arrow::MemoryPool">MemoryPool</a><a class="headerlink" href="#_CPPv4N5arrow15ProxyMemoryPoolE [...]
<dd><p>Derived class for memory allocation. </p>
<p>Tracks the number of bytes and maximum memory allocated through its direct calls. Actual allocation is delegated to <a class="reference internal" href="#classarrow_1_1_memory_pool"><span class="std std-ref">MemoryPool</span></a> class. </p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric">Public Functions</p>
<dl class="function">
-<dt id="_CPPv3N5arrow15ProxyMemoryPool8AllocateE7int64_tPP7uint8_t">
-<span id="_CPPv2N5arrow15ProxyMemoryPool8AllocateE7int64_tPP7uint8_t"></span><span id="arrow::ProxyMemoryPool::Allocate__int64_t.uint8_tPP"></span><span class="target" id="classarrow_1_1_proxy_memory_pool_1a335a8650da63a1ebf8ecbdf692e512b5"></span><a class="reference internal" href="support.html#_CPPv3N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descname">Allocate</code><span class="sig-paren">(</span>int64_t <em>size</em>, uint8_t **<em>out</em><span class="sig-paren"> [...]
+<dt id="_CPPv4N5arrow15ProxyMemoryPool8AllocateE7int64_tPP7uint8_t">
+<span id="_CPPv3N5arrow15ProxyMemoryPool8AllocateE7int64_tPP7uint8_t"></span><span id="_CPPv2N5arrow15ProxyMemoryPool8AllocateE7int64_tPP7uint8_t"></span><span id="arrow::ProxyMemoryPool::Allocate__int64_t.uint8_tPP"></span><span class="target" id="classarrow_1_1_proxy_memory_pool_1a335a8650da63a1ebf8ecbdf692e512b5"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descname">Allocate</code><span class="sig-paren"> [...]
<dd><p>Allocate a new memory region of at least size bytes. </p>
<p>The allocated region shall be 64-byte aligned. </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3N5arrow15ProxyMemoryPool10ReallocateE7int64_t7int64_tPP7uint8_t">
-<span id="_CPPv2N5arrow15ProxyMemoryPool10ReallocateE7int64_t7int64_tPP7uint8_t"></span><span id="arrow::ProxyMemoryPool::Reallocate__int64_t.int64_t.uint8_tPP"></span><span class="target" id="classarrow_1_1_proxy_memory_pool_1a6e21a87edb6fac307950ba03900ea5cc"></span><a class="reference internal" href="support.html#_CPPv3N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descname">Reallocate</code><span class="sig-paren">(</span>int64_t <em>old_size</em>, int64_t <em>new_siz [...]
+<dt id="_CPPv4N5arrow15ProxyMemoryPool10ReallocateE7int64_t7int64_tPP7uint8_t">
+<span id="_CPPv3N5arrow15ProxyMemoryPool10ReallocateE7int64_t7int64_tPP7uint8_t"></span><span id="_CPPv2N5arrow15ProxyMemoryPool10ReallocateE7int64_t7int64_tPP7uint8_t"></span><span id="arrow::ProxyMemoryPool::Reallocate__int64_t.int64_t.uint8_tPP"></span><span class="target" id="classarrow_1_1_proxy_memory_pool_1a6e21a87edb6fac307950ba03900ea5cc"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descname">Realloc [...]
<dd><p>Resize an already allocated memory section. </p>
<p>As by default most default allocators on a platform don’t support aligned reallocation, this function can involve a copy of the underlying data. </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3N5arrow15ProxyMemoryPool4FreeEP7uint8_t7int64_t">
-<span id="_CPPv2N5arrow15ProxyMemoryPool4FreeEP7uint8_t7int64_t"></span><span id="arrow::ProxyMemoryPool::Free__uint8_tP.int64_t"></span><span class="target" id="classarrow_1_1_proxy_memory_pool_1ac93a0a8e3f1c5274ecee4d59499a6888"></span>void <code class="descname">Free</code><span class="sig-paren">(</span>uint8_t *<em>buffer</em>, int64_t <em>size</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv3N5arrow15ProxyMemoryPool4FreeEP7uint8_t7int64_t" title="Permalink to [...]
+<dt id="_CPPv4N5arrow15ProxyMemoryPool4FreeEP7uint8_t7int64_t">
+<span id="_CPPv3N5arrow15ProxyMemoryPool4FreeEP7uint8_t7int64_t"></span><span id="_CPPv2N5arrow15ProxyMemoryPool4FreeEP7uint8_t7int64_t"></span><span id="arrow::ProxyMemoryPool::Free__uint8_tP.int64_t"></span><span class="target" id="classarrow_1_1_proxy_memory_pool_1ac93a0a8e3f1c5274ecee4d59499a6888"></span>void <code class="descname">Free</code><span class="sig-paren">(</span>uint8_t *<em>buffer</em>, int64_t <em>size</em><span class="sig-paren">)</span><a class="headerlink" href="#_CP [...]
<dd><p>Free an allocated region. </p>
<p><dl class="docutils">
<dt><strong>Parameters</strong></dt>
@@ -614,14 +623,14 @@
</dd></dl>
<dl class="function">
-<dt id="_CPPv3NK5arrow15ProxyMemoryPool15bytes_allocatedEv">
-<span id="_CPPv2NK5arrow15ProxyMemoryPool15bytes_allocatedEv"></span><span id="arrow::ProxyMemoryPool::bytes_allocatedC"></span><span class="target" id="classarrow_1_1_proxy_memory_pool_1ae067aaf2cbe1dd6ea54ec01d835131cc"></span>int64_t <code class="descname">bytes_allocated</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv3NK5arrow15ProxyMemoryPool15bytes_allocatedEv" title="Permalink to this definiti [...]
+<dt id="_CPPv4NK5arrow15ProxyMemoryPool15bytes_allocatedEv">
+<span id="_CPPv3NK5arrow15ProxyMemoryPool15bytes_allocatedEv"></span><span id="_CPPv2NK5arrow15ProxyMemoryPool15bytes_allocatedEv"></span><span id="arrow::ProxyMemoryPool::bytes_allocatedC"></span><span class="target" id="classarrow_1_1_proxy_memory_pool_1ae067aaf2cbe1dd6ea54ec01d835131cc"></span>int64_t <code class="descname">bytes_allocated</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv4NK5arrow15 [...]
<dd><p>The number of bytes that were allocated and not yet free’d through this allocator. </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3NK5arrow15ProxyMemoryPool10max_memoryEv">
-<span id="_CPPv2NK5arrow15ProxyMemoryPool10max_memoryEv"></span><span id="arrow::ProxyMemoryPool::max_memoryC"></span><span class="target" id="classarrow_1_1_proxy_memory_pool_1a0369b487efeb564ff40ed1101d86e8ad"></span>int64_t <code class="descname">max_memory</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv3NK5arrow15ProxyMemoryPool10max_memoryEv" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4NK5arrow15ProxyMemoryPool10max_memoryEv">
+<span id="_CPPv3NK5arrow15ProxyMemoryPool10max_memoryEv"></span><span id="_CPPv2NK5arrow15ProxyMemoryPool10max_memoryEv"></span><span id="arrow::ProxyMemoryPool::max_memoryC"></span><span class="target" id="classarrow_1_1_proxy_memory_pool_1a0369b487efeb564ff40ed1101d86e8ad"></span>int64_t <code class="descname">max_memory</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv4NK5arrow15ProxyMemoryPool10max [...]
<dd><p>Return peak memory allocation in this memory pool. </p>
<p><dl class="docutils">
<dt><strong>Return</strong></dt>
@@ -638,8 +647,8 @@
<h2>Allocation Functions<a class="headerlink" href="#allocation-functions" title="Permalink to this headline">¶</a></h2>
<p>These functions allocate a buffer from a particular memory pool.</p>
<dl class="function">
-<dt id="_CPPv3N5arrow14AllocateBufferEP10MemoryPoolK7int64_tPNSt10shared_ptrI6BufferEE">
-<span id="_CPPv2N5arrow14AllocateBufferEP10MemoryPoolK7int64_tPNSt10shared_ptrI6BufferEE"></span><span id="arrow::AllocateBuffer__MemoryPoolP.int64_tC.std::shared_ptr:Buffer:P"></span><span class="target" id="group__buffer-allocation-functions_1gaff11ee23eb038410107ea5246f2fb330"></span><a class="reference internal" href="support.html#_CPPv3N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descclassname">arrow<code class="descclassname">::</code></code><code class="descname" [...]
+<dt id="_CPPv4N5arrow14AllocateBufferEP10MemoryPoolK7int64_tPNSt10shared_ptrI6BufferEE">
+<span id="_CPPv3N5arrow14AllocateBufferEP10MemoryPoolK7int64_tPNSt10shared_ptrI6BufferEE"></span><span id="_CPPv2N5arrow14AllocateBufferEP10MemoryPoolK7int64_tPNSt10shared_ptrI6BufferEE"></span><span id="arrow::AllocateBuffer__MemoryPoolP.int64_tC.std::shared_ptr:Buffer:P"></span><span class="target" id="group__buffer-allocation-functions_1gaff11ee23eb038410107ea5246f2fb330"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status">Status</a> <c [...]
<dd><p>Allocate a fixed size mutable buffer from a memory pool, zero its padding. </p>
<p><dl class="docutils">
<dt><strong>Return</strong></dt>
@@ -656,8 +665,8 @@
</dd></dl>
<dl class="function">
-<dt id="_CPPv3N5arrow14AllocateBufferEP10MemoryPoolK7int64_tPNSt10unique_ptrI6BufferEE">
-<span id="_CPPv2N5arrow14AllocateBufferEP10MemoryPoolK7int64_tPNSt10unique_ptrI6BufferEE"></span><span id="arrow::AllocateBuffer__MemoryPoolP.int64_tC.std::unique_ptr:Buffer:P"></span><span class="target" id="group__buffer-allocation-functions_1gad9698aacbd4ac435cc0cb676e2cb1fe0"></span><a class="reference internal" href="support.html#_CPPv3N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descclassname">arrow<code class="descclassname">::</code></code><code class="descname" [...]
+<dt id="_CPPv4N5arrow14AllocateBufferEP10MemoryPoolK7int64_tPNSt10unique_ptrI6BufferEE">
+<span id="_CPPv3N5arrow14AllocateBufferEP10MemoryPoolK7int64_tPNSt10unique_ptrI6BufferEE"></span><span id="_CPPv2N5arrow14AllocateBufferEP10MemoryPoolK7int64_tPNSt10unique_ptrI6BufferEE"></span><span id="arrow::AllocateBuffer__MemoryPoolP.int64_tC.std::unique_ptr:Buffer:P"></span><span class="target" id="group__buffer-allocation-functions_1gad9698aacbd4ac435cc0cb676e2cb1fe0"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status">Status</a> <c [...]
<dd><p>Allocate a fixed size mutable buffer from a memory pool, zero its padding. </p>
<p><dl class="docutils">
<dt><strong>Return</strong></dt>
@@ -674,8 +683,8 @@
</dd></dl>
<dl class="function">
-<dt id="_CPPv3N5arrow14AllocateBufferEK7int64_tPNSt10shared_ptrI6BufferEE">
-<span id="_CPPv2N5arrow14AllocateBufferEK7int64_tPNSt10shared_ptrI6BufferEE"></span><span id="arrow::AllocateBuffer__int64_tC.std::shared_ptr:Buffer:P"></span><span class="target" id="group__buffer-allocation-functions_1gae4d3ff86145cc77724a56967ea8a3f5f"></span><a class="reference internal" href="support.html#_CPPv3N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descclassname">arrow<code class="descclassname">::</code></code><code class="descname">AllocateBuffer</code><sp [...]
+<dt id="_CPPv4N5arrow14AllocateBufferEK7int64_tPNSt10shared_ptrI6BufferEE">
+<span id="_CPPv3N5arrow14AllocateBufferEK7int64_tPNSt10shared_ptrI6BufferEE"></span><span id="_CPPv2N5arrow14AllocateBufferEK7int64_tPNSt10shared_ptrI6BufferEE"></span><span id="arrow::AllocateBuffer__int64_tC.std::shared_ptr:Buffer:P"></span><span class="target" id="group__buffer-allocation-functions_1gae4d3ff86145cc77724a56967ea8a3f5f"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descclassname">arrow<code c [...]
<dd><p>Allocate a fixed-size mutable buffer from the default memory pool. </p>
<p><dl class="docutils">
<dt><strong>Return</strong></dt>
@@ -691,8 +700,8 @@
</dd></dl>
<dl class="function">
-<dt id="_CPPv3N5arrow14AllocateBufferEK7int64_tPNSt10unique_ptrI6BufferEE">
-<span id="_CPPv2N5arrow14AllocateBufferEK7int64_tPNSt10unique_ptrI6BufferEE"></span><span id="arrow::AllocateBuffer__int64_tC.std::unique_ptr:Buffer:P"></span><span class="target" id="group__buffer-allocation-functions_1ga06f0e830cd9d1892b243dda5cc66429a"></span><a class="reference internal" href="support.html#_CPPv3N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descclassname">arrow<code class="descclassname">::</code></code><code class="descname">AllocateBuffer</code><sp [...]
+<dt id="_CPPv4N5arrow14AllocateBufferEK7int64_tPNSt10unique_ptrI6BufferEE">
+<span id="_CPPv3N5arrow14AllocateBufferEK7int64_tPNSt10unique_ptrI6BufferEE"></span><span id="_CPPv2N5arrow14AllocateBufferEK7int64_tPNSt10unique_ptrI6BufferEE"></span><span id="arrow::AllocateBuffer__int64_tC.std::unique_ptr:Buffer:P"></span><span class="target" id="group__buffer-allocation-functions_1ga06f0e830cd9d1892b243dda5cc66429a"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descclassname">arrow<code c [...]
<dd><p>Allocate a fixed-size mutable buffer from the default memory pool. </p>
<p><dl class="docutils">
<dt><strong>Return</strong></dt>
@@ -708,8 +717,8 @@
</dd></dl>
<dl class="function">
-<dt id="_CPPv3N5arrow23AllocateResizableBufferEP10MemoryPoolK7int64_tPNSt10shared_ptrI15ResizableBufferEE">
-<span id="_CPPv2N5arrow23AllocateResizableBufferEP10MemoryPoolK7int64_tPNSt10shared_ptrI15ResizableBufferEE"></span><span id="arrow::AllocateResizableBuffer__MemoryPoolP.int64_tC.std::shared_ptr:ResizableBuffer:P"></span><span class="target" id="group__buffer-allocation-functions_1ga9c3ce000978a518fad942be4a54e9870"></span><a class="reference internal" href="support.html#_CPPv3N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descclassname">arrow<code class="descclassname">: [...]
+<dt id="_CPPv4N5arrow23AllocateResizableBufferEP10MemoryPoolK7int64_tPNSt10shared_ptrI15ResizableBufferEE">
+<span id="_CPPv3N5arrow23AllocateResizableBufferEP10MemoryPoolK7int64_tPNSt10shared_ptrI15ResizableBufferEE"></span><span id="_CPPv2N5arrow23AllocateResizableBufferEP10MemoryPoolK7int64_tPNSt10shared_ptrI15ResizableBufferEE"></span><span id="arrow::AllocateResizableBuffer__MemoryPoolP.int64_tC.std::shared_ptr:ResizableBuffer:P"></span><span class="target" id="group__buffer-allocation-functions_1ga9c3ce000978a518fad942be4a54e9870"></span><a class="reference internal" href="support.html#_C [...]
<dd><p>Allocate a resizeable buffer from a memory pool, zero its padding. </p>
<p><dl class="docutils">
<dt><strong>Return</strong></dt>
@@ -726,8 +735,8 @@
</dd></dl>
<dl class="function">
-<dt id="_CPPv3N5arrow23AllocateResizableBufferEP10MemoryPoolK7int64_tPNSt10unique_ptrI15ResizableBufferEE">
-<span id="_CPPv2N5arrow23AllocateResizableBufferEP10MemoryPoolK7int64_tPNSt10unique_ptrI15ResizableBufferEE"></span><span id="arrow::AllocateResizableBuffer__MemoryPoolP.int64_tC.std::unique_ptr:ResizableBuffer:P"></span><span class="target" id="group__buffer-allocation-functions_1ga2fdac7fee8638d46c79b8136aa38c956"></span><a class="reference internal" href="support.html#_CPPv3N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descclassname">arrow<code class="descclassname">: [...]
+<dt id="_CPPv4N5arrow23AllocateResizableBufferEP10MemoryPoolK7int64_tPNSt10unique_ptrI15ResizableBufferEE">
+<span id="_CPPv3N5arrow23AllocateResizableBufferEP10MemoryPoolK7int64_tPNSt10unique_ptrI15ResizableBufferEE"></span><span id="_CPPv2N5arrow23AllocateResizableBufferEP10MemoryPoolK7int64_tPNSt10unique_ptrI15ResizableBufferEE"></span><span id="arrow::AllocateResizableBuffer__MemoryPoolP.int64_tC.std::unique_ptr:ResizableBuffer:P"></span><span class="target" id="group__buffer-allocation-functions_1ga2fdac7fee8638d46c79b8136aa38c956"></span><a class="reference internal" href="support.html#_C [...]
<dd><p>Allocate a resizeable buffer from a memory pool, zero its padding. </p>
<p><dl class="docutils">
<dt><strong>Return</strong></dt>
@@ -744,8 +753,8 @@
</dd></dl>
<dl class="function">
-<dt id="_CPPv3N5arrow23AllocateResizableBufferEK7int64_tPNSt10shared_ptrI15ResizableBufferEE">
-<span id="_CPPv2N5arrow23AllocateResizableBufferEK7int64_tPNSt10shared_ptrI15ResizableBufferEE"></span><span id="arrow::AllocateResizableBuffer__int64_tC.std::shared_ptr:ResizableBuffer:P"></span><span class="target" id="group__buffer-allocation-functions_1gaa80acc74f413afe7f8ed46cde85a5a80"></span><a class="reference internal" href="support.html#_CPPv3N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descclassname">arrow<code class="descclassname">::</code></code><code clas [...]
+<dt id="_CPPv4N5arrow23AllocateResizableBufferEK7int64_tPNSt10shared_ptrI15ResizableBufferEE">
+<span id="_CPPv3N5arrow23AllocateResizableBufferEK7int64_tPNSt10shared_ptrI15ResizableBufferEE"></span><span id="_CPPv2N5arrow23AllocateResizableBufferEK7int64_tPNSt10shared_ptrI15ResizableBufferEE"></span><span id="arrow::AllocateResizableBuffer__int64_tC.std::shared_ptr:ResizableBuffer:P"></span><span class="target" id="group__buffer-allocation-functions_1gaa80acc74f413afe7f8ed46cde85a5a80"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Sta [...]
<dd><p>Allocate a resizeable buffer from the default memory pool. </p>
<p><dl class="docutils">
<dt><strong>Return</strong></dt>
@@ -761,8 +770,8 @@
</dd></dl>
<dl class="function">
-<dt id="_CPPv3N5arrow23AllocateResizableBufferEK7int64_tPNSt10unique_ptrI15ResizableBufferEE">
-<span id="_CPPv2N5arrow23AllocateResizableBufferEK7int64_tPNSt10unique_ptrI15ResizableBufferEE"></span><span id="arrow::AllocateResizableBuffer__int64_tC.std::unique_ptr:ResizableBuffer:P"></span><span class="target" id="group__buffer-allocation-functions_1ga6eb313aa6e6d83310dcc2a951875b9d2"></span><a class="reference internal" href="support.html#_CPPv3N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descclassname">arrow<code class="descclassname">::</code></code><code clas [...]
+<dt id="_CPPv4N5arrow23AllocateResizableBufferEK7int64_tPNSt10unique_ptrI15ResizableBufferEE">
+<span id="_CPPv3N5arrow23AllocateResizableBufferEK7int64_tPNSt10unique_ptrI15ResizableBufferEE"></span><span id="_CPPv2N5arrow23AllocateResizableBufferEK7int64_tPNSt10unique_ptrI15ResizableBufferEE"></span><span id="arrow::AllocateResizableBuffer__int64_tC.std::unique_ptr:ResizableBuffer:P"></span><span class="target" id="group__buffer-allocation-functions_1ga6eb313aa6e6d83310dcc2a951875b9d2"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Sta [...]
<dd><p>Allocate a resizeable buffer from the default memory pool. </p>
<p><dl class="docutils">
<dt><strong>Return</strong></dt>
@@ -778,9 +787,9 @@
</dd></dl>
<dl class="function">
-<dt id="_CPPv3N5arrow19AllocateEmptyBitmapEP10MemoryPool7int64_tPNSt10shared_ptrI6BufferEE">
-<span id="_CPPv2N5arrow19AllocateEmptyBitmapEP10MemoryPool7int64_tPNSt10shared_ptrI6BufferEE"></span><span id="arrow::AllocateEmptyBitmap__MemoryPoolP.int64_t.std::shared_ptr:Buffer:P"></span><span class="target" id="group__buffer-allocation-functions_1ga79907066edd38d36e95c56673aa46a3b"></span><a class="reference internal" href="support.html#_CPPv3N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descclassname">arrow<code class="descclassname">::</code></code><code class="d [...]
-<dd><p>Allocate a zero-initialized bitmap buffer from a memory pool. </p>
+<dt id="_CPPv4N5arrow14AllocateBitmapEP10MemoryPool7int64_tPNSt10shared_ptrI6BufferEE">
+<span id="_CPPv3N5arrow14AllocateBitmapEP10MemoryPool7int64_tPNSt10shared_ptrI6BufferEE"></span><span id="_CPPv2N5arrow14AllocateBitmapEP10MemoryPool7int64_tPNSt10shared_ptrI6BufferEE"></span><span id="arrow::AllocateBitmap__MemoryPoolP.int64_t.std::shared_ptr:Buffer:P"></span><span class="target" id="group__buffer-allocation-functions_1ga93c20471c43a7a35eaabf2506d5b533e"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status">Status</a> <code [...]
+<dd><p>Allocate a bitmap buffer from a memory pool no guarantee on values is provided. </p>
<p><dl class="docutils">
<dt><strong>Return</strong></dt>
<dd><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a> message </dd>
@@ -796,8 +805,26 @@
</dd></dl>
<dl class="function">
-<dt id="_CPPv3N5arrow19AllocateEmptyBitmapE7int64_tPNSt10shared_ptrI6BufferEE">
-<span id="_CPPv2N5arrow19AllocateEmptyBitmapE7int64_tPNSt10shared_ptrI6BufferEE"></span><span id="arrow::AllocateEmptyBitmap__int64_t.std::shared_ptr:Buffer:P"></span><span class="target" id="group__buffer-allocation-functions_1ga2c62ce65a76507d648998fc260e5ead1"></span><a class="reference internal" href="support.html#_CPPv3N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descclassname">arrow<code class="descclassname">::</code></code><code class="descname">AllocateEmptyBit [...]
+<dt id="_CPPv4N5arrow19AllocateEmptyBitmapEP10MemoryPool7int64_tPNSt10shared_ptrI6BufferEE">
+<span id="_CPPv3N5arrow19AllocateEmptyBitmapEP10MemoryPool7int64_tPNSt10shared_ptrI6BufferEE"></span><span id="_CPPv2N5arrow19AllocateEmptyBitmapEP10MemoryPool7int64_tPNSt10shared_ptrI6BufferEE"></span><span id="arrow::AllocateEmptyBitmap__MemoryPoolP.int64_t.std::shared_ptr:Buffer:P"></span><span class="target" id="group__buffer-allocation-functions_1ga79907066edd38d36e95c56673aa46a3b"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status">S [...]
+<dd><p>Allocate a zero-initialized bitmap buffer from a memory pool. </p>
+<p><dl class="docutils">
+<dt><strong>Return</strong></dt>
+<dd><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a> message </dd>
+<dt><strong>Parameters</strong></dt>
+<dd><ul class="breatheparameterlist first last simple">
+<li><code class="docutils literal notranslate"><span class="pre">pool</span></code>: memory pool to allocate memory from </li>
+<li><code class="docutils literal notranslate"><span class="pre">length</span></code>: size in bits of bitmap to allocate </li>
+<li><code class="docutils literal notranslate"><span class="pre">out</span></code>: the resulting buffer (zero-initialized).</li>
+</ul>
+</dd>
+</dl>
+</p>
+</dd></dl>
+
+<dl class="function">
+<dt id="_CPPv4N5arrow19AllocateEmptyBitmapE7int64_tPNSt10shared_ptrI6BufferEE">
+<span id="_CPPv3N5arrow19AllocateEmptyBitmapE7int64_tPNSt10shared_ptrI6BufferEE"></span><span id="_CPPv2N5arrow19AllocateEmptyBitmapE7int64_tPNSt10shared_ptrI6BufferEE"></span><span id="arrow::AllocateEmptyBitmap__int64_t.std::shared_ptr:Buffer:P"></span><span class="target" id="group__buffer-allocation-functions_1ga2c62ce65a76507d648998fc260e5ead1"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descclassname"> [...]
<dd><p>Allocate a zero-initialized bitmap buffer from the default memory pool. </p>
<p><dl class="docutils">
<dt><strong>Return</strong></dt>
@@ -812,26 +839,44 @@
</p>
</dd></dl>
+<dl class="function">
+<dt id="_CPPv4N5arrow18ConcatenateBuffersERK12BufferVectorP10MemoryPoolPNSt10shared_ptrI6BufferEE">
+<span id="_CPPv3N5arrow18ConcatenateBuffersERK12BufferVectorP10MemoryPoolPNSt10shared_ptrI6BufferEE"></span><span id="_CPPv2N5arrow18ConcatenateBuffersERK12BufferVectorP10MemoryPoolPNSt10shared_ptrI6BufferEE"></span><span id="arrow::ConcatenateBuffers__BufferVectorCR.MemoryPoolP.std::shared_ptr:Buffer:P"></span><span class="target" id="group__buffer-allocation-functions_1ga193a7618d4456e8d4f40d305c8d683f1"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" tit [...]
+<dd><p>Concatenate multiple buffers into a single buffer. </p>
+<p><dl class="docutils">
+<dt><strong>Return</strong></dt>
+<dd><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a> </dd>
+<dt><strong>Parameters</strong></dt>
+<dd><ul class="breatheparameterlist first last simple">
+<li><code class="docutils literal notranslate"><span class="pre">buffers</span></code>: to be concatenated </li>
+<li><code class="docutils literal notranslate"><span class="pre">pool</span></code>: memory pool to allocate the new buffer from </li>
+<li><code class="docutils literal notranslate"><span class="pre">out</span></code>: the concatenated buffer</li>
+</ul>
+</dd>
+</dl>
+</p>
+</dd></dl>
+
</div>
<div class="section" id="slicing">
<h2>Slicing<a class="headerlink" href="#slicing" title="Permalink to this headline">¶</a></h2>
<dl class="function">
-<dt id="_CPPv3N5arrow11SliceBufferERKNSt10shared_ptrI6BufferEEK7int64_tK7int64_t">
-<span id="_CPPv2N5arrow11SliceBufferERKNSt10shared_ptrI6BufferEEK7int64_tK7int64_t"></span><span id="arrow::SliceBuffer__std::shared_ptr:Buffer:CR.int64_tC.int64_tC"></span><span class="target" id="group__buffer-slicing-functions_1ga23386d14ecaa97d5c1c93b53676c34e2"></span><em class="property">static</em> std::shared_ptr<<a class="reference internal" href="#_CPPv3N5arrow6BufferE" title="arrow::Buffer">Buffer</a>> <code class="descclassname">arrow<code class="descclassname">::</code [...]
+<dt id="_CPPv4N5arrow11SliceBufferERKNSt10shared_ptrI6BufferEEK7int64_tK7int64_t">
+<span id="_CPPv3N5arrow11SliceBufferERKNSt10shared_ptrI6BufferEEK7int64_tK7int64_t"></span><span id="_CPPv2N5arrow11SliceBufferERKNSt10shared_ptrI6BufferEEK7int64_tK7int64_t"></span><span id="arrow::SliceBuffer__std::shared_ptr:Buffer:CR.int64_tC.int64_tC"></span><span class="target" id="group__buffer-slicing-functions_1ga23386d14ecaa97d5c1c93b53676c34e2"></span><em class="property">static</em> std::shared_ptr<<a class="reference internal" href="#_CPPv4N5arrow6BufferE" title="arrow::B [...]
<dd><p>Construct a view on a buffer at the given offset and length. </p>
<p>This function cannot fail and does not check for errors (except in debug builds) </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3N5arrow11SliceBufferERKNSt10shared_ptrI6BufferEEK7int64_t">
-<span id="_CPPv2N5arrow11SliceBufferERKNSt10shared_ptrI6BufferEEK7int64_t"></span><span id="arrow::SliceBuffer__std::shared_ptr:Buffer:CR.int64_tC"></span><span class="target" id="group__buffer-slicing-functions_1gab051c8518e0c9881042fdf8cf1416cbe"></span><em class="property">static</em> std::shared_ptr<<a class="reference internal" href="#_CPPv3N5arrow6BufferE" title="arrow::Buffer">Buffer</a>> <code class="descclassname">arrow<code class="descclassname">::</code></code><code clas [...]
+<dt id="_CPPv4N5arrow11SliceBufferERKNSt10shared_ptrI6BufferEEK7int64_t">
+<span id="_CPPv3N5arrow11SliceBufferERKNSt10shared_ptrI6BufferEEK7int64_t"></span><span id="_CPPv2N5arrow11SliceBufferERKNSt10shared_ptrI6BufferEEK7int64_t"></span><span id="arrow::SliceBuffer__std::shared_ptr:Buffer:CR.int64_tC"></span><span class="target" id="group__buffer-slicing-functions_1gab051c8518e0c9881042fdf8cf1416cbe"></span><em class="property">static</em> std::shared_ptr<<a class="reference internal" href="#_CPPv4N5arrow6BufferE" title="arrow::Buffer">Buffer</a>> <code [...]
<dd><p>Construct a view on a buffer at the given offset, up to the buffer’s end. </p>
<p>This function cannot fail and does not check for errors (except in debug builds) </p>
</dd></dl>
<dl class="function">
-<dt id="_CPPv3N5arrow18SliceMutableBufferERKNSt10shared_ptrI6BufferEEK7int64_tK7int64_t">
-<span id="_CPPv2N5arrow18SliceMutableBufferERKNSt10shared_ptrI6BufferEEK7int64_tK7int64_t"></span><span id="arrow::SliceMutableBuffer__std::shared_ptr:Buffer:CR.int64_tC.int64_tC"></span><span class="target" id="group__buffer-slicing-functions_1ga44c8f98a2874248eb7d5658ccee5718e"></span>std::shared_ptr<<a class="reference internal" href="#_CPPv3N5arrow6BufferE" title="arrow::Buffer">Buffer</a>> <code class="descclassname">arrow<code class="descclassname">::</code></code><code class [...]
+<dt id="_CPPv4N5arrow18SliceMutableBufferERKNSt10shared_ptrI6BufferEEK7int64_tK7int64_t">
+<span id="_CPPv3N5arrow18SliceMutableBufferERKNSt10shared_ptrI6BufferEEK7int64_tK7int64_t"></span><span id="_CPPv2N5arrow18SliceMutableBufferERKNSt10shared_ptrI6BufferEEK7int64_tK7int64_t"></span><span id="arrow::SliceMutableBuffer__std::shared_ptr:Buffer:CR.int64_tC.int64_tC"></span><span class="target" id="group__buffer-slicing-functions_1ga44c8f98a2874248eb7d5658ccee5718e"></span>std::shared_ptr<<a class="reference internal" href="#_CPPv4N5arrow6BufferE" title="arrow::Buffer">Buffe [...]
<dd><p>Like SliceBuffer, but construct a mutable buffer slice. </p>
<p>If the parent buffer is not mutable, behavior is undefined (it may abort in debug builds). </p>
</dd></dl>
@@ -840,22 +885,21 @@
<div class="section" id="buffer-builders">
<h2>Buffer Builders<a class="headerlink" href="#buffer-builders" title="Permalink to this headline">¶</a></h2>
<dl class="class">
-<dt id="_CPPv3N5arrow13BufferBuilderE">
-<span id="_CPPv2N5arrow13BufferBuilderE"></span><span id="arrow::BufferBuilder"></span><span class="target" id="classarrow_1_1_buffer_builder"></span><em class="property">class </em><code class="descname">BufferBuilder</code><a class="headerlink" href="#_CPPv3N5arrow13BufferBuilderE" title="Permalink to this definition">¶</a><br /></dt>
+<dt id="_CPPv4N5arrow13BufferBuilderE">
+<span id="_CPPv3N5arrow13BufferBuilderE"></span><span id="_CPPv2N5arrow13BufferBuilderE"></span><span id="arrow::BufferBuilder"></span><span class="target" id="classarrow_1_1_buffer_builder"></span><em class="property">class </em><code class="descname">BufferBuilder</code><a class="headerlink" href="#_CPPv4N5arrow13BufferBuilderE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>A class for incrementally building a contiguous chunk of in-memory data. </p>
-<p>Subclassed by <a class="reference internal" href="#classarrow_1_1_typed_buffer_builder"><span class="std std-ref">arrow::TypedBufferBuilder< T ></span></a>, <a class="reference internal" href="#classarrow_1_1_typed_buffer_builder"><span class="std std-ref">arrow::TypedBufferBuilder< int32_t ></span></a>, <a class="reference internal" href="#classarrow_1_1_typed_buffer_builder"><span class="std std-ref">arrow::TypedBufferBuilder< uint8_t ></span></a></p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric">Public Functions</p>
<dl class="function">
-<dt id="_CPPv3N5arrow13BufferBuilder6ResizeEK7int64_tb">
-<span id="_CPPv2N5arrow13BufferBuilder6ResizeEK7int64_tb"></span><span id="arrow::BufferBuilder::Resize__int64_tC.b"></span><span class="target" id="classarrow_1_1_buffer_builder_1a7d037234bc80bdf7505c953e1317a429"></span><a class="reference internal" href="support.html#_CPPv3N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descname">Resize</code><span class="sig-paren">(</span><em class="property">const</em> int64_t <em>elements</em>, bool <em>shrink_to_fit</em> = true<spa [...]
+<dt id="_CPPv4N5arrow13BufferBuilder6ResizeEK7int64_tb">
+<span id="_CPPv3N5arrow13BufferBuilder6ResizeEK7int64_tb"></span><span id="_CPPv2N5arrow13BufferBuilder6ResizeEK7int64_tb"></span><span id="arrow::BufferBuilder::Resize__int64_tC.b"></span><span class="target" id="classarrow_1_1_buffer_builder_1a865e377404f5e80e3b716e654d0f3ec9"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descname">Resize</code><span class="sig-paren">(</span><em class="property">const</em> [...]
<dd><p>Resize the buffer to the nearest multiple of 64 bytes. </p>
<p><dl class="docutils">
<dt><strong>Return</strong></dt>
<dd><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a> </dd>
<dt><strong>Parameters</strong></dt>
<dd><ul class="breatheparameterlist first last simple">
-<li><code class="docutils literal notranslate"><span class="pre">elements</span></code>: the new capacity of the of the builder. Will be rounded up to a multiple of 64 bytes for padding </li>
+<li><code class="docutils literal notranslate"><span class="pre">new_capacity</span></code>: the new capacity of the of the builder. Will be rounded up to a multiple of 64 bytes for padding</li>
<li><code class="docutils literal notranslate"><span class="pre">shrink_to_fit</span></code>: if new capacity is smaller than the existing size, reallocate internal buffer. Set to false to avoid reallocations when shrinking the builder. </li>
</ul>
</dd>
@@ -864,15 +908,16 @@
</dd></dl>
<dl class="function">
-<dt id="_CPPv3N5arrow13BufferBuilder7ReserveEK7int64_t">
-<span id="_CPPv2N5arrow13BufferBuilder7ReserveEK7int64_t"></span><span id="arrow::BufferBuilder::Reserve__int64_tC"></span><span class="target" id="classarrow_1_1_buffer_builder_1afac16a92de1d0349a9395addfe7d67bb"></span><a class="reference internal" href="support.html#_CPPv3N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descname">Reserve</code><span class="sig-paren">(</span><em class="property">const</em> int64_t <em>size</em><span class="sig-paren">)</span><a class="he [...]
+<dt id="_CPPv4N5arrow13BufferBuilder7ReserveEK7int64_tb">
+<span id="_CPPv3N5arrow13BufferBuilder7ReserveEK7int64_tb"></span><span id="_CPPv2N5arrow13BufferBuilder7ReserveEK7int64_tb"></span><span id="arrow::BufferBuilder::Reserve__int64_tC.b"></span><span class="target" id="classarrow_1_1_buffer_builder_1a3a1474ceabc356cf1927edc400c6e2fc"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descname">Reserve</code><span class="sig-paren">(</span><em class="property">const</ [...]
<dd><p>Ensure that builder can accommodate the additional number of bytes without the need to perform allocations. </p>
<p><dl class="docutils">
<dt><strong>Return</strong></dt>
<dd><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a> </dd>
<dt><strong>Parameters</strong></dt>
<dd><ul class="breatheparameterlist first last simple">
-<li><code class="docutils literal notranslate"><span class="pre">size</span></code>: number of additional bytes to make space for </li>
+<li><code class="docutils literal notranslate"><span class="pre">additional_bytes</span></code>: number of additional bytes to make space for </li>
+<li><code class="docutils literal notranslate"><span class="pre">grow_by_factor</span></code>: if true, round up allocations using the strategy in <a class="reference internal" href="#classarrow_1_1_buffer_builder_1a4be4f4efd20c51b1d6cf3f704c01a3c2"><span class="std std-ref">BufferBuilder::GrowByFactor</span></a> </li>
</ul>
</dd>
</dl>
@@ -880,22 +925,29 @@
</dd></dl>
<dl class="function">
... 53868 lines suppressed ...