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/08/05 23:24:15 UTC
[arrow-site] branch asf-site updated: Update main docs site to
0.14.1
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 1a8b602 Update main docs site to 0.14.1
1a8b602 is described below
commit 1a8b6024ceaf9faea0652639edf3930b282d8bef
Author: Wes McKinney <we...@apache.org>
AuthorDate: Mon Aug 5 18:24:07 2019 -0500
Update main docs site to 0.14.1
---
docs/_modules/index.html | 8 +-
docs/_modules/pyarrow.html | 91 +-
docs/_modules/pyarrow/feather.html | 28 +-
docs/_modules/pyarrow/filesystem.html | 8 +-
docs/_modules/pyarrow/hdfs.html | 34 +-
docs/_modules/pyarrow/ipc.html | 18 +-
docs/_modules/pyarrow/parquet.html | 207 +++-
docs/_modules/pyarrow/types.html | 52 +-
docs/_sources/cpp/api.rst.txt | 1 +
docs/_sources/cpp/api/flight.rst.txt | 126 +++
docs/_sources/developers/benchmarks.rst.txt | 172 +++
docs/_sources/developers/contributing.rst.txt | 54 +-
docs/_sources/developers/cpp.rst.txt | 217 +++-
docs/_sources/developers/documentation.rst.txt | 2 +-
docs/_sources/developers/integration.rst.txt | 3 +-
docs/_sources/developers/python.rst.txt | 98 +-
docs/_sources/format/Flight.rst.txt | 106 ++
docs/_sources/format/IPC.rst.txt | 2 +-
docs/_sources/format/Layout.rst.txt | 130 ++-
docs/_sources/format/Metadata.rst.txt | 308 +++---
docs/_sources/index.rst.txt | 8 +-
docs/_sources/python/api.rst.txt | 1 +
docs/_sources/python/api/flight.rst.txt | 82 ++
docs/_sources/python/api/formats.rst.txt | 18 +-
docs/_sources/python/api/tables.rst.txt | 1 +
docs/_sources/python/csv.rst.txt | 2 +-
.../python/generated/pyarrow.Array.rst.txt | 3 +
.../python/generated/pyarrow.ArrayValue.rst.txt | 6 +
.../python/generated/pyarrow.BinaryArray.rst.txt | 3 +
.../python/generated/pyarrow.BinaryValue.rst.txt | 1 +
.../python/generated/pyarrow.BooleanArray.rst.txt | 3 +
.../python/generated/pyarrow.BooleanValue.rst.txt | 1 +
.../python/generated/pyarrow.Buffer.rst.txt | 2 +
.../generated/pyarrow.BufferOutputStream.rst.txt | 2 +
.../python/generated/pyarrow.BufferReader.rst.txt | 2 +
.../python/generated/pyarrow.ChunkedArray.rst.txt | 1 +
.../python/generated/pyarrow.Column.rst.txt | 1 +
.../pyarrow.CompressedInputStream.rst.txt | 2 +
.../pyarrow.CompressedOutputStream.rst.txt | 2 +
.../python/generated/pyarrow.DataType.rst.txt | 3 +
.../python/generated/pyarrow.Date32Array.rst.txt | 3 +
.../python/generated/pyarrow.Date32Value.rst.txt | 1 +
.../python/generated/pyarrow.Date64Array.rst.txt | 3 +
.../python/generated/pyarrow.Date64Value.rst.txt | 1 +
.../generated/pyarrow.Decimal128Array.rst.txt | 3 +
.../generated/pyarrow.Decimal128Type.rst.txt | 3 +
.../python/generated/pyarrow.DecimalValue.rst.txt | 1 +
.../generated/pyarrow.DictionaryArray.rst.txt | 3 +
.../generated/pyarrow.DictionaryType.rst.txt | 5 +-
.../generated/pyarrow.DictionaryValue.rst.txt | 1 +
.../python/generated/pyarrow.DoubleValue.rst.txt | 1 +
.../python/generated/pyarrow.Field.rst.txt | 1 +
.../generated/pyarrow.FixedSizeBinaryArray.rst.txt | 3 +
.../generated/pyarrow.FixedSizeBinaryType.rst.txt | 3 +
.../generated/pyarrow.FixedSizeBinaryValue.rst.txt | 1 +
.../pyarrow.FixedSizeBufferWriter.rst.txt | 2 +
.../python/generated/pyarrow.FloatValue.rst.txt | 1 +
.../generated/pyarrow.FloatingPointArray.rst.txt | 3 +
.../python/generated/pyarrow.HdfsFile.rst.txt | 2 +
.../python/generated/pyarrow.Int16Array.rst.txt | 3 +
.../python/generated/pyarrow.Int16Value.rst.txt | 1 +
.../python/generated/pyarrow.Int32Array.rst.txt | 3 +
.../python/generated/pyarrow.Int32Value.rst.txt | 1 +
.../python/generated/pyarrow.Int64Array.rst.txt | 3 +
.../python/generated/pyarrow.Int64Value.rst.txt | 1 +
.../python/generated/pyarrow.Int8Array.rst.txt | 3 +
.../python/generated/pyarrow.Int8Value.rst.txt | 1 +
.../python/generated/pyarrow.IntegerArray.rst.txt | 3 +
.../python/generated/pyarrow.ListArray.rst.txt | 3 +
.../python/generated/pyarrow.ListType.rst.txt | 3 +
.../python/generated/pyarrow.ListValue.rst.txt | 1 +
.../generated/pyarrow.LocalFileSystem.rst.txt | 1 +
.../generated/pyarrow.MemoryMappedFile.rst.txt | 2 +
.../python/generated/pyarrow.MemoryPool.rst.txt | 1 +
.../python/generated/pyarrow.Message.rst.txt | 1 +
.../python/generated/pyarrow.MessageReader.rst.txt | 1 +
.../python/generated/pyarrow.NativeFile.rst.txt | 2 +
.../python/generated/pyarrow.NullArray.rst.txt | 3 +
.../python/generated/pyarrow.NumericArray.rst.txt | 3 +
.../python/generated/pyarrow.OSFile.rst.txt | 2 +
.../python/generated/pyarrow.PythonFile.rst.txt | 2 +
.../python/generated/pyarrow.RecordBatch.rst.txt | 1 +
.../generated/pyarrow.ResizableBuffer.rst.txt | 2 +
.../python/generated/pyarrow.Scalar.rst.txt | 6 +
.../python/generated/pyarrow.Schema.rst.txt | 1 +
.../generated/pyarrow.SerializationContext.rst.txt | 1 +
.../generated/pyarrow.SerializedPyObject.rst.txt | 1 +
.../python/generated/pyarrow.StringArray.rst.txt | 3 +
.../python/generated/pyarrow.StringValue.rst.txt | 1 +
.../python/generated/pyarrow.StructArray.rst.txt | 3 +
.../python/generated/pyarrow.StructType.rst.txt | 2 +
.../python/generated/pyarrow.StructValue.rst.txt | 1 +
.../python/generated/pyarrow.Table.rst.txt | 5 +
.../python/generated/pyarrow.Tensor.rst.txt | 1 +
.../python/generated/pyarrow.Time32Array.rst.txt | 3 +
.../python/generated/pyarrow.Time32Type.rst.txt | 3 +
.../python/generated/pyarrow.Time32Value.rst.txt | 1 +
.../python/generated/pyarrow.Time64Array.rst.txt | 3 +
.../python/generated/pyarrow.Time64Type.rst.txt | 3 +
.../python/generated/pyarrow.Time64Value.rst.txt | 1 +
.../generated/pyarrow.TimestampArray.rst.txt | 3 +
.../python/generated/pyarrow.TimestampType.rst.txt | 3 +
.../generated/pyarrow.TimestampValue.rst.txt | 1 +
.../python/generated/pyarrow.UInt16Array.rst.txt | 3 +
.../python/generated/pyarrow.UInt16Value.rst.txt | 1 +
.../python/generated/pyarrow.UInt32Array.rst.txt | 3 +
.../python/generated/pyarrow.UInt32Value.rst.txt | 1 +
.../python/generated/pyarrow.UInt64Array.rst.txt | 3 +
.../python/generated/pyarrow.UInt64Value.rst.txt | 1 +
.../python/generated/pyarrow.UInt8Array.rst.txt | 3 +
.../python/generated/pyarrow.UInt8Value.rst.txt | 1 +
.../python/generated/pyarrow.UnionArray.rst.txt | 3 +
.../python/generated/pyarrow.UnionType.rst.txt | 2 +
.../python/generated/pyarrow.UnionValue.rst.txt | 1 +
.../generated/pyarrow.csv.ConvertOptions.rst.txt | 9 +
.../generated/pyarrow.csv.ParseOptions.rst.txt | 6 +
.../generated/pyarrow.csv.ReadOptions.rst.txt | 6 +
.../generated/pyarrow.cuda.BufferReader.rst.txt | 2 +
.../generated/pyarrow.cuda.BufferWriter.rst.txt | 2 +
.../python/generated/pyarrow.cuda.Context.rst.txt | 1 +
.../generated/pyarrow.cuda.CudaBuffer.rst.txt | 2 +
.../generated/pyarrow.cuda.HostBuffer.rst.txt | 2 +
.../generated/pyarrow.cuda.IpcMemHandle.rst.txt | 1 +
.../python/generated/pyarrow.flight.Action.rst.txt | 29 +
.../generated/pyarrow.flight.ActionType.rst.txt | 32 +
.../pyarrow.flight.ClientAuthHandler.rst.txt | 24 +
.../pyarrow.flight.DescriptorType.rst.txt | 24 +
.../pyarrow.flight.FlightCallOptions.rst.txt | 22 +
.../generated/pyarrow.flight.FlightClient.rst.txt | 30 +
.../pyarrow.flight.FlightDescriptor.rst.txt | 32 +
.../pyarrow.flight.FlightEndpoint.rst.txt | 29 +
.../generated/pyarrow.flight.FlightInfo.rst.txt | 32 +
.../pyarrow.flight.FlightServerBase.rst.txt | 30 +
.../pyarrow.flight.GeneratorStream.rst.txt | 22 +
.../generated/pyarrow.flight.Location.rst.txt | 32 +
.../pyarrow.flight.RecordBatchStream.rst.txt | 22 +
...Value.rst.txt => pyarrow.flight.Result.rst.txt} | 12 +-
.../pyarrow.flight.ServerAuthHandler.rst.txt | 24 +
...Value.rst.txt => pyarrow.flight.Ticket.rst.txt} | 12 +-
.../generated/pyarrow.json.ParseOptions.rst.txt | 29 +
...ns.rst.txt => pyarrow.json.ReadOptions.rst.txt} | 12 +-
.../generated/pyarrow.json.read_json.rst.txt | 6 +
.../pyarrow.parquet.ParquetDataset.rst.txt | 1 +
.../generated/pyarrow.plasma.ObjectID.rst.txt | 1 +
.../generated/pyarrow.plasma.PlasmaBuffer.rst.txt | 2 +
.../generated/pyarrow.plasma.PlasmaClient.rst.txt | 1 +
.../python/generated/pyarrow.table.rst.txt | 6 +
docs/_sources/python/index.rst.txt | 1 +
docs/_sources/python/json.rst.txt | 114 ++
docs/_sources/python/pandas.rst.txt | 33 +
docs/_sources/python/parquet.rst.txt | 41 +-
docs/_static/basic.css | 89 +-
docs/_static/doctools.js | 5 +-
docs/_static/documentation_options.js | 4 +-
docs/_static/fonts/Inconsolata-Bold.ttf | Bin 0 -> 109948 bytes
docs/_static/fonts/Inconsolata-Regular.ttf | Bin 0 -> 96964 bytes
docs/_static/fonts/Inconsolata.ttf | Bin 0 -> 63184 bytes
docs/_static/fonts/Lato-Bold.ttf | Bin 0 -> 656544 bytes
docs/_static/fonts/Lato-Regular.ttf | Bin 0 -> 656568 bytes
docs/_static/fonts/RobotoSlab-Bold.ttf | Bin 0 -> 170616 bytes
docs/_static/fonts/RobotoSlab-Regular.ttf | Bin 0 -> 169064 bytes
docs/_static/searchtools.js | 51 +-
docs/cpp/api.html | 13 +-
docs/cpp/api/array.html | 437 +++++---
docs/cpp/api/builder.html | 649 ++++++------
docs/cpp/api/cuda.html | 401 ++++---
docs/cpp/api/datatype.html | 906 +++++++++-------
docs/cpp/api/flight.html | 1104 ++++++++++++++++++++
docs/cpp/api/memory.html | 606 +++++------
docs/cpp/api/support.html | 105 +-
docs/cpp/api/table.html | 538 +++++-----
docs/cpp/api/utilities.html | 62 +-
docs/cpp/arrays.html | 10 +-
docs/cpp/conventions.html | 6 +-
docs/cpp/datatypes.html | 16 +-
docs/cpp/examples/index.html | 6 +-
docs/cpp/examples/row_columnar_conversion.html | 6 +-
docs/cpp/examples/tuple_range_conversion.html | 12 +-
docs/cpp/getting_started.html | 6 +-
docs/cpp/index.html | 11 +-
docs/cpp/memory.html | 14 +-
docs/cpp/overview.html | 6 +-
docs/cpp/tables.html | 6 +-
docs/developers/benchmarks.html | 378 +++++++
docs/developers/contributing.html | 86 +-
docs/developers/cpp.html | 401 ++++---
docs/developers/documentation.html | 26 +-
docs/developers/integration.html | 37 +-
docs/developers/python.html | 145 ++-
docs/format/Flight.html | 934 +++++++++++++++++
docs/format/Guidelines.html | 6 +-
docs/format/IPC.html | 39 +-
docs/format/Layout.html | 253 +++--
docs/format/Metadata.html | 359 +++----
docs/format/README.html | 26 +-
docs/genindex.html | 720 +++++++++++--
docs/index.html | 25 +-
docs/objects.inv | Bin 35288 -> 43137 bytes
docs/python/api.html | 16 +-
docs/python/api/arrays.html | 252 ++---
docs/python/api/cuda.html | 72 +-
docs/python/api/datatypes.html | 336 +++---
docs/python/api/files.html | 94 +-
docs/python/api/{formats.html => flight.html} | 161 +--
docs/python/api/formats.html | 121 ++-
docs/python/api/ipc.html | 112 +-
docs/python/api/memory.html | 88 +-
docs/python/api/misc.html | 44 +-
docs/python/api/plasma.html | 28 +-
docs/python/api/tables.html | 71 +-
docs/python/benchmarks.html | 13 +-
docs/python/csv.html | 31 +-
docs/python/cuda.html | 19 +-
docs/python/data.html | 69 +-
docs/python/extending.html | 105 +-
docs/python/filesystems.html | 103 +-
docs/python/generated/pyarrow.Array.html | 392 +++----
docs/python/generated/pyarrow.ArrayValue.html | 38 +-
docs/python/generated/pyarrow.BinaryArray.html | 392 +++----
docs/python/generated/pyarrow.BinaryValue.html | 49 +-
docs/python/generated/pyarrow.BooleanArray.html | 392 +++----
docs/python/generated/pyarrow.BooleanValue.html | 43 +-
docs/python/generated/pyarrow.Buffer.html | 131 ++-
.../generated/pyarrow.BufferOutputStream.html | 333 +++---
docs/python/generated/pyarrow.BufferReader.html | 327 +++---
docs/python/generated/pyarrow.ChunkedArray.html | 277 +++--
docs/python/generated/pyarrow.Column.html | 322 +++---
.../generated/pyarrow.CompressedInputStream.html | 334 +++---
.../generated/pyarrow.CompressedOutputStream.html | 334 +++---
docs/python/generated/pyarrow.DataType.html | 92 +-
docs/python/generated/pyarrow.Date32Array.html | 392 +++----
docs/python/generated/pyarrow.Date32Value.html | 43 +-
docs/python/generated/pyarrow.Date64Array.html | 392 +++----
docs/python/generated/pyarrow.Date64Value.html | 43 +-
docs/python/generated/pyarrow.Decimal128Array.html | 392 +++----
docs/python/generated/pyarrow.Decimal128Type.html | 110 +-
docs/python/generated/pyarrow.DecimalValue.html | 43 +-
docs/python/generated/pyarrow.DictionaryArray.html | 448 ++++----
docs/python/generated/pyarrow.DictionaryType.html | 121 ++-
docs/python/generated/pyarrow.DictionaryValue.html | 55 +-
docs/python/generated/pyarrow.DoubleValue.html | 43 +-
docs/python/generated/pyarrow.Field.html | 141 ++-
.../generated/pyarrow.FixedSizeBinaryArray.html | 392 +++----
.../generated/pyarrow.FixedSizeBinaryType.html | 98 +-
.../generated/pyarrow.FixedSizeBinaryValue.html | 43 +-
.../generated/pyarrow.FixedSizeBufferWriter.html | 332 +++---
docs/python/generated/pyarrow.FloatValue.html | 43 +-
.../generated/pyarrow.FloatingPointArray.html | 392 +++----
.../generated/pyarrow.HadoopFileSystem.cat.html | 22 +-
.../generated/pyarrow.HadoopFileSystem.chmod.html | 27 +-
.../generated/pyarrow.HadoopFileSystem.chown.html | 29 +-
.../generated/pyarrow.HadoopFileSystem.delete.html | 27 +-
.../generated/pyarrow.HadoopFileSystem.df.html | 22 +-
.../pyarrow.HadoopFileSystem.disk_usage.html | 27 +-
.../pyarrow.HadoopFileSystem.download.html | 9 +-
.../generated/pyarrow.HadoopFileSystem.exists.html | 9 +-
.../pyarrow.HadoopFileSystem.get_capacity.html | 22 +-
.../pyarrow.HadoopFileSystem.get_space_used.html | 22 +-
.../generated/pyarrow.HadoopFileSystem.info.html | 27 +-
.../generated/pyarrow.HadoopFileSystem.ls.html | 33 +-
.../generated/pyarrow.HadoopFileSystem.mkdir.html | 22 +-
.../generated/pyarrow.HadoopFileSystem.open.html | 27 +-
.../generated/pyarrow.HadoopFileSystem.rename.html | 27 +-
.../generated/pyarrow.HadoopFileSystem.rm.html | 9 +-
.../generated/pyarrow.HadoopFileSystem.upload.html | 9 +-
docs/python/generated/pyarrow.HdfsFile.html | 325 +++---
docs/python/generated/pyarrow.Int16Array.html | 392 +++----
docs/python/generated/pyarrow.Int16Value.html | 43 +-
docs/python/generated/pyarrow.Int32Array.html | 392 +++----
docs/python/generated/pyarrow.Int32Value.html | 43 +-
docs/python/generated/pyarrow.Int64Array.html | 392 +++----
docs/python/generated/pyarrow.Int64Value.html | 43 +-
docs/python/generated/pyarrow.Int8Array.html | 392 +++----
docs/python/generated/pyarrow.Int8Value.html | 43 +-
docs/python/generated/pyarrow.IntegerArray.html | 392 +++----
docs/python/generated/pyarrow.ListArray.html | 443 ++++----
docs/python/generated/pyarrow.ListType.html | 98 +-
docs/python/generated/pyarrow.ListValue.html | 49 +-
docs/python/generated/pyarrow.LocalFileSystem.html | 264 +++--
.../python/generated/pyarrow.MemoryMappedFile.html | 341 +++---
docs/python/generated/pyarrow.MemoryPool.html | 35 +-
docs/python/generated/pyarrow.Message.html | 103 +-
docs/python/generated/pyarrow.MessageReader.html | 37 +-
docs/python/generated/pyarrow.NA.html | 10 +-
docs/python/generated/pyarrow.NativeFile.html | 314 +++---
docs/python/generated/pyarrow.NullArray.html | 392 +++----
docs/python/generated/pyarrow.NumericArray.html | 392 +++----
docs/python/generated/pyarrow.OSFile.html | 314 +++---
docs/python/generated/pyarrow.PythonFile.html | 301 +++---
docs/python/generated/pyarrow.RecordBatch.html | 363 +++----
.../generated/pyarrow.RecordBatchFileReader.html | 106 +-
.../generated/pyarrow.RecordBatchFileWriter.html | 105 +-
.../generated/pyarrow.RecordBatchStreamReader.html | 93 +-
.../generated/pyarrow.RecordBatchStreamWriter.html | 105 +-
docs/python/generated/pyarrow.ResizableBuffer.html | 157 +--
docs/python/generated/pyarrow.Scalar.html | 38 +-
docs/python/generated/pyarrow.Schema.html | 377 ++++---
.../generated/pyarrow.SerializationContext.html | 130 ++-
.../generated/pyarrow.SerializedPyObject.html | 93 +-
docs/python/generated/pyarrow.StringArray.html | 389 +++----
docs/python/generated/pyarrow.StringValue.html | 43 +-
docs/python/generated/pyarrow.StructArray.html | 472 ++++-----
docs/python/generated/pyarrow.StructType.html | 91 +-
docs/python/generated/pyarrow.StructValue.html | 43 +-
docs/python/generated/pyarrow.Table.html | 567 +++++-----
docs/python/generated/pyarrow.Tensor.html | 93 +-
docs/python/generated/pyarrow.Time32Array.html | 392 +++----
docs/python/generated/pyarrow.Time32Type.html | 98 +-
docs/python/generated/pyarrow.Time32Value.html | 43 +-
docs/python/generated/pyarrow.Time64Array.html | 392 +++----
docs/python/generated/pyarrow.Time64Type.html | 98 +-
docs/python/generated/pyarrow.Time64Value.html | 43 +-
docs/python/generated/pyarrow.TimestampArray.html | 392 +++----
docs/python/generated/pyarrow.TimestampType.html | 104 +-
docs/python/generated/pyarrow.TimestampValue.html | 49 +-
docs/python/generated/pyarrow.UInt16Array.html | 392 +++----
docs/python/generated/pyarrow.UInt16Value.html | 43 +-
docs/python/generated/pyarrow.UInt32Array.html | 392 +++----
docs/python/generated/pyarrow.UInt32Value.html | 43 +-
docs/python/generated/pyarrow.UInt64Array.html | 392 +++----
docs/python/generated/pyarrow.UInt64Value.html | 43 +-
docs/python/generated/pyarrow.UInt8Array.html | 392 +++----
docs/python/generated/pyarrow.UInt8Value.html | 43 +-
docs/python/generated/pyarrow.UnionArray.html | 462 ++++----
docs/python/generated/pyarrow.UnionType.html | 103 +-
docs/python/generated/pyarrow.UnionValue.html | 43 +-
docs/python/generated/pyarrow.allocate_buffer.html | 38 +-
docs/python/generated/pyarrow.array.html | 73 +-
docs/python/generated/pyarrow.binary.html | 25 +-
docs/python/generated/pyarrow.bool_.html | 10 +-
docs/python/generated/pyarrow.chunked_array.html | 35 +-
docs/python/generated/pyarrow.column.html | 38 +-
docs/python/generated/pyarrow.compress.html | 40 +-
docs/python/generated/pyarrow.concat_tables.html | 28 +-
docs/python/generated/pyarrow.cpu_count.html | 10 +-
.../generated/pyarrow.create_memory_map.html | 34 +-
.../generated/pyarrow.csv.ConvertOptions.html | 110 +-
.../python/generated/pyarrow.csv.ParseOptions.html | 113 +-
docs/python/generated/pyarrow.csv.ReadOptions.html | 65 +-
docs/python/generated/pyarrow.csv.read_csv.html | 48 +-
.../generated/pyarrow.cuda.BufferReader.html | 334 +++---
.../generated/pyarrow.cuda.BufferWriter.html | 354 ++++---
docs/python/generated/pyarrow.cuda.Context.html | 300 +++---
docs/python/generated/pyarrow.cuda.CudaBuffer.html | 335 +++---
docs/python/generated/pyarrow.cuda.HostBuffer.html | 134 +--
.../generated/pyarrow.cuda.IpcMemHandle.html | 77 +-
.../generated/pyarrow.cuda.new_host_buffer.html | 34 +-
.../generated/pyarrow.cuda.read_message.html | 34 +-
.../generated/pyarrow.cuda.read_record_batch.html | 36 +-
.../pyarrow.cuda.serialize_record_batch.html | 34 +-
docs/python/generated/pyarrow.date32.html | 10 +-
docs/python/generated/pyarrow.date64.html | 10 +-
docs/python/generated/pyarrow.decimal128.html | 34 +-
docs/python/generated/pyarrow.decompress.html | 44 +-
.../generated/pyarrow.default_memory_pool.html | 10 +-
docs/python/generated/pyarrow.deserialize.html | 34 +-
.../generated/pyarrow.deserialize_components.html | 34 +-
.../python/generated/pyarrow.deserialize_from.html | 38 +-
docs/python/generated/pyarrow.dictionary.html | 36 +-
.../generated/pyarrow.feather.read_feather.html | 39 +-
.../generated/pyarrow.feather.write_feather.html | 33 +-
docs/python/generated/pyarrow.field.html | 38 +-
...estampValue.html => pyarrow.flight.Action.html} | 110 +-
...e32Type.html => pyarrow.flight.ActionType.html} | 144 +--
....html => pyarrow.flight.ClientAuthHandler.html} | 113 +-
...dle.html => pyarrow.flight.DescriptorType.html} | 136 +--
....html => pyarrow.flight.FlightCallOptions.html} | 76 +-
.../generated/pyarrow.flight.FlightClient.html | 408 ++++++++
...e.html => pyarrow.flight.FlightDescriptor.html} | 136 +--
...ype.html => pyarrow.flight.FlightEndpoint.html} | 125 +--
...ionType.html => pyarrow.flight.FlightInfo.html} | 159 ++-
...d.html => pyarrow.flight.FlightServerBase.html} | 208 ++--
...ue.html => pyarrow.flight.GeneratorStream.html} | 97 +-
...ime64Type.html => pyarrow.flight.Location.html} | 138 ++-
....html => pyarrow.flight.RecordBatchStream.html} | 93 +-
...estampValue.html => pyarrow.flight.Result.html} | 104 +-
....html => pyarrow.flight.ServerAuthHandler.html} | 133 ++-
...Date32Value.html => pyarrow.flight.Ticket.html} | 85 +-
docs/python/generated/pyarrow.float16.html | 10 +-
docs/python/generated/pyarrow.float32.html | 10 +-
docs/python/generated/pyarrow.float64.html | 10 +-
docs/python/generated/pyarrow.foreign_buffer.html | 10 +-
.../python/generated/pyarrow.from_numpy_dtype.html | 10 +-
docs/python/generated/pyarrow.get_include.html | 10 +-
docs/python/generated/pyarrow.get_libraries.html | 10 +-
.../python/generated/pyarrow.get_library_dirs.html | 10 +-
.../generated/pyarrow.get_record_batch_size.html | 10 +-
docs/python/generated/pyarrow.get_tensor_size.html | 10 +-
docs/python/generated/pyarrow.hdfs.connect.html | 52 +-
docs/python/generated/pyarrow.input_stream.html | 34 +-
docs/python/generated/pyarrow.int16.html | 10 +-
docs/python/generated/pyarrow.int32.html | 10 +-
docs/python/generated/pyarrow.int64.html | 10 +-
docs/python/generated/pyarrow.int8.html | 10 +-
docs/python/generated/pyarrow.ipc.open_file.html | 36 +-
docs/python/generated/pyarrow.ipc.open_stream.html | 36 +-
...Options.html => pyarrow.json.ParseOptions.html} | 111 +-
...dOptions.html => pyarrow.json.ReadOptions.html} | 93 +-
...te_feather.html => pyarrow.json.read_json.html} | 53 +-
docs/python/generated/pyarrow.list_.html | 28 +-
.../generated/pyarrow.log_memory_allocations.html | 23 +-
docs/python/generated/pyarrow.memory_map.html | 36 +-
docs/python/generated/pyarrow.null.html | 10 +-
docs/python/generated/pyarrow.output_stream.html | 34 +-
.../generated/pyarrow.parquet.ParquetDataset.html | 136 +--
.../generated/pyarrow.parquet.ParquetFile.html | 187 ++--
.../generated/pyarrow.parquet.ParquetWriter.html | 93 +-
.../generated/pyarrow.parquet.read_metadata.html | 35 +-
.../generated/pyarrow.parquet.read_pandas.html | 51 +-
.../generated/pyarrow.parquet.read_schema.html | 35 +-
.../generated/pyarrow.parquet.read_table.html | 55 +-
.../generated/pyarrow.parquet.write_metadata.html | 41 +-
.../generated/pyarrow.parquet.write_table.html | 63 +-
.../pyarrow.parquet.write_to_dataset.html | 69 +-
docs/python/generated/pyarrow.plasma.ObjectID.html | 63 +-
.../generated/pyarrow.plasma.PlasmaBuffer.html | 161 +--
.../generated/pyarrow.plasma.PlasmaClient.html | 550 +++++-----
docs/python/generated/pyarrow.py_buffer.html | 10 +-
docs/python/generated/pyarrow.read_message.html | 28 +-
.../generated/pyarrow.read_record_batch.html | 36 +-
docs/python/generated/pyarrow.read_serialized.html | 36 +-
docs/python/generated/pyarrow.read_tensor.html | 28 +-
docs/python/generated/pyarrow.schema.html | 41 +-
docs/python/generated/pyarrow.serialize.html | 36 +-
docs/python/generated/pyarrow.serialize_to.html | 32 +-
docs/python/generated/pyarrow.set_cpu_count.html | 10 +-
docs/python/generated/pyarrow.set_memory_pool.html | 10 +-
docs/python/generated/pyarrow.string.html | 10 +-
docs/python/generated/pyarrow.struct.html | 36 +-
.../{pyarrow.column.html => pyarrow.table.html} | 56 +-
docs/python/generated/pyarrow.time32.html | 23 +-
docs/python/generated/pyarrow.time64.html | 23 +-
docs/python/generated/pyarrow.timestamp.html | 43 +-
.../generated/pyarrow.total_allocated_bytes.html | 10 +-
docs/python/generated/pyarrow.types.is_binary.html | 10 +-
.../python/generated/pyarrow.types.is_boolean.html | 10 +-
docs/python/generated/pyarrow.types.is_date.html | 10 +-
docs/python/generated/pyarrow.types.is_date32.html | 10 +-
docs/python/generated/pyarrow.types.is_date64.html | 10 +-
.../python/generated/pyarrow.types.is_decimal.html | 10 +-
.../generated/pyarrow.types.is_dictionary.html | 10 +-
.../pyarrow.types.is_fixed_size_binary.html | 10 +-
.../python/generated/pyarrow.types.is_float16.html | 10 +-
.../python/generated/pyarrow.types.is_float32.html | 10 +-
.../python/generated/pyarrow.types.is_float64.html | 10 +-
.../generated/pyarrow.types.is_floating.html | 10 +-
docs/python/generated/pyarrow.types.is_int16.html | 10 +-
docs/python/generated/pyarrow.types.is_int32.html | 10 +-
docs/python/generated/pyarrow.types.is_int64.html | 10 +-
docs/python/generated/pyarrow.types.is_int8.html | 10 +-
.../python/generated/pyarrow.types.is_integer.html | 10 +-
docs/python/generated/pyarrow.types.is_list.html | 10 +-
docs/python/generated/pyarrow.types.is_map.html | 10 +-
docs/python/generated/pyarrow.types.is_nested.html | 10 +-
docs/python/generated/pyarrow.types.is_null.html | 10 +-
.../generated/pyarrow.types.is_signed_integer.html | 10 +-
docs/python/generated/pyarrow.types.is_string.html | 10 +-
docs/python/generated/pyarrow.types.is_struct.html | 10 +-
.../generated/pyarrow.types.is_temporal.html | 10 +-
docs/python/generated/pyarrow.types.is_time.html | 10 +-
docs/python/generated/pyarrow.types.is_time32.html | 10 +-
docs/python/generated/pyarrow.types.is_time64.html | 10 +-
.../generated/pyarrow.types.is_timestamp.html | 10 +-
docs/python/generated/pyarrow.types.is_uint16.html | 10 +-
docs/python/generated/pyarrow.types.is_uint32.html | 10 +-
docs/python/generated/pyarrow.types.is_uint64.html | 10 +-
docs/python/generated/pyarrow.types.is_uint8.html | 10 +-
.../python/generated/pyarrow.types.is_unicode.html | 10 +-
docs/python/generated/pyarrow.types.is_union.html | 10 +-
.../pyarrow.types.is_unsigned_integer.html | 10 +-
docs/python/generated/pyarrow.uint16.html | 10 +-
docs/python/generated/pyarrow.uint32.html | 10 +-
docs/python/generated/pyarrow.uint64.html | 10 +-
docs/python/generated/pyarrow.uint8.html | 10 +-
docs/python/generated/pyarrow.utf8.html | 10 +-
docs/python/generated/pyarrow.write_tensor.html | 34 +-
docs/python/getting_involved.html | 15 +-
docs/python/index.html | 19 +-
docs/python/install.html | 11 +-
docs/python/ipc.html | 99 +-
docs/python/{csv.html => json.html} | 146 +--
docs/python/memory.html | 78 +-
docs/python/numpy.html | 7 +-
docs/python/pandas.html | 142 ++-
docs/python/parquet.html | 136 ++-
docs/python/plasma.html | 44 +-
docs/python/timestamps.html | 17 +-
docs/search.html | 6 +-
docs/searchindex.js | 2 +-
489 files changed, 24510 insertions(+), 17326 deletions(-)
diff --git a/docs/_modules/index.html b/docs/_modules/index.html
index f2170a2..931c8e8 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.13.0</title>
+ <title>Overview: module code — Apache Arrow v0.14.2.dev0+g5f564424c.d20190805</title>
@@ -59,7 +59,7 @@
<div class="version">
- 0.13.0
+ 0.14.2.dev0+g5f564424c.d20190805
</div>
@@ -90,6 +90,7 @@
<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>
+<li class="toctree-l1"><a class="reference internal" href="../format/Flight.html">Arrow Flight RPC</a></li>
</ul>
<p class="caption"><span class="caption-text">Arrow Libraries</span></p>
<ul>
@@ -102,6 +103,7 @@
<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/benchmarks.html">Benchmarks</a></li>
<li class="toctree-l1"><a class="reference internal" href="../developers/documentation.html">Building the Documentation</a></li>
</ul>
@@ -167,6 +169,8 @@
<ul><li><a href="pyarrow.html">pyarrow</a></li>
<ul><li><a href="pyarrow/_csv.html">pyarrow._csv</a></li>
<li><a href="pyarrow/_cuda.html">pyarrow._cuda</a></li>
+<li><a href="pyarrow/_flight.html">pyarrow._flight</a></li>
+<li><a href="pyarrow/_json.html">pyarrow._json</a></li>
<li><a href="pyarrow/_plasma.html">pyarrow._plasma</a></li>
<li><a href="pyarrow/feather.html">pyarrow.feather</a></li>
<li><a href="pyarrow/filesystem.html">pyarrow.filesystem</a></li>
diff --git a/docs/_modules/pyarrow.html b/docs/_modules/pyarrow.html
index d86ffbb..af98bda 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.13.0</title>
+ <title>pyarrow — Apache Arrow v0.14.2.dev0+g5f564424c.d20190805</title>
@@ -59,7 +59,7 @@
<div class="version">
- 0.13.0
+ 0.14.2.dev0+g5f564424c.d20190805
</div>
@@ -90,6 +90,7 @@
<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>
+<li class="toctree-l1"><a class="reference internal" href="../format/Flight.html">Arrow Flight RPC</a></li>
</ul>
<p class="caption"><span class="caption-text">Arrow Libraries</span></p>
<ul>
@@ -102,6 +103,7 @@
<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/benchmarks.html">Benchmarks</a></li>
<li class="toctree-l1"><a class="reference internal" href="../developers/documentation.html">Building the Documentation</a></li>
</ul>
@@ -185,6 +187,8 @@
<span class="c1"># flake8: noqa</span>
+<span class="kn">from</span> <span class="nn">__future__</span> <span class="k">import</span> <span class="n">absolute_import</span>
+
<span class="kn">import</span> <span class="nn">os</span> <span class="k">as</span> <span class="nn">_os</span>
<span class="kn">import</span> <span class="nn">sys</span> <span class="k">as</span> <span class="nn">_sys</span>
@@ -224,12 +228,15 @@
<span class="n">DataType</span><span class="p">,</span> <span class="n">DictionaryType</span><span class="p">,</span> <span class="n">ListType</span><span class="p">,</span> <span class="n">StructType</span><span class="p">,</span>
<span class="n">UnionType</span><span class="p">,</span> <span class="n">TimestampType</span><span class="p">,</span> <span class="n">Time32Type</span><span class="p">,</span> <span class="n">Time64Type</span><span class="p">,</span>
<span class="n">FixedSizeBinaryType</span><span class="p">,</span> <span class="n">Decimal128Type</span><span class="p">,</span>
+ <span class="n">BaseExtensionType</span><span class="p">,</span> <span class="n">ExtensionType</span><span class="p">,</span>
+ <span class="n">UnknownExtensionType</span><span class="p">,</span>
+ <span class="n">DictionaryMemo</span><span class="p">,</span>
<span class="n">Field</span><span class="p">,</span>
<span class="n">Schema</span><span class="p">,</span>
<span class="n">schema</span><span class="p">,</span>
<span class="n">Array</span><span class="p">,</span> <span class="n">Tensor</span><span class="p">,</span>
- <span class="n">array</span><span class="p">,</span> <span class="n">chunked_array</span><span class="p">,</span> <span class="n">column</span><span class="p">,</span>
- <span class="n">from_numpy_dtype</span><span class="p">,</span>
+ <span class="n">array</span><span class="p">,</span> <span class="n">chunked_array</span><span class="p">,</span> <span class="n">column</span><span class="p">,</span> <span class="n">table</span><span class="p">,</span>
+ <span class="n">infer_type</span><span class="p">,</span> <span class="n">from_numpy_dtype</span><span class="p">,</span>
<span class="n">NullArray</span><span class="p">,</span>
<span class="n">NumericArray</span><span class="p">,</span> <span class="n">IntegerArray</span><span class="p">,</span> <span class="n">FloatingPointArray</span><span class="p">,</span>
<span class="n">BooleanArray</span><span class="p">,</span>
@@ -243,7 +250,7 @@
<span class="n">DictionaryArray</span><span class="p">,</span>
<span class="n">Date32Array</span><span class="p">,</span> <span class="n">Date64Array</span><span class="p">,</span>
<span class="n">TimestampArray</span><span class="p">,</span> <span class="n">Time32Array</span><span class="p">,</span> <span class="n">Time64Array</span><span class="p">,</span>
- <span class="n">Decimal128Array</span><span class="p">,</span> <span class="n">StructArray</span><span class="p">,</span>
+ <span class="n">Decimal128Array</span><span class="p">,</span> <span class="n">StructArray</span><span class="p">,</span> <span class="n">ExtensionArray</span><span class="p">,</span>
<span class="n">ArrayValue</span><span class="p">,</span> <span class="n">Scalar</span><span class="p">,</span> <span class="n">NA</span><span class="p">,</span> <span class="n">_NULL</span> <span class="k">as</span> <span class="n">NULL</span><span class="p">,</span>
<span class="n">BooleanValue</span><span class="p">,</span>
<span class="n">Int8Value</span><span class="p">,</span> <span class="n">Int16Value</span><span class="p">,</span> <span class="n">Int32Value</span><span class="p">,</span> <span class="n">Int64Value</span><span class="p">,</span>
@@ -274,7 +281,7 @@
<span class="n">MockOutputStream</span><span class="p">,</span> <span class="n">input_stream</span><span class="p">,</span> <span class="n">output_stream</span><span class="p">)</span>
<span class="kn">from</span> <span class="nn">pyarrow.lib</span> <span class="k">import</span> <span class="p">(</span><span class="n">ChunkedArray</span><span class="p">,</span> <span class="n">Column</span><span class="p">,</span> <span class="n">RecordBatch</span><span class="p">,</span> <span class="n">Table</span><span class="p">,</span>
- <span class="n">concat_tables</span><span class="p">)</span>
+ <span class="n">concat_arrays</span><span class="p">,</span> <span class="n">concat_tables</span><span class="p">)</span>
<span class="c1"># Exceptions</span>
<span class="kn">from</span> <span class="nn">pyarrow.lib</span> <span class="k">import</span> <span class="p">(</span><span class="n">ArrowException</span><span class="p">,</span>
@@ -372,55 +379,79 @@
<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">join</span><span class="p">(</span><span class="n">_os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">dirname</span><span class="p">(</span><span class="vm">__file__</span><span class="p">),</span> <span class="s1">'include'</span><span class="p">)</span></div>
-<div class="viewcode-block" id="get_libraries"><a class="viewcode-back" href="../python/generated/pyarrow.get_libraries.html#pyarrow.get_libraries">[docs]</a><span class="k">def</span> <span class="nf">get_libraries</span><span class="p">():</span>
+<span class="k">def</span> <span class="nf">_get_pkg_config_executable</span><span class="p">():</span>
+ <span class="k">return</span> <span class="n">_os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'PKG_CONFIG'</span><span class="p">,</span> <span class="s1">'pkg-config'</span><span class="p">)</span>
+
+
+<span class="k">def</span> <span class="nf">_has_pkg_config</span><span class="p">(</span><span class="n">pkgname</span><span class="p">):</span>
+ <span class="kn">import</span> <span class="nn">subprocess</span>
+ <span class="k">try</span><span class="p">:</span>
+ <span class="k">return</span> <span class="n">subprocess</span><span class="o">.</span><span class="n">call</span><span class="p">([</span><span class="n">_get_pkg_config_executable</span><span class="p">(),</span>
+ <span class="s1">'--exists'</span><span class="p">,</span> <span class="n">pkgname</span><span class="p">])</span> <span class="o">==</span> <span class="mi">0</span>
+ <span class="k">except</span> <span class="ne">OSError</span><span class="p">:</span>
+ <span class="c1"># TODO: replace with FileNotFoundError once we ditch 2.7</span>
+ <span class="k">return</span> <span class="kc">False</span>
+
+
+<span class="k">def</span> <span class="nf">_read_pkg_config_variable</span><span class="p">(</span><span class="n">pkgname</span><span class="p">,</span> <span class="n">cli_args</span><span class="p">):</span>
+ <span class="kn">import</span> <span class="nn">subprocess</span>
+ <span class="n">cmd</span> <span class="o">=</span> <span class="p">[</span><span class="n">_get_pkg_config_executable</span><span class="p">(),</span> <span class="n">pkgname</span><span class="p">]</span> <span class="o">+</span> <span class="n">cli_args</span>
+ <span class="n">proc</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="n">cmd</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="n">stderr</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="n">out</span><span class="p">,</span> <span class="n">err</span> <span class="o">=</span> <span class="n">proc</span><span class="o">.</span><span class="n">communicate</span><span class="p">()</span>
+ <span class="k">if</span> <span class="n">proc</span><span class="o">.</span><span class="n">returncode</span> <span class="o">!=</span> <span class="mi">0</span><span class="p">:</span>
+ <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">(</span><span class="s2">"pkg-config failed: "</span> <span class="o">+</span> <span class="n">err</span><span class="o">.</span><span class="n">decode</span><span class="p">(</span><span class="s1">'utf8'</span><span class="p">))</span>
+ <span class="k">return</span> <span class="n">out</span><span class="o">.</span><span class="n">rstrip</span><span class="p">()</span><span class="o">.</span><span class="n">decode</span><span class="p">(</span><span class="s1">'utf8'</span><span class="p">)</span>
+
+
+<span class="k">def</span> <span class="nf">get_libraries</span><span class="p">():</span>
<span class="sd">"""</span>
<span class="sd"> Return list of library names to include in the `libraries` argument for C</span>
<span class="sd"> or Cython extensions using pyarrow</span>
<span class="sd"> """</span>
- <span class="k">return</span> <span class="p">[</span><span class="s1">'arrow'</span><span class="p">,</span> <span class="s1">'arrow_python'</span><span class="p">]</span></div>
+ <span class="k">return</span> <span class="p">[</span><span class="s1">'arrow'</span><span class="p">,</span> <span class="s1">'arrow_python'</span><span class="p">]</span>
-<div class="viewcode-block" id="get_library_dirs"><a class="viewcode-back" href="../python/generated/pyarrow.get_library_dirs.html#pyarrow.get_library_dirs">[docs]</a><span class="k">def</span> <span class="nf">get_library_dirs</span><span class="p">():</span>
+<span class="k">def</span> <span class="nf">get_library_dirs</span><span class="p">():</span>
<span class="sd">"""</span>
<span class="sd"> Return lists of directories likely to contain Arrow C++ libraries for</span>
<span class="sd"> linking C or Cython extensions using pyarrow</span>
<span class="sd"> """</span>
<span class="n">package_cwd</span> <span class="o">=</span> <span class="n">_os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">dirname</span><span class="p">(</span><span class="vm">__file__</span><span class="p">)</span>
-
<span class="n">library_dirs</span> <span class="o">=</span> <span class="p">[</span><span class="n">package_cwd</span><span class="p">]</span>
+ <span class="k">def</span> <span class="nf">append_library_dir</span><span class="p">(</span><span class="n">library_dir</span><span class="p">):</span>
+ <span class="k">if</span> <span class="n">library_dir</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">library_dirs</span><span class="p">:</span>
+ <span class="n">library_dirs</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">library_dir</span><span class="p">)</span>
+
<span class="c1"># Search library paths via pkg-config. This is necessary if the user</span>
<span class="c1"># installed libarrow and the other shared libraries manually and they</span>
<span class="c1"># are not shipped inside the pyarrow package (see also ARROW-2976).</span>
- <span class="kn">from</span> <span class="nn">subprocess</span> <span class="k">import</span> <span class="n">call</span><span class="p">,</span> <span class="n">PIPE</span><span class="p">,</span> <span class="n">Popen</span>
- <span class="n">pkg_config_executable</span> <span class="o">=</span> <span class="n">_os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'PKG_CONFIG'</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span> <span class="ow">or</span> <span class="s1">'pkg-config'</span>
- <span class="k">for</span> <span class="n">package</span> <span class="ow">in</span> <span class="p">[</span><span class="s2">"arrow"</span><span class="p">,</span> <span class="s2">"plasma"</span><span class="p">,</span> <span class="s2">"arrow_python"</span><span class="p">]:</span>
- <span class="n">cmd</span> <span class="o">=</span> <span class="s1">'</span><span class="si">{0}</span><span class="s1"> --exists </span><span class="si">{1}</span><span class="s1">'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">pkg_config_executable</span><span class="p">,</span> <span class="n">package</span><span class="p">)</span><span class="o">.</span><span class="n">split</span><span class="p">()</span>
- <span class="k">try</span><span class="p">:</span>
- <span class="k">if</span> <span class="n">call</span><span class="p">(</span><span class="n">cmd</span><span class="p">)</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
- <span class="n">cmd</span> <span class="o">=</span> <span class="p">[</span><span class="n">pkg_config_executable</span><span class="p">,</span> <span class="s2">"--libs-only-L"</span><span class="p">,</span> <span class="n">package</span><span class="p">]</span>
- <span class="n">proc</span> <span class="o">=</span> <span class="n">Popen</span><span class="p">(</span><span class="n">cmd</span><span class="p">,</span> <span class="n">stdout</span><span class="o">=</span><span class="n">PIPE</span><span class="p">,</span> <span class="n">stderr</span><span class="o">=</span><span class="n">PIPE</span><span class="p">)</span>
- <span class="n">out</span><span class="p">,</span> <span class="n">err</span> <span class="o">=</span> <span class="n">proc</span><span class="o">.</span><span class="n">communicate</span><span class="p">()</span>
- <span class="n">library_dir</span> <span class="o">=</span> <span class="n">out</span><span class="o">.</span><span class="n">rstrip</span><span class="p">()</span><span class="o">.</span><span class="n">decode</span><span class="p">(</span><span class="s1">'utf-8'</span><span class="p">)[</span><span class="mi">2</span><span class="p">:]</span> <span class="c1"># strip "-L"</span>
- <span class="k">if</span> <span class="n">library_dir</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">library_dirs</span><span class="p">:</span>
- <span class="n">library_dirs</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">library_dir</span><span class="p">)</span>
- <span class="k">except</span> <span class="ne">FileNotFoundError</span><span class="p">:</span>
- <span class="k">pass</span>
+ <span class="n">pkg_config_executable</span> <span class="o">=</span> <span class="n">_os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'PKG_CONFIG'</span><span class="p">)</span> <span class="ow">or</span> <span class="s1">'pkg-config'</span>
+ <span class="k">for</span> <span class="n">pkgname</span> <span class="ow">in</span> <span class="p">[</span><span class="s2">"arrow"</span><span class="p">,</span> <span class="s2">"arrow_python"</span><span class="p">]:</span>
+ <span class="k">if</span> <span class="n">_has_pkg_config</span><span class="p">(</span><span class="n">pkgname</span><span class="p">):</span>
+ <span class="n">library_dir</span> <span class="o">=</span> <span class="n">_read_pkg_config_variable</span><span class="p">(</span><span class="n">pkgname</span><span class="p">,</span>
+ <span class="p">[</span><span class="s2">"--libs-only-L"</span><span class="p">])</span>
+ <span class="k">assert</span> <span class="n">library_dir</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s2">"-L"</span><span class="p">)</span>
+ <span class="n">append_library_dir</span><span class="p">(</span><span class="n">library_dir</span><span class="p">[</span><span class="mi">2</span><span class="p">:])</span>
<span class="k">if</span> <span class="n">_sys</span><span class="o">.</span><span class="n">platform</span> <span class="o">==</span> <span class="s1">'win32'</span><span class="p">:</span>
<span class="c1"># TODO(wesm): Is this necessary, or does setuptools within a conda</span>
<span class="c1"># installation add Library\lib to the linker path for MSVC?</span>
<span class="n">python_base_install</span> <span class="o">=</span> <span class="n">_os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">dirname</span><span class="p">(</span><span class="n">_sys</span><span class="o">.</span><span class="n">executable</span><span class="p">)</span>
- <span class="n">library_lib</span> <span class="o">=</span> <span class="n">_os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">python_base_install</span><span class="p">,</span> <span class="s1">'Library'</span><span class="p">,</span> <span class="s1">'lib'</span><span class="p">)</span>
+ <span class="n">library_dir</span> <span class="o">=</span> <span class="n">_os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">python_base_install</span><span class="p">,</span> <span class="s1">'Library'</span><span class="p">,</span> <span class="s1">'lib'</span><span class="p">)</span>
- <span class="k">if</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">_os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">library_lib</span><span class="p">,</span> <span class="s1">'arrow.lib'</span><span class="p">)):</span>
- <span class="n">library_dirs</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">library_lib</span><span class="p">)</span>
+ <span class="k">if</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">_os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">library_dir</span><span class="p">,</span> <span class="s1">'arrow.lib'</span><span class="p">)):</span>
+ <span class="n">append_library_dir</span><span class="p">(</span><span class="n">library_dir</span><span class="p">)</span>
<span class="c1"># ARROW-4074: Allow for ARROW_HOME to be set to some other directory</span>
- <span class="k">if</span> <span class="s1">'ARROW_HOME'</span> <span class="ow">in</span> <span class="n">_os</span><span class="o">.</span><span class="n">environ</span><span class="p">:</span>
- <span class="n">library_dirs</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">_os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">_os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s1">'ARROW_HOME'</span><span class="p">],</span> <span class="s1">'lib'</span><span cla [...]
+ <span class="k">if</span> <span class="n">_os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'ARROW_HOME'</span><span class="p">):</span>
+ <span class="n">append_library_dir</span><span class="p">(</span><span class="n">_os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">_os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s1">'ARROW_HOME'</span><span class="p">],</span> <span class="s1">'lib'</span><span class="p">))</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="c1"># Python wheels bundle the Arrow libraries in the pyarrow directory.</span>
+ <span class="n">append_library_dir</span><span class="p">(</span><span class="n">_os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">dirname</span><span class="p">(</span><span class="n">_os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">abspath</span><span class="p">(</span><span class="vm">__file__</span><span class="p">)))</span>
- <span class="k">return</span> <span class="n">library_dirs</span></div>
+ <span class="k">return</span> <span class="n">library_dirs</span>
</pre></div>
</div>
diff --git a/docs/_modules/pyarrow/feather.html b/docs/_modules/pyarrow/feather.html
index cf64ba4..e3be6ab 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.13.0</title>
+ <title>pyarrow.feather — Apache Arrow v0.14.2.dev0+g5f564424c.d20190805</title>
@@ -59,7 +59,7 @@
<div class="version">
- 0.13.0
+ 0.14.2.dev0+g5f564424c.d20190805
</div>
@@ -90,6 +90,7 @@
<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>
+<li class="toctree-l1"><a class="reference internal" href="../../format/Flight.html">Arrow Flight RPC</a></li>
</ul>
<p class="caption"><span class="caption-text">Arrow Libraries</span></p>
<ul>
@@ -102,6 +103,7 @@
<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/benchmarks.html">Benchmarks</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../developers/documentation.html">Building the Documentation</a></li>
</ul>
@@ -185,31 +187,27 @@
<span class="c1"># specific language governing permissions and limitations</span>
<span class="c1"># under the License.</span>
-<span class="kn">from</span> <span class="nn">distutils.version</span> <span class="k">import</span> <span class="n">LooseVersion</span>
+<span class="kn">from</span> <span class="nn">__future__</span> <span class="k">import</span> <span class="n">absolute_import</span>
+
<span class="kn">import</span> <span class="nn">os</span>
<span class="kn">import</span> <span class="nn">six</span>
-<span class="kn">import</span> <span class="nn">pandas</span> <span class="k">as</span> <span class="nn">pd</span>
-<span class="kn">from</span> <span class="nn">pyarrow.compat</span> <span class="k">import</span> <span class="n">pdapi</span>
+<span class="kn">from</span> <span class="nn">pyarrow.pandas_compat</span> <span class="k">import</span> <span class="n">_pandas_api</span> <span class="c1"># noqa</span>
<span class="kn">from</span> <span class="nn">pyarrow.lib</span> <span class="k">import</span> <span class="n">FeatherError</span> <span class="c1"># noqa</span>
<span class="kn">from</span> <span class="nn">pyarrow.lib</span> <span class="k">import</span> <span class="n">Table</span><span class="p">,</span> <span class="n">concat_tables</span>
<span class="kn">import</span> <span class="nn">pyarrow.lib</span> <span class="k">as</span> <span class="nn">ext</span>
-<span class="k">try</span><span class="p">:</span>
- <span class="n">infer_dtype</span> <span class="o">=</span> <span class="n">pdapi</span><span class="o">.</span><span class="n">infer_dtype</span>
-<span class="k">except</span> <span class="ne">AttributeError</span><span class="p">:</span>
- <span class="n">infer_dtype</span> <span class="o">=</span> <span class="n">pd</span><span class="o">.</span><span class="n">lib</span><span class="o">.</span><span class="n">infer_dtype</span>
-
-
-<span class="k">if</span> <span class="n">LooseVersion</span><span class="p">(</span><span class="n">pd</span><span class="o">.</span><span class="n">__version__</span><span class="p">)</span> <span class="o"><</span> <span class="s1">'0.17.0'</span><span class="p">:</span>
- <span class="k">raise</span> <span class="ne">ImportError</span><span class="p">(</span><span class="s2">"feather requires pandas >= 0.17.0"</span><span class="p">)</span>
+<span class="k">def</span> <span class="nf">_check_pandas_version</span><span class="p">():</span>
+ <span class="k">if</span> <span class="n">_pandas_api</span><span class="o">.</span><span class="n">loose_version</span> <span class="o"><</span> <span class="s1">'0.17.0'</span><span class="p">:</span>
+ <span class="k">raise</span> <span class="ne">ImportError</span><span class="p">(</span><span class="s2">"feather requires pandas >= 0.17.0"</span><span class="p">)</span>
<span class="k">class</span> <span class="nc">FeatherReader</span><span class="p">(</span><span class="n">ext</span><span class="o">.</span><span class="n">FeatherReader</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">source</span><span class="p">):</span>
+ <span class="n">_check_pandas_version</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">source</span> <span class="o">=</span> <span class="n">source</span>
<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>
@@ -250,12 +248,13 @@
<span class="k">class</span> <span class="nc">FeatherWriter</span><span class="p">(</span><span class="nb">object</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">dest</span><span class="p">):</span>
+ <span class="n">_check_pandas_version</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">dest</span> <span class="o">=</span> <span class="n">dest</span>
<span class="bp">self</span><span class="o">.</span><span class="n">writer</span> <span class="o">=</span> <span class="n">ext</span><span class="o">.</span><span class="n">FeatherWriter</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">writer</span><span class="o">.</span><span class="n">open</span><span class="p">(</span><span class="n">dest</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">write</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">df</span><span class="p">):</span>
- <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">df</span><span class="p">,</span> <span class="n">pd</span><span class="o">.</span><span class="n">SparseDataFrame</span><span class="p">):</span>
+ <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">df</span><span class="p">,</span> <span class="n">_pandas_api</span><span class="o">.</span><span class="n">pd</span><span class="o">.</span><span class="n">SparseDataFrame</span><span class="p">):</span>
<span class="n">df</span> <span class="o">=</span> <span class="n">df</span><span class="o">.</span><span class="n">to_dense</span><span class="p">()</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">df</span><span class="o">.</span><span class="n">columns</span><span class="o">.</span><span class="n">is_unique</span><span class="p">:</span>
@@ -284,6 +283,7 @@
<span class="sd"> Check that individual file schemas are all the same / compatible</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_or_paths</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">_check_pandas_version</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">path_or_paths</span>
<span class="bp">self</span><span class="o">.</span><span class="n">validate_schema</span> <span class="o">=</span> <span class="n">validate_schema</span>
diff --git a/docs/_modules/pyarrow/filesystem.html b/docs/_modules/pyarrow/filesystem.html
index 1848b7b..f0fc579 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.13.0</title>
+ <title>pyarrow.filesystem — Apache Arrow v0.14.2.dev0+g5f564424c.d20190805</title>
@@ -59,7 +59,7 @@
<div class="version">
- 0.13.0
+ 0.14.2.dev0+g5f564424c.d20190805
</div>
@@ -90,6 +90,7 @@
<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>
+<li class="toctree-l1"><a class="reference internal" href="../../format/Flight.html">Arrow Flight RPC</a></li>
</ul>
<p class="caption"><span class="caption-text">Arrow Libraries</span></p>
<ul>
@@ -102,6 +103,7 @@
<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/benchmarks.html">Benchmarks</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../developers/documentation.html">Building the Documentation</a></li>
</ul>
@@ -185,6 +187,8 @@
<span class="c1"># specific language governing permissions and limitations</span>
<span class="c1"># under the License.</span>
+<span class="kn">from</span> <span class="nn">__future__</span> <span class="k">import</span> <span class="n">absolute_import</span>
+
<span class="kn">import</span> <span class="nn">os</span>
<span class="kn">import</span> <span class="nn">inspect</span>
<span class="kn">import</span> <span class="nn">posixpath</span>
diff --git a/docs/_modules/pyarrow/hdfs.html b/docs/_modules/pyarrow/hdfs.html
index d940b29..f243603 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.13.0</title>
+ <title>pyarrow.hdfs — Apache Arrow v0.14.2.dev0+g5f564424c.d20190805</title>
@@ -59,7 +59,7 @@
<div class="version">
- 0.13.0
+ 0.14.2.dev0+g5f564424c.d20190805
</div>
@@ -90,6 +90,7 @@
<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>
+<li class="toctree-l1"><a class="reference internal" href="../../format/Flight.html">Arrow Flight RPC</a></li>
</ul>
<p class="caption"><span class="caption-text">Arrow Libraries</span></p>
<ul>
@@ -102,6 +103,7 @@
<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/benchmarks.html">Benchmarks</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../developers/documentation.html">Building the Documentation</a></li>
</ul>
@@ -185,6 +187,8 @@
<span class="c1"># specific language governing permissions and limitations</span>
<span class="c1"># under the License.</span>
+<span class="kn">from</span> <span class="nn">__future__</span> <span class="k">import</span> <span class="n">absolute_import</span>
+
<span class="kn">import</span> <span class="nn">os</span>
<span class="kn">import</span> <span class="nn">posixpath</span>
<span class="kn">import</span> <span class="nn">sys</span>
@@ -194,7 +198,7 @@
<span class="kn">import</span> <span class="nn">pyarrow.lib</span> <span class="k">as</span> <span class="nn">lib</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>
+<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="sd">"""</span>
<span class="sd"> FileSystem interface for HDFS cluster. See pyarrow.hdfs.connect for full</span>
<span class="sd"> connection details</span>
@@ -227,11 +231,11 @@
<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="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">isfile</span><span class="p">(</span><span class="n">path</span><span class="p">)</span>
-<div class="viewcode-block" id="HadoopFileSystem.delete"><a class="viewcode-back" href="../../python/generated/pyarrow.HadoopFileSystem.delete.html#pyarrow.HadoopFileSystem.delete">[docs]</a> <span class="nd">@implements</span><span class="p">(</span><span class="n">FileSystem</span><span class="o">.</span><span class="n">delete</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">delete</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">delete</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">recursive</span><span class="o">=</span><span class="kc">False</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">delete</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">recursive</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">delete</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">recursive</span><span class="p">)</span>
-<div class="viewcode-block" id="HadoopFileSystem.mkdir"><a class="viewcode-back" href="../../python/generated/pyarrow.HadoopFileSystem.mkdir.html#pyarrow.HadoopFileSystem.mkdir">[docs]</a> <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="o">**</span><span class="n">kwargs</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="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Create directory in HDFS</span>
@@ -244,17 +248,17 @@
<span class="sd"> -----</span>
<span class="sd"> libhdfs does not support create_parents=False, so we ignore this here</span>
<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>
+ <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>
<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 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="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="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">exists</span><span class="p">(</span><span class="n">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">exists</span><span class="p">(</span><span class="n">path</span><span class="p">)</span>
-<div class="viewcode-block" id="HadoopFileSystem.ls"><a class="viewcode-back" href="../../python/generated/pyarrow.HadoopFileSystem.ls.html#pyarrow.HadoopFileSystem.ls">[docs]</a> <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">detail</span><span class="o">=</span><span class="kc">False</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">detail</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Retrieve directory contents and metadata, if requested.</span>
@@ -268,7 +272,7 @@
<span class="sd"> -------</span>
<span class="sd"> result : list of dicts (detail=True) or strings (detail=False)</span>
<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">ls</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">detail</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">ls</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">detail</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">top_path</span><span class="p">):</span>
<span class="sd">"""</span>
@@ -289,11 +293,13 @@
<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>
+ <span class="k">yield</span> <span class="n">tup</span></div>
<span class="k">def</span> <span class="nf">_maybe_set_hadoop_classpath</span><span class="p">():</span>
- <span class="k">if</span> <span class="s1">'hadoop'</span> <span class="ow">in</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'CLASSPATH'</span><span class="p">,</span> <span class="s1">''</span><span class="p">):</span>
+ <span class="kn">import</span> <span class="nn">re</span>
+
+ <span class="k">if</span> <span class="n">re</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="sa">r</span><span class="s1">'hadoop-common[^/]+.jar'</span><span class="p">,</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'CLASSPATH'</span><span class="p">,</span> <span class="s1">''</span [...]
<span class="k">return</span>
<span class="k">if</span> <span class="s1">'HADOOP_HOME'</span> <span class="ow">in</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">:</span>
@@ -311,7 +317,7 @@
<span class="k">def</span> <span class="nf">_derive_hadoop_classpath</span><span class="p">():</span>
<span class="kn">import</span> <span class="nn">subprocess</span>
- <span class="n">find_args</span> <span class="o">=</span> <span class="p">(</span><span class="s1">'find'</span><span class="p">,</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s1">'HADOOP_HOME'</span><span class="p">],</span> <span class="s1">'-name'</span><span class="p">,</span> <span class="s1">'*.jar'</span><span class="p">)</span>
+ <span class="n">find_args</span> <span class="o">=</span> <span class="p">(</span><span class="s1">'find'</span><span class="p">,</span> <span class="s1">'-L'</span><span class="p">,</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s1">'HADOOP_HOME'</span><span class="p">],</span> <span class="s1">'-name'</span><span class="p">,</span> <span class="s1">'*.jar'</span><span [...]
<span class="n">find</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="n">find_args</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="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>
diff --git a/docs/_modules/pyarrow/ipc.html b/docs/_modules/pyarrow/ipc.html
index b7a6a2c..f2ad491 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.13.0</title>
+ <title>pyarrow.ipc — Apache Arrow v0.14.2.dev0+g5f564424c.d20190805</title>
@@ -59,7 +59,7 @@
<div class="version">
- 0.13.0
+ 0.14.2.dev0+g5f564424c.d20190805
</div>
@@ -90,6 +90,7 @@
<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>
+<li class="toctree-l1"><a class="reference internal" href="../../format/Flight.html">Arrow Flight RPC</a></li>
</ul>
<p class="caption"><span class="caption-text">Arrow Libraries</span></p>
<ul>
@@ -102,6 +103,7 @@
<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/benchmarks.html">Benchmarks</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../developers/documentation.html">Building the Documentation</a></li>
</ul>
@@ -187,6 +189,8 @@
<span class="c1"># Arrow file and stream reader/writer classes, and other messaging tools</span>
+<span class="kn">from</span> <span class="nn">__future__</span> <span class="k">import</span> <span class="n">absolute_import</span>
+
<span class="kn">import</span> <span class="nn">pyarrow</span> <span class="k">as</span> <span class="nn">pa</span>
<span class="kn">from</span> <span class="nn">pyarrow.lib</span> <span class="k">import</span> <span class="p">(</span><span class="n">Message</span><span class="p">,</span> <span class="n">MessageReader</span><span class="p">,</span> <span class="c1"># noqa</span>
@@ -312,7 +316,7 @@
<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>
+<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">None</span><span class="p">):</span>
<span class="sd">"""Serialize a pandas DataFrame into a buffer protocol compatible object.</span>
<span class="sd"> Parameters</span>
@@ -320,9 +324,11 @@
<span class="sd"> df : pandas.DataFrame</span>
<span class="sd"> nthreads : int, default None</span>
<span class="sd"> Number of threads to use for conversion to Arrow, default all CPUs</span>
-<span class="sd"> preserve_index : boolean, default True</span>
-<span class="sd"> If True, preserve the pandas index data, otherwise the result will have</span>
-<span class="sd"> a default RangeIndex</span>
+<span class="sd"> preserve_index : boolean, default None</span>
+<span class="sd"> The default of None will store the index as a column, except for</span>
+<span class="sd"> RangeIndex which is stored as metadata only. If True, always</span>
+<span class="sd"> preserve the pandas index data as a column. If False, no index</span>
+<span class="sd"> information is saved and the result will have a default RangeIndex.</span>
<span class="sd"> Returns</span>
<span class="sd"> -------</span>
diff --git a/docs/_modules/pyarrow/parquet.html b/docs/_modules/pyarrow/parquet.html
index 0c62aa9..cff33eb 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.13.0</title>
+ <title>pyarrow.parquet — Apache Arrow v0.14.2.dev0+g5f564424c.d20190805</title>
@@ -59,7 +59,7 @@
<div class="version">
- 0.13.0
+ 0.14.2.dev0+g5f564424c.d20190805
</div>
@@ -90,6 +90,7 @@
<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>
+<li class="toctree-l1"><a class="reference internal" href="../../format/Flight.html">Arrow Flight RPC</a></li>
</ul>
<p class="caption"><span class="caption-text">Arrow Libraries</span></p>
<ul>
@@ -102,6 +103,7 @@
<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/benchmarks.html">Benchmarks</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../developers/documentation.html">Building the Documentation</a></li>
</ul>
@@ -185,6 +187,8 @@
<span class="c1"># specific language governing permissions and limitations</span>
<span class="c1"># under the License.</span>
+<span class="kn">from</span> <span class="nn">__future__</span> <span class="k">import</span> <span class="n">absolute_import</span>
+
<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>
@@ -195,12 +199,13 @@
<span class="kn">import</span> <span class="nn">os</span>
<span class="kn">import</span> <span class="nn">re</span>
<span class="kn">import</span> <span class="nn">six</span>
+<span class="kn">import</span> <span class="nn">warnings</span>
<span class="kn">import</span> <span class="nn">pyarrow</span> <span class="k">as</span> <span class="nn">pa</span>
<span class="kn">import</span> <span class="nn">pyarrow.lib</span> <span class="k">as</span> <span class="nn">lib</span>
<span class="kn">import</span> <span class="nn">pyarrow._parquet</span> <span class="k">as</span> <span class="nn">_parquet</span>
-<span class="kn">from</span> <span class="nn">pyarrow._parquet</span> <span class="k">import</span> <span class="p">(</span><span class="n">ParquetReader</span><span class="p">,</span> <span class="n">RowGroupStatistics</span><span class="p">,</span> <span class="c1"># noqa</span>
+<span class="kn">from</span> <span class="nn">pyarrow._parquet</span> <span class="k">import</span> <span class="p">(</span><span class="n">ParquetReader</span><span class="p">,</span> <span class="n">Statistics</span><span class="p">,</span> <span class="c1"># noqa</span>
<span class="n">FileMetaData</span><span class="p">,</span> <span class="n">RowGroupMetaData</span><span class="p">,</span>
<span class="n">ColumnChunkMetaData</span><span class="p">,</span>
<span class="n">ParquetSchema</span><span class="p">,</span> <span class="n">ColumnSchema</span><span class="p">)</span>
@@ -284,9 +289,9 @@
<span class="sd"> source : str, pathlib.Path, pyarrow.NativeFile, or file-like object</span>
<span class="sd"> Readable source. For passing bytes or buffer-like file containing a</span>
<span class="sd"> Parquet file, use pyarorw.BufferReader</span>
-<span class="sd"> metadata : ParquetFileMetadata, default None</span>
+<span class="sd"> metadata : FileMetaData, default None</span>
<span class="sd"> Use existing metadata object, rather than reading from file.</span>
-<span class="sd"> common_metadata : ParquetFileMetadata, default None</span>
+<span class="sd"> common_metadata : FileMetaData, default None</span>
<span class="sd"> Will be used in reads for pandas schema metadata if not found in the</span>
<span class="sd"> main file's metadata, no other uses at the moment</span>
<span class="sd"> memory_map : boolean, default True</span>
@@ -427,9 +432,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="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="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="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">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">descr</span><span class="p">,</span> <span class="nb">dict</span><span class="p">)]</span>
<span class="k">return</span> <span class="n">indices</span></div>
@@ -485,6 +490,10 @@
<span class="s2">coerce_timestamps : string, default None</span>
<span class="s2"> Cast timestamps a particular resolution.</span>
<span class="s2"> Valid values: {None, 'ms', 'us'}</span>
+<span class="s2">data_page_size : int, default None</span>
+<span class="s2"> Set a target threshhold for the approximate encoded size of data</span>
+<span class="s2"> pages within a column chunk. If None, use the default data page</span>
+<span class="s2"> size of 1MByte.</span>
<span class="s2">allow_truncated_timestamps : boolean, default False</span>
<span class="s2"> Allow loss of data when coercing timestamps to a particular</span>
<span class="s2"> resolution. E.g. if microsecond or nanosecond data is lost when coercing to</span>
@@ -492,8 +501,12 @@
<span class="s2">compression : str or dict</span>
<span class="s2"> Specify the compression codec, either on a general basis or per-column.</span>
<span class="s2"> Valid values: {'NONE', 'SNAPPY', 'GZIP', 'LZO', 'BROTLI', 'LZ4', 'ZSTD'}</span>
+<span class="s2">write_statistics : bool or list</span>
+<span class="s2"> Specify if we should write statistics in general (default is True) or only</span>
+<span class="s2"> for some columns.</span>
<span class="s2">flavor : {'spark'}, default None</span>
-<span class="s2"> Sanitize schema or set other compatibility options for compatibility</span>
+<span class="s2"> Sanitize schema or set other compatibility options to work with</span>
+<span class="s2"> various target systems</span>
<span class="s2">filesystem : FileSystem, default None</span>
<span class="s2"> If nothing passed, will be inferred from `where` if path-like, else</span>
<span class="s2"> `where` is already a file-like object so no filesystem is needed."""</span>
@@ -509,6 +522,11 @@
<span class="s2">where : path or file-like object</span>
<span class="s2">schema : arrow Schema</span>
<span class="si">{0}</span><span class="s2"></span>
+<span class="s2">**options : dict</span>
+<span class="s2"> If options contains a key `metadata_collector` then the</span>
+<span class="s2"> corresponding value is assumed to be a list (or any object with</span>
+<span class="s2"> `.append` method) that will be filled with file metadata instances</span>
+<span class="s2"> of dataset pieces.</span>
<span class="s2">"""</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">_parquet_writer_arg_docs</span><span class="p">)</span>
<div class="viewcode-block" id="ParquetWriter.__init__"><a class="viewcode-back" href="../../python/generated/pyarrow.parquet.ParquetWriter.html#pyarrow.parquet.ParquetWriter.__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">where</span><span class="p">,</span> <span class="n">schema</span><span class="p">,</span> <span class="n">filesystem</span><span class="o">= [...]
@@ -516,6 +534,7 @@
<span class="n">version</span><span class="o">=</span><span class="s1">'1.0'</span><span class="p">,</span>
<span class="n">use_dictionary</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
<span class="n">compression</span><span class="o">=</span><span class="s1">'snappy'</span><span class="p">,</span>
+ <span class="n">write_statistics</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
<span class="n">use_deprecated_int96_timestamps</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="o">**</span><span class="n">options</span><span class="p">):</span>
<span class="k">if</span> <span class="n">use_deprecated_int96_timestamps</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="c1"># Use int96 timestamps for Spark</span>
@@ -542,12 +561,13 @@
<span class="n">sink</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">file_handle</span> <span class="o">=</span> <span class="n">filesystem</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="s1">'wb'</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">sink</span> <span class="o">=</span> <span class="n">where</span>
-
+ <span class="bp">self</span><span class="o">.</span><span class="n">_metadata_collector</span> <span class="o">=</span> <span class="n">options</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="s1">'metadata_collector'</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">writer</span> <span class="o">=</span> <span class="n">_parquet</span><span class="o">.</span><span class="n">ParquetWriter</span><span class="p">(</span>
<span class="n">sink</span><span class="p">,</span> <span class="n">schema</span><span class="p">,</span>
<span class="n">version</span><span class="o">=</span><span class="n">version</span><span class="p">,</span>
<span class="n">compression</span><span class="o">=</span><span class="n">compression</span><span class="p">,</span>
<span class="n">use_dictionary</span><span class="o">=</span><span class="n">use_dictionary</span><span class="p">,</span>
+ <span class="n">write_statistics</span><span class="o">=</span><span class="n">write_statistics</span><span class="p">,</span>
<span class="n">use_deprecated_int96_timestamps</span><span class="o">=</span><span class="n">use_deprecated_int96_timestamps</span><span class="p">,</span>
<span class="o">**</span><span class="n">options</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">is_open</span> <span class="o">=</span> <span class="kc">True</span></div>
@@ -581,6 +601,8 @@
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">is_open</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">writer</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">is_open</span> <span class="o">=</span> <span class="kc">False</span>
+ <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_metadata_collector</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">_metadata_collector</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">writer</span><span class="o">.</span><span class="n">metadata</span><span class="p">)</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">file_handle</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">file_handle</span><span class="o">.</span><span class="n">close</span><span class="p">()</span></div></div>
@@ -650,12 +672,37 @@
<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="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="sd">"""</span>
+<span class="sd"> Returns the file's metadata</span>
+
+<span class="sd"> Parameters</span>
+<span class="sd"> ----------</span>
+<span class="sd"> open_file_func : function, deprecated</span>
+<span class="sd"> Function to use for obtaining file handle to dataset piece.</span>
+<span class="sd"> Deprecated in version 0.13.0. Use ``open_file_func`` parameter of</span>
+<span class="sd"> the constructor instead.</span>
+
+<span class="sd"> Returns</span>
+<span class="sd"> -------</span>
+<span class="sd"> metadata : FileMetaData</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">f</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">else</span><span class="p">:</span>
+ <span class="n">f</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">return</span> <span class="n">f</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="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"> Returns instance of ParquetFile</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="o">.</span><span class="n">metadata</span>
+ <span class="n">warnings</span><span class="o">.</span><span class="n">warn</span><span class="p">(</span><span class="s1">'open_file_func argument is deprecated, please pass '</span>
+ <span class="s1">'it to ParquetDatasetPiece instead'</span><span class="p">,</span> <span class="ne">DeprecationWarning</span><span class="p">)</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="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">open</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""</span>
@@ -667,7 +714,7 @@
<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">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">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="sd">"""</span>
<span class="sd"> Read this piece as a pyarrow.Table</span>
@@ -677,9 +724,10 @@
<span class="sd"> use_threads : boolean, default True</span>
<span class="sd"> Perform multi-threaded column reads</span>
<span class="sd"> partitions : ParquetPartitions, default None</span>
-<span class="sd"> open_file_func : function, default None</span>
-<span class="sd"> A function that knows how to construct a ParquetFile object given</span>
-<span class="sd"> the file path in this piece</span>
+<span class="sd"> open_file_func : function, deprecated</span>
+<span class="sd"> Function to use for obtaining file handle to dataset piece.</span>
+<span class="sd"> Deprecated in version 0.13.0. Use ``open_file_func`` parameter of</span>
+<span class="sd"> the constructor instead.</span>
<span class="sd"> file : file-like object</span>
<span class="sd"> passed to ParquetFile</span>
@@ -687,7 +735,9 @@
<span class="sd"> -------</span>
<span class="sd"> table : pyarrow.Table</span>
<span class="sd"> """</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="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">elif</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>
@@ -804,6 +854,23 @@
<span class="k">def</span> <span class="nf">__getitem__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">i</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">levels</span><span class="p">[</span><span class="n">i</span><span class="p">]</span>
+ <span class="k">def</span> <span class="nf">equals</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</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">other</span><span class="p">,</span> <span class="n">ParquetPartitions</span><span class="p">):</span>
+ <span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="s1">'`other` must be an instance of ParquetPartitions'</span><span class="p">)</span>
+
+ <span class="k">return</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">levels</span> <span class="o">==</span> <span class="n">other</span><span class="o">.</span><span class="n">levels</span> <span class="ow">and</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">partition_names</span> <span class="o">==</span> <span class="n">other</span><span class="o">.</span><span class="n">partition_names</span><span class="p">)</span>
+
+ <span class="k">def</span> <span class="nf">__eq__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span>
+ <span class="k">try</span><span class="p">:</span>
+ <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">equals</span><span class="p">(</span><span class="n">other</span><span class="p">)</span>
+ <span class="k">except</span> <span class="ne">TypeError</span><span class="p">:</span>
+ <span class="k">return</span> <span class="bp">NotImplemented</span>
+
+ <span class="k">def</span> <span class="nf">__ne__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span>
+ <span class="c1"># required for python 2, cython implements it by default</span>
+ <span class="k">return</span> <span class="ow">not</span> <span class="p">(</span><span class="bp">self</span> <span class="o">==</span> <span class="n">other</span><span class="p">)</span>
+
<span class="k">def</span> <span class="nf">get_index</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">level</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">key</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Record a partition value at a particular level, returning the distinct</span>
@@ -947,7 +1014,8 @@
<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="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 starting with .</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 starting with _</span>
<span class="n">file_name</span> <span class="ow">in</span> <span class="n">EXCLUDED_PARQUET_PATHS</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">_visit_directories</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">level</span><span class="p">,</span> <span class="n">directories</span><span class="p">,</span> <span class="n">part_keys</span><span class="p">):</span>
@@ -1008,6 +1076,16 @@
<span class="n">EXCLUDED_PARQUET_PATHS</span> <span class="o">=</span> <span class="p">{</span><span class="s1">'_SUCCESS'</span><span class="p">}</span>
+<span class="k">def</span> <span class="nf">_open_dataset_file</span><span class="p">(</span><span class="n">dataset</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">if</span> <span class="n">dataset</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="n">dataset</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">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="n">dataset</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="n">dataset</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">return</span> <span class="n">ParquetFile</span><span class="p">(</span><span class="n">dataset</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">metadata</span><span class="o">=</span><span class="n">meta</ [...]
+ <span class="n">memory_map</span><span class="o">=</span><span class="n">dataset</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="n">dataset</span><span class="o">.</span><span class="n">common_metadata</span><span class="p">)</span>
+
+
<div class="viewcode-block" id="ParquetDataset"><a class="viewcode-back" href="../../python/generated/pyarrow.parquet.ParquetDataset.html#pyarrow.parquet.ParquetDataset">[docs]</a><span class="k">class</span> <span class="nc">ParquetDataset</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Encapsulates details of reading a complete Parquet dataset possibly</span>
@@ -1066,14 +1144,13 @@
<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">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="n">open_file_func</span><span class="o">=</span><span class="n">partial</span><span class="p">(</span><span class="n">_open_dataset_file</span><span class="p">,</span> <span class="bp">self</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>
@@ -1095,12 +1172,37 @@
<span class="k">if</span> <span class="n">split_row_groups</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">(</span><span class="s2">"split_row_groups not yet implemented"</span><span class="p">)</span>
- <span class="k">if</span> <span class="n">validate_schema</span><span class="p">:</span>
- <span class="bp">self</span><span class="o">.</span><span class="n">validate_schemas</span><span class="p">()</span>
-
<span class="k">if</span> <span class="n">filters</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">filters</span> <span class="o">=</span> <span class="n">_check_filters</span><span class="p">(</span><span class="n">filters</span><span class="p">)</span>
- <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>
+ <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>
+
+ <span class="k">if</span> <span class="n">validate_schema</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">validate_schemas</span><span class="p">()</span></div>
+
+<div class="viewcode-block" id="ParquetDataset.equals"><a class="viewcode-back" href="../../python/generated/pyarrow.parquet.ParquetDataset.html#pyarrow.parquet.ParquetDataset.equals">[docs]</a> <span class="k">def</span> <span class="nf">equals</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</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">other</span><span class="p">,</span> <span class="n">ParquetDataset</span><span class="p">):</span>
+ <span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="s1">'`other` must be an instance of ParquetDataset'</span><span class="p">)</span>
+
+ <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">fs</span><span class="o">.</span><span class="vm">__class__</span> <span class="o">!=</span> <span class="n">other</span><span class="o">.</span><span class="n">fs</span><span class="o">.</span><span class="vm">__class__</span><span class="p">:</span>
+ <span class="k">return</span> <span class="kc">False</span>
+ <span class="k">for</span> <span class="n">prop</span> <span class="ow">in</span> <span class="p">(</span><span class="s1">'paths'</span><span class="p">,</span> <span class="s1">'memory_map'</span><span class="p">,</span> <span class="s1">'pieces'</span><span class="p">,</span> <span class="s1">'partitions'</span><span class="p">,</span>
+ <span class="s1">'common_metadata_path'</span><span class="p">,</span> <span class="s1">'metadata_path'</span><span class="p">,</span>
+ <span class="s1">'common_metadata'</span><span class="p">,</span> <span class="s1">'metadata'</span><span class="p">,</span> <span class="s1">'schema'</span><span class="p">,</span>
+ <span class="s1">'split_row_groups'</span><span class="p">):</span>
+ <span class="k">if</span> <span class="nb">getattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">prop</span><span class="p">)</span> <span class="o">!=</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">other</span><span class="p">,</span> <span class="n">prop</span><span class="p">):</span>
+ <span class="k">return</span> <span class="kc">False</span>
+
+ <span class="k">return</span> <span class="kc">True</span></div>
+
+ <span class="k">def</span> <span class="nf">__eq__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span>
+ <span class="k">try</span><span class="p">:</span>
+ <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">equals</span><span class="p">(</span><span class="n">other</span><span class="p">)</span>
+ <span class="k">except</span> <span class="ne">TypeError</span><span class="p">:</span>
+ <span class="k">return</span> <span class="bp">NotImplemented</span>
+
+ <span class="k">def</span> <span class="nf">__ne__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span>
+ <span class="c1"># required for python 2, cython implements it by default</span>
+ <span class="k">return</span> <span class="ow">not</span> <span class="p">(</span><span class="bp">self</span> <span class="o">==</span> <span class="n">other</span><span class="p">)</span>
<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="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>
@@ -1189,20 +1291,6 @@
<span class="n">keyvalues</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">metadata</span>
<span class="k">return</span> <span class="n">keyvalues</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="sa">b</span><span class="s1">'pandas'</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
- <span class="k">def</span> <span class="nf">_get_open_file_func</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
- <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>
-
<span class="k">def</span> <span class="nf">_filter</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">filters</span><span class="p">):</span>
<span class="n">accepts_filter</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">partitions</span><span class="o">.</span><span class="n">filter_accepts_partition</span>
@@ -1276,6 +1364,11 @@
<span class="s2"> If the source is a file path, use a memory map to read file, which can</span>
<span class="s2"> improve performance in some environments</span>
<span class="si">{1}</span><span class="s2"></span>
+<span class="s2">filters : List[Tuple] or List[List[Tuple]] or None (default)</span>
+<span class="s2"> List of filters to apply, like ``[[('x', '=', 0), ...], ...]``. This</span>
+<span class="s2"> implements partition-level (hive) filtering only, i.e., to prevent the</span>
+<span class="s2"> loading of some files of the dataset if `source` is a directory.</span>
+<span class="s2"> See the docstring of ParquetDataset for more details.</span>
<span class="s2">Returns</span>
<span class="s2">-------</span>
@@ -1285,14 +1378,12 @@
<div class="viewcode-block" id="read_table"><a class="viewcode-back" href="../../python/generated/pyarrow.parquet.read_table.html#pyarrow.parquet.read_table">[docs]</a><span class="k">def</span> <span class="nf">read_table</span><span class="p">(</span><span class="n">source</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">Tru [...]
<span class="n">use_pandas_metadata</span><span class="o">=</span><span class="kc">False</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">filesystem</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">filters</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="k">if</span> <span class="n">_is_path_like</span><span class="p">(</span><span class="n">source</span><span class="p">):</span>
- <span class="n">fs</span><span class="p">,</span> <span class="n">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">source</span><span class="p">)</span>
- <span class="k">return</span> <span class="n">fs</span><span class="o">.</span><span class="n">read_parquet</span><span class="p">(</span><span class="n">path</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">metadata</span><span class="o">=</span><span class="n">metadata</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">pf</span> <span class="o">=</span> <span class="n">ParquetFile</span><span class="p">(</span><span class="n">source</span><span class="p">,</span> <span class="n">metadata</span><span class="o">=</span><span class="n">metadata</span><span class="p">)</span>
+ <span class="n">pf</span> <span class="o">=</span> <span class="n">ParquetDataset</span><span class="p">(</span><span class="n">source</span><span class="p">,</span> <span class="n">metadata</span><span class="o">=</span><span class="n">metadata</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="n">filesystem</span><span class="o">=</span><span class="n">filesystem</span><span class="p">,</span> <span class="n">filters</span><span class="o">=</span><span class="n">filters</span><span class="p">)</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">pf</span> <span class="o">=</span> <span class="n">ParquetFile</span><span class="p">(</span><span class="n">source</span><span class="p">,</span> <span class="n">metadata</span><span class="o">=</span><span class="n">metadata</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="k">return</span> <span class="n">pf</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">use_pandas_metadata</span><span class="o">=</span><span class="n">use_pandas_metadata</span><span class="p">)</span></div>
@@ -1307,10 +1398,11 @@
<div class="viewcode-block" id="read_pandas"><a class="viewcode-back" href="../../python/generated/pyarrow.parquet.read_pandas.html#pyarrow.parquet.read_pandas">[docs]</a><span class="k">def</span> <span class="nf">read_pandas</span><span class="p">(</span><span class="n">source</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" [...]
- <span class="n">metadata</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
+ <span class="n">metadata</span><span class="o">=</span><span class="kc">None</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="k">return</span> <span class="n">read_table</span><span class="p">(</span><span class="n">source</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">metadata</span><span class="o">=</span><span class="n">metadata</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">filters</span><span class="o">=</span><span class="n">filters</span><span class="p">,</span>
<span class="n">use_pandas_metadata</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span></div>
@@ -1325,10 +1417,12 @@
<div class="viewcode-block" id="write_table"><a class="viewcode-back" href="../../python/generated/pyarrow.parquet.write_table.html#pyarrow.parquet.write_table">[docs]</a><span class="k">def</span> <span class="nf">write_table</span><span class="p">(</span><span class="n">table</span><span class="p">,</span> <span class="n">where</span><span class="p">,</span> <span class="n">row_group_size</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n" [...]
<span class="n">use_dictionary</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">compression</span><span class="o">=</span><span class="s1">'snappy'</span><span class="p">,</span>
+ <span class="n">write_statistics</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
<span class="n">use_deprecated_int96_timestamps</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">coerce_timestamps</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">allow_truncated_timestamps</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span>
- <span class="n">flavor</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="o">**</span><span class="n">kwargs</span><span class="p">):</span>
+ <span class="n">data_page_size</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">flavor</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="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="n">row_group_size</span> <span class="o">=</span> <span class="n">kwargs</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="s1">'chunk_size'</span><span class="p">,</span> <span class="n">row_group_size</span><span class="p">)</span>
<span class="n">use_int96</span> <span class="o">=</span> <span class="n">use_deprecated_int96_timestamps</span>
<span class="k">try</span><span class="p">:</span>
@@ -1338,7 +1432,9 @@
<span class="n">version</span><span class="o">=</span><span class="n">version</span><span class="p">,</span>
<span class="n">flavor</span><span class="o">=</span><span class="n">flavor</span><span class="p">,</span>
<span class="n">use_dictionary</span><span class="o">=</span><span class="n">use_dictionary</span><span class="p">,</span>
+ <span class="n">write_statistics</span><span class="o">=</span><span class="n">write_statistics</span><span class="p">,</span>
<span class="n">coerce_timestamps</span><span class="o">=</span><span class="n">coerce_timestamps</span><span class="p">,</span>
+ <span class="n">data_page_size</span><span class="o">=</span><span class="n">data_page_size</span><span class="p">,</span>
<span class="n">allow_truncated_timestamps</span><span class="o">=</span><span class="n">allow_truncated_timestamps</span><span class="p">,</span>
<span class="n">compression</span><span class="o">=</span><span class="n">compression</span><span class="p">,</span>
<span class="n">use_deprecated_int96_timestamps</span><span class="o">=</span><span class="n">use_int96</span><span class="p">,</span>
@@ -1373,9 +1469,8 @@
<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="n">preserve_index</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
+ <span class="sd">"""Wrapper around parquet.write_table for writing a Table to</span>
<span class="sd"> Parquet format by partitions.</span>
<span class="sd"> For each combination of partition columns and values,</span>
<span class="sd"> a subdirectories are created in the following</span>
@@ -1404,8 +1499,16 @@
<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"> **kwargs : dict, kwargs for write_table function.</span>
+<span class="sd"> **kwargs : dict,</span>
+<span class="sd"> kwargs for write_table function. Using `metadata_collector` in</span>
+<span class="sd"> kwargs allows one to collect the file metadata instances of</span>
+<span class="sd"> dataset pieces. See docstring for `write_table` or</span>
+<span class="sd"> `ParquetWriter` for more information.</span>
<span class="sd"> """</span>
+ <span class="k">if</span> <span class="n">preserve_index</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
+ <span class="n">warnings</span><span class="o">.</span><span class="n">warn</span><span class="p">(</span><span class="s1">'preserve_index argument is deprecated as of 0.13.0 and '</span>
+ <span class="s1">'has no effect'</span><span class="p">,</span> <span class="ne">DeprecationWarning</span><span class="p">)</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>
<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>
diff --git a/docs/_modules/pyarrow/types.html b/docs/_modules/pyarrow/types.html
index 759da4b..20efb28 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.13.0</title>
+ <title>pyarrow.types — Apache Arrow v0.14.2.dev0+g5f564424c.d20190805</title>
@@ -59,7 +59,7 @@
<div class="version">
- 0.13.0
+ 0.14.2.dev0+g5f564424c.d20190805
</div>
@@ -90,6 +90,7 @@
<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>
+<li class="toctree-l1"><a class="reference internal" href="../../format/Flight.html">Arrow Flight RPC</a></li>
</ul>
<p class="caption"><span class="caption-text">Arrow Libraries</span></p>
<ul>
@@ -102,6 +103,7 @@
<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/benchmarks.html">Benchmarks</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../developers/documentation.html">Building the Documentation</a></li>
</ul>
@@ -187,6 +189,8 @@
<span class="c1"># Tools for dealing with Arrow type metadata in Python</span>
+<span class="kn">from</span> <span class="nn">__future__</span> <span class="k">import</span> <span class="n">absolute_import</span>
+
<span class="kn">from</span> <span class="nn">pyarrow.lib</span> <span class="k">import</span> <span class="p">(</span><span class="n">is_boolean_value</span><span class="p">,</span> <span class="c1"># noqa</span>
<span class="n">is_integer_value</span><span class="p">,</span>
<span class="n">is_float_value</span><span class="p">)</span>
@@ -206,11 +210,11 @@
<span class="n">_NESTED_TYPES</span> <span class="o">=</span> <span class="p">{</span><span class="n">lib</span><span class="o">.</span><span class="n">Type_LIST</span><span class="p">,</span> <span class="n">lib</span><span class="o">.</span><span class="n">Type_STRUCT</span><span class="p">,</span> <span class="n">lib</span><span class="o">.</span><span class="n">Type_UNION</span><span class="p">,</span> <span class="n">lib</span><span class="o">.</span><span class="n">Type_MAP</span>< [...]
-<div class="viewcode-block" id="is_null"><a class="viewcode-back" href="../../python/generated/pyarrow.types.is_null.html#pyarrow.types.is_null">[docs]</a><span class="k">def</span> <span class="nf">is_null</span><span class="p">(</span><span class="n">t</span><span class="p">):</span>
+<span class="k">def</span> <span class="nf">is_null</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 null 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_NA</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_NA</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>
@@ -227,11 +231,11 @@
<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>
+<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>
<span class="sd">"""</span>
<span class="sd"> Return True if value is an instance of any signed 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">_SIGNED_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">_SIGNED_INTEGER_TYPES</span>
<div class="viewcode-block" id="is_unsigned_integer"><a class="viewcode-back" href="../../python/generated/pyarrow.types.is_unsigned_integer.html#pyarrow.types.is_unsigned_integer">[docs]</a><span class="k">def</span> <span class="nf">is_unsigned_integer</span><span class="p">(</span><span class="n">t</span><span class="p">):</span>
@@ -276,11 +280,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_UINT8</span></div>
-<div class="viewcode-block" id="is_uint16"><a class="viewcode-back" href="../../python/generated/pyarrow.types.is_uint16.html#pyarrow.types.is_uint16">[docs]</a><span class="k">def</span> <span class="nf">is_uint16</span><span class="p">(</span><span class="n">t</span><span class="p">):</span>
+<span class="k">def</span> <span class="nf">is_uint16</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 uint16 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_UINT16</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_UINT16</span>
<div class="viewcode-block" id="is_uint32"><a class="viewcode-back" href="../../python/generated/pyarrow.types.is_uint32.html#pyarrow.types.is_uint32">[docs]</a><span class="k">def</span> <span class="nf">is_uint32</span><span class="p">(</span><span class="n">t</span><span class="p">):</span>
@@ -332,11 +336,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_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>
+<span class="k">def</span> <span class="nf">is_struct</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 struct 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_STRUCT</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_STRUCT</span>
<div class="viewcode-block" id="is_union"><a class="viewcode-back" href="../../python/generated/pyarrow.types.is_union.html#pyarrow.types.is_union">[docs]</a><span class="k">def</span> <span class="nf">is_union</span><span class="p">(</span><span class="n">t</span><span class="p">):</span>
@@ -346,47 +350,47 @@
<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_UNION</span></div>
-<div class="viewcode-block" id="is_nested"><a class="viewcode-back" href="../../python/generated/pyarrow.types.is_nested.html#pyarrow.types.is_nested">[docs]</a><span class="k">def</span> <span class="nf">is_nested</span><span class="p">(</span><span class="n">t</span><span class="p">):</span>
+<span class="k">def</span> <span class="nf">is_nested</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 nested 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">_NESTED_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">_NESTED_TYPES</span>
-<div class="viewcode-block" id="is_temporal"><a class="viewcode-back" href="../../python/generated/pyarrow.types.is_temporal.html#pyarrow.types.is_temporal">[docs]</a><span class="k">def</span> <span class="nf">is_temporal</span><span class="p">(</span><span class="n">t</span><span class="p">):</span>
+<span class="k">def</span> <span class="nf">is_temporal</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 temporal (date, time, timestamp)</span>
<span class="sd"> 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">_TEMPORAL_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">_TEMPORAL_TYPES</span>
-<div class="viewcode-block" id="is_timestamp"><a class="viewcode-back" href="../../python/generated/pyarrow.types.is_timestamp.html#pyarrow.types.is_timestamp">[docs]</a><span class="k">def</span> <span class="nf">is_timestamp</span><span class="p">(</span><span class="n">t</span><span class="p">):</span>
+<span class="k">def</span> <span class="nf">is_timestamp</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 timestamp 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_TIMESTAMP</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_TIMESTAMP</span>
-<div class="viewcode-block" id="is_time"><a class="viewcode-back" href="../../python/generated/pyarrow.types.is_time.html#pyarrow.types.is_time">[docs]</a><span class="k">def</span> <span class="nf">is_time</span><span class="p">(</span><span class="n">t</span><span class="p">):</span>
+<span class="k">def</span> <span class="nf">is_time</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 time 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">_TIME_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">_TIME_TYPES</span>
-<div class="viewcode-block" id="is_time32"><a class="viewcode-back" href="../../python/generated/pyarrow.types.is_time32.html#pyarrow.types.is_time32">[docs]</a><span class="k">def</span> <span class="nf">is_time32</span><span class="p">(</span><span class="n">t</span><span class="p">):</span>
+<span class="k">def</span> <span class="nf">is_time32</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 time32 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_TIME32</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_TIME32</span>
-<div class="viewcode-block" id="is_time64"><a class="viewcode-back" href="../../python/generated/pyarrow.types.is_time64.html#pyarrow.types.is_time64">[docs]</a><span class="k">def</span> <span class="nf">is_time64</span><span class="p">(</span><span class="n">t</span><span class="p">):</span>
+<span class="k">def</span> <span class="nf">is_time64</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 time64 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_TIME64</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_TIME64</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>
@@ -403,11 +407,11 @@
<span class="k">return</span> <span class="n">is_string</span><span class="p">(</span><span class="n">t</span><span class="p">)</span></div>
-<div class="viewcode-block" id="is_string"><a class="viewcode-back" href="../../python/generated/pyarrow.types.is_string.html#pyarrow.types.is_string">[docs]</a><span class="k">def</span> <span class="nf">is_string</span><span class="p">(</span><span class="n">t</span><span class="p">):</span>
+<span class="k">def</span> <span class="nf">is_string</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 string (utf8 unicode) 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_STRING</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_STRING</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>
diff --git a/docs/_sources/cpp/api.rst.txt b/docs/_sources/cpp/api.rst.txt
index 522609e..1c113b7 100644
--- a/docs/_sources/cpp/api.rst.txt
+++ b/docs/_sources/cpp/api.rst.txt
@@ -30,3 +30,4 @@ API Reference
api/table
api/utilities
api/cuda
+ api/flight
diff --git a/docs/_sources/cpp/api/flight.rst.txt b/docs/_sources/cpp/api/flight.rst.txt
new file mode 100644
index 0000000..4e56a76
--- /dev/null
+++ b/docs/_sources/cpp/api/flight.rst.txt
@@ -0,0 +1,126 @@
+.. 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.
+
+================
+Arrow Flight RPC
+================
+
+.. warning:: Flight is currently unstable. APIs are subject to change,
+ though we don't expect drastic changes.
+
+.. warning:: Flight is currently only available when built from source
+ appropriately.
+
+Common Types
+============
+
+.. doxygenstruct:: arrow::flight::Action
+ :project: arrow_cpp
+ :members:
+
+.. doxygenstruct:: arrow::flight::ActionType
+ :project: arrow_cpp
+ :members:
+
+.. doxygenstruct:: arrow::flight::Criteria
+ :project: arrow_cpp
+ :members:
+
+.. doxygenstruct:: arrow::flight::FlightDescriptor
+ :project: arrow_cpp
+ :members:
+
+.. doxygenstruct:: arrow::flight::FlightEndpoint
+ :project: arrow_cpp
+ :members:
+
+.. doxygenclass:: arrow::flight::FlightInfo
+ :project: arrow_cpp
+ :members:
+
+.. doxygenstruct:: arrow::flight::FlightPayload
+ :project: arrow_cpp
+ :members:
+
+.. doxygenclass:: arrow::flight::FlightListing
+ :project: arrow_cpp
+ :members:
+
+.. doxygenstruct:: arrow::flight::Location
+ :project: arrow_cpp
+ :members:
+
+.. doxygenstruct:: arrow::flight::PutResult
+ :project: arrow_cpp
+ :members:
+
+.. doxygenstruct:: arrow::flight::Result
+ :project: arrow_cpp
+ :members:
+
+.. doxygenclass:: arrow::flight::ResultStream
+ :project: arrow_cpp
+ :members:
+
+.. doxygenstruct:: arrow::flight::Ticket
+ :project: arrow_cpp
+ :members:
+
+Clients
+=======
+
+.. doxygenclass:: arrow::flight::FlightClient
+ :project: arrow_cpp
+ :members:
+
+.. doxygenclass:: arrow::flight::FlightCallOptions
+ :project: arrow_cpp
+ :members:
+
+.. doxygenclass:: arrow::flight::ClientAuthHandler
+ :project: arrow_cpp
+ :members:
+
+.. doxygentypedef:: arrow::flight::TimeoutDuration
+ :project: arrow_cpp
+
+Servers
+=======
+
+.. doxygenclass:: arrow::flight::FlightServerBase
+ :project: arrow_cpp
+ :members:
+
+.. doxygenclass:: arrow::flight::FlightDataStream
+ :project: arrow_cpp
+ :members:
+
+.. doxygenclass:: arrow::flight::FlightMessageReader
+ :project: arrow_cpp
+ :members:
+
+.. doxygenclass:: arrow::flight::RecordBatchStream
+ :project: arrow_cpp
+ :members:
+
+.. doxygenclass:: arrow::flight::ServerAuthHandler
+ :project: arrow_cpp
+ :members:
+
+.. doxygenclass:: arrow::flight::ServerCallContext
+ :project: arrow_cpp
+ :members:
diff --git a/docs/_sources/developers/benchmarks.rst.txt b/docs/_sources/developers/benchmarks.rst.txt
new file mode 100644
index 0000000..2ae767b
--- /dev/null
+++ b/docs/_sources/developers/benchmarks.rst.txt
@@ -0,0 +1,172 @@
+.. 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.
+
+.. _benchmarks:
+
+**********
+Benchmarks
+**********
+
+Archery
+=======
+
+``archery`` is a python library and command line utility made to interact with
+Arrow's sources. The main feature is the benchmarking process.
+
+Installation
+~~~~~~~~~~~~
+
+The simplest way to install archery is with pip from the top-level directory.
+It is recommended to use the ``-e,--editable`` flag so that pip don't copy
+the module files but uses the actual sources.
+
+.. code-block:: shell
+
+ pip install -e dev/archery
+ archery --help
+
+ # optional: enable bash/zsh autocompletion
+ eval "$(_ARCHERY_COMPLETE=source archery)"
+
+Running the benchmark suite
+===========================
+
+The benchmark suites can be ran with the ``benchmark run`` sub-command.
+
+.. code-block:: shell
+
+ # Run benchmarks in the current git workspace
+ archery benchmark run
+ # Storing the results in a file
+ archery benchmark run --output=run.json
+
+Sometimes, it is required to pass custom CMake flags, e.g.
+
+.. code-block:: shell
+
+ export CC=clang-8 CXX=clang++8
+ archery benchmark run --cmake-extras="-DARROW_USE_SIMD=ON"
+
+Comparison
+==========
+
+One goal with benchmarking is to detect performance regressions. To this end,
+``archery`` implements a benchmark comparison facility via the ``benchmark
+diff`` sub-command.
+
+In the default invocation, it will compare the current source (known as the
+current workspace in git) with local master branch.
+
+For more information, invoke the ``archery benchmark diff --help`` command for
+multiple examples of invocation.
+
+Iterating efficiently
+~~~~~~~~~~~~~~~~~~~~~
+
+Iterating with benchmark development can be a tedious process due to long
+build time and long run times. Multiple tricks can be used with
+``archery benchmark diff`` to reduce this overhead.
+
+First, the benchmark command supports comparing existing
+build directories, This can be paired with the ``--preserve`` flag to
+avoid rebuilding sources from zero.
+
+.. code-block:: shell
+
+ # First invocation clone and checkouts in a temporary directory. The
+ # directory is preserved with --preserve
+ archery benchmark diff --preserve
+
+ # Modify C++ sources
+
+ # Re-run benchmark in the previously created build directory.
+ archery benchmark diff /tmp/arrow-bench*/{WORKSPACE,master}/build
+
+Second, a benchmark run result can be saved in a json file. This also avoids
+rebuilding the sources, but also executing the (sometimes) heavy benchmarks.
+This technique can be used as a poor's man caching.
+
+.. code-block:: shell
+
+ # Run the benchmarks on a given commit and save the result
+ archery benchmark run --output=run-head-1.json HEAD~1
+ # Compare the previous captured result with HEAD
+ archery benchmark diff HEAD run-head-1.json
+
+Third, the benchmark command supports filtering suites (``--suite-filter``)
+and benchmarks (``--benchmark-filter``), both options supports regular
+expressions.
+
+.. code-block:: shell
+
+ # Taking over a previous run, but only filtering for benchmarks matching
+ # `Kernel` and suite matching `compute-aggregate`.
+ archery benchmark diff \
+ --suite-filter=compute-aggregate --benchmark-filter=Kernel \
+ /tmp/arrow-bench*/{WORKSPACE,master}/build
+
+Regression detection
+====================
+
+Writing a benchmark
+~~~~~~~~~~~~~~~~~~~
+
+1. The benchmark command will filter (by default) benchmarks with the regular
+ expression ``^Regression``. This way, not all benchmarks are run by default.
+ Thus, if you want your benchmark to be verified for regression
+ automatically, the name must match.
+
+2. The benchmark command will run with the ``--benchmark_repetitions=K``
+ options for statistical significance. Thus, a benchmark should not override
+ the repetitions in the (C++) benchmark's arguments definition.
+
+3. Due to #2, a benchmark should run sufficiently fast. Often, when the input
+ does not fit in memory (L2/L3), the benchmark will be memory bound instead
+ of CPU bound. In this case, the input can be downsized.
+
+4. By default, google's benchmark library will use the cputime metric, which
+ is the sum of runtime dedicated on the CPU for all threads of the process.
+ By contrast to realtime which is the wall clock time, e.g. the difference
+ between end_time - start_time. In a single thread model, the cputime is
+ preferable since it is less affected by context switching. In a multi thread
+ scenario, the cputime will give incorrect result since the since it'll
+ be inflated by the number of threads and can be far off realtime. Thus, if
+ the benchmark is multi threaded, it might be better to use
+ ``SetRealtime()``, see this `example <https://github.com/apache/arrow/blob/a9582ea6ab2db055656809a2c579165fe6a811ba/cpp/src/arrow/io/memory-benchmark.cc#L223-L227>`.
+
+Scripting
+=========
+
+``archery`` is written as a python library with a command line frontend. The
+library can be imported to automate some tasks.
+
+Some invocation of the command line interface can be quite verbose due to build
+output. This can be controlled/avoided with the ``--quiet`` option, e.g.
+
+.. code-block:: shell
+
+ archery --quiet benchmark diff --benchmark-filter=Kernel
+ {"benchmark": "BenchSumKernel/32768/0", "change": -0.6498, "regression": true, ...
+ {"benchmark": "BenchSumKernel/32768/1", "change": 0.01553, "regression": false, ...
+ ...
+
+or the ``--output=<file>`` can be used, e.g.
+
+.. code-block:: shell
+
+ archery benchmark diff --benchmark-filter=Kernel --output=compare.json
+ ...
diff --git a/docs/_sources/developers/contributing.rst.txt b/docs/_sources/developers/contributing.rst.txt
index 326bdda..14de516 100644
--- a/docs/_sources/developers/contributing.rst.txt
+++ b/docs/_sources/developers/contributing.rst.txt
@@ -25,32 +25,55 @@ 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
+* Participating in discussions on `JIRA <https://issues.apache.org/jira/projects/ARROW/issues>`_ or the `mailing list <ht...@arrow.apache.org>`_
* Helping users of the libraries
* Reporting bugs and asking questions
-Mailing Lists and Issue Tracker
-===============================
+Mailing List
+============
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
+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.
+Mailing list archives can be found `here <ht...@arrow.apache.org>`_.
+
+Issue Tracking
+==============
+
+We use the `ASF JIRA <https://issues.apache.org/jira/projects/ARROW/issues>`_
+to manage our development "todo" list and to maintain changelogs for releases.
+In addition, the project's `Confluence site <https://cwiki.apache.org/confluence/display/ARROW>`_
+has some useful higher-level views of the JIRA issues.
+
+To create a JIRA issue, you'll need to have an account on the ASF JIRA, which
+you can `sign yourself up for <https://issues.apache.org/jira/secure/Signup!default.jspa>`_. No
+additional permissions are needed to create issues. Only once you are involved
+in the project and want to do more on JIRA, such as assign yourself an issue,
+will you need "Contributor" permissions on the Apache Arrow JIRA. To get this
+role, ask on the mailing list for a project maintainer's help.
+
+When reporting a new issue, follow these conventions to help make sure the
+right people see it:
+
+* If the issue is specific to a language binding or other key component, prefix the issue name with it, like ``[Python] issue name``.
+* If you're reporting something that used to work in a previous version but doesn't work in the current release, you can add the "Affects version" field. For feature requests and other proposals, "Affects version" isn't appropriate.
+
+Project maintainers may later tweak formatting and labels to help improve their
+visibility. They may add a "Fix version" to indicate that they're considering
+it for inclusion in the next release, though adding that tag is not a
+commitment that it will be done in the next release.
GitHub issues
-------------
-We support GitHub issues as a lightweight way to ask questions and engage with
+We support `GitHub issues <https://github.com/apache/arrow/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
@@ -76,11 +99,14 @@ 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.
+* If one doesn't already exist, create a JIRA for your patch on the
+ `Arrow Project JIRA <https://issues.apache.org/jira/projects/ARROW/issues>`_.
* 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).
+ tutorial, see the GitHub guides on `forking a repo <https://help.github.com/en/articles/fork-a-repo>`_
+ and `sending a pull request <https://help.github.com/en/articles/creating-a-pull-request-from-a-fork>`_.
+ So that your pull request syncs with the JIRA issue, prefix your pull request
+ name with the JIRA issue id (ex:
+ `ARROW-767: [C++] Filesystem abstraction <https://github.com/apache/arrow/pull/4225>`_).
* 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.
diff --git a/docs/_sources/developers/cpp.rst.txt b/docs/_sources/developers/cpp.rst.txt
index 9025bce..b44b0d6 100644
--- a/docs/_sources/developers/cpp.rst.txt
+++ b/docs/_sources/developers/cpp.rst.txt
@@ -40,7 +40,8 @@ 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
+* Boost 1.58 or higher, though some unit tests require 1.64 or
+ newer.
* ``bison`` and ``flex`` (for building Apache Thrift from source only, an
Apache Parquet dependency.)
@@ -82,7 +83,33 @@ On macOS, you can use `Homebrew <https://brew.sh/>`_.
git clone https://github.com/apache/arrow.git
cd arrow
- brew update && brew bundle --file=c_glib/Brewfile
+ brew update && brew bundle --file=cpp/Brewfile
+
+On MSYS2:
+
+.. code-block:: shell
+
+ pacman --sync --refresh --noconfirm \
+ ccache \
+ git \
+ mingw-w64-${MSYSTEM_CARCH}-boost \
+ mingw-w64-${MSYSTEM_CARCH}-brotli \
+ mingw-w64-${MSYSTEM_CARCH}-cmake \
+ mingw-w64-${MSYSTEM_CARCH}-double-conversion \
+ mingw-w64-${MSYSTEM_CARCH}-flatbuffers \
+ mingw-w64-${MSYSTEM_CARCH}-gcc \
+ mingw-w64-${MSYSTEM_CARCH}-gflags \
+ mingw-w64-${MSYSTEM_CARCH}-glog \
+ mingw-w64-${MSYSTEM_CARCH}-gtest \
+ mingw-w64-${MSYSTEM_CARCH}-lz4 \
+ mingw-w64-${MSYSTEM_CARCH}-protobuf \
+ mingw-w64-${MSYSTEM_CARCH}-python3-numpy \
+ mingw-w64-${MSYSTEM_CARCH}-rapidjson \
+ mingw-w64-${MSYSTEM_CARCH}-snappy \
+ mingw-w64-${MSYSTEM_CARCH}-thrift \
+ mingw-w64-${MSYSTEM_CARCH}-uriparser \
+ mingw-w64-${MSYSTEM_CARCH}-zlib \
+ mingw-w64-${MSYSTEM_CARCH}-zstd
Building
========
@@ -90,6 +117,11 @@ Building
The build system uses ``CMAKE_BUILD_TYPE=release`` by default, so if this
argument is omitted then a release build will be produced.
+.. note::
+
+ You need to more options to build on Windows. See
+ :ref:`developers-cpp-windows` for details.
+
Minimal release build:
.. code-block:: shell
@@ -98,7 +130,7 @@ Minimal release build:
cd arrow/cpp
mkdir release
cd release
- cmake -DARROW_BUILD_TESTS=ON ..
+ cmake -DARROW_BUILD_TESTS=ON ..
make unittest
Minimal debug build:
@@ -145,6 +177,7 @@ boolean flags to ``cmake``.
gRPC
* ``-DARROW_GANDIVA=ON``: Gandiva expression compiler, depends on LLVM,
Protocol Buffers, and re2
+* ``-DARROW_GANDIVA_JAVA=ON``: Gandiva JNI bindings for Java
* ``-DARROW_HDFS=ON``: Arrow integration with libhdfs for accessing the Hadoop
Filesystem
* ``-DARROW_HIVESERVER2=ON``: Client library for HiveServer2 database protocol
@@ -180,6 +213,8 @@ 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).
+.. _cpp-build-dependency-management:
+
Build Dependency Management
===========================
@@ -256,12 +291,6 @@ 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
~~~~~~~~~~~~~~
@@ -300,7 +329,19 @@ C++ codebase.
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.
+ on Windows, have a look at :ref:`developers-cpp-windows`.
+
+Compiler warning levels
+~~~~~~~~~~~~~~~~~~~~~~~
+
+The ``BUILD_WARNING_LEVEL`` CMake option switches between sets of predetermined
+compiler warning levels that we use for code tidiness. For release builds, the
+default warning level is ``PRODUCTION``, while for debug builds the default is
+``CHECKIN``.
+
+When using ``CHECKIN`` for debug builds, ``-Werror`` is added when using gcc
+and clang, causing build failures for any warning, and ``/WX`` is set with MSVC
+having the same effect.
Code Style, Linting, and CI
~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -309,8 +350,6 @@ 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)
@@ -322,7 +361,10 @@ 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++ builds with the project's active version of ``clang`` without
+ compiler warnings with ``-DBUILD_WARNING_LEVEL=CHECKIN``. Note that
+ there are classes of warnings (such as `-Wdocumentation`, see more
+ on this below) that are not caught by `gcc`.
* C++ unit test suite with valgrind enabled, use ``-DARROW_TEST_MEMCHECK=ON``
when invoking CMake
* Passes cpplint checks, checked with ``make lint``
@@ -354,6 +396,31 @@ target that is executable from the root of the repository:
See :ref:`integration` for more information about the project's
``docker-compose`` configuration.
+API Documentation
+~~~~~~~~~~~~~~~~~
+
+We use Doxygen style comments (``///``) in header files for comments
+that we wish to show up in API documentation for classes and
+functions.
+
+When using ``clang`` and building with
+``-DBUILD_WARNING_LEVEL=CHECKIN``, the ``-Wdocumentation`` flag is
+used which checks for some common documnetation inconsistencies, like
+documenting some, but not all function parameters with ``\param``. See
+the `LLVM documentation warnings section
+<https://releases.llvm.org/7.0.1/tools/clang/docs/DiagnosticsReference.html#wdocumentation>`_
+for more about this.
+
+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.
+
Modular Build Targets
~~~~~~~~~~~~~~~~~~~~~
@@ -386,19 +453,6 @@ Parquet libraries, its tests, and its dependencies, you can run:
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
~~~~~~~~~~~~
@@ -443,7 +497,10 @@ work). You can build them using the following code:
.. code-block:: shell
- cmake -DARROW_FUZZING=ON -DARROW_USE_ASAN=ON ..
+ export CC=clang
+ export CXX=clang++
+ cmake -DARROW_FUZZING=ON -DARROW_USE_ASAN=ON -DCMAKE_BUILD_TYPE=RelWithDebInfo ..
+ make
``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
@@ -455,16 +512,40 @@ provoked by the fuzzer will be found early. You may also enable other sanitizers
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.
+We use the ``RelWithDebInfo`` build type which is optimized ``Release`` but contains
+debug information. Just using ``Debug`` would be too slow to get proper fuzzing
+results and ``Release`` would make it impossible to get proper tracebacks. Also, some
+bugs might (but hopefully are not) be specific to the release build due to
+misoptimization.
+
Now you can start one of the fuzzer, e.g.:
.. code-block:: shell
- ./debug/debug/ipc-fuzzing-test
+ ./relwithdebinfo/arrow-ipc-fuzzing-test corpus
-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.
+This will try to find a malformed input that crashes the payload. A corpus of
+interesting inputs will be stored into the ``corpus`` directory. You can save and
+share this with others if you want, or even pre-fill it with files to provide the
+fuzzer with a warm-start. Apache provides a test corpus under
+https://github.com/apache/arrow-testing. If a crash was found, the program will
+show the stack trace as well as the input data. The input data will also be written
+to a file named ``crash-<some id>``. 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. To debug the
+underlying issue, you can use GDB:
+
+.. code-block:: shell
+
+ env ASAN_OPTIONS=abort_on_error=1 gdb -ex r --args ./relwithdebinfo/arrow-ipc-fuzzing-test crash-<some id>
+
+For more options, use:
+
+.. code-block:: shell
+
+ ./relwithdebinfo/arrow-ipc-fuzzing-test -help=1
+
+or visit the `libFuzzer documentation <https://llvm.org/docs/LibFuzzer.html>`_.
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
@@ -555,6 +636,28 @@ generated, you can build a comparision report using
The report is then generated in ``compat_reports/libarrow`` as a HTML.
+.. _developers-cpp-windows:
+
+Debugging with Xcode on macOS
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Xcode is the IDE provided with macOS and can be use to develop and debug Arrow
+by generating an Xcode project:
+
+.. code-block:: shell
+
+ cd cpp
+ mkdir xcode-build
+ cd xcode-build
+ cmake .. -G Xcode -DARROW_BUILD_TESTS=ON
+ open arrow.xcodeproj
+
+This will generate a project and open it in the Xcode app. As an alternative,
+the command ``xcodebuild`` will perform a command-line build using the
+generated project. It is recommended to use the "Automatically Create Schemes"
+option when first launching the project. Selecting an auto-generated scheme
+will allow you to build and run a unittest with breakpoints enabled.
+
Developing on Windows
=====================
@@ -648,16 +751,9 @@ an out of source build by generating a MSVC solution:
mkdir build
cd build
cmake .. -G "Visual Studio 14 2015 Win64" ^
- -DARROW_BUILD_TESTS=ON ^
- -DGTest_SOURCE=BUNDLED
+ -DARROW_BUILD_TESTS=ON
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
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -691,7 +787,7 @@ Building with NMake
~~~~~~~~~~~~~~~~~~~
Change working directory in ``cmd.exe`` to the root directory of Arrow and
-do an out of source build using `nmake`:
+do an out of source build using ``nmake``:
.. code-block:: shell
@@ -699,9 +795,44 @@ do an out of source build using `nmake`:
mkdir build
cd build
cmake -G "NMake Makefiles" ..
- cmake --build . --config Release
nmake
+Building on MSYS2
+~~~~~~~~~~~~~~~~~
+
+You can build on MSYS2 terminal, ``cmd.exe`` or PowerShell terminal.
+
+On MSYS2 terminal:
+
+.. code-block:: shell
+
+ cd cpp
+ mkdir build
+ cd build
+ cmake -G "MSYS Makefiles" ..
+ make
+
+On ``cmd.exe`` or PowerShell terminal, you can use the following batch
+file:
+
+.. code-block:: batch
+
+ setlocal
+
+ REM For 64bit
+ set MINGW_PACKAGE_PREFIX=mingw-w64-x86_64
+ set MINGW_PREFIX=c:\msys64\mingw64
+ set MSYSTEM=MINGW64
+
+ set PATH=%MINGW_PREFIX%\bin;c:\msys64\usr\bin;%PATH%
+
+ rmdir /S /Q cpp\build
+ mkdir cpp\build
+ pushd cpp\build
+ cmake -G "MSYS Makefiles" .. || exit /B
+ make || exit /B
+ popd
+
Debug builds
~~~~~~~~~~~~
@@ -731,7 +862,7 @@ The command line to build Arrow in Debug will look something like this:
Windows dependency resolution issues
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Because Windows uses `.lib` files for both static and dynamic linking of
+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
diff --git a/docs/_sources/developers/documentation.rst.txt b/docs/_sources/developers/documentation.rst.txt
index 452305b..3a8eb07 100644
--- a/docs/_sources/developers/documentation.rst.txt
+++ b/docs/_sources/developers/documentation.rst.txt
@@ -66,7 +66,7 @@ These two steps are mandatory and must be executed in order.
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
+ 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
diff --git a/docs/_sources/developers/integration.rst.txt b/docs/_sources/developers/integration.rst.txt
index df56231..7b87733 100644
--- a/docs/_sources/developers/integration.rst.txt
+++ b/docs/_sources/developers/integration.rst.txt
@@ -49,7 +49,8 @@ build mount is used for caching and sharing state between staged images.
- *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
+- *clang-format*: Run clang-format on the C++ sources, modifying in place
+- *clang-tidy*: Run clang-tidy on the C++ sources, outputting recommendations
- *docs*: Builds this documentation
You can build and run a service by using the `build` and `run` docker-compose
diff --git a/docs/_sources/developers/python.rst.txt b/docs/_sources/developers/python.rst.txt
index 0ebe8f1..4691d2e 100644
--- a/docs/_sources/developers/python.rst.txt
+++ b/docs/_sources/developers/python.rst.txt
@@ -39,6 +39,14 @@ build. Check for style errors before submitting your pull request with:
flake8 .
flake8 --config=.flake8.cython .
+The package ``autopep8`` (also available from pip or conda) can automatically
+fix many of the errors reported by ``flake8``:
+
+.. code-block:: shell
+
+ autopep8 --in-place ../integration/integration_test.py
+ autopep8 --in-place --global-config=.flake8.cython pyarrow/table.pxi
+
Unit Testing
============
@@ -51,7 +59,7 @@ like so:
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`` and can be installed if needed with ``pip install -r
requirements-test.txt``.
The project has a number of custom command line options for its test
@@ -98,7 +106,7 @@ Building on Linux and MacOS
System Requirements
-------------------
-On macOS, any modern XCode (6.4 or higher; the current version is 8.3.1) is
+On macOS, any modern XCode (6.4 or higher; the current version is 10) is
sufficient.
On Linux, for this guide, we require a minimum of gcc 4.8, or clang 3.7 or
@@ -138,10 +146,18 @@ You should now see
Using Conda
~~~~~~~~~~~
+.. note::
+
+ Using conda to build Arrow on macOS is complicated by the
+ fact that the `conda-forge compilers require an older macOS SDK <https://stackoverflow.com/a/55798942>`_.
+ Conda offers some `installation instructions <https://docs.conda.io/projects/conda-build/en/latest/resources/compiler-tools.html#macos-sdk>`_;
+ the alternative would be to use :ref:`Homebrew <python-homebrew>` and
+ ``pip`` instead.
+
Let's create a conda environment with all the C++ build and Python dependencies
from conda-forge, targeting development for Python 3.7:
-On Linux and OSX:
+On Linux and macOS:
.. code-block:: shell
@@ -152,10 +168,13 @@ On Linux and OSX:
compilers \
python=3.7
-As of January 2019, the `compilers` package is needed on many Linux distributions to use packages from conda-forge.
+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
+.. code-block:: shell
+
conda activate pyarrow-dev
For Windows, see the `Building on Windows`_ section below.
@@ -177,12 +196,17 @@ Using pip
to manage your development. Please follow the conda-based development
instructions instead.
-On macOS, install all dependencies through Homebrew that are required for
+.. _python-homebrew:
+
+On macOS, use Homebrew to install all dependencies required for
building Arrow C++:
.. code-block:: shell
- brew update && brew bundle --file=arrow/python/Brewfile
+ brew update && brew bundle --file=arrow/cpp/Brewfile
+
+See :ref:`here <cpp-build-dependency-management>` for a list of dependencies you
+may need.
On Debian/Ubuntu, you need the following minimal set of dependencies. All other
dependencies will be automatically built by Arrow's third-party toolchain.
@@ -213,7 +237,7 @@ folder as the repositories and a target installation folder:
virtualenv pyarrow
source ./pyarrow/bin/activate
- pip install six numpy pandas cython pytest
+ pip install six numpy pandas cython pytest hypothesis
# This is the folder where we will install the Arrow libraries during
# development
@@ -266,7 +290,7 @@ to ``OFF``:
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
+``-DPYTHON_EXECUTABLE=$VIRTUAL_ENV/bin/python`` (assuming that you're in
virtualenv) enables cmake to choose the python executable which you are using.
.. note::
@@ -276,6 +300,16 @@ virtualenv) enables cmake to choose the python executable which you are using.
this reason we recommend passing ``-DCMAKE_INSTALL_LIBDIR=lib`` because the
Python build scripts assume the library directory is ``lib``
+.. note::
+
+ If you have conda installed but are not using it to manage dependencies,
+ and you have trouble building the C++ library, you may need to set
+ ``-DARROW_DEPENDENCY_SOURCE=AUTO`` or some other value (described
+ :ref:`here <cpp-build-dependency-management>`)
+ to explicitly tell CMake not to use conda.
+
+For any other C++ build challenges, see :ref:`cpp-development`.
+
Now, build pyarrow:
.. code-block:: shell
@@ -285,30 +319,14 @@ Now, build pyarrow:
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
+ python setup.py build_ext --inplace
popd
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:
-
-.. code-block:: shell
-
- $ py.test pyarrow
- ================================ test session starts ====================
- platform linux -- Python 3.6.1, pytest-3.0.7, py-1.4.33, pluggy-0.4.0
- rootdir: /home/wesm/arrow-clone/python, inifile:
-
- collected 1061 items / 1 skipped
-
- [... test output not shown here ...]
-
- ============================== warnings summary ===============================
-
- [... many warnings not shown here ...]
-
- ====== 1000 passed, 56 skipped, 6 xfailed, 19 warnings in 26.52 seconds =======
+Now you are ready to install test dependencies and run `Unit Testing`_, as
+described above.
To build a self-contained wheel (including the Arrow and Parquet C++
libraries), one can set ``--bundle-arrow-cpp``:
@@ -331,6 +349,32 @@ environment variable when building pyarrow:
export PYARROW_WITH_CUDA=1
+Debugging
+---------
+
+Since pyarrow depends on the Arrow C++ libraries, debugging can
+frequently involve crossing between Python and C++ shared libraries.
+
+Using gdb on Linux
+~~~~~~~~~~~~~~~~~~
+
+To debug the C++ libraries with gdb while running the Python unit
+ test, first start pytest with gdb:
+
+.. code-block:: shell
+
+ gdb --args python -m pytest pyarrow/tests/test_to_run.py -k $TEST_TO_MATCH
+
+To set a breakpoint, use the same gdb syntax that you would when
+debugging a C++ unitttest, for example:
+
+.. code-block:: shell
+
+ (gdb) b src/arrow/python/arrow_to_pandas.cc:1874
+ No source file named src/arrow/python/arrow_to_pandas.cc.
+ Make breakpoint pending on future shared library load? (y or [n]) y
+ Breakpoint 1 (src/arrow/python/arrow_to_pandas.cc:1874) pending.
+
Building on Windows
===================
diff --git a/docs/_sources/format/Flight.rst.txt b/docs/_sources/format/Flight.rst.txt
new file mode 100644
index 0000000..b3476ea
--- /dev/null
+++ b/docs/_sources/format/Flight.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.
+
+Arrow Flight RPC
+================
+
+Arrow Flight is a RPC framework for high-performance data services
+based on Arrow data, and is built on top of gRPC_ and the :doc:`IPC
+format <IPC>`.
+
+Flight is organized around streams of Arrow record batches, being
+either downloaded from or uploaded to another service. A set of
+metadata methods offers discovery and introspection of streams, as
+well as the ability to implement application-specific methods.
+
+Methods and message wire formats are defined by Protobuf, enabling
+interoperability with clients that may support gRPC and Arrow
+separately, but not Flight. However, Flight implementations include
+further optimizations to avoid overhead in usage of Protobuf (mostly
+around avoiding excessive memory copies).
+
+.. _gRPC: https://grpc.io/
+
+RPC Methods
+-----------
+
+Flight defines a set of RPC methods for uploading/downloading data,
+retrieving metadata about a data stream, listing available data
+streams, and for implementing application-specific RPC methods. A
+Flight service implements some subset of these methods, while a Flight
+client can call any of these methods. Thus, one Flight client can
+connect to any Flight service and perform basic operations.
+
+Data streams are identified by descriptors, which are either a path or
+an arbitrary binary command. A client that wishes to download the data
+would:
+
+#. Construct or acquire a ``FlightDescriptor`` for the data set they
+ are interested in. A client may know what descriptor they want
+ already, or they may use methods like ``ListFlights`` to discover
+ them.
+#. Call ``GetFlightInfo(FlightDescriptor)`` to get a ``FlightInfo``
+ message containing details on where the data is located (as well as
+ other metadata, like the schema and possibly an estimate of the
+ dataset size).
+
+ Flight does not require that data live on the same server as
+ metadata: this call may list other servers to connect to. The
+ ``FlightInfo`` message includes a ``Ticket``, an opaque binary
+ token that the server uses to identify the exact data set being
+ requested.
+#. Connect to other servers (if needed).
+#. Call ``DoGet(Ticket)`` to get back a stream of Arrow record
+ batches.
+
+To upload data, a client would:
+
+#. Construct or acquire a ``FlightDescriptor``, as before.
+#. Call ``DoPut(FlightData)`` and upload a stream of Arrow record
+ batches. They would also include the ``FlightDescriptor`` with the
+ first message.
+
+See `Protocol Buffer Definitions`_ for full details on the methods and
+messages involved.
+
+Authentication
+~~~~~~~~~~~~~~
+
+Flight supports application-implemented authentication
+methods. Authentication, if enabled, has two phases: at connection
+time, the client and server can exchange any number of messages. Then,
+the client can provide a token alongside each call, and the server can
+validate that token.
+
+Applications may use any part of this; for instance, they may ignore
+the initial handshake and send an externally acquired token on each
+call, or they may establish trust during the handshake and not
+validate a token for each call. (Note that the latter is not secure if
+you choose to deploy a layer 7 load balancer, as is common with gRPC.)
+
+External Resources
+------------------
+
+- https://arrow.apache.org/blog/2018/10/09/0.11.0-release/
+- https://www.slideshare.net/JacquesNadeau5/apache-arrow-flight-overview
+
+Protocol Buffer Definitions
+---------------------------
+
+.. literalinclude:: ../../../format/Flight.proto
+ :language: protobuf
+ :linenos:
diff --git a/docs/_sources/format/IPC.rst.txt b/docs/_sources/format/IPC.rst.txt
index 62a1237..16567a6 100644
--- a/docs/_sources/format/IPC.rst.txt
+++ b/docs/_sources/format/IPC.rst.txt
@@ -104,7 +104,7 @@ Schematically we have: ::
<magic number "ARROW1">
<empty padding bytes [to 8 byte boundary]>
- <STREAMING FORMAT>
+ <STREAMING FORMAT with EOS>
<FOOTER>
<FOOTER SIZE: int32>
<magic number "ARROW1">
diff --git a/docs/_sources/format/Layout.rst.txt b/docs/_sources/format/Layout.rst.txt
index 99a798a..c4efe48 100644
--- a/docs/_sources/format/Layout.rst.txt
+++ b/docs/_sources/format/Layout.rst.txt
@@ -359,6 +359,49 @@ will be represented as follows: ::
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.
+Fixed Size List type
+--------------------
+
+Fixed Size List is a nested type in which each array slot contains a fixed-size
+sequence of values all having the same relative type (heterogeneity can be
+achieved through unions, described later).
+
+A fixed size list type is specified like ``FixedSizeList<T>[N]``, where ``T`` is
+any relative type (primitive or nested) and ``N`` is a 32-bit signed integer
+representing the length of the lists.
+
+A fixed size list array is represented by a values array, which is a child array of
+type T. T may also be a nested type. The value in slot ``j`` of a fixed size list
+array is stored in an ``N``-long slice of the values array, starting at an offset of
+``j * N``.
+
+Example Layout: ``FixedSizeList<byte>[4]`` Array
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Let's consider an example, the type ``FixedSizeList<byte>[4]``.
+
+For an array of length 4 with respective values: ::
+
+ [[192, 168, 0, 12], null, [192, 168, 0, 25], [192, 168, 0, 1]]
+
+will have the following representation: ::
+
+ * Length: 4, Null count: 1
+ * Null bitmap buffer:
+
+ | Byte 0 (validity bitmap) | Bytes 1-63 |
+ |--------------------------|-----------------------|
+ | 00001101 | 0 (padding) |
+
+ * Values array (byte array):
+ * Length: 16, Null count: 0
+ * Null bitmap buffer: Not required
+
+ | Bytes 0-3 | Bytes 4-7 | Bytes 8-15 |
+ |-----------------|-------------|---------------------------------|
+ | 192, 168, 0, 12 | unspecified | 192, 168, 0, 25, 192, 168, 0, 1 |
+
+
Struct type
-----------
@@ -448,6 +491,91 @@ for the null struct but are 'hidden' from the consumer by the parent array's
null bitmap. However, when treated independently corresponding
values of the children array will be non-null.
+
+Map type
+--------
+
+Map is a nested type in which each array slot contains a variable size sequence
+of key-item pairs.
+
+A map type is specified like ``Map<K, I>``, where ``K`` and ``I`` are
+any relative type (primitive or nested) and represent the key and item types
+respectively.
+
+A map array is represented by the combination of the following:
+
+* A child array (of type ``Struct<K, I>``) containing key item pairs. This has
+ child arrays:
+ * A keys array of type ``K``. This array may not contain nulls.
+ * An items array of type ``I``.
+* An offsets buffer containing 32-bit signed integers with length equal to the
+ length of the top-level array plus one. Note that this limits the size of the
+ child arrays to 2 :sup:`31` -1.
+
+The offsets array encodes a start position in the child arrays, and the length
+of the map in each slot is computed using the first difference with the next
+element in the offsets array. (Equivalent offsets layout to ``List<T>``).
+Each slice of the child arrays delimited by the offsets array represent a set
+of key item pairs in the corresponding slot of the parent map array.
+
+Example Layout: ``Map<K, I>`` Array
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Let's consider an example, the type ``Map<String, Int32>``.
+
+For an array of length 4 with respective values: ::
+
+ [{'joe': 0}, null, {'mark': null, 'cap': 8}, {}]
+
+will have the following representation: ::
+
+ * Length: 4, Null count: 1
+ * Null bitmap buffer:
+
+ | Byte 0 (validity bitmap) | Bytes 1-63 |
+ |--------------------------|-----------------------|
+ | 00001101 | 0 (padding) |
+
+ * Offsets buffer (int32):
+
+ | Bytes 0-19 |
+ |----------------|
+ | 0, 1, 1, 3, 3 |
+
+ * 'pairs' array (`Struct<String, Int32>`):
+ * Length: 3, Null count: 0
+ * Null bitmap buffer: Not required
+
+ * 'keys' array (`String`):
+ * Length: 3, Null count: 0
+ * Null bitmap buffer: Not required
+ * Offsets buffer (int32):
+
+ | Bytes 0-15 |
+ |--------------|
+ | 0, 3, 7, 10 |
+
+ * Values buffer:
+
+ | Bytes 0-10 |
+ |----------------|
+ | joemarkcap |
+
+ * 'items' array (`Int32`):
+ * Length: 3, Null count: 1
+ * Null bitmap buffer:
+
+ | Byte 0 (validity bitmap) | Bytes 1-63 |
+ |--------------------------|-----------------------|
+ | 00000101 | 0 (padding) |
+
+ * Value Buffer (int32):
+
+ | Bytes 0-3 | Bytes 4-7 | Bytes 8-11 |
+ |-------------|-------------|-------------|
+ | 0 | unspecified | 8 |
+
+
Dense union type
----------------
@@ -600,7 +728,7 @@ will have the following layout: ::
* Length: 7, Null count: 0
* Null bitmap buffer: Not required
- | Bytes 0-7 | Bytes 8-63 |
+ | Bytes 0-6 | Bytes 7-63 |
|------------|-----------------------|
| joemark | unspecified (padding) |
diff --git a/docs/_sources/format/Metadata.rst.txt b/docs/_sources/format/Metadata.rst.txt
index 293d011..f4be82b 100644
--- a/docs/_sources/format/Metadata.rst.txt
+++ b/docs/_sources/format/Metadata.rst.txt
@@ -29,9 +29,6 @@ systems to communicate the
* "Data headers" indicating the physical locations of memory buffers sufficient
to reconstruct a Arrow data structures without copying memory.
-Canonical implementation
-------------------------
-
We are using `Flatbuffers`_ for low-overhead reading and writing of the Arrow
metadata. See ``Message.fbs``.
@@ -65,98 +62,8 @@ the columns. The Flatbuffers IDL for a field is: ::
The ``type`` is the logical type of the field. Nested types, such as List,
Struct, and Union, have a sequence of child fields.
-A JSON representation of the schema is also provided:
-
-Field: ::
-
- {
- "name" : "name_of_the_field",
- "nullable" : false,
- "type" : /* Type */,
- "children" : [ /* Field */ ],
- }
-
-Type: ::
-
- {
- "name" : "null|struct|list|union|int|floatingpoint|utf8|binary|fixedsizebinary|bool|decimal|date|time|timestamp|interval"
- // fields as defined in the Flatbuffer depending on the type name
- }
-
-Union: ::
-
- {
- "name" : "union",
- "mode" : "Sparse|Dense",
- "typeIds" : [ /* integer */ ]
- }
-
-The ``typeIds`` field in the Union are the codes used to denote each type, which
-may be different from the index of the child array. This is so that the union
-type ids do not have to be enumerated from 0.
-
-Int: ::
-
- {
- "name" : "int",
- "bitWidth" : /* integer */,
- "isSigned" : /* boolean */
- }
-
-FloatingPoint: ::
-
- {
- "name" : "floatingpoint",
- "precision" : "HALF|SINGLE|DOUBLE"
- }
-
-Decimal: ::
-
- {
- "name" : "decimal",
- "precision" : /* integer */,
- "scale" : /* integer */
- }
-
-Timestamp: ::
-
- {
- "name" : "timestamp",
- "unit" : "SECOND|MILLISECOND|MICROSECOND|NANOSECOND"
- }
-
-Date: ::
-
- {
- "name" : "date",
- "unit" : "DAY|MILLISECOND"
- }
-
-Time: ::
-
- {
- "name" : "time",
- "unit" : "SECOND|MILLISECOND|MICROSECOND|NANOSECOND",
- "bitWidth": /* integer: 32 or 64 */
- }
-
-Interval: ::
-
- {
- "name" : "interval",
- "unit" : "YEAR_MONTH|DAY_TIME"
- }
-
-Schema: ::
-
- {
- "fields" : [
- /* Field */
- ]
- }
-
-Record data headers
--------------------
+Record Batch Data Headers
+-------------------------
A record batch is a collection of top-level named, equal length Arrow arrays
(or vectors). If one of the arrays contains nested data, its child arrays are
@@ -280,117 +187,156 @@ categories:
* Types having equivalent memory layout to a physical nested type (e.g. strings
use the list representation, but logically are not nested types)
-Integers
-~~~~~~~~
-
-In the first version of Arrow we provide the standard 8-bit through 64-bit size
-standard C integer types, both signed and unsigned:
+Refer to `Schema.fbs`_ for up-to-date descriptions of each built-in
+logical type.
+
+Custom Application Metadata
+---------------------------
+
+We provide a ``custom_metadata`` field at three levels to provide a
+mechanism for developers to pass application-specific metadata in
+Arrow protocol messages. This includes ``Field``, ``Schema``, and
+``Message``.
+
+The colon symbol ``:`` is to be used as a namespace separator. It can
+be used multiple times in a key.
+
+The ``ARROW`` pattern is a reserved namespace for internal Arrow use
+in the ``custom_metadata`` fields. For example,
+``ARROW:extension:name``.
+
+Extension Types
+---------------
+
+User-defined "extension" types can be defined setting certain
+``KeyValue`` pairs in ``custom_metadata`` in the ``Field`` metadata
+structure. These extension keys are:
+
+* ``'ARROW:extension:name'`` for the string name identifying the
+ custom data type. We recommend that you use a "namespace"-style
+ prefix for extension type names to minimize the possibility of
+ conflicts with multiple Arrow readers and writers in the same
+ application. For example, use ``myorg.name_of_type`` instead of
+ simply ``name_of_type``
+* ``'ARROW:extension:metadata'`` for a serialized representation
+ of the ``ExtensionType`` necessary to reconstruct the custom type
+
+This extension metadata can annotate any of the built-in Arrow logical
+types. The intent is that an implementation that does not support an
+extension type can still handle the underlying data. For example a
+16-byte UUID value could be embedded in ``FixedSizeBinary(16)``, and
+implementations that do not have this extension type can still work
+with the underlying binary values and pass along the
+``custom_metadata`` in subsequent Arrow protocol messages.
+
+Extension types may or may not use the
+``'ARROW:extension:metadata'`` field. Let's consider some example
+extension types:
+
+* ``uuid`` represented as ``FixedSizeBinary(16)`` with empty metadata
+* ``latitude-longitude`` represented as ``struct<latitude: double,
+ longitude: double>``, and empty metadata
+* ``tensor`` (multidimensional array) stored as ``Binary`` values and
+ having serialized metadata indicating the data type and shape of
+ each value. This could be JSON like ``{'type': 'int8', 'shape': [4,
+ 5]}`` for a 4x5 cell tensor.
+* ``trading-time`` represented as ``Timestamp`` with serialized
+ metadata indicating the market trading calendar the data corresponds
+ to
+
+Integration Testing
+-------------------
-* Signed types: Int8, Int16, Int32, Int64
-* Unsigned types: UInt8, UInt16, UInt32, UInt64
+A JSON representation of the schema is provided for cross-language
+integration testing purposes.
-The IDL looks like: ::
+Schema: ::
- table Int {
- bitWidth: int;
- is_signed: bool;
+ {
+ "fields" : [
+ /* Field */
+ ]
}
-The integer endianness is currently set globally at the schema level. If a
-schema is set to be little-endian, then all integer types occurring within must
-be little-endian. Integers that are part of other data representations, such as
-list offsets and union types, must have the same endianness as the entire
-record batch.
-
-Floating point numbers
-~~~~~~~~~~~~~~~~~~~~~~
-
-We provide 3 types of floating point numbers as fixed bit-width primitive array
-
-- Half precision, 16-bit width
-- Single precision, 32-bit width
-- Double precision, 64-bit width
-
-The IDL looks like: ::
-
- enum Precision:int {HALF, SINGLE, DOUBLE}
+Field: ::
- table FloatingPoint {
- precision: Precision;
+ {
+ "name" : "name_of_the_field",
+ "nullable" : false,
+ "type" : /* Type */,
+ "children" : [ /* Field */ ],
}
-Boolean
-~~~~~~~
-
-The Boolean logical type is represented as a 1-bit wide primitive physical
-type. The bits are numbered using least-significant bit (LSB) ordering.
-
-Like other fixed bit-width primitive types, boolean data appears as 2 buffers
-in the data header (one bitmap for the validity vector and one for the values).
-
-List
-~~~~
-
-The ``List`` logical type is the logical (and identically-named) counterpart to
-the List physical type.
-
-In data header form, the list field node contains 2 buffers:
+Type: ::
-* Validity bitmap
-* List offsets
+ {
+ "name" : "null|struct|list|union|int|floatingpoint|utf8|binary|fixedsizebinary|bool|decimal|date|time|timestamp|interval"
+ // fields as defined in the Flatbuffer depending on the type name
+ }
-The buffers associated with a list's child field are handled recursively
-according to the child logical type (e.g. ``List<Utf8>`` vs. ``List<Boolean>``).
+Union: ::
-Utf8 and Binary
-~~~~~~~~~~~~~~~
+ {
+ "name" : "union",
+ "mode" : "Sparse|Dense",
+ "typeIds" : [ /* integer */ ]
+ }
-We specify two logical types for variable length bytes:
+The ``typeIds`` field in the Union are the codes used to denote each type, which
+may be different from the index of the child array. This is so that the union
+type ids do not have to be enumerated from 0.
-* ``Utf8`` data is Unicode values with UTF-8 encoding
-* ``Binary`` is any other variable length bytes
+Int: ::
-These types both have the same memory layout as the nested type ``List<UInt8>``,
-with the constraint that the inner bytes can contain no null values. From a
-logical type perspective they are primitive, not nested types.
+ {
+ "name" : "int",
+ "bitWidth" : /* integer */,
+ "isSigned" : /* boolean */
+ }
-In data header form, while ``List<UInt8>`` would appear as 2 field nodes (``List``
-and ``UInt8``) and 4 buffers (2 for each of the nodes, as per above), these types
-have a simplified representation single field node (of ``Utf8`` or ``Binary``
-logical type, which have no children) and 3 buffers:
+FloatingPoint: ::
-* Validity bitmap
-* List offsets
-* Byte data
+ {
+ "name" : "floatingpoint",
+ "precision" : "HALF|SINGLE|DOUBLE"
+ }
-Decimal
-~~~~~~~
+Decimal: ::
-Decimals are represented as a 2's complement 128-bit (16 byte) signed integer
-in little-endian byte order.
+ {
+ "name" : "decimal",
+ "precision" : /* integer */,
+ "scale" : /* integer */
+ }
-Timestamp
-~~~~~~~~~
+Timestamp: ::
-All timestamps are stored as a 64-bit integer, with one of four unit
-resolutions: second, millisecond, microsecond, and nanosecond.
+ {
+ "name" : "timestamp",
+ "unit" : "SECOND|MILLISECOND|MICROSECOND|NANOSECOND"
+ }
-Date
-~~~~
+Date: ::
-We support two different date types:
+ {
+ "name" : "date",
+ "unit" : "DAY|MILLISECOND"
+ }
-* Days since the UNIX epoch as a 32-bit integer
-* Milliseconds since the UNIX epoch as a 64-bit integer
+Time: ::
-Time
-~~~~
+ {
+ "name" : "time",
+ "unit" : "SECOND|MILLISECOND|MICROSECOND|NANOSECOND",
+ "bitWidth": /* integer: 32 or 64 */
+ }
-Time supports the same unit resolutions: second, millisecond, microsecond, and
-nanosecond. We represent time as the smallest integer accommodating the
-indicated unit. For second and millisecond: 32-bit, for the others 64-bit.
+Interval: ::
-Dictionary encoding
--------------------
+ {
+ "name" : "interval",
+ "unit" : "YEAR_MONTH|DAY_TIME"
+ }
.. _Flatbuffers: http://github.com/google/flatbuffers
+.. _Schema.fbs: https://github.com/apache/arrow/blob/master/format/Schema.fbs
diff --git a/docs/_sources/index.rst.txt b/docs/_sources/index.rst.txt
index 3a5728a..6fb16f2 100644
--- a/docs/_sources/index.rst.txt
+++ b/docs/_sources/index.rst.txt
@@ -43,6 +43,7 @@ such topics as:
format/Layout
format/Metadata
format/IPC
+ format/Flight
.. _toc.usage:
@@ -59,4 +60,9 @@ such topics as:
:maxdepth: 2
:caption: Development and Contributing
- developers/index
+ developers/contributing
+ developers/cpp
+ developers/python
+ developers/integration
+ developers/benchmarks
+ developers/documentation
diff --git a/docs/_sources/python/api.rst.txt b/docs/_sources/python/api.rst.txt
index b06509f..b1dccd4 100644
--- a/docs/_sources/python/api.rst.txt
+++ b/docs/_sources/python/api.rst.txt
@@ -30,6 +30,7 @@ API Reference
api/files
api/tables
api/ipc
+ api/flight
api/formats
api/plasma
api/cuda
diff --git a/docs/_sources/python/api/flight.rst.txt b/docs/_sources/python/api/flight.rst.txt
new file mode 100644
index 0000000..4fa1374
--- /dev/null
+++ b/docs/_sources/python/api/flight.rst.txt
@@ -0,0 +1,82 @@
+.. 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.
+
+.. currentmodule:: pyarrow.flight
+
+Arrow Flight
+============
+
+.. ifconfig:: not flight_enabled
+
+ .. error::
+ This documentation was built without Flight enabled. The Flight
+ API docs are not available.
+
+.. NOTE We still generate those API docs (with empty docstrings)
+.. when Flight is disabled and `pyarrow.flight` mocked (see conf.py).
+.. Otherwise we'd get autodoc warnings, see https://github.com/sphinx-doc/sphinx/issues/4770
+
+.. warning:: Flight is currently unstable. APIs are subject to change,
+ though we don't expect drastic changes.
+
+.. warning:: Flight is currently not distributed as part of wheels or
+ in Conda - it is only available when built from source
+ appropriately.
+
+Common Types
+------------
+
+.. autosummary::
+ :toctree: ../generated/
+
+ Action
+ ActionType
+ DescriptorType
+ FlightDescriptor
+ FlightEndpoint
+ FlightInfo
+ Location
+ Ticket
+ Result
+
+Flight Client
+-------------
+
+.. autosummary::
+ :toctree: ../generated/
+
+ FlightCallOptions
+ FlightClient
+
+Flight Server
+-------------
+
+.. autosummary::
+ :toctree: ../generated/
+
+ FlightServerBase
+ GeneratorStream
+ RecordBatchStream
+
+Authentication
+--------------
+
+.. autosummary::
+ :toctree: ../generated/
+
+ ClientAuthHandler
+ ServerAuthHandler
diff --git a/docs/_sources/python/api/formats.rst.txt b/docs/_sources/python/api/formats.rst.txt
index 8de30ec..f8aab4a 100644
--- a/docs/_sources/python/api/formats.rst.txt
+++ b/docs/_sources/python/api/formats.rst.txt
@@ -18,13 +18,13 @@
Tabular File Formats
====================
-.. currentmodule:: pyarrow.csv
-
.. _api.csv:
CSV Files
---------
+.. currentmodule:: pyarrow.csv
+
.. autosummary::
:toctree: ../generated/
@@ -46,7 +46,19 @@ Feather Files
read_feather
write_feather
-.. currentmodule:: pyarrow
+.. _api.json:
+
+JSON Files
+----------
+
+.. currentmodule:: pyarrow.json
+
+.. autosummary::
+ :toctree: ../generated/
+
+ ReadOptions
+ ParseOptions
+ read_json
.. _api.parquet:
diff --git a/docs/_sources/python/api/tables.rst.txt b/docs/_sources/python/api/tables.rst.txt
index 5a229d2..9d350a4 100644
--- a/docs/_sources/python/api/tables.rst.txt
+++ b/docs/_sources/python/api/tables.rst.txt
@@ -28,6 +28,7 @@ Factory Functions
.. autosummary::
:toctree: ../generated/
+ table
column
chunked_array
concat_tables
diff --git a/docs/_sources/python/csv.rst.txt b/docs/_sources/python/csv.rst.txt
index 17023b1..96a79e6 100644
--- a/docs/_sources/python/csv.rst.txt
+++ b/docs/_sources/python/csv.rst.txt
@@ -21,7 +21,7 @@
Reading CSV files
=================
-Arrow provides preliminary support for reading data from CSV files.
+Arrow supports reading columnar data from CSV files.
The features currently offered are the following:
* multi-threaded or single-threaded reading
diff --git a/docs/_sources/python/generated/pyarrow.Array.rst.txt b/docs/_sources/python/generated/pyarrow.Array.rst.txt
index 97c71a1..40e4409 100644
--- a/docs/_sources/python/generated/pyarrow.Array.rst.txt
+++ b/docs/_sources/python/generated/pyarrow.Array.rst.txt
@@ -13,6 +13,7 @@ pyarrow.Array
.. autosummary::
+ ~Array.__init__
~Array.buffers
~Array.cast
~Array.dictionary_encode
@@ -22,6 +23,8 @@ pyarrow.Array
~Array.from_pandas
~Array.isnull
~Array.slice
+ ~Array.sum
+ ~Array.take
~Array.to_numpy
~Array.to_pandas
~Array.to_pylist
diff --git a/docs/_sources/python/generated/pyarrow.ArrayValue.rst.txt b/docs/_sources/python/generated/pyarrow.ArrayValue.rst.txt
index 336485f..682e93b 100644
--- a/docs/_sources/python/generated/pyarrow.ArrayValue.rst.txt
+++ b/docs/_sources/python/generated/pyarrow.ArrayValue.rst.txt
@@ -9,6 +9,12 @@ pyarrow.ArrayValue
.. automethod:: __init__
+ .. rubric:: Methods
+
+ .. autosummary::
+
+ ~ArrayValue.__init__
+
diff --git a/docs/_sources/python/generated/pyarrow.BinaryArray.rst.txt b/docs/_sources/python/generated/pyarrow.BinaryArray.rst.txt
index 2017a7f..11e0657 100644
--- a/docs/_sources/python/generated/pyarrow.BinaryArray.rst.txt
+++ b/docs/_sources/python/generated/pyarrow.BinaryArray.rst.txt
@@ -13,6 +13,7 @@ pyarrow.BinaryArray
.. autosummary::
+ ~BinaryArray.__init__
~BinaryArray.buffers
~BinaryArray.cast
~BinaryArray.dictionary_encode
@@ -22,6 +23,8 @@ pyarrow.BinaryArray
~BinaryArray.from_pandas
~BinaryArray.isnull
~BinaryArray.slice
+ ~BinaryArray.sum
+ ~BinaryArray.take
~BinaryArray.to_numpy
~BinaryArray.to_pandas
~BinaryArray.to_pylist
diff --git a/docs/_sources/python/generated/pyarrow.BinaryValue.rst.txt b/docs/_sources/python/generated/pyarrow.BinaryValue.rst.txt
index b5324a9..6307cda 100644
--- a/docs/_sources/python/generated/pyarrow.BinaryValue.rst.txt
+++ b/docs/_sources/python/generated/pyarrow.BinaryValue.rst.txt
@@ -13,6 +13,7 @@ pyarrow.BinaryValue
.. autosummary::
+ ~BinaryValue.__init__
~BinaryValue.as_buffer
~BinaryValue.as_py
diff --git a/docs/_sources/python/generated/pyarrow.BooleanArray.rst.txt b/docs/_sources/python/generated/pyarrow.BooleanArray.rst.txt
index a341ec9..e67cea4 100644
--- a/docs/_sources/python/generated/pyarrow.BooleanArray.rst.txt
+++ b/docs/_sources/python/generated/pyarrow.BooleanArray.rst.txt
@@ -13,6 +13,7 @@ pyarrow.BooleanArray
.. autosummary::
+ ~BooleanArray.__init__
~BooleanArray.buffers
~BooleanArray.cast
~BooleanArray.dictionary_encode
@@ -22,6 +23,8 @@ pyarrow.BooleanArray
~BooleanArray.from_pandas
~BooleanArray.isnull
~BooleanArray.slice
+ ~BooleanArray.sum
+ ~BooleanArray.take
~BooleanArray.to_numpy
~BooleanArray.to_pandas
~BooleanArray.to_pylist
diff --git a/docs/_sources/python/generated/pyarrow.BooleanValue.rst.txt b/docs/_sources/python/generated/pyarrow.BooleanValue.rst.txt
index 9f2a415..f495149 100644
--- a/docs/_sources/python/generated/pyarrow.BooleanValue.rst.txt
+++ b/docs/_sources/python/generated/pyarrow.BooleanValue.rst.txt
@@ -13,6 +13,7 @@ pyarrow.BooleanValue
.. autosummary::
+ ~BooleanValue.__init__
~BooleanValue.as_py
diff --git a/docs/_sources/python/generated/pyarrow.Buffer.rst.txt b/docs/_sources/python/generated/pyarrow.Buffer.rst.txt
index 532ff81..fa7f1f6 100644
--- a/docs/_sources/python/generated/pyarrow.Buffer.rst.txt
+++ b/docs/_sources/python/generated/pyarrow.Buffer.rst.txt
@@ -13,7 +13,9 @@ pyarrow.Buffer
.. autosummary::
+ ~Buffer.__init__
~Buffer.equals
+ ~Buffer.hex
~Buffer.slice
~Buffer.to_pybytes
diff --git a/docs/_sources/python/generated/pyarrow.BufferOutputStream.rst.txt b/docs/_sources/python/generated/pyarrow.BufferOutputStream.rst.txt
index 3da213e..70f0cb5 100644
--- a/docs/_sources/python/generated/pyarrow.BufferOutputStream.rst.txt
+++ b/docs/_sources/python/generated/pyarrow.BufferOutputStream.rst.txt
@@ -13,6 +13,7 @@ pyarrow.BufferOutputStream
.. autosummary::
+ ~BufferOutputStream.__init__
~BufferOutputStream.close
~BufferOutputStream.download
~BufferOutputStream.fileno
@@ -21,6 +22,7 @@ pyarrow.BufferOutputStream
~BufferOutputStream.isatty
~BufferOutputStream.read
~BufferOutputStream.read1
+ ~BufferOutputStream.read_at
~BufferOutputStream.read_buffer
~BufferOutputStream.readable
~BufferOutputStream.readall
diff --git a/docs/_sources/python/generated/pyarrow.BufferReader.rst.txt b/docs/_sources/python/generated/pyarrow.BufferReader.rst.txt
index bd895cd..d13389d 100644
--- a/docs/_sources/python/generated/pyarrow.BufferReader.rst.txt
+++ b/docs/_sources/python/generated/pyarrow.BufferReader.rst.txt
@@ -13,6 +13,7 @@ pyarrow.BufferReader
.. autosummary::
+ ~BufferReader.__init__
~BufferReader.close
~BufferReader.download
~BufferReader.fileno
@@ -20,6 +21,7 @@ pyarrow.BufferReader
~BufferReader.isatty
~BufferReader.read
~BufferReader.read1
+ ~BufferReader.read_at
~BufferReader.read_buffer
~BufferReader.readable
~BufferReader.readall
diff --git a/docs/_sources/python/generated/pyarrow.ChunkedArray.rst.txt b/docs/_sources/python/generated/pyarrow.ChunkedArray.rst.txt
index 52c6de0..a59effa 100644
--- a/docs/_sources/python/generated/pyarrow.ChunkedArray.rst.txt
+++ b/docs/_sources/python/generated/pyarrow.ChunkedArray.rst.txt
@@ -13,6 +13,7 @@ pyarrow.ChunkedArray
.. autosummary::
+ ~ChunkedArray.__init__
~ChunkedArray.chunk
~ChunkedArray.dictionary_encode
~ChunkedArray.equals
diff --git a/docs/_sources/python/generated/pyarrow.Column.rst.txt b/docs/_sources/python/generated/pyarrow.Column.rst.txt
index fa1dc59..eff532d 100644
--- a/docs/_sources/python/generated/pyarrow.Column.rst.txt
+++ b/docs/_sources/python/generated/pyarrow.Column.rst.txt
@@ -13,6 +13,7 @@ pyarrow.Column
.. autosummary::
+ ~Column.__init__
~Column.cast
~Column.dictionary_encode
~Column.equals
diff --git a/docs/_sources/python/generated/pyarrow.CompressedInputStream.rst.txt b/docs/_sources/python/generated/pyarrow.CompressedInputStream.rst.txt
index fe90320..f573b02 100644
--- a/docs/_sources/python/generated/pyarrow.CompressedInputStream.rst.txt
+++ b/docs/_sources/python/generated/pyarrow.CompressedInputStream.rst.txt
@@ -13,6 +13,7 @@ pyarrow.CompressedInputStream
.. autosummary::
+ ~CompressedInputStream.__init__
~CompressedInputStream.close
~CompressedInputStream.download
~CompressedInputStream.fileno
@@ -20,6 +21,7 @@ pyarrow.CompressedInputStream
~CompressedInputStream.isatty
~CompressedInputStream.read
~CompressedInputStream.read1
+ ~CompressedInputStream.read_at
~CompressedInputStream.read_buffer
~CompressedInputStream.readable
~CompressedInputStream.readall
diff --git a/docs/_sources/python/generated/pyarrow.CompressedOutputStream.rst.txt b/docs/_sources/python/generated/pyarrow.CompressedOutputStream.rst.txt
index 4a2c04b..3919a60 100644
--- a/docs/_sources/python/generated/pyarrow.CompressedOutputStream.rst.txt
+++ b/docs/_sources/python/generated/pyarrow.CompressedOutputStream.rst.txt
@@ -13,6 +13,7 @@ pyarrow.CompressedOutputStream
.. autosummary::
+ ~CompressedOutputStream.__init__
~CompressedOutputStream.close
~CompressedOutputStream.download
~CompressedOutputStream.fileno
@@ -20,6 +21,7 @@ pyarrow.CompressedOutputStream
~CompressedOutputStream.isatty
~CompressedOutputStream.read
~CompressedOutputStream.read1
+ ~CompressedOutputStream.read_at
~CompressedOutputStream.read_buffer
~CompressedOutputStream.readable
~CompressedOutputStream.readall
diff --git a/docs/_sources/python/generated/pyarrow.DataType.rst.txt b/docs/_sources/python/generated/pyarrow.DataType.rst.txt
index cb602d0..3017139 100644
--- a/docs/_sources/python/generated/pyarrow.DataType.rst.txt
+++ b/docs/_sources/python/generated/pyarrow.DataType.rst.txt
@@ -13,6 +13,7 @@ pyarrow.DataType
.. autosummary::
+ ~DataType.__init__
~DataType.equals
~DataType.to_pandas_dtype
@@ -26,5 +27,7 @@ pyarrow.DataType
~DataType.bit_width
~DataType.id
+ ~DataType.num_buffers
+ ~DataType.num_children
\ No newline at end of file
diff --git a/docs/_sources/python/generated/pyarrow.Date32Array.rst.txt b/docs/_sources/python/generated/pyarrow.Date32Array.rst.txt
index d7af1a6..ace6c81 100644
--- a/docs/_sources/python/generated/pyarrow.Date32Array.rst.txt
+++ b/docs/_sources/python/generated/pyarrow.Date32Array.rst.txt
@@ -13,6 +13,7 @@ pyarrow.Date32Array
.. autosummary::
+ ~Date32Array.__init__
~Date32Array.buffers
~Date32Array.cast
~Date32Array.dictionary_encode
@@ -22,6 +23,8 @@ pyarrow.Date32Array
~Date32Array.from_pandas
~Date32Array.isnull
~Date32Array.slice
+ ~Date32Array.sum
+ ~Date32Array.take
~Date32Array.to_numpy
~Date32Array.to_pandas
~Date32Array.to_pylist
diff --git a/docs/_sources/python/generated/pyarrow.Date32Value.rst.txt b/docs/_sources/python/generated/pyarrow.Date32Value.rst.txt
index 6b976f7..235f732 100644
--- a/docs/_sources/python/generated/pyarrow.Date32Value.rst.txt
+++ b/docs/_sources/python/generated/pyarrow.Date32Value.rst.txt
@@ -13,6 +13,7 @@ pyarrow.Date32Value
.. autosummary::
+ ~Date32Value.__init__
~Date32Value.as_py
diff --git a/docs/_sources/python/generated/pyarrow.Date64Array.rst.txt b/docs/_sources/python/generated/pyarrow.Date64Array.rst.txt
index 95f814d..21fa284 100644
--- a/docs/_sources/python/generated/pyarrow.Date64Array.rst.txt
+++ b/docs/_sources/python/generated/pyarrow.Date64Array.rst.txt
@@ -13,6 +13,7 @@ pyarrow.Date64Array
.. autosummary::
+ ~Date64Array.__init__
~Date64Array.buffers
~Date64Array.cast
~Date64Array.dictionary_encode
@@ -22,6 +23,8 @@ pyarrow.Date64Array
~Date64Array.from_pandas
~Date64Array.isnull
~Date64Array.slice
+ ~Date64Array.sum
+ ~Date64Array.take
~Date64Array.to_numpy
~Date64Array.to_pandas
~Date64Array.to_pylist
diff --git a/docs/_sources/python/generated/pyarrow.Date64Value.rst.txt b/docs/_sources/python/generated/pyarrow.Date64Value.rst.txt
index 5ae7675..1767911 100644
--- a/docs/_sources/python/generated/pyarrow.Date64Value.rst.txt
+++ b/docs/_sources/python/generated/pyarrow.Date64Value.rst.txt
@@ -13,6 +13,7 @@ pyarrow.Date64Value
.. autosummary::
+ ~Date64Value.__init__
~Date64Value.as_py
diff --git a/docs/_sources/python/generated/pyarrow.Decimal128Array.rst.txt b/docs/_sources/python/generated/pyarrow.Decimal128Array.rst.txt
index 9f30dce..17aa949 100644
--- a/docs/_sources/python/generated/pyarrow.Decimal128Array.rst.txt
+++ b/docs/_sources/python/generated/pyarrow.Decimal128Array.rst.txt
@@ -13,6 +13,7 @@ pyarrow.Decimal128Array
.. autosummary::
+ ~Decimal128Array.__init__
~Decimal128Array.buffers
~Decimal128Array.cast
~Decimal128Array.dictionary_encode
@@ -22,6 +23,8 @@ pyarrow.Decimal128Array
~Decimal128Array.from_pandas
~Decimal128Array.isnull
~Decimal128Array.slice
+ ~Decimal128Array.sum
+ ~Decimal128Array.take
~Decimal128Array.to_numpy
~Decimal128Array.to_pandas
~Decimal128Array.to_pylist
diff --git a/docs/_sources/python/generated/pyarrow.Decimal128Type.rst.txt b/docs/_sources/python/generated/pyarrow.Decimal128Type.rst.txt
index ca6c491..2eb5c4f 100644
--- a/docs/_sources/python/generated/pyarrow.Decimal128Type.rst.txt
+++ b/docs/_sources/python/generated/pyarrow.Decimal128Type.rst.txt
@@ -13,6 +13,7 @@ pyarrow.Decimal128Type
.. autosummary::
+ ~Decimal128Type.__init__
~Decimal128Type.equals
~Decimal128Type.to_pandas_dtype
@@ -27,6 +28,8 @@ pyarrow.Decimal128Type
~Decimal128Type.bit_width
~Decimal128Type.byte_width
~Decimal128Type.id
+ ~Decimal128Type.num_buffers
+ ~Decimal128Type.num_children
~Decimal128Type.precision
~Decimal128Type.scale
diff --git a/docs/_sources/python/generated/pyarrow.DecimalValue.rst.txt b/docs/_sources/python/generated/pyarrow.DecimalValue.rst.txt
index ea8bbd6..1541b1d 100644
--- a/docs/_sources/python/generated/pyarrow.DecimalValue.rst.txt
+++ b/docs/_sources/python/generated/pyarrow.DecimalValue.rst.txt
@@ -13,6 +13,7 @@ pyarrow.DecimalValue
.. autosummary::
+ ~DecimalValue.__init__
~DecimalValue.as_py
diff --git a/docs/_sources/python/generated/pyarrow.DictionaryArray.rst.txt b/docs/_sources/python/generated/pyarrow.DictionaryArray.rst.txt
index 024f81c..d6bc6d5 100644
--- a/docs/_sources/python/generated/pyarrow.DictionaryArray.rst.txt
+++ b/docs/_sources/python/generated/pyarrow.DictionaryArray.rst.txt
@@ -13,6 +13,7 @@ pyarrow.DictionaryArray
.. autosummary::
+ ~DictionaryArray.__init__
~DictionaryArray.buffers
~DictionaryArray.cast
~DictionaryArray.dictionary_encode
@@ -23,6 +24,8 @@ pyarrow.DictionaryArray
~DictionaryArray.from_pandas
~DictionaryArray.isnull
~DictionaryArray.slice
+ ~DictionaryArray.sum
+ ~DictionaryArray.take
~DictionaryArray.to_numpy
~DictionaryArray.to_pandas
~DictionaryArray.to_pylist
diff --git a/docs/_sources/python/generated/pyarrow.DictionaryType.rst.txt b/docs/_sources/python/generated/pyarrow.DictionaryType.rst.txt
index eb9826b..22fdb68 100644
--- a/docs/_sources/python/generated/pyarrow.DictionaryType.rst.txt
+++ b/docs/_sources/python/generated/pyarrow.DictionaryType.rst.txt
@@ -13,6 +13,7 @@ pyarrow.DictionaryType
.. autosummary::
+ ~DictionaryType.__init__
~DictionaryType.equals
~DictionaryType.to_pandas_dtype
@@ -25,9 +26,11 @@ pyarrow.DictionaryType
.. autosummary::
~DictionaryType.bit_width
- ~DictionaryType.dictionary
~DictionaryType.id
~DictionaryType.index_type
+ ~DictionaryType.num_buffers
+ ~DictionaryType.num_children
~DictionaryType.ordered
+ ~DictionaryType.value_type
\ No newline at end of file
diff --git a/docs/_sources/python/generated/pyarrow.DictionaryValue.rst.txt b/docs/_sources/python/generated/pyarrow.DictionaryValue.rst.txt
index 13c1c6d..ca7da3a 100644
--- a/docs/_sources/python/generated/pyarrow.DictionaryValue.rst.txt
+++ b/docs/_sources/python/generated/pyarrow.DictionaryValue.rst.txt
@@ -13,6 +13,7 @@ pyarrow.DictionaryValue
.. autosummary::
+ ~DictionaryValue.__init__
~DictionaryValue.as_py
diff --git a/docs/_sources/python/generated/pyarrow.DoubleValue.rst.txt b/docs/_sources/python/generated/pyarrow.DoubleValue.rst.txt
index ebd9975..9a18662 100644
--- a/docs/_sources/python/generated/pyarrow.DoubleValue.rst.txt
+++ b/docs/_sources/python/generated/pyarrow.DoubleValue.rst.txt
@@ -13,6 +13,7 @@ pyarrow.DoubleValue
.. autosummary::
+ ~DoubleValue.__init__
~DoubleValue.as_py
diff --git a/docs/_sources/python/generated/pyarrow.Field.rst.txt b/docs/_sources/python/generated/pyarrow.Field.rst.txt
index bd79297..63cbae8 100644
--- a/docs/_sources/python/generated/pyarrow.Field.rst.txt
+++ b/docs/_sources/python/generated/pyarrow.Field.rst.txt
@@ -13,6 +13,7 @@ pyarrow.Field
.. autosummary::
+ ~Field.__init__
~Field.add_metadata
~Field.equals
~Field.flatten
diff --git a/docs/_sources/python/generated/pyarrow.FixedSizeBinaryArray.rst.txt b/docs/_sources/python/generated/pyarrow.FixedSizeBinaryArray.rst.txt
index ee87f3b..0412522 100644
--- a/docs/_sources/python/generated/pyarrow.FixedSizeBinaryArray.rst.txt
+++ b/docs/_sources/python/generated/pyarrow.FixedSizeBinaryArray.rst.txt
@@ -13,6 +13,7 @@ pyarrow.FixedSizeBinaryArray
.. autosummary::
+ ~FixedSizeBinaryArray.__init__
~FixedSizeBinaryArray.buffers
~FixedSizeBinaryArray.cast
~FixedSizeBinaryArray.dictionary_encode
@@ -22,6 +23,8 @@ pyarrow.FixedSizeBinaryArray
~FixedSizeBinaryArray.from_pandas
~FixedSizeBinaryArray.isnull
~FixedSizeBinaryArray.slice
+ ~FixedSizeBinaryArray.sum
+ ~FixedSizeBinaryArray.take
~FixedSizeBinaryArray.to_numpy
~FixedSizeBinaryArray.to_pandas
~FixedSizeBinaryArray.to_pylist
diff --git a/docs/_sources/python/generated/pyarrow.FixedSizeBinaryType.rst.txt b/docs/_sources/python/generated/pyarrow.FixedSizeBinaryType.rst.txt
index 6c248e4..2f8f0dc 100644
--- a/docs/_sources/python/generated/pyarrow.FixedSizeBinaryType.rst.txt
+++ b/docs/_sources/python/generated/pyarrow.FixedSizeBinaryType.rst.txt
@@ -13,6 +13,7 @@ pyarrow.FixedSizeBinaryType
.. autosummary::
+ ~FixedSizeBinaryType.__init__
~FixedSizeBinaryType.equals
~FixedSizeBinaryType.to_pandas_dtype
@@ -27,5 +28,7 @@ pyarrow.FixedSizeBinaryType
~FixedSizeBinaryType.bit_width
~FixedSizeBinaryType.byte_width
~FixedSizeBinaryType.id
+ ~FixedSizeBinaryType.num_buffers
+ ~FixedSizeBinaryType.num_children
\ No newline at end of file
diff --git a/docs/_sources/python/generated/pyarrow.FixedSizeBinaryValue.rst.txt b/docs/_sources/python/generated/pyarrow.FixedSizeBinaryValue.rst.txt
index e8ed264..aecb165 100644
--- a/docs/_sources/python/generated/pyarrow.FixedSizeBinaryValue.rst.txt
+++ b/docs/_sources/python/generated/pyarrow.FixedSizeBinaryValue.rst.txt
@@ -13,6 +13,7 @@ pyarrow.FixedSizeBinaryValue
.. autosummary::
+ ~FixedSizeBinaryValue.__init__
~FixedSizeBinaryValue.as_py
diff --git a/docs/_sources/python/generated/pyarrow.FixedSizeBufferWriter.rst.txt b/docs/_sources/python/generated/pyarrow.FixedSizeBufferWriter.rst.txt
index b656e80..f7c9453 100644
--- a/docs/_sources/python/generated/pyarrow.FixedSizeBufferWriter.rst.txt
+++ b/docs/_sources/python/generated/pyarrow.FixedSizeBufferWriter.rst.txt
@@ -13,6 +13,7 @@ pyarrow.FixedSizeBufferWriter
.. autosummary::
+ ~FixedSizeBufferWriter.__init__
~FixedSizeBufferWriter.close
~FixedSizeBufferWriter.download
~FixedSizeBufferWriter.fileno
@@ -20,6 +21,7 @@ pyarrow.FixedSizeBufferWriter
~FixedSizeBufferWriter.isatty
~FixedSizeBufferWriter.read
~FixedSizeBufferWriter.read1
+ ~FixedSizeBufferWriter.read_at
~FixedSizeBufferWriter.read_buffer
~FixedSizeBufferWriter.readable
~FixedSizeBufferWriter.readall
diff --git a/docs/_sources/python/generated/pyarrow.FloatValue.rst.txt b/docs/_sources/python/generated/pyarrow.FloatValue.rst.txt
index f5bab4b..8a26b9f 100644
--- a/docs/_sources/python/generated/pyarrow.FloatValue.rst.txt
+++ b/docs/_sources/python/generated/pyarrow.FloatValue.rst.txt
@@ -13,6 +13,7 @@ pyarrow.FloatValue
.. autosummary::
+ ~FloatValue.__init__
~FloatValue.as_py
diff --git a/docs/_sources/python/generated/pyarrow.FloatingPointArray.rst.txt b/docs/_sources/python/generated/pyarrow.FloatingPointArray.rst.txt
index cfb43d7..cd46682 100644
--- a/docs/_sources/python/generated/pyarrow.FloatingPointArray.rst.txt
+++ b/docs/_sources/python/generated/pyarrow.FloatingPointArray.rst.txt
@@ -13,6 +13,7 @@ pyarrow.FloatingPointArray
.. autosummary::
+ ~FloatingPointArray.__init__
~FloatingPointArray.buffers
~FloatingPointArray.cast
~FloatingPointArray.dictionary_encode
@@ -22,6 +23,8 @@ pyarrow.FloatingPointArray
~FloatingPointArray.from_pandas
~FloatingPointArray.isnull
~FloatingPointArray.slice
+ ~FloatingPointArray.sum
+ ~FloatingPointArray.take
~FloatingPointArray.to_numpy
~FloatingPointArray.to_pandas
~FloatingPointArray.to_pylist
diff --git a/docs/_sources/python/generated/pyarrow.HdfsFile.rst.txt b/docs/_sources/python/generated/pyarrow.HdfsFile.rst.txt
index c7159df..c4eb98d 100644
--- a/docs/_sources/python/generated/pyarrow.HdfsFile.rst.txt
+++ b/docs/_sources/python/generated/pyarrow.HdfsFile.rst.txt
@@ -13,6 +13,7 @@ pyarrow.HdfsFile
.. autosummary::
+ ~HdfsFile.__init__
~HdfsFile.close
~HdfsFile.download
~HdfsFile.fileno
@@ -20,6 +21,7 @@ pyarrow.HdfsFile
~HdfsFile.isatty
~HdfsFile.read
~HdfsFile.read1
+ ~HdfsFile.read_at
~HdfsFile.read_buffer
~HdfsFile.readable
~HdfsFile.readall
diff --git a/docs/_sources/python/generated/pyarrow.Int16Array.rst.txt b/docs/_sources/python/generated/pyarrow.Int16Array.rst.txt
index f595250..68d9c42 100644
--- a/docs/_sources/python/generated/pyarrow.Int16Array.rst.txt
+++ b/docs/_sources/python/generated/pyarrow.Int16Array.rst.txt
@@ -13,6 +13,7 @@ pyarrow.Int16Array
.. autosummary::
+ ~Int16Array.__init__
~Int16Array.buffers
~Int16Array.cast
~Int16Array.dictionary_encode
@@ -22,6 +23,8 @@ pyarrow.Int16Array
~Int16Array.from_pandas
~Int16Array.isnull
~Int16Array.slice
+ ~Int16Array.sum
+ ~Int16Array.take
~Int16Array.to_numpy
~Int16Array.to_pandas
~Int16Array.to_pylist
diff --git a/docs/_sources/python/generated/pyarrow.Int16Value.rst.txt b/docs/_sources/python/generated/pyarrow.Int16Value.rst.txt
index 5284621..0381d0b 100644
--- a/docs/_sources/python/generated/pyarrow.Int16Value.rst.txt
+++ b/docs/_sources/python/generated/pyarrow.Int16Value.rst.txt
@@ -13,6 +13,7 @@ pyarrow.Int16Value
.. autosummary::
+ ~Int16Value.__init__
~Int16Value.as_py
diff --git a/docs/_sources/python/generated/pyarrow.Int32Array.rst.txt b/docs/_sources/python/generated/pyarrow.Int32Array.rst.txt
index 785da02..3ab80a7 100644
--- a/docs/_sources/python/generated/pyarrow.Int32Array.rst.txt
+++ b/docs/_sources/python/generated/pyarrow.Int32Array.rst.txt
@@ -13,6 +13,7 @@ pyarrow.Int32Array
.. autosummary::
+ ~Int32Array.__init__
~Int32Array.buffers
~Int32Array.cast
~Int32Array.dictionary_encode
@@ -22,6 +23,8 @@ pyarrow.Int32Array
~Int32Array.from_pandas
~Int32Array.isnull
~Int32Array.slice
+ ~Int32Array.sum
+ ~Int32Array.take
~Int32Array.to_numpy
~Int32Array.to_pandas
~Int32Array.to_pylist
diff --git a/docs/_sources/python/generated/pyarrow.Int32Value.rst.txt b/docs/_sources/python/generated/pyarrow.Int32Value.rst.txt
index 609261b..d57f288 100644
--- a/docs/_sources/python/generated/pyarrow.Int32Value.rst.txt
+++ b/docs/_sources/python/generated/pyarrow.Int32Value.rst.txt
@@ -13,6 +13,7 @@ pyarrow.Int32Value
.. autosummary::
+ ~Int32Value.__init__
~Int32Value.as_py
diff --git a/docs/_sources/python/generated/pyarrow.Int64Array.rst.txt b/docs/_sources/python/generated/pyarrow.Int64Array.rst.txt
index d74f437..18f6ba4 100644
--- a/docs/_sources/python/generated/pyarrow.Int64Array.rst.txt
+++ b/docs/_sources/python/generated/pyarrow.Int64Array.rst.txt
@@ -13,6 +13,7 @@ pyarrow.Int64Array
.. autosummary::
+ ~Int64Array.__init__
~Int64Array.buffers
~Int64Array.cast
~Int64Array.dictionary_encode
@@ -22,6 +23,8 @@ pyarrow.Int64Array
~Int64Array.from_pandas
~Int64Array.isnull
~Int64Array.slice
+ ~Int64Array.sum
+ ~Int64Array.take
~Int64Array.to_numpy
~Int64Array.to_pandas
~Int64Array.to_pylist
diff --git a/docs/_sources/python/generated/pyarrow.Int64Value.rst.txt b/docs/_sources/python/generated/pyarrow.Int64Value.rst.txt
index 994effa..ee325a1 100644
--- a/docs/_sources/python/generated/pyarrow.Int64Value.rst.txt
+++ b/docs/_sources/python/generated/pyarrow.Int64Value.rst.txt
@@ -13,6 +13,7 @@ pyarrow.Int64Value
.. autosummary::
+ ~Int64Value.__init__
~Int64Value.as_py
diff --git a/docs/_sources/python/generated/pyarrow.Int8Array.rst.txt b/docs/_sources/python/generated/pyarrow.Int8Array.rst.txt
index 8daeec3..fef86de 100644
--- a/docs/_sources/python/generated/pyarrow.Int8Array.rst.txt
+++ b/docs/_sources/python/generated/pyarrow.Int8Array.rst.txt
@@ -13,6 +13,7 @@ pyarrow.Int8Array
.. autosummary::
+ ~Int8Array.__init__
~Int8Array.buffers
~Int8Array.cast
~Int8Array.dictionary_encode
@@ -22,6 +23,8 @@ pyarrow.Int8Array
~Int8Array.from_pandas
~Int8Array.isnull
~Int8Array.slice
+ ~Int8Array.sum
+ ~Int8Array.take
~Int8Array.to_numpy
~Int8Array.to_pandas
~Int8Array.to_pylist
diff --git a/docs/_sources/python/generated/pyarrow.Int8Value.rst.txt b/docs/_sources/python/generated/pyarrow.Int8Value.rst.txt
index 50bd51c..2a48308 100644
--- a/docs/_sources/python/generated/pyarrow.Int8Value.rst.txt
+++ b/docs/_sources/python/generated/pyarrow.Int8Value.rst.txt
@@ -13,6 +13,7 @@ pyarrow.Int8Value
.. autosummary::
+ ~Int8Value.__init__
~Int8Value.as_py
diff --git a/docs/_sources/python/generated/pyarrow.IntegerArray.rst.txt b/docs/_sources/python/generated/pyarrow.IntegerArray.rst.txt
index 72b7beb..3fdb98b 100644
--- a/docs/_sources/python/generated/pyarrow.IntegerArray.rst.txt
+++ b/docs/_sources/python/generated/pyarrow.IntegerArray.rst.txt
@@ -13,6 +13,7 @@ pyarrow.IntegerArray
.. autosummary::
+ ~IntegerArray.__init__
~IntegerArray.buffers
~IntegerArray.cast
~IntegerArray.dictionary_encode
@@ -22,6 +23,8 @@ pyarrow.IntegerArray
~IntegerArray.from_pandas
~IntegerArray.isnull
~IntegerArray.slice
+ ~IntegerArray.sum
+ ~IntegerArray.take
~IntegerArray.to_numpy
~IntegerArray.to_pandas
~IntegerArray.to_pylist
diff --git a/docs/_sources/python/generated/pyarrow.ListArray.rst.txt b/docs/_sources/python/generated/pyarrow.ListArray.rst.txt
index ac6536a..140a855 100644
--- a/docs/_sources/python/generated/pyarrow.ListArray.rst.txt
+++ b/docs/_sources/python/generated/pyarrow.ListArray.rst.txt
@@ -13,6 +13,7 @@ pyarrow.ListArray
.. autosummary::
+ ~ListArray.__init__
~ListArray.buffers
~ListArray.cast
~ListArray.dictionary_encode
@@ -24,6 +25,8 @@ pyarrow.ListArray
~ListArray.from_pandas
~ListArray.isnull
~ListArray.slice
+ ~ListArray.sum
+ ~ListArray.take
~ListArray.to_numpy
~ListArray.to_pandas
~ListArray.to_pylist
diff --git a/docs/_sources/python/generated/pyarrow.ListType.rst.txt b/docs/_sources/python/generated/pyarrow.ListType.rst.txt
index f6f1d7a..5b5ee53 100644
--- a/docs/_sources/python/generated/pyarrow.ListType.rst.txt
+++ b/docs/_sources/python/generated/pyarrow.ListType.rst.txt
@@ -13,6 +13,7 @@ pyarrow.ListType
.. autosummary::
+ ~ListType.__init__
~ListType.equals
~ListType.to_pandas_dtype
@@ -26,6 +27,8 @@ pyarrow.ListType
~ListType.bit_width
~ListType.id
+ ~ListType.num_buffers
+ ~ListType.num_children
~ListType.value_type
\ No newline at end of file
diff --git a/docs/_sources/python/generated/pyarrow.ListValue.rst.txt b/docs/_sources/python/generated/pyarrow.ListValue.rst.txt
index 90a650e..9cb8d70 100644
--- a/docs/_sources/python/generated/pyarrow.ListValue.rst.txt
+++ b/docs/_sources/python/generated/pyarrow.ListValue.rst.txt
@@ -13,6 +13,7 @@ pyarrow.ListValue
.. autosummary::
+ ~ListValue.__init__
~ListValue.as_py
diff --git a/docs/_sources/python/generated/pyarrow.LocalFileSystem.rst.txt b/docs/_sources/python/generated/pyarrow.LocalFileSystem.rst.txt
index 4d1ece3..abad0f8 100644
--- a/docs/_sources/python/generated/pyarrow.LocalFileSystem.rst.txt
+++ b/docs/_sources/python/generated/pyarrow.LocalFileSystem.rst.txt
@@ -13,6 +13,7 @@ pyarrow.LocalFileSystem
.. autosummary::
+ ~LocalFileSystem.__init__
~LocalFileSystem.cat
~LocalFileSystem.delete
~LocalFileSystem.disk_usage
diff --git a/docs/_sources/python/generated/pyarrow.MemoryMappedFile.rst.txt b/docs/_sources/python/generated/pyarrow.MemoryMappedFile.rst.txt
index 6518204..e75a8f9 100644
--- a/docs/_sources/python/generated/pyarrow.MemoryMappedFile.rst.txt
+++ b/docs/_sources/python/generated/pyarrow.MemoryMappedFile.rst.txt
@@ -13,6 +13,7 @@ pyarrow.MemoryMappedFile
.. autosummary::
+ ~MemoryMappedFile.__init__
~MemoryMappedFile.close
~MemoryMappedFile.create
~MemoryMappedFile.download
@@ -21,6 +22,7 @@ pyarrow.MemoryMappedFile
~MemoryMappedFile.isatty
~MemoryMappedFile.read
~MemoryMappedFile.read1
+ ~MemoryMappedFile.read_at
~MemoryMappedFile.read_buffer
~MemoryMappedFile.readable
~MemoryMappedFile.readall
diff --git a/docs/_sources/python/generated/pyarrow.MemoryPool.rst.txt b/docs/_sources/python/generated/pyarrow.MemoryPool.rst.txt
index 1c77c24..95acd11 100644
--- a/docs/_sources/python/generated/pyarrow.MemoryPool.rst.txt
+++ b/docs/_sources/python/generated/pyarrow.MemoryPool.rst.txt
@@ -13,6 +13,7 @@ pyarrow.MemoryPool
.. autosummary::
+ ~MemoryPool.__init__
~MemoryPool.bytes_allocated
~MemoryPool.max_memory
diff --git a/docs/_sources/python/generated/pyarrow.Message.rst.txt b/docs/_sources/python/generated/pyarrow.Message.rst.txt
index 54282b7..ab9864f 100644
--- a/docs/_sources/python/generated/pyarrow.Message.rst.txt
+++ b/docs/_sources/python/generated/pyarrow.Message.rst.txt
@@ -13,6 +13,7 @@ pyarrow.Message
.. autosummary::
+ ~Message.__init__
~Message.equals
~Message.serialize
diff --git a/docs/_sources/python/generated/pyarrow.MessageReader.rst.txt b/docs/_sources/python/generated/pyarrow.MessageReader.rst.txt
index 3dbe79d..527bfca 100644
--- a/docs/_sources/python/generated/pyarrow.MessageReader.rst.txt
+++ b/docs/_sources/python/generated/pyarrow.MessageReader.rst.txt
@@ -13,6 +13,7 @@ pyarrow.MessageReader
.. autosummary::
+ ~MessageReader.__init__
~MessageReader.open_stream
~MessageReader.read_next_message
diff --git a/docs/_sources/python/generated/pyarrow.NativeFile.rst.txt b/docs/_sources/python/generated/pyarrow.NativeFile.rst.txt
index 415a705..5f9f974 100644
--- a/docs/_sources/python/generated/pyarrow.NativeFile.rst.txt
+++ b/docs/_sources/python/generated/pyarrow.NativeFile.rst.txt
@@ -13,6 +13,7 @@ pyarrow.NativeFile
.. autosummary::
+ ~NativeFile.__init__
~NativeFile.close
~NativeFile.download
~NativeFile.fileno
@@ -20,6 +21,7 @@ pyarrow.NativeFile
~NativeFile.isatty
~NativeFile.read
~NativeFile.read1
+ ~NativeFile.read_at
~NativeFile.read_buffer
~NativeFile.readable
~NativeFile.readall
diff --git a/docs/_sources/python/generated/pyarrow.NullArray.rst.txt b/docs/_sources/python/generated/pyarrow.NullArray.rst.txt
index b892c07..fb18777 100644
--- a/docs/_sources/python/generated/pyarrow.NullArray.rst.txt
+++ b/docs/_sources/python/generated/pyarrow.NullArray.rst.txt
@@ -13,6 +13,7 @@ pyarrow.NullArray
.. autosummary::
+ ~NullArray.__init__
~NullArray.buffers
~NullArray.cast
~NullArray.dictionary_encode
@@ -22,6 +23,8 @@ pyarrow.NullArray
~NullArray.from_pandas
~NullArray.isnull
~NullArray.slice
+ ~NullArray.sum
+ ~NullArray.take
~NullArray.to_numpy
~NullArray.to_pandas
~NullArray.to_pylist
diff --git a/docs/_sources/python/generated/pyarrow.NumericArray.rst.txt b/docs/_sources/python/generated/pyarrow.NumericArray.rst.txt
index 6776508..e9b59c2 100644
--- a/docs/_sources/python/generated/pyarrow.NumericArray.rst.txt
+++ b/docs/_sources/python/generated/pyarrow.NumericArray.rst.txt
@@ -13,6 +13,7 @@ pyarrow.NumericArray
.. autosummary::
+ ~NumericArray.__init__
~NumericArray.buffers
~NumericArray.cast
~NumericArray.dictionary_encode
@@ -22,6 +23,8 @@ pyarrow.NumericArray
~NumericArray.from_pandas
~NumericArray.isnull
~NumericArray.slice
+ ~NumericArray.sum
+ ~NumericArray.take
~NumericArray.to_numpy
~NumericArray.to_pandas
~NumericArray.to_pylist
diff --git a/docs/_sources/python/generated/pyarrow.OSFile.rst.txt b/docs/_sources/python/generated/pyarrow.OSFile.rst.txt
index 2c0899d..b37897b 100644
--- a/docs/_sources/python/generated/pyarrow.OSFile.rst.txt
+++ b/docs/_sources/python/generated/pyarrow.OSFile.rst.txt
@@ -13,6 +13,7 @@ pyarrow.OSFile
.. autosummary::
+ ~OSFile.__init__
~OSFile.close
~OSFile.download
~OSFile.fileno
@@ -20,6 +21,7 @@ pyarrow.OSFile
~OSFile.isatty
~OSFile.read
~OSFile.read1
+ ~OSFile.read_at
~OSFile.read_buffer
~OSFile.readable
~OSFile.readall
diff --git a/docs/_sources/python/generated/pyarrow.PythonFile.rst.txt b/docs/_sources/python/generated/pyarrow.PythonFile.rst.txt
index 40cab6d..013ca12 100644
--- a/docs/_sources/python/generated/pyarrow.PythonFile.rst.txt
+++ b/docs/_sources/python/generated/pyarrow.PythonFile.rst.txt
@@ -13,6 +13,7 @@ pyarrow.PythonFile
.. autosummary::
+ ~PythonFile.__init__
~PythonFile.close
~PythonFile.download
~PythonFile.fileno
@@ -20,6 +21,7 @@ pyarrow.PythonFile
~PythonFile.isatty
~PythonFile.read
~PythonFile.read1
+ ~PythonFile.read_at
~PythonFile.read_buffer
~PythonFile.readable
~PythonFile.readall
diff --git a/docs/_sources/python/generated/pyarrow.RecordBatch.rst.txt b/docs/_sources/python/generated/pyarrow.RecordBatch.rst.txt
index 99358d5..b0d98f9 100644
--- a/docs/_sources/python/generated/pyarrow.RecordBatch.rst.txt
+++ b/docs/_sources/python/generated/pyarrow.RecordBatch.rst.txt
@@ -13,6 +13,7 @@ pyarrow.RecordBatch
.. autosummary::
+ ~RecordBatch.__init__
~RecordBatch.column
~RecordBatch.equals
~RecordBatch.from_arrays
diff --git a/docs/_sources/python/generated/pyarrow.ResizableBuffer.rst.txt b/docs/_sources/python/generated/pyarrow.ResizableBuffer.rst.txt
index 9712446..ea42f3a 100644
--- a/docs/_sources/python/generated/pyarrow.ResizableBuffer.rst.txt
+++ b/docs/_sources/python/generated/pyarrow.ResizableBuffer.rst.txt
@@ -13,7 +13,9 @@ pyarrow.ResizableBuffer
.. autosummary::
+ ~ResizableBuffer.__init__
~ResizableBuffer.equals
+ ~ResizableBuffer.hex
~ResizableBuffer.resize
~ResizableBuffer.slice
~ResizableBuffer.to_pybytes
diff --git a/docs/_sources/python/generated/pyarrow.Scalar.rst.txt b/docs/_sources/python/generated/pyarrow.Scalar.rst.txt
index 412ebda..dfc8933 100644
--- a/docs/_sources/python/generated/pyarrow.Scalar.rst.txt
+++ b/docs/_sources/python/generated/pyarrow.Scalar.rst.txt
@@ -9,6 +9,12 @@ pyarrow.Scalar
.. automethod:: __init__
+ .. rubric:: Methods
+
+ .. autosummary::
+
+ ~Scalar.__init__
+
diff --git a/docs/_sources/python/generated/pyarrow.Schema.rst.txt b/docs/_sources/python/generated/pyarrow.Schema.rst.txt
index 488f321..f4c245d 100644
--- a/docs/_sources/python/generated/pyarrow.Schema.rst.txt
+++ b/docs/_sources/python/generated/pyarrow.Schema.rst.txt
@@ -13,6 +13,7 @@ pyarrow.Schema
.. autosummary::
+ ~Schema.__init__
~Schema.add_metadata
~Schema.append
~Schema.empty_table
diff --git a/docs/_sources/python/generated/pyarrow.SerializationContext.rst.txt b/docs/_sources/python/generated/pyarrow.SerializationContext.rst.txt
index db26983..728e0df 100644
--- a/docs/_sources/python/generated/pyarrow.SerializationContext.rst.txt
+++ b/docs/_sources/python/generated/pyarrow.SerializationContext.rst.txt
@@ -13,6 +13,7 @@ pyarrow.SerializationContext
.. autosummary::
+ ~SerializationContext.__init__
~SerializationContext.clone
~SerializationContext.deserialize
~SerializationContext.deserialize_components
diff --git a/docs/_sources/python/generated/pyarrow.SerializedPyObject.rst.txt b/docs/_sources/python/generated/pyarrow.SerializedPyObject.rst.txt
index f8cdbe3..e1bd936 100644
--- a/docs/_sources/python/generated/pyarrow.SerializedPyObject.rst.txt
+++ b/docs/_sources/python/generated/pyarrow.SerializedPyObject.rst.txt
@@ -13,6 +13,7 @@ pyarrow.SerializedPyObject
.. autosummary::
+ ~SerializedPyObject.__init__
~SerializedPyObject.deserialize
~SerializedPyObject.from_components
~SerializedPyObject.to_buffer
diff --git a/docs/_sources/python/generated/pyarrow.StringArray.rst.txt b/docs/_sources/python/generated/pyarrow.StringArray.rst.txt
index 13835b3..b9f2e81 100644
--- a/docs/_sources/python/generated/pyarrow.StringArray.rst.txt
+++ b/docs/_sources/python/generated/pyarrow.StringArray.rst.txt
@@ -13,6 +13,7 @@ pyarrow.StringArray
.. autosummary::
+ ~StringArray.__init__
~StringArray.buffers
~StringArray.cast
~StringArray.dictionary_encode
@@ -22,6 +23,8 @@ pyarrow.StringArray
~StringArray.from_pandas
~StringArray.isnull
~StringArray.slice
+ ~StringArray.sum
+ ~StringArray.take
~StringArray.to_numpy
~StringArray.to_pandas
~StringArray.to_pylist
diff --git a/docs/_sources/python/generated/pyarrow.StringValue.rst.txt b/docs/_sources/python/generated/pyarrow.StringValue.rst.txt
index ad262e9..1ee4a25 100644
--- a/docs/_sources/python/generated/pyarrow.StringValue.rst.txt
+++ b/docs/_sources/python/generated/pyarrow.StringValue.rst.txt
@@ -13,6 +13,7 @@ pyarrow.StringValue
.. autosummary::
+ ~StringValue.__init__
~StringValue.as_py
diff --git a/docs/_sources/python/generated/pyarrow.StructArray.rst.txt b/docs/_sources/python/generated/pyarrow.StructArray.rst.txt
index 407b4e3..944679d 100644
--- a/docs/_sources/python/generated/pyarrow.StructArray.rst.txt
+++ b/docs/_sources/python/generated/pyarrow.StructArray.rst.txt
@@ -13,6 +13,7 @@ pyarrow.StructArray
.. autosummary::
+ ~StructArray.__init__
~StructArray.buffers
~StructArray.cast
~StructArray.dictionary_encode
@@ -25,6 +26,8 @@ pyarrow.StructArray
~StructArray.from_pandas
~StructArray.isnull
~StructArray.slice
+ ~StructArray.sum
+ ~StructArray.take
~StructArray.to_numpy
~StructArray.to_pandas
~StructArray.to_pylist
diff --git a/docs/_sources/python/generated/pyarrow.StructType.rst.txt b/docs/_sources/python/generated/pyarrow.StructType.rst.txt
index e25ff49..3616bf6 100644
--- a/docs/_sources/python/generated/pyarrow.StructType.rst.txt
+++ b/docs/_sources/python/generated/pyarrow.StructType.rst.txt
@@ -13,6 +13,7 @@ pyarrow.StructType
.. autosummary::
+ ~StructType.__init__
~StructType.equals
~StructType.to_pandas_dtype
@@ -26,6 +27,7 @@ pyarrow.StructType
~StructType.bit_width
~StructType.id
+ ~StructType.num_buffers
~StructType.num_children
\ No newline at end of file
diff --git a/docs/_sources/python/generated/pyarrow.StructValue.rst.txt b/docs/_sources/python/generated/pyarrow.StructValue.rst.txt
index 9aac40b..9752ade 100644
--- a/docs/_sources/python/generated/pyarrow.StructValue.rst.txt
+++ b/docs/_sources/python/generated/pyarrow.StructValue.rst.txt
@@ -13,6 +13,7 @@ pyarrow.StructValue
.. autosummary::
+ ~StructValue.__init__
~StructValue.as_py
diff --git a/docs/_sources/python/generated/pyarrow.Table.rst.txt b/docs/_sources/python/generated/pyarrow.Table.rst.txt
index 1d76077..d41717f 100644
--- a/docs/_sources/python/generated/pyarrow.Table.rst.txt
+++ b/docs/_sources/python/generated/pyarrow.Table.rst.txt
@@ -13,18 +13,22 @@ pyarrow.Table
.. autosummary::
+ ~Table.__init__
~Table.add_column
~Table.append_column
~Table.cast
~Table.column
+ ~Table.combine_chunks
~Table.drop
~Table.equals
~Table.flatten
~Table.from_arrays
~Table.from_batches
~Table.from_pandas
+ ~Table.from_pydict
~Table.itercolumns
~Table.remove_column
+ ~Table.rename_columns
~Table.replace_schema_metadata
~Table.set_column
~Table.to_batches
@@ -39,6 +43,7 @@ pyarrow.Table
.. autosummary::
+ ~Table.column_names
~Table.columns
~Table.num_columns
~Table.num_rows
diff --git a/docs/_sources/python/generated/pyarrow.Tensor.rst.txt b/docs/_sources/python/generated/pyarrow.Tensor.rst.txt
index 334478a..76953ed 100644
--- a/docs/_sources/python/generated/pyarrow.Tensor.rst.txt
+++ b/docs/_sources/python/generated/pyarrow.Tensor.rst.txt
@@ -13,6 +13,7 @@ pyarrow.Tensor
.. autosummary::
+ ~Tensor.__init__
~Tensor.equals
~Tensor.from_numpy
~Tensor.to_numpy
diff --git a/docs/_sources/python/generated/pyarrow.Time32Array.rst.txt b/docs/_sources/python/generated/pyarrow.Time32Array.rst.txt
index 8e64b8f..483e5d6 100644
--- a/docs/_sources/python/generated/pyarrow.Time32Array.rst.txt
+++ b/docs/_sources/python/generated/pyarrow.Time32Array.rst.txt
@@ -13,6 +13,7 @@ pyarrow.Time32Array
.. autosummary::
+ ~Time32Array.__init__
~Time32Array.buffers
~Time32Array.cast
~Time32Array.dictionary_encode
@@ -22,6 +23,8 @@ pyarrow.Time32Array
~Time32Array.from_pandas
~Time32Array.isnull
~Time32Array.slice
+ ~Time32Array.sum
+ ~Time32Array.take
~Time32Array.to_numpy
~Time32Array.to_pandas
~Time32Array.to_pylist
diff --git a/docs/_sources/python/generated/pyarrow.Time32Type.rst.txt b/docs/_sources/python/generated/pyarrow.Time32Type.rst.txt
index 376670c..0f48177 100644
--- a/docs/_sources/python/generated/pyarrow.Time32Type.rst.txt
+++ b/docs/_sources/python/generated/pyarrow.Time32Type.rst.txt
@@ -13,6 +13,7 @@ pyarrow.Time32Type
.. autosummary::
+ ~Time32Type.__init__
~Time32Type.equals
~Time32Type.to_pandas_dtype
@@ -26,6 +27,8 @@ pyarrow.Time32Type
~Time32Type.bit_width
~Time32Type.id
+ ~Time32Type.num_buffers
+ ~Time32Type.num_children
~Time32Type.unit
\ No newline at end of file
diff --git a/docs/_sources/python/generated/pyarrow.Time32Value.rst.txt b/docs/_sources/python/generated/pyarrow.Time32Value.rst.txt
index 055c882..86e8b2a 100644
--- a/docs/_sources/python/generated/pyarrow.Time32Value.rst.txt
+++ b/docs/_sources/python/generated/pyarrow.Time32Value.rst.txt
@@ -13,6 +13,7 @@ pyarrow.Time32Value
.. autosummary::
+ ~Time32Value.__init__
~Time32Value.as_py
diff --git a/docs/_sources/python/generated/pyarrow.Time64Array.rst.txt b/docs/_sources/python/generated/pyarrow.Time64Array.rst.txt
index 4e89c3a..fbabf1a 100644
--- a/docs/_sources/python/generated/pyarrow.Time64Array.rst.txt
+++ b/docs/_sources/python/generated/pyarrow.Time64Array.rst.txt
@@ -13,6 +13,7 @@ pyarrow.Time64Array
.. autosummary::
+ ~Time64Array.__init__
~Time64Array.buffers
~Time64Array.cast
~Time64Array.dictionary_encode
@@ -22,6 +23,8 @@ pyarrow.Time64Array
~Time64Array.from_pandas
~Time64Array.isnull
~Time64Array.slice
+ ~Time64Array.sum
+ ~Time64Array.take
~Time64Array.to_numpy
~Time64Array.to_pandas
~Time64Array.to_pylist
diff --git a/docs/_sources/python/generated/pyarrow.Time64Type.rst.txt b/docs/_sources/python/generated/pyarrow.Time64Type.rst.txt
index 87a79ed..fce1822 100644
--- a/docs/_sources/python/generated/pyarrow.Time64Type.rst.txt
+++ b/docs/_sources/python/generated/pyarrow.Time64Type.rst.txt
@@ -13,6 +13,7 @@ pyarrow.Time64Type
.. autosummary::
+ ~Time64Type.__init__
~Time64Type.equals
~Time64Type.to_pandas_dtype
@@ -26,6 +27,8 @@ pyarrow.Time64Type
~Time64Type.bit_width
~Time64Type.id
+ ~Time64Type.num_buffers
+ ~Time64Type.num_children
~Time64Type.unit
\ No newline at end of file
diff --git a/docs/_sources/python/generated/pyarrow.Time64Value.rst.txt b/docs/_sources/python/generated/pyarrow.Time64Value.rst.txt
index e7e5215..784887c 100644
--- a/docs/_sources/python/generated/pyarrow.Time64Value.rst.txt
+++ b/docs/_sources/python/generated/pyarrow.Time64Value.rst.txt
@@ -13,6 +13,7 @@ pyarrow.Time64Value
.. autosummary::
+ ~Time64Value.__init__
~Time64Value.as_py
diff --git a/docs/_sources/python/generated/pyarrow.TimestampArray.rst.txt b/docs/_sources/python/generated/pyarrow.TimestampArray.rst.txt
index 35632bf..b1fa94e 100644
--- a/docs/_sources/python/generated/pyarrow.TimestampArray.rst.txt
+++ b/docs/_sources/python/generated/pyarrow.TimestampArray.rst.txt
@@ -13,6 +13,7 @@ pyarrow.TimestampArray
.. autosummary::
+ ~TimestampArray.__init__
~TimestampArray.buffers
~TimestampArray.cast
~TimestampArray.dictionary_encode
@@ -22,6 +23,8 @@ pyarrow.TimestampArray
~TimestampArray.from_pandas
~TimestampArray.isnull
~TimestampArray.slice
+ ~TimestampArray.sum
+ ~TimestampArray.take
~TimestampArray.to_numpy
~TimestampArray.to_pandas
~TimestampArray.to_pylist
diff --git a/docs/_sources/python/generated/pyarrow.TimestampType.rst.txt b/docs/_sources/python/generated/pyarrow.TimestampType.rst.txt
index d9f1ef4..88d13a3 100644
--- a/docs/_sources/python/generated/pyarrow.TimestampType.rst.txt
+++ b/docs/_sources/python/generated/pyarrow.TimestampType.rst.txt
@@ -13,6 +13,7 @@ pyarrow.TimestampType
.. autosummary::
+ ~TimestampType.__init__
~TimestampType.equals
~TimestampType.to_pandas_dtype
@@ -26,6 +27,8 @@ pyarrow.TimestampType
~TimestampType.bit_width
~TimestampType.id
+ ~TimestampType.num_buffers
+ ~TimestampType.num_children
~TimestampType.tz
~TimestampType.unit
diff --git a/docs/_sources/python/generated/pyarrow.TimestampValue.rst.txt b/docs/_sources/python/generated/pyarrow.TimestampValue.rst.txt
index 931ff39..91131ba 100644
--- a/docs/_sources/python/generated/pyarrow.TimestampValue.rst.txt
+++ b/docs/_sources/python/generated/pyarrow.TimestampValue.rst.txt
@@ -13,6 +13,7 @@ pyarrow.TimestampValue
.. autosummary::
+ ~TimestampValue.__init__
~TimestampValue.as_py
diff --git a/docs/_sources/python/generated/pyarrow.UInt16Array.rst.txt b/docs/_sources/python/generated/pyarrow.UInt16Array.rst.txt
index fdfcef6..d96da5f 100644
--- a/docs/_sources/python/generated/pyarrow.UInt16Array.rst.txt
+++ b/docs/_sources/python/generated/pyarrow.UInt16Array.rst.txt
@@ -13,6 +13,7 @@ pyarrow.UInt16Array
.. autosummary::
+ ~UInt16Array.__init__
~UInt16Array.buffers
~UInt16Array.cast
~UInt16Array.dictionary_encode
@@ -22,6 +23,8 @@ pyarrow.UInt16Array
~UInt16Array.from_pandas
~UInt16Array.isnull
~UInt16Array.slice
+ ~UInt16Array.sum
+ ~UInt16Array.take
~UInt16Array.to_numpy
~UInt16Array.to_pandas
~UInt16Array.to_pylist
diff --git a/docs/_sources/python/generated/pyarrow.UInt16Value.rst.txt b/docs/_sources/python/generated/pyarrow.UInt16Value.rst.txt
index c223373..a3af4ec 100644
--- a/docs/_sources/python/generated/pyarrow.UInt16Value.rst.txt
+++ b/docs/_sources/python/generated/pyarrow.UInt16Value.rst.txt
@@ -13,6 +13,7 @@ pyarrow.UInt16Value
.. autosummary::
+ ~UInt16Value.__init__
~UInt16Value.as_py
diff --git a/docs/_sources/python/generated/pyarrow.UInt32Array.rst.txt b/docs/_sources/python/generated/pyarrow.UInt32Array.rst.txt
index 6f1f017..72f0ba0 100644
--- a/docs/_sources/python/generated/pyarrow.UInt32Array.rst.txt
+++ b/docs/_sources/python/generated/pyarrow.UInt32Array.rst.txt
@@ -13,6 +13,7 @@ pyarrow.UInt32Array
.. autosummary::
+ ~UInt32Array.__init__
~UInt32Array.buffers
~UInt32Array.cast
~UInt32Array.dictionary_encode
@@ -22,6 +23,8 @@ pyarrow.UInt32Array
~UInt32Array.from_pandas
~UInt32Array.isnull
~UInt32Array.slice
+ ~UInt32Array.sum
+ ~UInt32Array.take
~UInt32Array.to_numpy
~UInt32Array.to_pandas
~UInt32Array.to_pylist
diff --git a/docs/_sources/python/generated/pyarrow.UInt32Value.rst.txt b/docs/_sources/python/generated/pyarrow.UInt32Value.rst.txt
index 46ae92a..30baa33 100644
--- a/docs/_sources/python/generated/pyarrow.UInt32Value.rst.txt
+++ b/docs/_sources/python/generated/pyarrow.UInt32Value.rst.txt
@@ -13,6 +13,7 @@ pyarrow.UInt32Value
.. autosummary::
+ ~UInt32Value.__init__
~UInt32Value.as_py
diff --git a/docs/_sources/python/generated/pyarrow.UInt64Array.rst.txt b/docs/_sources/python/generated/pyarrow.UInt64Array.rst.txt
index 14f911d..006c7e8 100644
--- a/docs/_sources/python/generated/pyarrow.UInt64Array.rst.txt
+++ b/docs/_sources/python/generated/pyarrow.UInt64Array.rst.txt
@@ -13,6 +13,7 @@ pyarrow.UInt64Array
.. autosummary::
+ ~UInt64Array.__init__
~UInt64Array.buffers
~UInt64Array.cast
~UInt64Array.dictionary_encode
@@ -22,6 +23,8 @@ pyarrow.UInt64Array
~UInt64Array.from_pandas
~UInt64Array.isnull
~UInt64Array.slice
+ ~UInt64Array.sum
+ ~UInt64Array.take
~UInt64Array.to_numpy
~UInt64Array.to_pandas
~UInt64Array.to_pylist
diff --git a/docs/_sources/python/generated/pyarrow.UInt64Value.rst.txt b/docs/_sources/python/generated/pyarrow.UInt64Value.rst.txt
index f8d313b..6e782da 100644
--- a/docs/_sources/python/generated/pyarrow.UInt64Value.rst.txt
+++ b/docs/_sources/python/generated/pyarrow.UInt64Value.rst.txt
@@ -13,6 +13,7 @@ pyarrow.UInt64Value
.. autosummary::
+ ~UInt64Value.__init__
~UInt64Value.as_py
diff --git a/docs/_sources/python/generated/pyarrow.UInt8Array.rst.txt b/docs/_sources/python/generated/pyarrow.UInt8Array.rst.txt
index aec9b77..8e94ef6 100644
--- a/docs/_sources/python/generated/pyarrow.UInt8Array.rst.txt
+++ b/docs/_sources/python/generated/pyarrow.UInt8Array.rst.txt
@@ -13,6 +13,7 @@ pyarrow.UInt8Array
.. autosummary::
+ ~UInt8Array.__init__
~UInt8Array.buffers
~UInt8Array.cast
~UInt8Array.dictionary_encode
@@ -22,6 +23,8 @@ pyarrow.UInt8Array
~UInt8Array.from_pandas
~UInt8Array.isnull
~UInt8Array.slice
+ ~UInt8Array.sum
+ ~UInt8Array.take
~UInt8Array.to_numpy
~UInt8Array.to_pandas
~UInt8Array.to_pylist
diff --git a/docs/_sources/python/generated/pyarrow.UInt8Value.rst.txt b/docs/_sources/python/generated/pyarrow.UInt8Value.rst.txt
index 3d06365..ad8b351 100644
--- a/docs/_sources/python/generated/pyarrow.UInt8Value.rst.txt
+++ b/docs/_sources/python/generated/pyarrow.UInt8Value.rst.txt
@@ -13,6 +13,7 @@ pyarrow.UInt8Value
.. autosummary::
+ ~UInt8Value.__init__
~UInt8Value.as_py
diff --git a/docs/_sources/python/generated/pyarrow.UnionArray.rst.txt b/docs/_sources/python/generated/pyarrow.UnionArray.rst.txt
index 265ca4c..1860ec7 100644
--- a/docs/_sources/python/generated/pyarrow.UnionArray.rst.txt
+++ b/docs/_sources/python/generated/pyarrow.UnionArray.rst.txt
@@ -13,6 +13,7 @@ pyarrow.UnionArray
.. autosummary::
+ ~UnionArray.__init__
~UnionArray.buffers
~UnionArray.cast
~UnionArray.dictionary_encode
@@ -24,6 +25,8 @@ pyarrow.UnionArray
~UnionArray.from_sparse
~UnionArray.isnull
~UnionArray.slice
+ ~UnionArray.sum
+ ~UnionArray.take
~UnionArray.to_numpy
~UnionArray.to_pandas
~UnionArray.to_pylist
diff --git a/docs/_sources/python/generated/pyarrow.UnionType.rst.txt b/docs/_sources/python/generated/pyarrow.UnionType.rst.txt
index 278627f..363d426 100644
--- a/docs/_sources/python/generated/pyarrow.UnionType.rst.txt
+++ b/docs/_sources/python/generated/pyarrow.UnionType.rst.txt
@@ -13,6 +13,7 @@ pyarrow.UnionType
.. autosummary::
+ ~UnionType.__init__
~UnionType.equals
~UnionType.to_pandas_dtype
@@ -27,6 +28,7 @@ pyarrow.UnionType
~UnionType.bit_width
~UnionType.id
~UnionType.mode
+ ~UnionType.num_buffers
~UnionType.num_children
~UnionType.type_codes
diff --git a/docs/_sources/python/generated/pyarrow.UnionValue.rst.txt b/docs/_sources/python/generated/pyarrow.UnionValue.rst.txt
index 6f1f088..b57abfb 100644
--- a/docs/_sources/python/generated/pyarrow.UnionValue.rst.txt
+++ b/docs/_sources/python/generated/pyarrow.UnionValue.rst.txt
@@ -13,6 +13,7 @@ pyarrow.UnionValue
.. autosummary::
+ ~UnionValue.__init__
~UnionValue.as_py
diff --git a/docs/_sources/python/generated/pyarrow.csv.ConvertOptions.rst.txt b/docs/_sources/python/generated/pyarrow.csv.ConvertOptions.rst.txt
index 77f6c25..2cac9e9 100644
--- a/docs/_sources/python/generated/pyarrow.csv.ConvertOptions.rst.txt
+++ b/docs/_sources/python/generated/pyarrow.csv.ConvertOptions.rst.txt
@@ -9,6 +9,12 @@ pyarrow.csv.ConvertOptions
.. automethod:: __init__
+ .. rubric:: Methods
+
+ .. autosummary::
+
+ ~ConvertOptions.__init__
+
@@ -19,6 +25,9 @@ pyarrow.csv.ConvertOptions
~ConvertOptions.check_utf8
~ConvertOptions.column_types
+ ~ConvertOptions.false_values
~ConvertOptions.null_values
+ ~ConvertOptions.strings_can_be_null
+ ~ConvertOptions.true_values
\ No newline at end of file
diff --git a/docs/_sources/python/generated/pyarrow.csv.ParseOptions.rst.txt b/docs/_sources/python/generated/pyarrow.csv.ParseOptions.rst.txt
index d1de415..4ddfa06 100644
--- a/docs/_sources/python/generated/pyarrow.csv.ParseOptions.rst.txt
+++ b/docs/_sources/python/generated/pyarrow.csv.ParseOptions.rst.txt
@@ -9,6 +9,12 @@ pyarrow.csv.ParseOptions
.. automethod:: __init__
+ .. rubric:: Methods
+
+ .. autosummary::
+
+ ~ParseOptions.__init__
+
diff --git a/docs/_sources/python/generated/pyarrow.csv.ReadOptions.rst.txt b/docs/_sources/python/generated/pyarrow.csv.ReadOptions.rst.txt
index 2aae594..abbc803 100644
--- a/docs/_sources/python/generated/pyarrow.csv.ReadOptions.rst.txt
+++ b/docs/_sources/python/generated/pyarrow.csv.ReadOptions.rst.txt
@@ -9,6 +9,12 @@ pyarrow.csv.ReadOptions
.. automethod:: __init__
+ .. rubric:: Methods
+
+ .. autosummary::
+
+ ~ReadOptions.__init__
+
diff --git a/docs/_sources/python/generated/pyarrow.cuda.BufferReader.rst.txt b/docs/_sources/python/generated/pyarrow.cuda.BufferReader.rst.txt
index a56d68d..b30f71c 100644
--- a/docs/_sources/python/generated/pyarrow.cuda.BufferReader.rst.txt
+++ b/docs/_sources/python/generated/pyarrow.cuda.BufferReader.rst.txt
@@ -13,6 +13,7 @@ pyarrow.cuda.BufferReader
.. autosummary::
+ ~BufferReader.__init__
~BufferReader.close
~BufferReader.download
~BufferReader.fileno
@@ -20,6 +21,7 @@ pyarrow.cuda.BufferReader
~BufferReader.isatty
~BufferReader.read
~BufferReader.read1
+ ~BufferReader.read_at
~BufferReader.read_buffer
~BufferReader.readable
~BufferReader.readall
diff --git a/docs/_sources/python/generated/pyarrow.cuda.BufferWriter.rst.txt b/docs/_sources/python/generated/pyarrow.cuda.BufferWriter.rst.txt
index a2def63..de7e2bb 100644
--- a/docs/_sources/python/generated/pyarrow.cuda.BufferWriter.rst.txt
+++ b/docs/_sources/python/generated/pyarrow.cuda.BufferWriter.rst.txt
@@ -13,6 +13,7 @@ pyarrow.cuda.BufferWriter
.. autosummary::
+ ~BufferWriter.__init__
~BufferWriter.close
~BufferWriter.download
~BufferWriter.fileno
@@ -20,6 +21,7 @@ pyarrow.cuda.BufferWriter
~BufferWriter.isatty
~BufferWriter.read
~BufferWriter.read1
+ ~BufferWriter.read_at
~BufferWriter.read_buffer
~BufferWriter.readable
~BufferWriter.readall
diff --git a/docs/_sources/python/generated/pyarrow.cuda.Context.rst.txt b/docs/_sources/python/generated/pyarrow.cuda.Context.rst.txt
index 768070e..800bf3a 100644
--- a/docs/_sources/python/generated/pyarrow.cuda.Context.rst.txt
+++ b/docs/_sources/python/generated/pyarrow.cuda.Context.rst.txt
@@ -13,6 +13,7 @@ pyarrow.cuda.Context
.. autosummary::
+ ~Context.__init__
~Context.buffer_from_data
~Context.buffer_from_object
~Context.foreign_buffer
diff --git a/docs/_sources/python/generated/pyarrow.cuda.CudaBuffer.rst.txt b/docs/_sources/python/generated/pyarrow.cuda.CudaBuffer.rst.txt
index 4b325fa..8924e28 100644
--- a/docs/_sources/python/generated/pyarrow.cuda.CudaBuffer.rst.txt
+++ b/docs/_sources/python/generated/pyarrow.cuda.CudaBuffer.rst.txt
@@ -13,6 +13,7 @@ pyarrow.cuda.CudaBuffer
.. autosummary::
+ ~CudaBuffer.__init__
~CudaBuffer.copy_from_device
~CudaBuffer.copy_from_host
~CudaBuffer.copy_to_host
@@ -20,6 +21,7 @@ pyarrow.cuda.CudaBuffer
~CudaBuffer.export_for_ipc
~CudaBuffer.from_buffer
~CudaBuffer.from_numba
+ ~CudaBuffer.hex
~CudaBuffer.slice
~CudaBuffer.to_numba
~CudaBuffer.to_pybytes
diff --git a/docs/_sources/python/generated/pyarrow.cuda.HostBuffer.rst.txt b/docs/_sources/python/generated/pyarrow.cuda.HostBuffer.rst.txt
index 1239c0f..1fd32d9 100644
--- a/docs/_sources/python/generated/pyarrow.cuda.HostBuffer.rst.txt
+++ b/docs/_sources/python/generated/pyarrow.cuda.HostBuffer.rst.txt
@@ -13,7 +13,9 @@ pyarrow.cuda.HostBuffer
.. autosummary::
+ ~HostBuffer.__init__
~HostBuffer.equals
+ ~HostBuffer.hex
~HostBuffer.slice
~HostBuffer.to_pybytes
diff --git a/docs/_sources/python/generated/pyarrow.cuda.IpcMemHandle.rst.txt b/docs/_sources/python/generated/pyarrow.cuda.IpcMemHandle.rst.txt
index 74f0515..9754d1a 100644
--- a/docs/_sources/python/generated/pyarrow.cuda.IpcMemHandle.rst.txt
+++ b/docs/_sources/python/generated/pyarrow.cuda.IpcMemHandle.rst.txt
@@ -13,6 +13,7 @@ pyarrow.cuda.IpcMemHandle
.. autosummary::
+ ~IpcMemHandle.__init__
~IpcMemHandle.from_buffer
~IpcMemHandle.serialize
diff --git a/docs/_sources/python/generated/pyarrow.flight.Action.rst.txt b/docs/_sources/python/generated/pyarrow.flight.Action.rst.txt
new file mode 100644
index 0000000..18cda09
--- /dev/null
+++ b/docs/_sources/python/generated/pyarrow.flight.Action.rst.txt
@@ -0,0 +1,29 @@
+pyarrow.flight.Action
+=====================
+
+.. currentmodule:: pyarrow.flight
+
+.. autoclass:: Action
+
+
+ .. automethod:: __init__
+
+
+ .. rubric:: Methods
+
+ .. autosummary::
+
+ ~Action.__init__
+
+
+
+
+
+ .. rubric:: Attributes
+
+ .. autosummary::
+
+ ~Action.body
+ ~Action.type
+
+
\ No newline at end of file
diff --git a/docs/_sources/python/generated/pyarrow.flight.ActionType.rst.txt b/docs/_sources/python/generated/pyarrow.flight.ActionType.rst.txt
new file mode 100644
index 0000000..89b56a5
--- /dev/null
+++ b/docs/_sources/python/generated/pyarrow.flight.ActionType.rst.txt
@@ -0,0 +1,32 @@
+pyarrow.flight.ActionType
+=========================
+
+.. currentmodule:: pyarrow.flight
+
+.. autoclass:: ActionType
+
+
+ .. automethod:: __init__
+
+
+ .. rubric:: Methods
+
+ .. autosummary::
+
+ ~ActionType.__init__
+ ~ActionType.count
+ ~ActionType.index
+
+
+
+
+
+ .. rubric:: Attributes
+
+ .. autosummary::
+
+ ~ActionType.description
+ ~ActionType.make_action
+ ~ActionType.type
+
+
\ No newline at end of file
diff --git a/docs/_sources/python/generated/pyarrow.flight.ClientAuthHandler.rst.txt b/docs/_sources/python/generated/pyarrow.flight.ClientAuthHandler.rst.txt
new file mode 100644
index 0000000..81bb600
--- /dev/null
+++ b/docs/_sources/python/generated/pyarrow.flight.ClientAuthHandler.rst.txt
@@ -0,0 +1,24 @@
+pyarrow.flight.ClientAuthHandler
+================================
+
+.. currentmodule:: pyarrow.flight
+
+.. autoclass:: ClientAuthHandler
+
+
+ .. automethod:: __init__
+
+
+ .. rubric:: Methods
+
+ .. autosummary::
+
+ ~ClientAuthHandler.__init__
+ ~ClientAuthHandler.authenticate
+ ~ClientAuthHandler.get_token
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/_sources/python/generated/pyarrow.flight.DescriptorType.rst.txt b/docs/_sources/python/generated/pyarrow.flight.DescriptorType.rst.txt
new file mode 100644
index 0000000..8b745bf
--- /dev/null
+++ b/docs/_sources/python/generated/pyarrow.flight.DescriptorType.rst.txt
@@ -0,0 +1,24 @@
+pyarrow.flight.DescriptorType
+=============================
+
+.. currentmodule:: pyarrow.flight
+
+.. autoclass:: DescriptorType
+
+
+ .. automethod:: __init__
+
+
+
+
+
+
+ .. rubric:: Attributes
+
+ .. autosummary::
+
+ ~DescriptorType.CMD
+ ~DescriptorType.PATH
+ ~DescriptorType.UNKNOWN
+
+
\ No newline at end of file
diff --git a/docs/_sources/python/generated/pyarrow.flight.FlightCallOptions.rst.txt b/docs/_sources/python/generated/pyarrow.flight.FlightCallOptions.rst.txt
new file mode 100644
index 0000000..8ee0c8c
--- /dev/null
+++ b/docs/_sources/python/generated/pyarrow.flight.FlightCallOptions.rst.txt
@@ -0,0 +1,22 @@
+pyarrow.flight.FlightCallOptions
+================================
+
+.. currentmodule:: pyarrow.flight
+
+.. autoclass:: FlightCallOptions
+
+
+ .. automethod:: __init__
+
+
+ .. rubric:: Methods
+
+ .. autosummary::
+
+ ~FlightCallOptions.__init__
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/_sources/python/generated/pyarrow.flight.FlightClient.rst.txt b/docs/_sources/python/generated/pyarrow.flight.FlightClient.rst.txt
new file mode 100644
index 0000000..c00a255
--- /dev/null
+++ b/docs/_sources/python/generated/pyarrow.flight.FlightClient.rst.txt
@@ -0,0 +1,30 @@
+pyarrow.flight.FlightClient
+===========================
+
+.. currentmodule:: pyarrow.flight
+
+.. autoclass:: FlightClient
+
+
+ .. automethod:: __init__
+
+
+ .. rubric:: Methods
+
+ .. autosummary::
+
+ ~FlightClient.__init__
+ ~FlightClient.authenticate
+ ~FlightClient.connect
+ ~FlightClient.do_action
+ ~FlightClient.do_get
+ ~FlightClient.do_put
+ ~FlightClient.get_flight_info
+ ~FlightClient.list_actions
+ ~FlightClient.list_flights
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/_sources/python/generated/pyarrow.flight.FlightDescriptor.rst.txt b/docs/_sources/python/generated/pyarrow.flight.FlightDescriptor.rst.txt
new file mode 100644
index 0000000..080b12d
--- /dev/null
+++ b/docs/_sources/python/generated/pyarrow.flight.FlightDescriptor.rst.txt
@@ -0,0 +1,32 @@
+pyarrow.flight.FlightDescriptor
+===============================
+
+.. currentmodule:: pyarrow.flight
+
+.. autoclass:: FlightDescriptor
+
+
+ .. automethod:: __init__
+
+
+ .. rubric:: Methods
+
+ .. autosummary::
+
+ ~FlightDescriptor.__init__
+ ~FlightDescriptor.for_command
+ ~FlightDescriptor.for_path
+
+
+
+
+
+ .. rubric:: Attributes
+
+ .. autosummary::
+
+ ~FlightDescriptor.command
+ ~FlightDescriptor.descriptor_type
+ ~FlightDescriptor.path
+
+
\ No newline at end of file
diff --git a/docs/_sources/python/generated/pyarrow.flight.FlightEndpoint.rst.txt b/docs/_sources/python/generated/pyarrow.flight.FlightEndpoint.rst.txt
new file mode 100644
index 0000000..529818a
--- /dev/null
+++ b/docs/_sources/python/generated/pyarrow.flight.FlightEndpoint.rst.txt
@@ -0,0 +1,29 @@
+pyarrow.flight.FlightEndpoint
+=============================
+
+.. currentmodule:: pyarrow.flight
+
+.. autoclass:: FlightEndpoint
+
+
+ .. automethod:: __init__
+
+
+ .. rubric:: Methods
+
+ .. autosummary::
+
+ ~FlightEndpoint.__init__
+
+
+
+
+
+ .. rubric:: Attributes
+
+ .. autosummary::
+
+ ~FlightEndpoint.locations
+ ~FlightEndpoint.ticket
+
+
\ No newline at end of file
diff --git a/docs/_sources/python/generated/pyarrow.flight.FlightInfo.rst.txt b/docs/_sources/python/generated/pyarrow.flight.FlightInfo.rst.txt
new file mode 100644
index 0000000..3d601c9
--- /dev/null
+++ b/docs/_sources/python/generated/pyarrow.flight.FlightInfo.rst.txt
@@ -0,0 +1,32 @@
+pyarrow.flight.FlightInfo
+=========================
+
+.. currentmodule:: pyarrow.flight
+
+.. autoclass:: FlightInfo
+
+
+ .. automethod:: __init__
+
+
+ .. rubric:: Methods
+
+ .. autosummary::
+
+ ~FlightInfo.__init__
+
+
+
+
+
+ .. rubric:: Attributes
+
+ .. autosummary::
+
+ ~FlightInfo.descriptor
+ ~FlightInfo.endpoints
+ ~FlightInfo.schema
+ ~FlightInfo.total_bytes
+ ~FlightInfo.total_records
+
+
\ No newline at end of file
diff --git a/docs/_sources/python/generated/pyarrow.flight.FlightServerBase.rst.txt b/docs/_sources/python/generated/pyarrow.flight.FlightServerBase.rst.txt
new file mode 100644
index 0000000..9e84006
--- /dev/null
+++ b/docs/_sources/python/generated/pyarrow.flight.FlightServerBase.rst.txt
@@ -0,0 +1,30 @@
+pyarrow.flight.FlightServerBase
+===============================
+
+.. currentmodule:: pyarrow.flight
+
+.. autoclass:: FlightServerBase
+
+
+ .. automethod:: __init__
+
+
+ .. rubric:: Methods
+
+ .. autosummary::
+
+ ~FlightServerBase.__init__
+ ~FlightServerBase.do_action
+ ~FlightServerBase.do_get
+ ~FlightServerBase.do_put
+ ~FlightServerBase.get_flight_info
+ ~FlightServerBase.list_actions
+ ~FlightServerBase.list_flights
+ ~FlightServerBase.run
+ ~FlightServerBase.shutdown
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/_sources/python/generated/pyarrow.flight.GeneratorStream.rst.txt b/docs/_sources/python/generated/pyarrow.flight.GeneratorStream.rst.txt
new file mode 100644
index 0000000..2355c12
--- /dev/null
+++ b/docs/_sources/python/generated/pyarrow.flight.GeneratorStream.rst.txt
@@ -0,0 +1,22 @@
+pyarrow.flight.GeneratorStream
+==============================
+
+.. currentmodule:: pyarrow.flight
+
+.. autoclass:: GeneratorStream
+
+
+ .. automethod:: __init__
+
+
+ .. rubric:: Methods
+
+ .. autosummary::
+
+ ~GeneratorStream.__init__
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/_sources/python/generated/pyarrow.flight.Location.rst.txt b/docs/_sources/python/generated/pyarrow.flight.Location.rst.txt
new file mode 100644
index 0000000..0afb8ae
--- /dev/null
+++ b/docs/_sources/python/generated/pyarrow.flight.Location.rst.txt
@@ -0,0 +1,32 @@
+pyarrow.flight.Location
+=======================
+
+.. currentmodule:: pyarrow.flight
+
+.. autoclass:: Location
+
+
+ .. automethod:: __init__
+
+
+ .. rubric:: Methods
+
+ .. autosummary::
+
+ ~Location.__init__
+ ~Location.equals
+ ~Location.for_grpc_tcp
+ ~Location.for_grpc_tls
+ ~Location.for_grpc_unix
+
+
+
+
+
+ .. rubric:: Attributes
+
+ .. autosummary::
+
+ ~Location.uri
+
+
\ No newline at end of file
diff --git a/docs/_sources/python/generated/pyarrow.flight.RecordBatchStream.rst.txt b/docs/_sources/python/generated/pyarrow.flight.RecordBatchStream.rst.txt
new file mode 100644
index 0000000..8ef6c59
--- /dev/null
+++ b/docs/_sources/python/generated/pyarrow.flight.RecordBatchStream.rst.txt
@@ -0,0 +1,22 @@
+pyarrow.flight.RecordBatchStream
+================================
+
+.. currentmodule:: pyarrow.flight
+
+.. autoclass:: RecordBatchStream
+
+
+ .. automethod:: __init__
+
+
+ .. rubric:: Methods
+
+ .. autosummary::
+
+ ~RecordBatchStream.__init__
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/_sources/python/generated/pyarrow.Int16Value.rst.txt b/docs/_sources/python/generated/pyarrow.flight.Result.rst.txt
similarity index 52%
copy from docs/_sources/python/generated/pyarrow.Int16Value.rst.txt
copy to docs/_sources/python/generated/pyarrow.flight.Result.rst.txt
index 5284621..0d82625 100644
--- a/docs/_sources/python/generated/pyarrow.Int16Value.rst.txt
+++ b/docs/_sources/python/generated/pyarrow.flight.Result.rst.txt
@@ -1,9 +1,9 @@
-pyarrow.Int16Value
-==================
+pyarrow.flight.Result
+=====================
-.. currentmodule:: pyarrow
+.. currentmodule:: pyarrow.flight
-.. autoclass:: Int16Value
+.. autoclass:: Result
.. automethod:: __init__
@@ -13,7 +13,7 @@ pyarrow.Int16Value
.. autosummary::
- ~Int16Value.as_py
+ ~Result.__init__
@@ -23,6 +23,6 @@ pyarrow.Int16Value
.. autosummary::
- ~Int16Value.type
+ ~Result.body
\ No newline at end of file
diff --git a/docs/_sources/python/generated/pyarrow.flight.ServerAuthHandler.rst.txt b/docs/_sources/python/generated/pyarrow.flight.ServerAuthHandler.rst.txt
new file mode 100644
index 0000000..219d12f
--- /dev/null
+++ b/docs/_sources/python/generated/pyarrow.flight.ServerAuthHandler.rst.txt
@@ -0,0 +1,24 @@
+pyarrow.flight.ServerAuthHandler
+================================
+
+.. currentmodule:: pyarrow.flight
+
+.. autoclass:: ServerAuthHandler
+
+
+ .. automethod:: __init__
+
+
+ .. rubric:: Methods
+
+ .. autosummary::
+
+ ~ServerAuthHandler.__init__
+ ~ServerAuthHandler.authenticate
+ ~ServerAuthHandler.is_valid
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/_sources/python/generated/pyarrow.Date32Value.rst.txt b/docs/_sources/python/generated/pyarrow.flight.Ticket.rst.txt
similarity index 52%
copy from docs/_sources/python/generated/pyarrow.Date32Value.rst.txt
copy to docs/_sources/python/generated/pyarrow.flight.Ticket.rst.txt
index 6b976f7..a54aca6 100644
--- a/docs/_sources/python/generated/pyarrow.Date32Value.rst.txt
+++ b/docs/_sources/python/generated/pyarrow.flight.Ticket.rst.txt
@@ -1,9 +1,9 @@
-pyarrow.Date32Value
-===================
+pyarrow.flight.Ticket
+=====================
-.. currentmodule:: pyarrow
+.. currentmodule:: pyarrow.flight
-.. autoclass:: Date32Value
+.. autoclass:: Ticket
.. automethod:: __init__
@@ -13,7 +13,7 @@ pyarrow.Date32Value
.. autosummary::
- ~Date32Value.as_py
+ ~Ticket.__init__
@@ -23,6 +23,6 @@ pyarrow.Date32Value
.. autosummary::
- ~Date32Value.type
+ ~Ticket.ticket
\ No newline at end of file
diff --git a/docs/_sources/python/generated/pyarrow.json.ParseOptions.rst.txt b/docs/_sources/python/generated/pyarrow.json.ParseOptions.rst.txt
new file mode 100644
index 0000000..5390153
--- /dev/null
+++ b/docs/_sources/python/generated/pyarrow.json.ParseOptions.rst.txt
@@ -0,0 +1,29 @@
+pyarrow.json.ParseOptions
+=========================
+
+.. currentmodule:: pyarrow.json
+
+.. autoclass:: ParseOptions
+
+
+ .. automethod:: __init__
+
+
+ .. rubric:: Methods
+
+ .. autosummary::
+
+ ~ParseOptions.__init__
+
+
+
+
+
+ .. rubric:: Attributes
+
+ .. autosummary::
+
+ ~ParseOptions.explicit_schema
+ ~ParseOptions.newlines_in_values
+
+
\ No newline at end of file
diff --git a/docs/_sources/python/generated/pyarrow.csv.ReadOptions.rst.txt b/docs/_sources/python/generated/pyarrow.json.ReadOptions.rst.txt
similarity index 54%
copy from docs/_sources/python/generated/pyarrow.csv.ReadOptions.rst.txt
copy to docs/_sources/python/generated/pyarrow.json.ReadOptions.rst.txt
index 2aae594..9391981 100644
--- a/docs/_sources/python/generated/pyarrow.csv.ReadOptions.rst.txt
+++ b/docs/_sources/python/generated/pyarrow.json.ReadOptions.rst.txt
@@ -1,7 +1,7 @@
-pyarrow.csv.ReadOptions
-=======================
+pyarrow.json.ReadOptions
+========================
-.. currentmodule:: pyarrow.csv
+.. currentmodule:: pyarrow.json
.. autoclass:: ReadOptions
@@ -9,6 +9,12 @@ pyarrow.csv.ReadOptions
.. automethod:: __init__
+ .. rubric:: Methods
+
+ .. autosummary::
+
+ ~ReadOptions.__init__
+
diff --git a/docs/_sources/python/generated/pyarrow.json.read_json.rst.txt b/docs/_sources/python/generated/pyarrow.json.read_json.rst.txt
new file mode 100644
index 0000000..acae916
--- /dev/null
+++ b/docs/_sources/python/generated/pyarrow.json.read_json.rst.txt
@@ -0,0 +1,6 @@
+pyarrow.json.read\_json
+=======================
+
+.. currentmodule:: pyarrow.json
+
+.. autofunction:: read_json
\ No newline at end of file
diff --git a/docs/_sources/python/generated/pyarrow.parquet.ParquetDataset.rst.txt b/docs/_sources/python/generated/pyarrow.parquet.ParquetDataset.rst.txt
index 3aae660..8733c6e 100644
--- a/docs/_sources/python/generated/pyarrow.parquet.ParquetDataset.rst.txt
+++ b/docs/_sources/python/generated/pyarrow.parquet.ParquetDataset.rst.txt
@@ -14,6 +14,7 @@ pyarrow.parquet.ParquetDataset
.. autosummary::
~ParquetDataset.__init__
+ ~ParquetDataset.equals
~ParquetDataset.read
~ParquetDataset.read_pandas
~ParquetDataset.validate_schemas
diff --git a/docs/_sources/python/generated/pyarrow.plasma.ObjectID.rst.txt b/docs/_sources/python/generated/pyarrow.plasma.ObjectID.rst.txt
index 3bbaa6f..615f5eb 100644
--- a/docs/_sources/python/generated/pyarrow.plasma.ObjectID.rst.txt
+++ b/docs/_sources/python/generated/pyarrow.plasma.ObjectID.rst.txt
@@ -13,6 +13,7 @@ pyarrow.plasma.ObjectID
.. autosummary::
+ ~ObjectID.__init__
~ObjectID.binary
~ObjectID.from_random
diff --git a/docs/_sources/python/generated/pyarrow.plasma.PlasmaBuffer.rst.txt b/docs/_sources/python/generated/pyarrow.plasma.PlasmaBuffer.rst.txt
index bbcde11..ba74d27 100644
--- a/docs/_sources/python/generated/pyarrow.plasma.PlasmaBuffer.rst.txt
+++ b/docs/_sources/python/generated/pyarrow.plasma.PlasmaBuffer.rst.txt
@@ -13,7 +13,9 @@ pyarrow.plasma.PlasmaBuffer
.. autosummary::
+ ~PlasmaBuffer.__init__
~PlasmaBuffer.equals
+ ~PlasmaBuffer.hex
~PlasmaBuffer.slice
~PlasmaBuffer.to_pybytes
diff --git a/docs/_sources/python/generated/pyarrow.plasma.PlasmaClient.rst.txt b/docs/_sources/python/generated/pyarrow.plasma.PlasmaClient.rst.txt
index 52f3dd7..bc98e81 100644
--- a/docs/_sources/python/generated/pyarrow.plasma.PlasmaClient.rst.txt
+++ b/docs/_sources/python/generated/pyarrow.plasma.PlasmaClient.rst.txt
@@ -13,6 +13,7 @@ pyarrow.plasma.PlasmaClient
.. autosummary::
+ ~PlasmaClient.__init__
~PlasmaClient.contains
~PlasmaClient.create
~PlasmaClient.create_and_seal
diff --git a/docs/_sources/python/generated/pyarrow.table.rst.txt b/docs/_sources/python/generated/pyarrow.table.rst.txt
new file mode 100644
index 0000000..fd958a4
--- /dev/null
+++ b/docs/_sources/python/generated/pyarrow.table.rst.txt
@@ -0,0 +1,6 @@
+pyarrow.table
+=============
+
+.. currentmodule:: pyarrow
+
+.. autofunction:: table
\ No newline at end of file
diff --git a/docs/_sources/python/index.rst.txt b/docs/_sources/python/index.rst.txt
index 7f227c5..09367f4 100644
--- a/docs/_sources/python/index.rst.txt
+++ b/docs/_sources/python/index.rst.txt
@@ -43,6 +43,7 @@ files into Arrow structures.
pandas
timestamps
csv
+ json
parquet
cuda
extending
diff --git a/docs/_sources/python/json.rst.txt b/docs/_sources/python/json.rst.txt
new file mode 100644
index 0000000..e4abbff
--- /dev/null
+++ b/docs/_sources/python/json.rst.txt
@@ -0,0 +1,114 @@
+.. 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.
+
+.. currentmodule:: pyarrow.json
+.. _json:
+
+Reading JSON files
+==================
+
+Arrow supports reading columnar data from JSON files. In this context, a
+JSON file consists of multiple JSON objects, one per line, representing
+individual data rows. For example, this file represents two rows of data
+with four columns "a", "b", "c", "d":
+
+.. code-block:: json
+
+ {"a": 1, "b": 2.0, "c": "foo", "d": false}
+ {"a": 4, "b": -5.5, "c": null, "d": true}
+
+The features currently offered are the following:
+
+* multi-threaded or single-threaded reading
+* automatic decompression of input files (based on the filename extension,
+ such as ``my_data.json.gz``)
+* sophisticated type inference (see below)
+
+
+Usage
+-----
+
+JSON reading functionality is available through the :mod:`pyarrow.json` module.
+In many cases, you will simply call the :func:`read_json` function
+with the file path you want to read from::
+
+ >>> from pyarrow import json
+ >>> fn = 'my_data.json'
+ >>> table = json.read_json(fn)
+ >>> table
+ pyarrow.Table
+ a: int64
+ b: double
+ c: string
+ d: bool
+ >>> table.to_pandas()
+ a b c d
+ 0 1 2.0 foo False
+ 1 4 -5.5 None True
+
+
+Automatic Type Inference
+------------------------
+
+Arrow :ref:`data types <data.types>` are inferred from the JSON types and
+values of each column:
+
+* JSON null values convert to the ``null`` type, but can fall back to any
+ other type.
+* JSON booleans convert to ``bool_``.
+* JSON numbers convert to ``int64``, falling back to ``float64`` if a
+ non-integer is encountered.
+* JSON strings of the kind "YYYY-MM-DD" and "YYYY-MM-DD hh:mm:ss" convert
+ to ``timestamp[s]``, falling back to ``utf8`` if a conversion error occurs.
+* JSON arrays convert to a ``list`` type, and inference proceeds recursively
+ on the JSON arrays' values.
+* Nested JSON objects convert to a ``struct`` type, and inference proceeds
+ recursively on the JSON objects' values.
+
+Thus, reading this JSON file:
+
+.. code-block:: json
+
+ {"a": [1, 2], "b": {"c": true, "d": "1991-02-03"}}
+ {"a": [3, 4, 5], "b": {"c": false, "d": "2019-04-01"}}
+
+returns the following data::
+
+ >>> table = json.read_json("my_data.json")
+ >>> table
+ pyarrow.Table
+ a: list<item: int64>
+ child 0, item: int64
+ b: struct<c: bool, d: timestamp[s]>
+ child 0, c: bool
+ child 1, d: timestamp[s]
+ >>> table.to_pandas()
+ a b
+ 0 [1, 2] {'c': True, 'd': 1991-02-03 00:00:00}
+ 1 [3, 4, 5] {'c': False, 'd': 2019-04-01 00:00:00}
+
+
+Customized parsing
+------------------
+
+To alter the default parsing settings in case of reading JSON files with an
+unusual structure, you should create a :class:`ParseOptions` instance
+and pass it to :func:`read_json`. For example, you can pass an explicit
+:ref:`schema <data.schema>` in order to bypass automatic type inference.
+
+Similarly, you can choose performance settings by passing a
+:class:`ReadOptions` instance to :func:`read_json`.
diff --git a/docs/_sources/python/pandas.rst.txt b/docs/_sources/python/pandas.rst.txt
index dbc5e77..83d997c 100644
--- a/docs/_sources/python/pandas.rst.txt
+++ b/docs/_sources/python/pandas.rst.txt
@@ -62,6 +62,10 @@ Conversion from a Table to a DataFrame is done by calling
# Infer Arrow schema from pandas
schema = pa.Schema.from_pandas(df)
+By default ``pyarrow`` tries to preserve and restore the ``.index``
+data as accurately as possible. See the section below for more about
+this, and how to disable this logic.
+
Series
------
@@ -71,6 +75,29 @@ convert a pandas Series to an Arrow Array using :meth:`pyarrow.Array.from_pandas
As Arrow Arrays are always nullable, you can supply an optional mask using
the ``mask`` parameter to mark all null-entries.
+Handling pandas Indexes
+-----------------------
+
+Methods like :meth:`pyarrow.Table.from_pandas` have a
+``preserve_index`` option which defines how to preserve (store) or not
+to preserve (to not store) the data in the ``index`` member of the
+corresponding pandas object. This data is tracked using schema-level
+metadata in the internal ``arrow::Schema`` object.
+
+The default of ``preserve_index`` is ``None``, which behaves as
+follows:
+
+* ``RangeIndex`` is stored as metadata-only, not requiring any extra
+ storage.
+* Other index types are stored as one or more physical data columns in
+ the resulting :class:`Table`
+
+To not store the index at all pass ``preserve_index=False``. Since
+storing a ``RangeIndex`` can cause issues in some limited scenarios
+(such as storing multiple DataFrame objects in a Parquet file), to
+force all index data to be serialized in the resulting table, pass
+``preserve_index=True``.
+
Type differences
----------------
@@ -184,6 +211,12 @@ If you want to use NumPy's ``datetime64`` dtype instead, pass
s2 = pd.Series(arr.to_pandas(date_as_object=False))
s2.dtype
+.. warning::
+
+ As of Arrow ``0.13`` the parameter ``date_as_object`` is ``True``
+ by default. Older versions must pass ``date_as_object=True`` to
+ obtain this behavior
+
Time types
~~~~~~~~~~
diff --git a/docs/_sources/python/parquet.rst.txt b/docs/_sources/python/parquet.rst.txt
index bd3b349..5cd1248 100644
--- a/docs/_sources/python/parquet.rst.txt
+++ b/docs/_sources/python/parquet.rst.txt
@@ -112,6 +112,23 @@ In general, a Python file object will have the worst read performance, while a
string file path or an instance of :class:`~.NativeFile` (especially memory
maps) will perform the best.
+Parquet file writing options
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+:func:`~pyarrow.parquet.write_table()` has a number of options to
+control various settings when writing a Parquet file.
+
+* ``version``, the Parquet format version to use, whether ``'1.0'``
+ for compatibility with older readers, or ``'2.0'`` to unlock more
+ recent features.
+* ``data_page_size``, to control the approximate size of encoded data
+ pages within a column chunk. This currently defaults to 1MB
+* ``flavor``, to set compatibility options particular to a Parquet
+ consumer like ``'spark'`` for Apache Spark.
+
+There are some additional data type handling-specific options
+described below.
+
Omitting the DataFrame index
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -214,6 +231,16 @@ an exception will be raised. This can be suppressed by passing
pq.write_table(table, where, coerce_timestamps='ms',
allow_truncated_timestamps=True)
+Older Parquet implementations use ``INT96`` based storage of
+timestamps, but this is now deprecated. This includes some older
+versions of Apache Impala and Apache Spark. To write timestamps in
+this format, set the ``use_deprecated_int96_timestamps`` option to
+``True`` in ``write_table``.
+
+.. code-block:: python
+
+ pq.write_table(table, where, use_deprecated_int96_timestamps=True)
+
Compression, Encoding, and File Compatibility
---------------------------------------------
@@ -347,16 +374,18 @@ sanitize field characters unsupported by Spark SQL.
Multithreaded Reads
-------------------
-Each of the reading functions have an ``nthreads`` argument which will read
-columns with the indicated level of parallelism. Depending on the speed of IO
+Each of the reading functions by default use multi-threading for reading
+columns in parallel. Depending on the speed of IO
and how expensive it is to decode the columns in a particular file
(particularly with GZIP compression), this can yield significantly higher data
-throughput:
+throughput.
-.. code-block:: python
+This can be disabled by specifying ``use_threads=False``.
+
+.. note::
+ The number of threads to use concurrently is automatically inferred by Arrow
+ and can be inspected using the :func:`~pyarrow.cpu_count()` function.
- pq.read_table(where, nthreads=4)
- pq.ParquetDataset(where).read(nthreads=4)
Reading a Parquet File from Azure Blob storage
----------------------------------------------
diff --git a/docs/_static/basic.css b/docs/_static/basic.css
index 0807176..c41d718 100644
--- a/docs/_static/basic.css
+++ b/docs/_static/basic.css
@@ -231,6 +231,16 @@ a.headerlink {
visibility: hidden;
}
+a.brackets:before,
+span.brackets > a:before{
+ content: "[";
+}
+
+a.brackets:after,
+span.brackets > a:after {
+ content: "]";
+}
+
h1:hover > a.headerlink,
h2:hover > a.headerlink,
h3:hover > a.headerlink,
@@ -279,6 +289,12 @@ img.align-center, .figure.align-center, object.align-center {
margin-right: auto;
}
+img.align-default, .figure.align-default {
+ display: block;
+ margin-left: auto;
+ margin-right: auto;
+}
+
.align-left {
text-align: left;
}
@@ -287,6 +303,10 @@ img.align-center, .figure.align-center, object.align-center {
text-align: center;
}
+.align-default {
+ text-align: center;
+}
+
.align-right {
text-align: right;
}
@@ -358,6 +378,11 @@ table.align-center {
margin-right: auto;
}
+table.align-default {
+ margin-left: auto;
+ margin-right: auto;
+}
+
table caption span.caption-number {
font-style: italic;
}
@@ -391,6 +416,16 @@ table.citation td {
border-bottom: none;
}
+th > p:first-child,
+td > p:first-child {
+ margin-top: 0px;
+}
+
+th > p:last-child,
+td > p:last-child {
+ margin-bottom: 0px;
+}
+
/* -- figures --------------------------------------------------------------- */
div.figure {
@@ -460,11 +495,57 @@ ol.upperroman {
list-style: upper-roman;
}
+li > p:first-child {
+ margin-top: 0px;
+}
+
+li > p:last-child {
+ margin-bottom: 0px;
+}
+
+dl.footnote > dt,
+dl.citation > dt {
+ float: left;
+}
+
+dl.footnote > dd,
+dl.citation > dd {
+ margin-bottom: 0em;
+}
+
+dl.footnote > dd:after,
+dl.citation > dd:after {
+ content: "";
+ clear: both;
+}
+
+dl.field-list {
+ display: flex;
+ flex-wrap: wrap;
+}
+
+dl.field-list > dt {
+ flex-basis: 20%;
+ font-weight: bold;
+ word-break: break-word;
+}
+
+dl.field-list > dt:after {
+ content: ":";
+}
+
+dl.field-list > dd {
+ flex-basis: 70%;
+ padding-left: 1em;
+ margin-left: 0em;
+ margin-bottom: 0em;
+}
+
dl {
margin-bottom: 15px;
}
-dd p {
+dd > p:first-child {
margin-top: 0px;
}
@@ -537,6 +618,12 @@ dl.glossary dt {
font-style: oblique;
}
+.classifier:before {
+ font-style: normal;
+ margin: 0.5em;
+ content: ":";
+}
+
abbr, acronym {
border-bottom: dotted 1px;
cursor: help;
diff --git a/docs/_static/doctools.js b/docs/_static/doctools.js
index 344db17..b33f87f 100644
--- a/docs/_static/doctools.js
+++ b/docs/_static/doctools.js
@@ -87,14 +87,13 @@ jQuery.fn.highlightText = function(text, className) {
node.nextSibling));
node.nodeValue = val.substr(0, pos);
if (isInSVG) {
- var bbox = span.getBBox();
var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect");
- rect.x.baseVal.value = bbox.x;
+ var bbox = node.parentElement.getBBox();
+ rect.x.baseVal.value = bbox.x;
rect.y.baseVal.value = bbox.y;
rect.width.baseVal.value = bbox.width;
rect.height.baseVal.value = bbox.height;
rect.setAttribute('class', className);
- var parentOfText = node.parentNode.parentNode;
addItems.push({
"parent": node.parentNode,
"target": rect});
diff --git a/docs/_static/documentation_options.js b/docs/_static/documentation_options.js
index 1c53465..3b9c463 100644
--- a/docs/_static/documentation_options.js
+++ b/docs/_static/documentation_options.js
@@ -1,10 +1,10 @@
var DOCUMENTATION_OPTIONS = {
URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
- VERSION: '0.13.0',
+ VERSION: '0.14.2.dev0+g5f564424c.d20190805',
LANGUAGE: 'None',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt',
- NAVIGATION_WITH_KEYS: false,
+ NAVIGATION_WITH_KEYS: false
};
\ No newline at end of file
diff --git a/docs/_static/fonts/Inconsolata-Bold.ttf b/docs/_static/fonts/Inconsolata-Bold.ttf
new file mode 100644
index 0000000..809c1f5
Binary files /dev/null and b/docs/_static/fonts/Inconsolata-Bold.ttf differ
diff --git a/docs/_static/fonts/Inconsolata-Regular.ttf b/docs/_static/fonts/Inconsolata-Regular.ttf
new file mode 100644
index 0000000..fc981ce
Binary files /dev/null and b/docs/_static/fonts/Inconsolata-Regular.ttf differ
diff --git a/docs/_static/fonts/Inconsolata.ttf b/docs/_static/fonts/Inconsolata.ttf
new file mode 100644
index 0000000..4b8a36d
Binary files /dev/null and b/docs/_static/fonts/Inconsolata.ttf differ
diff --git a/docs/_static/fonts/Lato-Bold.ttf b/docs/_static/fonts/Lato-Bold.ttf
new file mode 100644
index 0000000..1d23c70
Binary files /dev/null and b/docs/_static/fonts/Lato-Bold.ttf differ
diff --git a/docs/_static/fonts/Lato-Regular.ttf b/docs/_static/fonts/Lato-Regular.ttf
new file mode 100644
index 0000000..0f3d0f8
Binary files /dev/null and b/docs/_static/fonts/Lato-Regular.ttf differ
diff --git a/docs/_static/fonts/RobotoSlab-Bold.ttf b/docs/_static/fonts/RobotoSlab-Bold.ttf
new file mode 100644
index 0000000..df5d1df
Binary files /dev/null and b/docs/_static/fonts/RobotoSlab-Bold.ttf differ
diff --git a/docs/_static/fonts/RobotoSlab-Regular.ttf b/docs/_static/fonts/RobotoSlab-Regular.ttf
new file mode 100644
index 0000000..eb52a79
Binary files /dev/null and b/docs/_static/fonts/RobotoSlab-Regular.ttf differ
diff --git a/docs/_static/searchtools.js b/docs/_static/searchtools.js
index 5ff3180..6031f99 100644
--- a/docs/_static/searchtools.js
+++ b/docs/_static/searchtools.js
@@ -36,8 +36,10 @@ if (!Scorer) {
// query found in title
title: 15,
+ partialTitle: 7,
// query found in terms
- term: 5
+ term: 5,
+ partialTerm: 2
};
}
@@ -56,6 +58,14 @@ var Search = {
_queued_query : null,
_pulse_status : -1,
+ htmlToText : function(htmlString) {
+ var htmlElement = document.createElement('span');
+ htmlElement.innerHTML = htmlString;
+ $(htmlElement).find('.headerlink').remove();
+ docContent = $(htmlElement).find('[role=main]')[0];
+ return docContent.textContent || docContent.innerText;
+ },
+
init : function() {
var params = $.getQueryParameters();
if (params.q) {
@@ -120,7 +130,7 @@ var Search = {
this.out = $('#search-results');
this.title = $('<h2>' + _('Searching') + '</h2>').appendTo(this.out);
this.dots = $('<span></span>').appendTo(this.title);
- this.status = $('<p style="display: none"></p>').appendTo(this.out);
+ this.status = $('<p class="search-summary"> </p>').appendTo(this.out);
this.output = $('<ul class="search"/>').appendTo(this.out);
$('#search-progress').text(_('Preparing search...'));
@@ -259,11 +269,7 @@ var Search = {
displayNextItem();
});
} else if (DOCUMENTATION_OPTIONS.HAS_SOURCE) {
- var suffix = DOCUMENTATION_OPTIONS.SOURCELINK_SUFFIX;
- if (suffix === undefined) {
- suffix = '.txt';
- }
- $.ajax({url: DOCUMENTATION_OPTIONS.URL_ROOT + '_sources/' + item[5] + (item[5].slice(-suffix.length) === suffix ? '' : suffix),
+ $.ajax({url: DOCUMENTATION_OPTIONS.URL_ROOT + item[0] + DOCUMENTATION_OPTIONS.FILE_SUFFIX,
dataType: "text",
complete: function(jqxhr, textstatus) {
var data = jqxhr.responseText;
@@ -313,12 +319,13 @@ var Search = {
for (var prefix in objects) {
for (var name in objects[prefix]) {
var fullname = (prefix ? prefix + '.' : '') + name;
- if (fullname.toLowerCase().indexOf(object) > -1) {
+ var fullnameLower = fullname.toLowerCase()
+ if (fullnameLower.indexOf(object) > -1) {
var score = 0;
- var parts = fullname.split('.');
+ var parts = fullnameLower.split('.');
// check for different match types: exact matches of full name or
// "last name" (i.e. last dotted part)
- if (fullname == object || parts[parts.length - 1] == object) {
+ if (fullnameLower == object || parts[parts.length - 1] == object) {
score += Scorer.objNameMatch;
// matches in last name
} else if (parts[parts.length - 1].indexOf(object) > -1) {
@@ -385,6 +392,19 @@ var Search = {
{files: terms[word], score: Scorer.term},
{files: titleterms[word], score: Scorer.title}
];
+ // add support for partial matches
+ if (word.length > 2) {
+ for (var w in terms) {
+ if (w.match(word) && !terms[word]) {
+ _o.push({files: terms[w], score: Scorer.partialTerm})
+ }
+ }
+ for (var w in titleterms) {
+ if (w.match(word) && !titleterms[word]) {
+ _o.push({files: titleterms[w], score: Scorer.partialTitle})
+ }
+ }
+ }
// no match but word was a required one
if ($u.every(_o, function(o){return o.files === undefined;})) {
@@ -424,8 +444,12 @@ var Search = {
var valid = true;
// check if all requirements are matched
- if (fileMap[file].length != searchterms.length)
- continue;
+ var filteredTermCount = // as search terms with length < 3 are discarded: ignore
+ searchterms.filter(function(term){return term.length > 2}).length
+ if (
+ fileMap[file].length != searchterms.length &&
+ fileMap[file].length != filteredTermCount
+ ) continue;
// ensure that none of the excluded terms is in the search result
for (i = 0; i < excluded.length; i++) {
@@ -456,7 +480,8 @@ var Search = {
* words. the first one is used to find the occurrence, the
* latter for highlighting it.
*/
- makeSearchSummary : function(text, keywords, hlwords) {
+ makeSearchSummary : function(htmlText, keywords, hlwords) {
+ var text = Search.htmlToText(htmlText);
var textLower = text.toLowerCase();
var start = 0;
$.each(keywords, function() {
diff --git a/docs/cpp/api.html b/docs/cpp/api.html
index 0308916..fac262a 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.13.0</title>
+ <title>API Reference — Apache Arrow v0.14.2.dev0+g5f564424c.d20190805</title>
@@ -61,7 +61,7 @@
<div class="version">
- 0.13.0
+ 0.14.2.dev0+g5f564424c.d20190805
</div>
@@ -92,6 +92,7 @@
<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>
+<li class="toctree-l1"><a class="reference internal" href="../format/Flight.html">Arrow Flight RPC</a></li>
</ul>
<p class="caption"><span class="caption-text">Arrow Libraries</span></p>
<ul class="current">
@@ -107,6 +108,7 @@
<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>
+<li class="toctree-l3"><a class="reference internal" href="api/flight.html">Arrow Flight RPC</a></li>
</ul>
</li>
</ul>
@@ -119,6 +121,7 @@
<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/benchmarks.html">Benchmarks</a></li>
<li class="toctree-l1"><a class="reference internal" href="../developers/documentation.html">Building the Documentation</a></li>
</ul>
@@ -246,6 +249,12 @@
<li class="toctree-l2"><a class="reference internal" href="api/cuda.html#cuda-ipc">CUDA IPC</a></li>
</ul>
</li>
+<li class="toctree-l1"><a class="reference internal" href="api/flight.html">Arrow Flight RPC</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="api/flight.html#common-types">Common Types</a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/flight.html#clients">Clients</a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/flight.html#servers">Servers</a></li>
+</ul>
+</li>
</ul>
</div>
</div>
diff --git a/docs/cpp/api/array.html b/docs/cpp/api/array.html
index 4248d65..4ed9802 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.13.0</title>
+ <title>Arrays — Apache Arrow v0.14.2.dev0+g5f564424c.d20190805</title>
@@ -61,7 +61,7 @@
<div class="version">
- 0.13.0
+ 0.14.2.dev0+g5f564424c.d20190805
</div>
@@ -92,6 +92,7 @@
<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>
+<li class="toctree-l1"><a class="reference internal" href="../../format/Flight.html">Arrow Flight RPC</a></li>
</ul>
<p class="caption"><span class="caption-text">Arrow Libraries</span></p>
<ul class="current">
@@ -111,6 +112,7 @@
<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>
+<li class="toctree-l3"><a class="reference internal" href="flight.html">Arrow Flight RPC</a></li>
</ul>
</li>
</ul>
@@ -123,6 +125,7 @@
<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/benchmarks.html">Benchmarks</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../developers/documentation.html">Building the Documentation</a></li>
</ul>
@@ -196,92 +199,98 @@
<h1>Arrays<a class="headerlink" href="#arrays" title="Permalink to this headline">¶</a></h1>
<dl class="class">
<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>
+<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="sig-name 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>, 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 [...]
+<p>Subclassed by <a class="reference internal" href="#classarrow_1_1_dictionary_array"><span class="std std-ref">arrow::DictionaryArray</span></a>, arrow::ExtensionArray, arrow::FixedSizeListArray, <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_stru [...]
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric">Public Functions</p>
<dl class="function">
<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 [...]
+<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="sig-name 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="Permal [...]
<dd><p>Return true if value at index is null. Does not boundscheck. </p>
</dd></dl>
<dl class="function">
<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 [...]
+<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="sig-name 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="P [...]
<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="_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>
+<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="sig-name 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="_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>
+<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="sig-name 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="_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 [...]
+<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="sig-name 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 [...]
<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="_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 [...]
+<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="sig-name descname">null_bitmap</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em clas [...]
<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="_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 [...]
+<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="sig-name descname">null_bitmap_data</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv4NK5arrow [...]
<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="_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 [...]
+<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="sig-name descname">Equals</code><span class="sig-paren">(</span><em class="property">const</em> <a class="reference internal" href="#_CPPv4N5arrow5ArrayE" title="arrow::Array">Arr [...]
<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 [...]
+<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="sig-name descname">ApproxEquals</code><span class="sig-paren">(</span><em class="property">const</em> std: [...]
<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 [...]
+<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="sig-name descname">RangeEquals</code><span class="sig-paren">(</span>int64_t <em>start_idx</em>, int64_t <em>end_idx</em>, int64_t <em>ot [...]
<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="_CPPv4N5arrow5Array4ViewERKNSt10shared_ptrI8DataTypeEEPNSt10shared_ptrI5ArrayEE">
+<span id="_CPPv3N5arrow5Array4ViewERKNSt10shared_ptrI8DataTypeEEPNSt10shared_ptrI5ArrayEE"></span><span id="_CPPv2N5arrow5Array4ViewERKNSt10shared_ptrI8DataTypeEEPNSt10shared_ptrI5ArrayEE"></span><span id="arrow::Array::View__std::shared_ptr:DataType:CR.std::shared_ptr:Array:P"></span><span class="target" id="classarrow_1_1_array_1a9c3b0b1d5e6be40087e75e883781e4d7"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status">Status</a> <code class= [...]
+<dd><p>Construct a zero-copy view of this array with the given type. </p>
+<p>This method checks if the types are layout-compatible. Nested types are traversed in depth-first order. Data buffers must have the same item sizes, even though the logical types may be different. An error is returned if the types are not layout-compatible. </p>
+</dd></dl>
+
+<dl class="function">
<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 [...]
+<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="sig-name descname">Slice</code><span class="sig-paren">(</span>int64_t <em>offset</em>, int64_t < [...]
<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>
-<dd>a new object wrapped in std::shared_ptr<Array> </dd>
-<dt><strong>Parameters</strong></dt>
-<dd><ul class="breatheparameterlist first last simple">
-<li><code class="docutils literal notranslate"><span class="pre">offset</span></code>: the position of the first element in the constructed slice </li>
-<li><code class="docutils literal notranslate"><span class="pre">length</span></code>: the length of the slice. If there are not enough elements in the array, the length will be adjusted accordingly</li>
+<p><dl class="simple">
+<dt><strong>Return</strong></dt><dd><p>a new object wrapped in std::shared_ptr<Array> </p>
+</dd>
+<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">offset</span></code>: the position of the first element in the constructed slice </p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">length</span></code>: the length of the slice. If there are not enough elements in the array, the length will be adjusted accordingly</p></li>
</ul>
</dd>
</dl>
@@ -290,16 +299,16 @@
<dl class="function">
<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=" [...]
+<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="sig-name descname">Slice</code><span class="sig-paren">(</span>int64_t <em>offset</em><span class="sig-paren">)</span> <e [...]
<dd><p>Slice from offset until end of the array. </p>
</dd></dl>
<dl class="function">
<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>
+<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="sig-name 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><b [...]
+<dd><p><dl class="simple">
+<dt><strong>Return</strong></dt><dd><p>PrettyPrint representation of array suitable for debugging </p>
+</dd>
</dl>
</p>
</dd></dl>
@@ -311,8 +320,8 @@
<h2>Concrete array subclasses<a class="headerlink" href="#concrete-array-subclasses" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<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>
+<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="sig-name 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= [...]
+<dd><p><a class="reference internal" href="#classarrow_1_1_array"><span class="std std-ref">Array</span></a> type for dictionary-encoded data with a data-dependent dictionary. </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>
<p>[“foo”, “bar”, “foo”, “bar”, “foo”, “bar”]</p>
@@ -322,37 +331,43 @@
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric">Public Functions</p>
<dl class="function">
-<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 [...]
+<dt id="_CPPv4NK5arrow15DictionaryArray9TransposeEP10MemoryPoolRKNSt10shared_ptrI8DataTypeEERKNSt10shared_ptrI5ArrayEERKNSt6vectorI7int32_tEEPNSt10shared_ptrI5ArrayEE">
+<span id="_CPPv3NK5arrow15DictionaryArray9TransposeEP10MemoryPoolRKNSt10shared_ptrI8DataTypeEERKNSt10shared_ptrI5ArrayEERKNSt6vectorI7int32_tEEPNSt10shared_ptrI5ArrayEE"></span><span id="_CPPv2NK5arrow15DictionaryArray9TransposeEP10MemoryPoolRKNSt10shared_ptrI8DataTypeEERKNSt10shared_ptrI5ArrayEERKNSt6vectorI7int32_tEEPNSt10shared_ptrI5ArrayEE"></span><span id="arrow::DictionaryArray::Transpose__MemoryPoolP.std::shared_ptr:DataType:CR.std::shared_ptr:Array:CR.std::vector:int32_t:CR.std:: [...]
<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">
-<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 pool to allocate the array data from </li>
-<li><code class="docutils literal notranslate"><span class="pre">type</span></code>: a dictionary type </li>
-<li><code class="docutils literal notranslate"><span class="pre">transpose_map</span></code>: a vector transposing this array’s indices into the target array’s indices </li>
-<li><code class="docutils literal notranslate"><span class="pre">out</span></code>: the resulting <a class="reference internal" href="#classarrow_1_1_dictionary_array"><span class="std std-ref">DictionaryArray</span></a> instance </li>
+<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_1a78d33c2774117eea79a47eb320bf63da"><span class="std std-ref">DictionaryType::Unify</span></a>.</p>
+<p><dl class="simple">
+<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">pool</span></code>: a pool to allocate the array data from </p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">type</span></code>: the new type object </p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">dictionary</span></code>: the new dictionary </p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">transpose_map</span></code>: a vector transposing this array’s indices into the target array’s indices </p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">[out]</span> <span class="pre">out</span></code>: the resulting <a class="reference internal" href="#classarrow_1_1_dictionary_array"><span class="std std-ref">DictionaryArray</span></a> instance </p></li>
</ul>
</dd>
</dl>
</p>
</dd></dl>
+<dl class="function">
+<dt id="_CPPv4NK5arrow15DictionaryArray10dictionaryEv">
+<span id="_CPPv3NK5arrow15DictionaryArray10dictionaryEv"></span><span id="_CPPv2NK5arrow15DictionaryArray10dictionaryEv"></span><span id="arrow::DictionaryArray::dictionaryC"></span><span class="target" id="classarrow_1_1_dictionary_array_1ab77f454477e3695592274f6266647175"></span>std::shared_ptr<<a class="reference internal" href="#_CPPv4N5arrow5ArrayE" title="arrow::Array">Array</a>> <code class="sig-name descname">dictionary</code><span class="sig-paren">(</span><span class="sig [...]
+<dd><p>Return the dictionary for this array, which is stored as a member of the ArrayData internal structure. </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="_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>
+<dt id="_CPPv4N5arrow15DictionaryArray10FromArraysERKNSt10shared_ptrI8DataTypeEERKNSt10shared_ptrI5ArrayEERKNSt10shared_ptrI5ArrayEEPNSt10shared_ptrI5ArrayEE">
+<span id="_CPPv3N5arrow15DictionaryArray10FromArraysERKNSt10shared_ptrI8DataTypeEERKNSt10shared_ptrI5ArrayEERKNSt10shared_ptrI5ArrayEEPNSt10shared_ptrI5ArrayEE"></span><span id="_CPPv2N5arrow15DictionaryArray10FromArraysERKNSt10shared_ptrI8DataTypeEERKNSt10shared_ptrI5ArrayEERKNSt10shared_ptrI5ArrayEEPNSt10shared_ptrI5ArrayEE"></span><span id="arrow::DictionaryArray::FromArrays__std::shared_ptr:DataType:CR.std::shared_ptr:Array:CR.std::shared_ptr:Array:CR.std::shared_ptr:Array:P"></span> [...]
+<dd><p>Construct <a class="reference internal" href="#classarrow_1_1_dictionary_array"><span class="std std-ref">DictionaryArray</span></a> from dictionary and indices array and validate. </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">
-<dt><strong>Parameters</strong></dt>
-<dd><ul class="breatheparameterlist first last simple">
-<li><code class="docutils literal notranslate"><span class="pre">type</span></code>: a dictionary type </li>
-<li><code class="docutils literal notranslate"><span class="pre">indices</span></code>: an array of non-negative signed integers smaller than the size of the dictionary </li>
-<li><code class="docutils literal notranslate"><span class="pre">out</span></code>: the resulting <a class="reference internal" href="#classarrow_1_1_dictionary_array"><span class="std std-ref">DictionaryArray</span></a> instance </li>
+<p><dl class="simple">
+<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">type</span></code>: a dictionary type </p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">dictionary</span></code>: the dictionary with same value type as the type object </p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">indices</span></code>: an array of non-negative signed integers smaller than the size of the dictionary </p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">[out]</span> <span class="pre">out</span></code>: the resulting <a class="reference internal" href="#classarrow_1_1_dictionary_array"><span class="std std-ref">DictionaryArray</span></a> instance </p></li>
</ul>
</dd>
</dl>
@@ -366,40 +381,39 @@
<h3>Non-nested<a class="headerlink" href="#non-nested" title="Permalink to this headline">¶</a></h3>
<dl class="class">
<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>
+<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="sig-name 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 [...]
<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="_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> [...]
+<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="sig-name 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 definiti [...]
<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="_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 [...]
+<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="sig-name 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 t [...]
<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="_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">) [...]
+<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="sig-name descname">GetValue</code><span class="sig-paren">(</span>int64_t <em>i</em>, int32_t *<em>out_length</em><span class="sig [...]
<dd><p>Return the pointer to the given elements bytes. </p>
</dd></dl>
<dl class="function">
<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 [...]
+<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="sig-name 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="#_CPPv4N [...]
<dd><p>Get binary value as a string_view. </p>
-<p><dl class="docutils">
-<dt><strong>Return</strong></dt>
-<dd>the view over the selected value </dd>
-<dt><strong>Parameters</strong></dt>
-<dd><ul class="breatheparameterlist first last simple">
-<li><code class="docutils literal notranslate"><span class="pre">i</span></code>: the value index </li>
+<p><dl class="simple">
+<dt><strong>Return</strong></dt><dd><p>the view over the selected value </p>
+</dd>
+<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
+<li><p><code class="docutils literal notranslate"><span class="pre">i</span></code>: the value index </p></li>
</ul>
</dd>
</dl>
@@ -408,14 +422,13 @@
<dl class="function">
<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 [...]
+<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="sig-name 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="#_CPPv [...]
<dd><p>Get binary value as a std::string. </p>
-<p><dl class="docutils">
-<dt><strong>Return</strong></dt>
-<dd>the value copied into a std::string </dd>
-<dt><strong>Parameters</strong></dt>
-<dd><ul class="breatheparameterlist first last simple">
-<li><code class="docutils literal notranslate"><span class="pre">i</span></code>: the value index </li>
+<p><dl class="simple">
+<dt><strong>Return</strong></dt><dd><p>the value copied into a std::string </p>
+</dd>
+<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
+<li><p><code class="docutils literal notranslate"><span class="pre">i</span></code>: the value index </p></li>
</ul>
</dd>
</dl>
@@ -424,13 +437,13 @@
<dl class="function">
<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 [...]
+<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="sig-name descname">value_offsets</code><span class="sig-paren">(</span><span [...]
<dd><p>Note that this buffer does not account for any slice offset. </p>
</dd></dl>
<dl class="function">
<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">)</ [...]
+<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="sig-name descname">value_data</code><span class="sig-paren">(</span><span class="sig-p [...]
<dd><p>Note that this buffer does not account for any slice offset. </p>
</dd></dl>
@@ -439,20 +452,20 @@
<dl class="class">
<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 [...]
+<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="sig-name 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="Perm [...]
<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="_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 [...]
+<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="sig-name 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" [...]
<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>
+<p>Subclassed by <a class="reference internal" href="#classarrow_1_1_boolean_array"><span class="std std-ref">arrow::BooleanArray</span></a>, arrow::DayTimeIntervalArray, <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="_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> [...]
+<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="sig-name descname">values</code><span class="sig-paren">(</span><span class="sig-paren"> [...]
<dd><p>Does not account for any slice offset. </p>
</dd></dl>
@@ -461,26 +474,26 @@
<dl class="class">
<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 [...]
+<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="sig-name descname">BooleanArray</code> : <em class="property">public</em> arrow::<a class="reference internal" href="#_CPPv4N5arrow14PrimitiveArrayE" title="arrow::PrimitiveArray">PrimitiveArray</a><a class="headerlink" href="#_CPPv4N5arrow12BooleanArra [...]
<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="_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" [...]
+<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="sig-name descname">FixedSizeBinaryArray</code> : <em class="property">public</em> arrow::<a class="reference internal" href="#_CPPv4N5arrow14PrimitiveArrayE" title="arrow::PrimitiveArray">PrimitiveArray</a><a class="hea [...]
<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="_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 [...]
+<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="sig-name descname">Decimal128Array</code> : <em class="property">public</em> arrow::<a class="reference internal" href="#_CPPv4N5arrow20FixedSizeBinaryArrayE" title="arrow::FixedSizeBinaryArray">FixedSizeBinaryArray</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 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="_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 [...]
+<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="sig-name descname">Decimal128Array</code><span class="sig-paren">(</span><em class="property">con [...]
<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>
@@ -488,8 +501,8 @@
</dd></dl>
<dl class="class">
-<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 [...]
+<dt id="_CPPv4I0EN5arrow12NumericArrayE">
+<span id="_CPPv3I0EN5arrow12NumericArrayE"></span><span id="_CPPv2I0EN5arrow12NumericArrayE"></span><span class="target" id="classarrow_1_1_numeric_array"></span>template<typename <code class="sig-name descname">TYPE</code>><br /><em class="property">class </em><code class="sig-name descname">NumericArray</code> : <em class="property">public</em> arrow::<a class="reference internal" href="#_CPPv4N5arrow14PrimitiveArrayE" title="arrow::PrimitiveArray">PrimitiveArray</a><a class="hea [...]
<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>
@@ -498,43 +511,144 @@
<h3>Nested<a class="headerlink" href="#nested" title="Permalink to this headline">¶</a></h3>
<dl class="class">
<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 [...]
+<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="sig-name 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" [...]
<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="_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 [...]
+<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="sig-name descname">type_ids</code><span class="sig-paren">(</span><span class="sig-paren">)</span> [...]
<dd><p>Note that this buffer does not account for any slice offset. </p>
</dd></dl>
<dl class="function">
<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 [...]
+<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="sig-name descname">value_offsets</code><span class="sig-paren">(</span><span clas [...]
<dd><p>Note that this buffer does not account for any slice offset. </p>
</dd></dl>
-<dl class="function">
-<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>
-
</div>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric">Public Static Functions</p>
<dl class="function">
+<dt id="_CPPv4N5arrow10UnionArray9MakeDenseERK5ArrayRK5ArrayRKNSt6vectorINSt10shared_ptrI5ArrayEEEERKNSt6vectorINSt6stringEEERKNSt6vectorI7uint8_tEEPNSt10shared_ptrI5ArrayEE">
+<span id="_CPPv3N5arrow10UnionArray9MakeDenseERK5ArrayRK5ArrayRKNSt6vectorINSt10shared_ptrI5ArrayEEEERKNSt6vectorINSt6stringEEERKNSt6vectorI7uint8_tEEPNSt10shared_ptrI5ArrayEE"></span><span id="_CPPv2N5arrow10UnionArray9MakeDenseERK5ArrayRK5ArrayRKNSt6vectorINSt10shared_ptrI5ArrayEEEERKNSt6vectorINSt6stringEEERKNSt6vectorI7uint8_tEEPNSt10shared_ptrI5ArrayEE"></span><span id="arrow::UnionArray::MakeDense__ArrayCR.ArrayCR.std::vector:std::shared_ptr:Array::CR.std::vector:ss:CR.std::vector: [...]
+<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="simple">
+<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">type_ids</span></code>: An array of 8-bit signed integers, enumerated from 0 corresponding to each type. </p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">value_offsets</span></code>: An array of signed int32 values indicating the relative offset into the respective child array for the type in a given slot. The respective offsets for each child value array must be in order / increasing. </p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">children</span></code>: Vector of children Arrays containing the data for each type. </p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">field_names</span></code>: Vector of strings containing the name of each field. </p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">type_codes</span></code>: Vector of type codes. </p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">[out]</span> <span class="pre">out</span></code>: Will have length equal to value_offsets.length() </p></li>
+</ul>
+</dd>
+</dl>
+</p>
+</dd></dl>
+
+<dl class="function">
+<dt id="_CPPv4N5arrow10UnionArray9MakeDenseERK5ArrayRK5ArrayRKNSt6vectorINSt10shared_ptrI5ArrayEEEERKNSt6vectorINSt6stringEEEPNSt10shared_ptrI5ArrayEE">
+<span id="_CPPv3N5arrow10UnionArray9MakeDenseERK5ArrayRK5ArrayRKNSt6vectorINSt10shared_ptrI5ArrayEEEERKNSt6vectorINSt6stringEEEPNSt10shared_ptrI5ArrayEE"></span><span id="_CPPv2N5arrow10UnionArray9MakeDenseERK5ArrayRK5ArrayRKNSt6vectorINSt10shared_ptrI5ArrayEEEERKNSt6vectorINSt6stringEEEPNSt10shared_ptrI5ArrayEE"></span><span id="arrow::UnionArray::MakeDense__ArrayCR.ArrayCR.std::vector:std::shared_ptr:Array::CR.std::vector:ss:CR.std::shared_ptr:Array:P"></span><span class="target" id="c [...]
+<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="simple">
+<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">type_ids</span></code>: An array of 8-bit signed integers, enumerated from 0 corresponding to each type. </p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">value_offsets</span></code>: An array of signed int32 values indicating the relative offset into the respective child array for the type in a given slot. The respective offsets for each child value array must be in order / increasing. </p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">children</span></code>: Vector of children Arrays containing the data for each type. </p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">field_names</span></code>: Vector of strings containing the name of each field. </p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">[out]</span> <span class="pre">out</span></code>: Will have length equal to value_offsets.length() </p></li>
+</ul>
+</dd>
+</dl>
+</p>
+</dd></dl>
+
+<dl class="function">
+<dt id="_CPPv4N5arrow10UnionArray9MakeDenseERK5ArrayRK5ArrayRKNSt6vectorINSt10shared_ptrI5ArrayEEEERKNSt6vectorI7uint8_tEEPNSt10shared_ptrI5ArrayEE">
+<span id="_CPPv3N5arrow10UnionArray9MakeDenseERK5ArrayRK5ArrayRKNSt6vectorINSt10shared_ptrI5ArrayEEEERKNSt6vectorI7uint8_tEEPNSt10shared_ptrI5ArrayEE"></span><span id="_CPPv2N5arrow10UnionArray9MakeDenseERK5ArrayRK5ArrayRKNSt6vectorINSt10shared_ptrI5ArrayEEEERKNSt6vectorI7uint8_tEEPNSt10shared_ptrI5ArrayEE"></span><span id="arrow::UnionArray::MakeDense__ArrayCR.ArrayCR.std::vector:std::shared_ptr:Array::CR.std::vector:uint8_t:CR.std::shared_ptr:Array:P"></span><span class="target" id="cl [...]
+<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="simple">
+<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">type_ids</span></code>: An array of 8-bit signed integers, enumerated from 0 corresponding to each type. </p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">value_offsets</span></code>: An array of signed int32 values indicating the relative offset into the respective child array for the type in a given slot. The respective offsets for each child value array must be in order / increasing. </p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">children</span></code>: Vector of children Arrays containing the data for each type. </p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">type_codes</span></code>: Vector of type codes. </p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">[out]</span> <span class="pre">out</span></code>: Will have length equal to value_offsets.length() </p></li>
+</ul>
+</dd>
+</dl>
+</p>
+</dd></dl>
+
+<dl class="function">
<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>< [...]
+<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">
-<dt><strong>Parameters</strong></dt>
-<dd><ul class="breatheparameterlist first last simple">
-<li><code class="docutils literal notranslate"><span class="pre">type_ids</span></code>: An array of 8-bit signed integers, enumerated from 0 corresponding to each type. </li>
-<li><code class="docutils literal notranslate"><span class="pre">value_offsets</span></code>: An array of signed int32 values indicating the relative offset into the respective child array for the type in a given slot. The respective offsets for each child value array must be in order / increasing. </li>
-<li><code class="docutils literal notranslate"><span class="pre">children</span></code>: Vector of children Arrays containing the data for each type. </li>
-<li><code class="docutils literal notranslate"><span class="pre">out</span></code>: Will have length equal to value_offsets.length() </li>
+<p>The name of each field is filled by the index of the field.</p>
+<p><dl class="simple">
+<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">type_ids</span></code>: An array of 8-bit signed integers, enumerated from 0 corresponding to each type. </p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">value_offsets</span></code>: An array of signed int32 values indicating the relative offset into the respective child array for the type in a given slot. The respective offsets for each child value array must be in order / increasing. </p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">children</span></code>: Vector of children Arrays containing the data for each type. </p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">[out]</span> <span class="pre">out</span></code>: Will have length equal to value_offsets.length() </p></li>
+</ul>
+</dd>
+</dl>
+</p>
+</dd></dl>
+
+<dl class="function">
+<dt id="_CPPv4N5arrow10UnionArray10MakeSparseERK5ArrayRKNSt6vectorINSt10shared_ptrI5ArrayEEEERKNSt6vectorINSt6stringEEERKNSt6vectorI7uint8_tEEPNSt10shared_ptrI5ArrayEE">
+<span id="_CPPv3N5arrow10UnionArray10MakeSparseERK5ArrayRKNSt6vectorINSt10shared_ptrI5ArrayEEEERKNSt6vectorINSt6stringEEERKNSt6vectorI7uint8_tEEPNSt10shared_ptrI5ArrayEE"></span><span id="_CPPv2N5arrow10UnionArray10MakeSparseERK5ArrayRKNSt6vectorINSt10shared_ptrI5ArrayEEEERKNSt6vectorINSt6stringEEERKNSt6vectorI7uint8_tEEPNSt10shared_ptrI5ArrayEE"></span><span id="arrow::UnionArray::MakeSparse__ArrayCR.std::vector:std::shared_ptr:Array::CR.std::vector:ss:CR.std::vector:uint8_t:CR.std::sha [...]
+<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="simple">
+<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">type_ids</span></code>: An array of 8-bit signed integers, enumerated from 0 corresponding to each type. </p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">children</span></code>: Vector of children Arrays containing the data for each type. </p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">field_names</span></code>: Vector of strings containing the name of each field. </p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">type_codes</span></code>: Vector of type codes. </p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">[out]</span> <span class="pre">out</span></code>: Will have length equal to type_ids.length() </p></li>
+</ul>
+</dd>
+</dl>
+</p>
+</dd></dl>
+
+<dl class="function">
+<dt id="_CPPv4N5arrow10UnionArray10MakeSparseERK5ArrayRKNSt6vectorINSt10shared_ptrI5ArrayEEEERKNSt6vectorINSt6stringEEEPNSt10shared_ptrI5ArrayEE">
+<span id="_CPPv3N5arrow10UnionArray10MakeSparseERK5ArrayRKNSt6vectorINSt10shared_ptrI5ArrayEEEERKNSt6vectorINSt6stringEEEPNSt10shared_ptrI5ArrayEE"></span><span id="_CPPv2N5arrow10UnionArray10MakeSparseERK5ArrayRKNSt6vectorINSt10shared_ptrI5ArrayEEEERKNSt6vectorINSt6stringEEEPNSt10shared_ptrI5ArrayEE"></span><span id="arrow::UnionArray::MakeSparse__ArrayCR.std::vector:std::shared_ptr:Array::CR.std::vector:ss:CR.std::shared_ptr:Array:P"></span><span class="target" id="classarrow_1_1_union [...]
+<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="simple">
+<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">type_ids</span></code>: An array of 8-bit signed integers, enumerated from 0 corresponding to each type. </p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">children</span></code>: Vector of children Arrays containing the data for each type. </p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">field_names</span></code>: Vector of strings containing the name of each field. </p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">[out]</span> <span class="pre">out</span></code>: Will have length equal to type_ids.length() </p></li>
+</ul>
+</dd>
+</dl>
+</p>
+</dd></dl>
+
+<dl class="function">
+<dt id="_CPPv4N5arrow10UnionArray10MakeSparseERK5ArrayRKNSt6vectorINSt10shared_ptrI5ArrayEEEERKNSt6vectorI7uint8_tEEPNSt10shared_ptrI5ArrayEE">
+<span id="_CPPv3N5arrow10UnionArray10MakeSparseERK5ArrayRKNSt6vectorINSt10shared_ptrI5ArrayEEEERKNSt6vectorI7uint8_tEEPNSt10shared_ptrI5ArrayEE"></span><span id="_CPPv2N5arrow10UnionArray10MakeSparseERK5ArrayRKNSt6vectorINSt10shared_ptrI5ArrayEEEERKNSt6vectorI7uint8_tEEPNSt10shared_ptrI5ArrayEE"></span><span id="arrow::UnionArray::MakeSparse__ArrayCR.std::vector:std::shared_ptr:Array::CR.std::vector:uint8_t:CR.std::shared_ptr:Array:P"></span><span class="target" id="classarrow_1_1_union_ [...]
+<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="simple">
+<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">type_ids</span></code>: An array of 8-bit signed integers, enumerated from 0 corresponding to each type. </p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">children</span></code>: Vector of children Arrays containing the data for each type. </p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">type_codes</span></code>: Vector of type codes. </p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">[out]</span> <span class="pre">out</span></code>: Will have length equal to type_ids.length() </p></li>
</ul>
</dd>
</dl>
@@ -543,15 +657,15 @@
<dl class="function">
<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" [...]
+<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">
-<dt><strong>Parameters</strong></dt>
-<dd><ul class="breatheparameterlist first last simple">
-<li><code class="docutils literal notranslate"><span class="pre">type_ids</span></code>: An array of 8-bit signed integers, enumerated from 0 corresponding to each type. </li>
-<li><code class="docutils literal notranslate"><span class="pre">children</span></code>: Vector of children Arrays containing the data for each type. </li>
-<li><code class="docutils literal notranslate"><span class="pre">out</span></code>: Will have length equal to type_ids.length() </li>
+<p>The name of each field is filled by the index of the field.</p>
+<p><dl class="simple">
+<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">type_ids</span></code>: An array of 8-bit signed integers, enumerated from 0 corresponding to each type. </p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">children</span></code>: Vector of children Arrays containing the data for each type. </p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">[out]</span> <span class="pre">out</span></code>: Will have length equal to type_ids.length() </p></li>
</ul>
</dd>
</dl>
@@ -563,25 +677,26 @@
<dl class="class">
<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>
+<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="sig-name 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 [...]
<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>
+<p>Subclassed by arrow::MapArray</p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric">Public Functions</p>
<dl class="function">
<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 [...]
+<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="sig-name descname">values</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const< [...]
<dd><p>Return array object containing the list’s values. </p>
</dd></dl>
<dl class="function">
<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">) [...]
+<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="sig-name descname">value_offsets</code><span class="sig-paren">(</span><span class="sig [...]
<dd><p>Note that this buffer does not account for any slice offset. </p>
</dd></dl>
<dl class="function">
<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 [...]
+<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="sig-name descname">raw_value_offsets</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" [...]
<dd><p>Return pointer to raw value offsets accounting for any slice offset. </p>
</dd></dl>
@@ -590,16 +705,15 @@
<p class="breathe-sectiondef-title rubric">Public Static Functions</p>
<dl class="function">
<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 [...]
+<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">
-<dt><strong>Parameters</strong></dt>
-<dd><ul class="breatheparameterlist first last simple">
-<li><code class="docutils literal notranslate"><span class="pre">offsets</span></code>: <a class="reference internal" href="#classarrow_1_1_array"><span class="std std-ref">Array</span></a> containing n + 1 offsets encoding length and size. Must be of int32 type </li>
-<li><code class="docutils literal notranslate"><span class="pre">values</span></code>: <a class="reference internal" href="#classarrow_1_1_array"><span class="std std-ref">Array</span></a> containing </li>
-<li><code class="docutils literal notranslate"><span class="pre">pool</span></code>: <a class="reference internal" href="memory.html#classarrow_1_1_memory_pool"><span class="std std-ref">MemoryPool</span></a> in case new offsets array needs to be allocated because of null values </li>
-<li><code class="docutils literal notranslate"><span class="pre">out</span></code>: Will have length equal to offsets.length() - 1 </li>
+<p><dl class="simple">
+<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">offsets</span></code>: <a class="reference internal" href="#classarrow_1_1_array"><span class="std std-ref">Array</span></a> containing n + 1 offsets encoding length and size. Must be of int32 type </p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">values</span></code>: <a class="reference internal" href="#classarrow_1_1_array"><span class="std std-ref">Array</span></a> containing </p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">pool</span></code>: <a class="reference internal" href="memory.html#classarrow_1_1_memory_pool"><span class="std std-ref">MemoryPool</span></a> in case new offsets array needs to be allocated because of null values </p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">[out]</span> <span class="pre">out</span></code>: Will have length equal to offsets.length() - 1 </p></li>
</ul>
</dd>
</dl>
@@ -611,25 +725,24 @@
<dl class="class">
<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">¶< [...]
+<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="sig-name 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 defin [...]
<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="_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">(</ [...]
+<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="sig-name descname">GetFieldByName</code><span class="sig-p [...]
<dd><p>Returns null if name not found. </p>
</dd></dl>
<dl class="function">
<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- [...]
+<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="sig-name descname">Flatten</code><span cl [...]
<dd><p>Flatten this array as a vector of arrays, one for each field. </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">pool</span></code>: The pool to allocate null bitmaps from, if necessary </li>
-<li><code class="docutils literal notranslate"><span class="pre">out</span></code>: The resulting vector of arrays </li>
+<p><dl class="simple">
+<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">pool</span></code>: The pool to allocate null bitmaps from, if necessary </p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">[out]</span> <span class="pre">out</span></code>: The resulting vector of arrays </p></li>
</ul>
</dd>
</dl>
@@ -637,6 +750,16 @@
</dd></dl>
</div>
+<div class="breathe-sectiondef docutils container">
+<p class="breathe-sectiondef-title rubric">Public Static Functions</p>
+<dl class="function">
+<dt id="_CPPv4N5arrow11StructArray4MakeERKNSt6vectorINSt10shared_ptrI5ArrayEEEERKNSt6vectorINSt6stringEEENSt10shared_ptrI6BufferEE7int64_t7int64_t">
+<span id="_CPPv3N5arrow11StructArray4MakeERKNSt6vectorINSt10shared_ptrI5ArrayEEEERKNSt6vectorINSt6stringEEENSt10shared_ptrI6BufferEE7int64_t7int64_t"></span><span id="_CPPv2N5arrow11StructArray4MakeERKNSt6vectorINSt10shared_ptrI5ArrayEEEERKNSt6vectorINSt6stringEEENSt10shared_ptrI6BufferEE7int64_t7int64_t"></span><span id="arrow::StructArray::Make__std::vector:std::shared_ptr:Array::CR.std::vector:ss:CR.std::shared_ptr:Buffer:.int64_t.int64_t"></span><span class="target" id="classarrow_1_ [...]
+<dd><p>Return a <a class="reference internal" href="#classarrow_1_1_struct_array"><span class="std std-ref">StructArray</span></a> from child arrays and field names. </p>
+<p>The length and data type are automatically inferred from the arguments. There should be at least one child array. </p>
+</dd></dl>
+
+</div>
</dd></dl>
</div>
@@ -645,71 +768,70 @@
<h2>Chunked Arrays<a class="headerlink" href="#chunked-arrays" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<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>
+<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="sig-name 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="_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 [...]
+<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="sig-name descname">ChunkedArray</code><span class="sig-paren">(</span><em class="property">const</em> ArrayVector &<em>chunks</em><span class="sig-paren">)</sp [...]
<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="_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 [...]
+<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="sig-name descname">ChunkedArray</code><span class="sig-paren">(</span><em class="property">const</em> std::shared_ptr<<a class= [...]
<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="_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 [...]
+<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="sig-name descname">ChunkedArray</code><span class="sig-paren">(</span><em cla [...]
<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="_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>
+<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="sig-name 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 [...]
+<dd><p><dl class="simple">
+<dt><strong>Return</strong></dt><dd><p>the total length of the chunked array; computed on construction </p>
+</dd>
</dl>
</p>
</dd></dl>
<dl class="function">
<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>
+<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="sig-name descname">null_count</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv4NK5arrow12ChunkedArray10null_count [...]
+<dd><p><dl class="simple">
+<dt><strong>Return</strong></dt><dd><p>the total number of nulls among all chunks </p>
+</dd>
</dl>
</p>
</dd></dl>
<dl class="function">
<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>
+<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="sig-name descname">chunk</code><span class="sig-paren">(</span>int <em>i</em><span class="sig-paren">)</span> [...]
+<dd><p><dl class="simple">
+<dt><strong>Return</strong></dt><dd><p>chunk a particular chunk from the chunked array </p>
+</dd>
</dl>
</p>
</dd></dl>
<dl class="function">
<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 [...]
+<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="sig-name descname">Slice</code><span class=" [...]
<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>
-<dd>a new object wrapped in std::shared_ptr<ChunkedArray> </dd>
-<dt><strong>Parameters</strong></dt>
-<dd><ul class="breatheparameterlist first last simple">
-<li><code class="docutils literal notranslate"><span class="pre">offset</span></code>: the position of the first element in the constructed slice </li>
-<li><code class="docutils literal notranslate"><span class="pre">length</span></code>: the length of the slice. If there are not enough elements in the chunked array, the length will be adjusted accordingly</li>
+<p><dl class="simple">
+<dt><strong>Return</strong></dt><dd><p>a new object wrapped in std::shared_ptr<ChunkedArray> </p>
+</dd>
+<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">offset</span></code>: the position of the first element in the constructed slice </p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">length</span></code>: the length of the slice. If there are not enough elements in the chunked array, the length will be adjusted accordingly</p></li>
</ul>
</dd>
</dl>
@@ -718,19 +840,18 @@
<dl class="function">
<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 [...]
+<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="sig-name descname">Slice</code><span class="sig-paren">(</span>int64 [...]
<dd><p>Slice from offset until end of the chunked array. </p>
</dd></dl>
<dl class="function">
<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 [...]
+<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>
-<dd><ul class="breatheparameterlist first last simple">
-<li><code class="docutils literal notranslate"><span class="pre">pool</span></code>: The pool for buffer allocations, if any </li>
-<li><code class="docutils literal notranslate"><span class="pre">out</span></code>: The resulting vector of arrays </li>
+<p><dl class="simple">
+<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">pool</span></code>: The pool for buffer allocations, if any </p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">[out]</span> <span class="pre">out</span></code>: The resulting vector of arrays </p></li>
</ul>
</dd>
</dl>
@@ -739,17 +860,23 @@
<dl class="function">
<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 [...]
+<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="sig-name descname">Equals</code><span class="sig-paren">(</span><em class="property">const</em> <a class="reference internal" href="#_CPPv4N5arrow12ChunkedArrayE" title="ar [...]
<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="_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 [...]
+<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="sig-name descname">Equals</code><span class="sig-paren">(</span><em class="property">const</em> std::shared_ptr<<a c [...]
<dd><p>Determine if two chunked arrays are equal. </p>
</dd></dl>
+<dl class="function">
+<dt id="_CPPv4NK5arrow12ChunkedArray8ValidateEv">
+<span id="_CPPv3NK5arrow12ChunkedArray8ValidateEv"></span><span id="_CPPv2NK5arrow12ChunkedArray8ValidateEv"></span><span id="arrow::ChunkedArray::ValidateC"></span><span class="target" id="classarrow_1_1_chunked_array_1a06ca5def32987d58b7577db269e39520"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status">Status</a> <code class="sig-name descname">Validate</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="pr [...]
+<dd><p>Check that all chunks have the same data type. </p>
+</dd></dl>
+
</div>
</dd></dl>
diff --git a/docs/cpp/api/builder.html b/docs/cpp/api/builder.html
index 2110c46..2e6daba 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.13.0</title>
+ <title>Array Builders — Apache Arrow v0.14.2.dev0+g5f564424c.d20190805</title>
@@ -61,7 +61,7 @@
<div class="version">
- 0.13.0
+ 0.14.2.dev0+g5f564424c.d20190805
</div>
@@ -92,6 +92,7 @@
<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>
+<li class="toctree-l1"><a class="reference internal" href="../../format/Flight.html">Arrow Flight RPC</a></li>
</ul>
<p class="caption"><span class="caption-text">Arrow Libraries</span></p>
<ul class="current">
@@ -110,6 +111,7 @@
<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>
+<li class="toctree-l3"><a class="reference internal" href="flight.html">Arrow Flight RPC</a></li>
</ul>
</li>
</ul>
@@ -122,6 +124,7 @@
<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/benchmarks.html">Benchmarks</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../developers/documentation.html">Building the Documentation</a></li>
</ul>
@@ -195,35 +198,34 @@
<h1>Array Builders<a class="headerlink" href="#array-builders" title="Permalink to this headline">¶</a></h1>
<dl class="class">
<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>
+<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="sig-name 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">
-<dt><strong>Note</strong></dt>
-<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>
+<p><dl class="simple">
+<dt><strong>Note</strong></dt><dd><p>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. </p>
+</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>, 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 [...]
+<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::DayTimeIntervalBuilder, arrow::DenseUnionBuilder, <a class="reference internal" href="#classarrow_1_1_dictionary_builder"><span class="std std-ref">arrow::DictionaryBuilder< T ></span></a>, arrow::Dictionar [...]
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric">Public Functions</p>
<dl class="function">
<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 [...]
+<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="sig-name descname">child</code><span class="sig-paren">(</span>int <em>i</em><span class="sig-paren">)</span><a c [...]
<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="_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 < [...]
+<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="sig-name descname">Resize</code><span class="sig-paren">(</span> [...]
<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>
+<p><dl class="simple">
+<dt><strong>Return</strong></dt><dd><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a> </p>
+</dd>
+<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">capacity</span></code>: the minimum number of total array values to accommodate. Must be greater than the current capacity. </p></li>
</ul>
</dd>
</dl>
@@ -232,14 +234,14 @@
<dl class="function">
<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 [...]
+<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="sig-name descname">Reserve</code><span class="sig-paren">(</span>int64_t <em>additional_capacit [...]
<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>
-<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">additional_capacity</span></code>: the number of additional array values </li>
+<p>Overallocation is used in order to minimize the impact of incremental <a class="reference internal" href="#classarrow_1_1_array_builder_1afe8448fda39a8529a119bde5ba7ba119"><span class="std std-ref">Reserve()</span></a> calls.</p>
+<p><dl class="simple">
+<dt><strong>Return</strong></dt><dd><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a> </p>
+</dd>
+<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">additional_capacity</span></code>: the number of additional array values </p></li>
</ul>
</dd>
</dl>
@@ -248,28 +250,27 @@
<dl class="function">
<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">¶ [...]
+<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="sig-name descname">Reset</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow12ArrayBuilder5ResetEv" title="Permalink to this defi [...]
<dd><p>Reset the builder. </p>
</dd></dl>
<dl class="function">
<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 [...]
+<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="sig-name descname">Advance</code><span class="sig-paren">(</span>int64_t <em>elements</em><span [...]
<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="_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"> [...]
+<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">
-<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>
+<p><dl class="simple">
+<dt><strong>Return</strong></dt><dd><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a> </p>
+</dd>
+<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
+<li><p><code class="docutils literal notranslate"><span class="pre">[out]</span> <span class="pre">out</span></code>: the finalized ArrayData object </p></li>
</ul>
</dd>
</dl>
@@ -278,15 +279,14 @@
<dl class="function">
<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">( [...]
+<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="sig-name descname">Finish</code><span class="sig [...]
<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">
-<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 <a class="reference internal" href="array.html#classarrow_1_1_array"><span class="std std-ref">Array</span></a> object </li>
+<p><dl class="simple">
+<dt><strong>Return</strong></dt><dd><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a> </p>
+</dd>
+<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
+<li><p><code class="docutils literal notranslate"><span class="pre">[out]</span> <span class="pre">out</span></code>: the finalized <a class="reference internal" href="array.html#classarrow_1_1_array"><span class="std std-ref">Array</span></a> object </p></li>
</ul>
</dd>
</dl>
@@ -300,32 +300,31 @@
<h2>Concrete builder subclasses<a class="headerlink" href="#concrete-builder-subclasses" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<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 [...]
+<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="sig-name 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="P [...]
<dd><div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric">Public Functions</p>
<dl class="function">
<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 [...]
+<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_1a16d3ef02a9cd9ac54c1d0f4c450e6d3b"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status">Status</a> <code class="sig-name descname">AppendNulls</code><span class="sig-paren">(</span>int64_t <em>leng [...]
<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 [...]
+<span id="_CPPv3N5arrow11NullBuilder10AppendNullEv"></span><span id="_CPPv2N5arrow11NullBuilder10AppendNullEv"></span><span id="arrow::NullBuilder::AppendNull"></span><span class="target" id="classarrow_1_1_null_builder_1af2c0562e2cb8a6e899bc07ab3c72858c"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status">Status</a> <code class="sig-name descname">AppendNull</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="h [...]
<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 [...]
+<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="sig-name descn [...]
<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>
+<p><dl class="simple">
+<dt><strong>Return</strong></dt><dd><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a> </p>
+</dd>
+<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
+<li><p><code class="docutils literal notranslate"><span class="pre">[out]</span> <span class="pre">out</span></code>: the finalized ArrayData object </p></li>
</ul>
</dd>
</dl>
@@ -337,39 +336,38 @@
<dl class="class">
<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" [...]
+<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="sig-name descname">BooleanBuilder</code> : <em class="property">public</em> arrow::<a class="reference internal" href="#_CPPv4N5arrow12ArrayBuilderE" title="arrow::ArrayBuilder">ArrayBuilder</a><a class="headerlink" href="#_CPPv4N5arrow14Boolean [...]
<dd><div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric">Public Functions</p>
<dl class="function">
<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 [...]
+<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_1a3ac08ddd73dd5be1d27f2f148cf95d75"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status">Status</a> <code class="sig-name descname">AppendNulls</code><span class="sig-paren">(</span>int6 [...]
<dd><p>Write nulls as uint8_t* (0 value indicates null) into pre-allocated memory. </p>
</dd></dl>
<dl class="function">
<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 [...]
+<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="sig-name descname">Append</code><span class="sig-paren">(</span><em class="property">const</em> bool <em>va [...]
<dd><p>Scalar append. </p>
</dd></dl>
<dl class="function">
<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 [...]
+<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="sig-name 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="#_CPPv4N [...]
<dd><p>Scalar append, without checking for capacity. </p>
</dd></dl>
<dl class="function">
<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"> [...]
+<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="sig-name d [...]
<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 array of bytes (non-zero is 1) </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>
+<p><dl class="simple">
+<dt><strong>Return</strong></dt><dd><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a> </p>
+</dd>
+<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">values</span></code>: a contiguous array of bytes (non-zero is 1) </p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">length</span></code>: the number of values to append </p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">valid_bytes</span></code>: an optional sequence of bytes where non-zero indicates a valid (non-null) value </p></li>
</ul>
</dd>
</dl>
@@ -378,16 +376,15 @@
<dl class="function">
<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 [...]
+<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>
-<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>
+<p><dl class="simple">
+<dt><strong>Return</strong></dt><dd><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a> </p>
+</dd>
+<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">values</span></code>: a contiguous C array of values </p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">length</span></code>: the number of values to append </p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">is_valid</span></code>: an std::vector<bool> indicating valid (1) or null (0). Equal in length to values </p></li>
</ul>
</dd>
</dl>
@@ -396,15 +393,14 @@
<dl class="function">
<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"> [...]
+<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>
-<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 bytes </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>
+<p><dl class="simple">
+<dt><strong>Return</strong></dt><dd><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a> </p>
+</dd>
+<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">values</span></code>: a std::vector of bytes </p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">is_valid</span></code>: an std::vector<bool> indicating valid (1) or null (0). Equal in length to values </p></li>
</ul>
</dd>
</dl>
@@ -413,14 +409,13 @@
<dl class="function">
<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 [...]
+<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="sig-name descname">Append [...]
<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 bytes </li>
+<p><dl class="simple">
+<dt><strong>Return</strong></dt><dd><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a> </p>
+</dd>
+<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">values</span></code>: a std::vector of bytes </p></li>
</ul>
</dd>
</dl>
@@ -429,15 +424,14 @@
<dl class="function">
<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 [...]
+<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>
-<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>: an std::vector<bool> indicating true (1) or false </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>
+<p><dl class="simple">
+<dt><strong>Return</strong></dt><dd><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a> </p>
+</dd>
+<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">values</span></code>: an std::vector<bool> indicating true (1) or false </p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">is_valid</span></code>: an std::vector<bool> indicating valid (1) or null (0). Equal in length to values </p></li>
</ul>
</dd>
</dl>
@@ -446,14 +440,13 @@
<dl class="function">
<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 [...]
+<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="sig-name descname">AppendValues</code><span c [...]
<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>: an std::vector<bool> indicating true (1) or false </li>
+<p><dl class="simple">
+<dt><strong>Return</strong></dt><dd><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a> </p>
+</dd>
+<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">values</span></code>: an std::vector<bool> indicating true (1) or false </p></li>
</ul>
</dd>
</dl>
@@ -461,16 +454,15 @@
</dd></dl>
<dl class="function">
-<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 [...]
+<dt id="_CPPv4I0EN5arrow14BooleanBuilder12AppendValuesE6Status10ValuesIter10ValuesIter">
+<span id="_CPPv3I0EN5arrow14BooleanBuilder12AppendValuesE10ValuesIter10ValuesIter"></span><span id="_CPPv2I0EN5arrow14BooleanBuilder12AppendValuesE10ValuesIter10ValuesIter"></span><span class="target" id="classarrow_1_1_boolean_builder_1ae2a6d1b574abe92480d25c9736c51e69"></span>template<typename <code class="sig-name descname">ValuesIter</code>><br /><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status">Status</a> <code class="sig-name descna [...]
<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 or null(0) values </li>
+<p><dl class="simple">
+<dt><strong>Return</strong></dt><dd><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a> </p>
+</dd>
+<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">values_begin</span></code>: InputIterator to the beginning of the values </p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">values_end</span></code>: InputIterator pointing to the end of the values or null(0) values </p></li>
</ul>
</dd>
</dl>
@@ -478,17 +470,16 @@
</dd></dl>
<dl class="function">
-<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 [...]
+<dt id="_CPPv4I00EN5arrow14BooleanBuilder12AppendValuesENSt9enable_ifIXntNSt10is_pointerI9ValidIterE5valueEE6StatusE4typeE10ValuesIter10ValuesIter9ValidIter">
+<span id="_CPPv3I00EN5arrow14BooleanBuilder12AppendValuesE10ValuesIter10ValuesIter9ValidIter"></span><span id="_CPPv2I00EN5arrow14BooleanBuilder12AppendValuesE10ValuesIter10ValuesIter9ValidIter"></span><span class="target" id="classarrow_1_1_boolean_builder_1a3e15348c55cf27f1f47d632facc88117"></span>template<typename <code class="sig-name descname">ValuesIter</code>, typename <code class="sig-name descname">ValidIter</code>><br />std::enable_if<!std::is_pointer<<a class="refe [...]
<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>
+<p><dl class="simple">
+<dt><strong>Return</strong></dt><dd><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a> </p>
+</dd>
+<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">values_begin</span></code>: InputIterator to the beginning of the values </p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">values_end</span></code>: InputIterator pointing to the end of the values </p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">valid_begin</span></code>: InputIterator with elements indication valid(1) or null(0) values </p></li>
</ul>
</dd>
</dl>
@@ -497,15 +488,14 @@
<dl class="function">
<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 [...]
+<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="si [...]
<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>
+<p><dl class="simple">
+<dt><strong>Return</strong></dt><dd><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a> </p>
+</dd>
+<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
+<li><p><code class="docutils literal notranslate"><span class="pre">[out]</span> <span class="pre">out</span></code>: the finalized ArrayData object </p></li>
</ul>
</dd>
</dl>
@@ -514,21 +504,20 @@
<dl class="function">
<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>
+<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="sig-name 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="_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 [...]
+<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="sig-name descname">Resize</code><span class="sig-paren">(</span>int64_t <em>capacity</em>< [...]
<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>
+<p><dl class="simple">
+<dt><strong>Return</strong></dt><dd><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a> </p>
+</dd>
+<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">capacity</span></code>: the minimum number of total array values to accommodate. Must be greater than the current capacity. </p></li>
</ul>
</dd>
</dl>
@@ -539,46 +528,45 @@
</dd></dl>
<dl class="class">
-<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 [...]
+<dt id="_CPPv4I0EN5arrow14NumericBuilderE">
+<span id="_CPPv3I0EN5arrow14NumericBuilderE"></span><span id="_CPPv2I0EN5arrow14NumericBuilderE"></span><span class="target" id="classarrow_1_1_numeric_builder"></span>template<typename <code class="sig-name descname">T</code>><br /><em class="property">class </em><code class="sig-name descname">NumericBuilder</code> : <em class="property">public</em> arrow::<a class="reference internal" href="#_CPPv4N5arrow12ArrayBuilderE" title="arrow::ArrayBuilder">ArrayBuilder</a><a class="head [...]
<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="_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"> [...]
+<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="sig-name descname">Append</code><span class="sig-paren">(</span><em class="p [...]
<dd><p>Append a single scalar and increase the size if necessary. </p>
</dd></dl>
<dl class="function">
<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 [...]
+<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_1a1e67c6dc6ade96b660c75ab3031ac8b7"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status">Status</a> <code class="sig-name descname">AppendNulls</code><span class="sig-paren">(</span>int6 [...]
<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 [...]
+<span id="_CPPv3N5arrow14NumericBuilder10AppendNullEv"></span><span id="_CPPv2N5arrow14NumericBuilder10AppendNullEv"></span><span id="arrow::NumericBuilder::AppendNull"></span><span class="target" id="classarrow_1_1_numeric_builder_1a1acc20f9680309d7ad1d55ab7401f815"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status">Status</a> <code class="sig-name descname">AppendNull</code><span class="sig-paren">(</span><span class="sig-paren">)</span [...]
<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>
+<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="sig-name 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 [...]
+<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="sig-name descname">Resize</code><span class="sig-paren">(</span>int64_t <em>capacity</em>< [...]
<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>
+<p><dl class="simple">
+<dt><strong>Return</strong></dt><dd><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a> </p>
+</dd>
+<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">capacity</span></code>: the minimum number of total array values to accommodate. Must be greater than the current capacity. </p></li>
</ul>
</dd>
</dl>
@@ -587,16 +575,15 @@
<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= [...]
+<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>
+<p><dl class="simple">
+<dt><strong>Return</strong></dt><dd><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a> </p>
+</dd>
+<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">values</span></code>: a contiguous C array of values </p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">length</span></code>: the number of values to append </p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">valid_bytes</span></code>: an optional sequence of bytes where non-zero indicates a valid (non-null) value </p></li>
</ul>
</dd>
</dl>
@@ -605,16 +592,15 @@
<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 [...]
+<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>
+<p><dl class="simple">
+<dt><strong>Return</strong></dt><dd><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a> </p>
+</dd>
+<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">values</span></code>: a contiguous C array of values </p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">length</span></code>: the number of values to append </p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">is_valid</span></code>: an std::vector<bool> indicating valid (1) or null (0). Equal in length to values </p></li>
</ul>
</dd>
</dl>
@@ -623,15 +609,14 @@
<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 [...]
+<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>
+<p><dl class="simple">
+<dt><strong>Return</strong></dt><dd><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a> </p>
+</dd>
+<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">values</span></code>: a std::vector of values </p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">is_valid</span></code>: an std::vector<bool> indicating valid (1) or null (0). Equal in length to values </p></li>
</ul>
</dd>
</dl>
@@ -640,14 +625,13 @@
<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 [...]
+<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="sig-name descn [...]
<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>
+<p><dl class="simple">
+<dt><strong>Return</strong></dt><dd><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a> </p>
+</dd>
+<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">values</span></code>: a std::vector of values </p></li>
</ul>
</dd>
</dl>
@@ -656,15 +640,14 @@
<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 [...]
+<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="si [...]
<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>
+<p><dl class="simple">
+<dt><strong>Return</strong></dt><dd><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a> </p>
+</dd>
+<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
+<li><p><code class="docutils literal notranslate"><span class="pre">[out]</span> <span class="pre">out</span></code>: the finalized ArrayData object </p></li>
</ul>
</dd>
</dl>
@@ -672,16 +655,15 @@
</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 [...]
+<dt id="_CPPv4I0EN5arrow14NumericBuilder12AppendValuesE6Status10ValuesIter10ValuesIter">
+<span id="_CPPv3I0EN5arrow14NumericBuilder12AppendValuesE10ValuesIter10ValuesIter"></span><span id="_CPPv2I0EN5arrow14NumericBuilder12AppendValuesE10ValuesIter10ValuesIter"></span><span class="target" id="classarrow_1_1_numeric_builder_1a9c3316f90bbf3c02d12bca34739456c5"></span>template<typename <code class="sig-name descname">ValuesIter</code>><br /><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status">Status</a> <code class="sig-name descna [...]
<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>
+<p><dl class="simple">
+<dt><strong>Return</strong></dt><dd><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a> </p>
+</dd>
+<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">values_begin</span></code>: InputIterator to the beginning of the values </p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">values_end</span></code>: InputIterator pointing to the end of the values </p></li>
</ul>
</dd>
</dl>
@@ -689,17 +671,16 @@
</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 [...]
+<dt id="_CPPv4I00EN5arrow14NumericBuilder12AppendValuesENSt9enable_ifIXntNSt10is_pointerI9ValidIterE5valueEE6StatusE4typeE10ValuesIter10ValuesIter9ValidIter">
+<span id="_CPPv3I00EN5arrow14NumericBuilder12AppendValuesE10ValuesIter10ValuesIter9ValidIter"></span><span id="_CPPv2I00EN5arrow14NumericBuilder12AppendValuesE10ValuesIter10ValuesIter9ValidIter"></span><span class="target" id="classarrow_1_1_numeric_builder_1a60372f6f793c3135c43f08775c514823"></span>template<typename <code class="sig-name descname">ValuesIter</code>, typename <code class="sig-name descname">ValidIter</code>><br />std::enable_if<!std::is_pointer<<a class="refe [...]
<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>
+<p><dl class="simple">
+<dt><strong>Return</strong></dt><dd><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a> </p>
+</dd>
+<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">values_begin</span></code>: InputIterator to the beginning of the values </p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">values_end</span></code>: InputIterator pointing to the end of the values </p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">valid_begin</span></code>: InputIterator with elements indication valid(1) or null(0) values. </p></li>
</ul>
</dd>
</dl>
@@ -708,7 +689,7 @@
<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 [...]
+<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="sig-name descname">UnsafeAppend</code><span class="sig-paren">(</span><em class="property">const</em> value_type <em>val</em><span class="sig-paren">)</span [...]
<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>
@@ -718,35 +699,34 @@
<dl class="class">
<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 [...]
+<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="sig-name descname">BinaryBuilder</code> : <em class="property">public</em> arrow::<a class="reference internal" href="#_CPPv4N5arrow12ArrayBuilderE" title="arrow::ArrayBuilder">ArrayBuilder</a><a class="headerlink" href="#_CPPv4N5arrow13BinaryBuilde [...]
<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="_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 [...]
+<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="sig-name descname">UnsafeAppend</code><span class="sig-paren">(</span><em class="property">const</em> uint8_t *<em>value</em>, int32_t <em>lengt [...]
<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="_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>
+<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="sig-name 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="_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 [...]
+<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="sig-name descname">Resize</code><span class="sig-paren">(</span>int64_t <em>capacity</em><span [...]
<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>
+<p><dl class="simple">
+<dt><strong>Return</strong></dt><dd><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a> </p>
+</dd>
+<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">capacity</span></code>: the minimum number of total array values to accommodate. Must be greater than the current capacity. </p></li>
</ul>
</dd>
</dl>
@@ -755,21 +735,20 @@
<dl class="function">
<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 [...]
+<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="sig-name descname">ReserveData</code><span class="sig-paren">(</span>int64_t [...]
<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="_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 [...]
+<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="sig-na [...]
<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>
+<p><dl class="simple">
+<dt><strong>Return</strong></dt><dd><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a> </p>
+</dd>
+<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
+<li><p><code class="docutils literal notranslate"><span class="pre">[out]</span> <span class="pre">out</span></code>: the finalized ArrayData object </p></li>
</ul>
</dd>
</dl>
@@ -778,34 +757,34 @@
<dl class="function">
<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>
+<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="sig-name descname">value_data_length</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv4NK [...]
+<dd><p><dl class="simple">
+<dt><strong>Return</strong></dt><dd><p>size of values buffer so far </p>
+</dd>
</dl>
</p>
</dd></dl>
<dl class="function">
<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>
+<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="sig-name descname">value_data_capacity</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="# [...]
+<dd><p><dl class="simple">
+<dt><strong>Return</strong></dt><dd><p>capacity of values buffer </p>
+</dd>
</dl>
</p>
</dd></dl>
<dl class="function">
<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- [...]
+<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="sig-name descname">GetValue</code><span class="sig-paren">(</span>int64_t <em>i</em>, int32_t *<em>out_length</em><span cl [...]
<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="_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 [...]
+<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="sig-name 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=" [...]
<dd><p>Temporary access to a value. </p>
<p>This view becomes invalid on the next modifying operation. </p>
</dd></dl>
@@ -815,21 +794,20 @@
<dl class="class">
<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 [...]
+<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="sig-name descname">StringBuilder</code> : <em class="property">public</em> arrow::<a class="reference internal" href="#_CPPv4N5arrow13BinaryBuilderE" title="arrow::BinaryBuilder">BinaryBuilder</a><a class="headerlink" href="#_CPPv4N5arrow13StringBui [...]
<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="_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 [...]
+<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>
-<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 vector of strings </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>
+<p><dl class="simple">
+<dt><strong>Return</strong></dt><dd><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a> </p>
+</dd>
+<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">values</span></code>: a vector of strings </p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">valid_bytes</span></code>: an optional sequence of bytes where non-zero indicates a valid (non-null) value </p></li>
</ul>
</dd>
</dl>
@@ -838,17 +816,16 @@
<dl class="function">
<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 [...]
+<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="sig-name descname">AppendValues [...]
<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">
-<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 nul-terminated char * </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>
+<p><dl class="simple">
+<dt><strong>Return</strong></dt><dd><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a> </p>
+</dd>
+<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">values</span></code>: a contiguous C array of nul-terminated char * </p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">length</span></code>: the number of values to append </p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">valid_bytes</span></code>: an optional sequence of bytes where non-zero indicates a valid (non-null) value </p></li>
</ul>
</dd>
</dl>
@@ -857,7 +834,7 @@
<dl class="function">
<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 [...]
+<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="sig-name descname">UnsafeAppend</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow13BinaryBuilder12UnsafeAppendEv" title="Permalink to [...]
<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>
@@ -867,27 +844,26 @@
<dl class="class">
<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 [...]
+<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="sig-name descname">FixedSizeBinaryBuilder</code> : <em class="property">public</em> arrow::<a class="reference internal" href="#_CPPv4N5arrow12ArrayBuilderE" title="arrow::ArrayBuilder">ArrayBuilder</a><a class= [...]
<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="_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 [...]
+<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="sig-name descname">Reset</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow22FixedSizeBinaryBuilder5ResetEv" title="Perm [...]
<dd><p>Reset the builder. </p>
</dd></dl>
<dl class="function">
<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 [...]
+<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="sig-name descname">Resize</code><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">
-<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>
+<p><dl class="simple">
+<dt><strong>Return</strong></dt><dd><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a> </p>
+</dd>
+<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">capacity</span></code>: the minimum number of total array values to accommodate. Must be greater than the current capacity. </p></li>
</ul>
</dd>
</dl>
@@ -896,15 +872,14 @@
<dl class="function">
<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:: [...]
+<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">
-<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>
+<p><dl class="simple">
+<dt><strong>Return</strong></dt><dd><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a> </p>
+</dd>
+<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
+<li><p><code class="docutils literal notranslate"><span class="pre">[out]</span> <span class="pre">out</span></code>: the finalized ArrayData object </p></li>
</ul>
</dd>
</dl>
@@ -913,24 +888,24 @@
<dl class="function">
<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>
+<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="sig-name descname">value_data_length</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em [...]
+<dd><p><dl class="simple">
+<dt><strong>Return</strong></dt><dd><p>size of values buffer so far </p>
+</dd>
</dl>
</p>
</dd></dl>
<dl class="function">
<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 [...]
+<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="sig-name descname">GetValue</code><span class="sig-paren">(</span>int64_t <em>i</em><span class="sig-paren">)</ [...]
<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="_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 [...]
+<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="sig-name descname">GetView</code><span class="sig-paren">(</span>int64_t <em>i</em><span class="sig-paren">)</span> <em class="property"> [...]
<dd><p>Temporary access to a value. </p>
<p>This view becomes invalid on the next modifying operation. </p>
</dd></dl>
@@ -940,20 +915,19 @@
<dl class="class">
<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 [...]
+<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="sig-name descname">Decimal128Builder</code> : <em class="property">public</em> arrow::<a class="reference internal" href="#_CPPv4N5arrow22FixedSizeBinaryBuilderE" title="arrow::FixedSizeBinaryBuilder">FixedSizeBinaryBuilder</a><a cla [...]
<dd><div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric">Public Functions</p>
<dl class="function">
<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 [...]
+<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">
-<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>
+<p><dl class="simple">
+<dt><strong>Return</strong></dt><dd><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a> </p>
+</dd>
+<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
+<li><p><code class="docutils literal notranslate"><span class="pre">[out]</span> <span class="pre">out</span></code>: the finalized ArrayData object </p></li>
</ul>
</dd>
</dl>
@@ -965,7 +939,7 @@
<dl class="class">
<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 [...]
+<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="sig-name 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="P [...]
<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>
@@ -973,21 +947,20 @@
<p class="breathe-sectiondef-title rubric">Public Functions</p>
<dl class="function">
<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 [...]
+<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_1ae00e12937a53a7f2603342c2d4eb406c"></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="_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 [...]
+<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="sig-name descname">Resize</code><span class="sig-paren">(</span>int64_t <em>capacity</em><span class=" [...]
<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>
+<p><dl class="simple">
+<dt><strong>Return</strong></dt><dd><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a> </p>
+</dd>
+<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">capacity</span></code>: the minimum number of total array values to accommodate. Must be greater than the current capacity. </p></li>
</ul>
</dd>
</dl>
@@ -996,21 +969,20 @@
<dl class="function">
<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>
+<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="sig-name 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="_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 [...]
+<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="sig-name descn [...]
<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>
+<p><dl class="simple">
+<dt><strong>Return</strong></dt><dd><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a> </p>
+</dd>
+<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
+<li><p><code class="docutils literal notranslate"><span class="pre">[out]</span> <span class="pre">out</span></code>: the finalized ArrayData object </p></li>
</ul>
</dd>
</dl>
@@ -1019,14 +991,14 @@
<dl class="function">
<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 [...]
+<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="sig-name descname">App [...]
<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="_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 [...]
+<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="sig-name descname">Append</code><span class="sig-paren">(</span>bool <em>is_valid</em> = true<span class="sig-paren">)</sp [...]
<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>
@@ -1036,22 +1008,21 @@
<dl class="class">
<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 [...]
+<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="sig-name descname">StructBuilder</code> : <em class="property">public</em> arrow::<a class="reference internal" href="#_CPPv4N5arrow12ArrayBuilderE" title="arrow::ArrayBuilder">ArrayBuilder</a><a class="headerlink" href="#_CPPv4N5arrow13StructBuilde [...]
<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="_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 [...]
+<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="sig-na [...]
<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>
+<p><dl class="simple">
+<dt><strong>Return</strong></dt><dd><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a> </p>
+</dd>
+<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
+<li><p><code class="docutils literal notranslate"><span class="pre">[out]</span> <span class="pre">out</span></code>: the finalized ArrayData object </p></li>
</ul>
</dd>
</dl>
@@ -1060,20 +1031,20 @@
<dl class="function">
<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 [...]
+<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="sig-name descname">AppendValues</code><span [...]
<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="_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 [...]
+<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="sig-name descname">Append</code><span class="sig-paren">(</span>bool <em>is_valid</em> = true<span class="sig-pare [...]
<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="_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>
+<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="sig-name 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>
@@ -1081,8 +1052,8 @@
</dd></dl>
<dl class="class">
-<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 [...]
+<dt id="_CPPv4I0EN5arrow17DictionaryBuilderE">
+<span id="_CPPv3I0EN5arrow17DictionaryBuilderE"></span><span id="_CPPv2I0EN5arrow17DictionaryBuilderE"></span><span class="target" id="classarrow_1_1_dictionary_builder"></span>template<typename <code class="sig-name descname">T</code>><br /><em class="property">class </em><code class="sig-name descname">DictionaryBuilder</code> : <em class="property">public</em> arrow::<a class="reference internal" href="#_CPPv4N5arrow12ArrayBuilderE" title="arrow::ArrayBuilder">ArrayBuilder</a><a [...]
<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>
@@ -1090,51 +1061,50 @@
<p class="breathe-sectiondef-title rubric">Public Functions</p>
<dl class="function">
<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" [...]
+<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="sig-name descname">Append</code><span class="sig-paren">(</span><em class=" [...]
<dd><p>Append a scalar value. </p>
</dd></dl>
<dl class="function">
-<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>< [...]
+<dt id="_CPPv4I0EN5arrow17DictionaryBuilder6AppendE6StatusNSt9enable_ifINSt10is_base_ofI19FixedSizeBinaryType2T1E5valueEPK7uint8_tE4typeE">
+<span id="_CPPv3I0EN5arrow17DictionaryBuilder6AppendENSt9enable_ifINSt10is_base_ofI19FixedSizeBinaryType2T1E5valueEPK7uint8_tE4typeE"></span><span id="_CPPv2I0EN5arrow17DictionaryBuilder6AppendENSt9enable_ifINSt10is_base_ofI19FixedSizeBinaryType2T1E5valueEPK7uint8_tE4typeE"></span><span class="target" id="classarrow_1_1_dictionary_builder_1adf4e20217353fb246aa54ead52f45e20"></span>template<typename <code class="sig-name descname">T1</code> = T><br /><a class="reference internal" hr [...]
<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="_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 [...]
+<dt id="_CPPv4I0EN5arrow17DictionaryBuilder6AppendE6StatusNSt9enable_ifINSt10is_base_ofI19FixedSizeBinaryType2T1E5valueEPKcE4typeE">
+<span id="_CPPv3I0EN5arrow17DictionaryBuilder6AppendENSt9enable_ifINSt10is_base_ofI19FixedSizeBinaryType2T1E5valueEPKcE4typeE"></span><span id="_CPPv2I0EN5arrow17DictionaryBuilder6AppendENSt9enable_ifINSt10is_base_ofI19FixedSizeBinaryType2T1E5valueEPKcE4typeE"></span><span class="target" id="classarrow_1_1_dictionary_builder_1a730d2bab01899f4a92d1b0343dbebfea"></span>template<typename <code class="sig-name descname">T1</code> = T><br /><a class="reference internal" href="support.ht [...]
<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="_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 [...]
+<span id="_CPPv3N5arrow17DictionaryBuilder10AppendNullEv"></span><span id="_CPPv2N5arrow17DictionaryBuilder10AppendNullEv"></span><span id="arrow::DictionaryBuilder::AppendNull"></span><span class="target" id="classarrow_1_1_dictionary_builder_1a0619e3dfda70e50a1d61716ed55d25be"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status">Status</a> <code class="sig-name descname">AppendNull</code><span class="sig-paren">(</span><span class="sig-pa [...]
<dd><p>Append a scalar null value. </p>
</dd></dl>
<dl class="function">
-<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>< [...]
+<dt id="_CPPv4I0EN5arrow17DictionaryBuilder11AppendArrayE6StatusNSt9enable_ifIXntNSt10is_base_ofI19FixedSizeBinaryType2T1E5valueEERK5ArrayE4typeE">
+<span id="_CPPv3I0EN5arrow17DictionaryBuilder11AppendArrayENSt9enable_ifIXntNSt10is_base_ofI19FixedSizeBinaryType2T1E5valueEERK5ArrayE4typeE"></span><span id="_CPPv2I0EN5arrow17DictionaryBuilder11AppendArrayENSt9enable_ifIX!std::is_base_of<FixedSizeBinaryType, T1>::valueERK5ArrayE4typeE"></span><span class="target" id="classarrow_1_1_dictionary_builder_1a473f93a4f217e95de42aebdc10a03188"></span>template<typename <code class="sig-name descname">T1</code> = T><br /><a class="referenc [...]
<dd><p>Append a whole dense array to the builder. </p>
</dd></dl>
<dl class="function">
<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>
+<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="sig-name descname">Reset</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow17DictionaryBuilder5ResetEv" title="Permalink to this definition">¶ [...]
<dd><p>Reset the builder. </p>
</dd></dl>
<dl class="function">
<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 [...]
+<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="sig-name descname">Resize</code><span class="sig-paren">(</span>int64_t <em>ca [...]
<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>
+<p><dl class="simple">
+<dt><strong>Return</strong></dt><dd><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a> </p>
+</dd>
+<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">capacity</span></code>: the minimum number of total array values to accommodate. Must be greater than the current capacity. </p></li>
</ul>
</dd>
</dl>
@@ -1143,15 +1113,14 @@
<dl class="function">
<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 [...]
+<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">
-<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>
+<p><dl class="simple">
+<dt><strong>Return</strong></dt><dd><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a> </p>
+</dd>
+<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
+<li><p><code class="docutils literal notranslate"><span class="pre">[out]</span> <span class="pre">out</span></code>: the finalized ArrayData object </p></li>
</ul>
</dd>
</dl>
@@ -1160,7 +1129,7 @@
<dl class="function">
<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 [...]
+<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="sig-name descname">is_building_delta</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow17DictionaryBuild [...]
<dd><p>is the dictionary builder in the delta building mode </p>
</dd></dl>
diff --git a/docs/cpp/api/cuda.html b/docs/cpp/api/cuda.html
index 12f4427..74695d5 100644
--- a/docs/cpp/api/cuda.html
+++ b/docs/cpp/api/cuda.html
@@ -9,7 +9,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>CUDA support — Apache Arrow v0.13.0</title>
+ <title>CUDA support — Apache Arrow v0.14.2.dev0+g5f564424c.d20190805</title>
@@ -36,7 +36,7 @@
<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="next" title="Arrow Flight RPC" href="flight.html" />
<link rel="prev" title="Utilities" href="utilities.html" />
</head>
@@ -61,7 +61,7 @@
<div class="version">
- 0.13.0
+ 0.14.2.dev0+g5f564424c.d20190805
</div>
@@ -92,6 +92,7 @@
<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>
+<li class="toctree-l1"><a class="reference internal" href="../../format/Flight.html">Arrow Flight RPC</a></li>
</ul>
<p class="caption"><span class="caption-text">Arrow Libraries</span></p>
<ul class="current">
@@ -113,6 +114,7 @@
<li class="toctree-l4"><a class="reference internal" href="#cuda-ipc">CUDA IPC</a></li>
</ul>
</li>
+<li class="toctree-l3"><a class="reference internal" href="flight.html">Arrow Flight RPC</a></li>
</ul>
</li>
</ul>
@@ -125,6 +127,7 @@
<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/benchmarks.html">Benchmarks</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../developers/documentation.html">Building the Documentation</a></li>
</ul>
@@ -200,18 +203,17 @@
<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>
+<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="sig-name 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 [...]
+<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>
+<p><dl class="simple">
+<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">device_number</span></code>: the CUDA device </p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">[out]</span> <span class="pre">out</span></code>: cached context </p></li>
</ul>
</dd>
</dl>
@@ -220,14 +222,13 @@
<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 [...]
+<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>
+<p><dl class="simple">
+<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">device_number</span></code>: the CUDA device </p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">handle</span></code>: CUDA context handler created by another library </p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">[out]</span> <span class="pre">out</span></code>: shared context </p></li>
</ul>
</dd>
</dl>
@@ -236,14 +237,13 @@
<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. [...]
+<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>
+<p><dl class="simple">
+<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">device_number</span></code>: the CUDA device </p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">nbytes</span></code>: number of bytes </p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">[out]</span> <span class="pre">out</span></code>: the allocated buffer </p></li>
</ul>
</dd>
</dl>
@@ -255,21 +255,20 @@
<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 [...]
+<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="sig-name 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 cl [...]
<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 [...]
+<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>
+<p><dl class="simple">
+<dt><strong>Return</strong></dt><dd><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a> </p>
+</dd>
+<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">nbytes</span></code>: number of bytes </p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">[out]</span> <span class="pre">out</span></code>: the allocated buffer </p></li>
</ul>
</dd>
</dl>
@@ -278,18 +277,17 @@
<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 [...]
+<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>
+<p><dl class="simple">
+<dt><strong>Return</strong></dt><dd><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a></p>
+</dd>
+<dt><strong>Note</strong></dt><dd><p>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. </p>
+</dd>
+<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">data</span></code>: the starting device address </p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">nbytes</span></code>: number of bytes </p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">[out]</span> <span class="pre">out</span></code>: the view buffer </p></li>
</ul>
</dd>
</dl>
@@ -298,15 +296,14 @@
<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 [...]
+<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>
+<p><dl class="simple">
+<dt><strong>Return</strong></dt><dd><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a> </p>
+</dd>
+<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">ipc_handle</span></code>: opaque pointer to CUipcMemHandle (driver API) </p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">[out]</span> <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 </p></li>
</ul>
</dd>
</dl>
@@ -315,14 +312,13 @@
<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 [...]
+<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="sig-name descname">CloseIpcBuffer</cod [...]
<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>
+<p><dl class="simple">
+<dt><strong>Return</strong></dt><dd><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a> </p>
+</dd>
+<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <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 </p></li>
</ul>
</dd>
</dl>
@@ -331,34 +327,49 @@
<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 [...]
+<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="sig-name descname">Synchronize</code><span class="sig-paren">(</span>void<span [...]
<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= [...]
+<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="sig-name descname">handle</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv4NK5arrow4cuda11CudaContext6handleE [...]
<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 [...]
+<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="sig-name descname">device_number</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv4NK5arr [...]
<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 [...]
+<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="sig-name desc [...]
<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>
+<dl class="simple">
+<dt><strong>Return</strong></dt><dd><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a></p>
+</dd>
+<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">addr</span></code>: device or host memory address </p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">[out]</span> <span class="pre">devaddr</span></code>: the device address </p></li>
+</ul>
+</dd>
+</dl>
+</p>
+</dd></dl>
+
+<dl class="function">
+<dt id="_CPPv4N5arrow4cuda11CudaContext4FreeEPv7int64_t">
+<span id="_CPPv3N5arrow4cuda11CudaContext4FreeEPv7int64_t"></span><span id="_CPPv2N5arrow4cuda11CudaContext4FreeEPv7int64_t"></span><span id="arrow::cuda::CudaContext::Free__voidP.int64_t"></span><span class="target" id="classarrow_1_1cuda_1_1_cuda_context_1aa08710d029fe38ea3ec8ad065ffe50fa"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status">Status</a> <code class="sig-name descname">Free</code><span class="sig-paren">(</span>void *<em>de [...]
+<dd><p>Release CUDA memory on GPU device for this context. </p>
+<p><dl class="simple">
+<dt><strong>Return</strong></dt><dd><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a> </p>
+</dd>
+<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">device_ptr</span></code>: the buffer address </p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">nbytes</span></code>: number of bytes </p></li>
</ul>
</dd>
</dl>
@@ -373,23 +384,22 @@
<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 [...]
+<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="sig-name 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="#_CPPv4N5arrow4cuda10CudaBu [...]
<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 [...]
+<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="sig-name descname">CopyTo [...]
<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>
+<p><dl class="simple">
+<dt><strong>Return</strong></dt><dd><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a> </p>
+</dd>
+<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">position</span></code>: start position inside buffer to copy bytes from </p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">nbytes</span></code>: number of bytes to copy </p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">[out]</span> <span class="pre">out</span></code>: start address of the host memory area to copy to </p></li>
</ul>
</dd>
</dl>
@@ -398,16 +408,15 @@
<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 [...]
+<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="sig-name descname">Cop [...]
<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>
+<p><dl class="simple">
+<dt><strong>Return</strong></dt><dd><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a> </p>
+</dd>
+<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">position</span></code>: start position to copy bytes to </p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">data</span></code>: the host data to copy </p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">nbytes</span></code>: number of bytes to copy </p></li>
</ul>
</dd>
</dl>
@@ -416,18 +425,17 @@
<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 [...]
+<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="sig-name descnam [...]
<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>
+<p><dl class="simple">
+<dt><strong>Return</strong></dt><dd><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a></p>
+</dd>
+<dt><strong>Note</strong></dt><dd><p>It is assumed that both source and destination device memories have been allocated within the same context. </p>
+</dd>
+<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">position</span></code>: start position inside buffer to copy bytes to </p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">data</span></code>: start address of the device memory area to copy from </p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">nbytes</span></code>: number of bytes to copy </p></li>
</ul>
</dd>
</dl>
@@ -436,17 +444,16 @@
<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 [...]
+<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>
+<p><dl class="simple">
+<dt><strong>Return</strong></dt><dd><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a> </p>
+</dd>
+<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">src_ctx</span></code>: context of the source device memory </p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">position</span></code>: start position inside buffer to copy bytes to </p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">data</span></code>: start address of the another device memory area to copy from </p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">nbytes</span></code>: number of bytes to copy </p></li>
</ul>
</dd>
</dl>
@@ -455,16 +462,15 @@
<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 [...]
+<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>
+<p><dl class="simple">
+<dt><strong>Return</strong></dt><dd><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a></p>
+</dd>
+<dt><strong>Note</strong></dt><dd><p>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 </p>
+</dd>
+<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
+<li><p><code class="docutils literal notranslate"><span class="pre">[out]</span> <span class="pre">handle</span></code>: the exported IPC handle </p></li>
</ul>
</dd>
</dl>
@@ -476,17 +482,16 @@
<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 [...]
+<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>
+<p><dl class="simple">
+<dt><strong>Return</strong></dt><dd><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a></p>
+</dd>
+<dt><strong>Note</strong></dt><dd><p>This function returns an error if the buffer isn’t backed by GPU memory </p>
+</dd>
+<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">buffer</span></code>: buffer to convert </p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">[out]</span> <span class="pre">out</span></code>: conversion result </p></li>
</ul>
</dd>
</dl>
@@ -498,16 +503,15 @@
<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 [...]
+<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>
+<p><dl class="simple">
+<dt><strong>Return</strong></dt><dd><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a> </p>
+</dd>
+<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">device_number</span></code>: device to expose host memory </p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">size</span></code>: number of bytes </p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">[out]</span> <span class="pre">out</span></code>: the allocated buffer </p></li>
</ul>
</dd>
</dl>
@@ -516,7 +520,7 @@
<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" [...]
+<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="sig-name descname">CudaHostBuffer</code> : <em class="property">public</em> arrow::<a class="reference internal" href="memory.html#_CPPv4N5arrow13MutableBufferE" title="arrow::MutableBuffer">MutableBuffer</a><a class="he [...]
<dd><p>Device-accessible CPU memory created using cudaHostAlloc. </p>
</dd></dl>
@@ -525,21 +529,20 @@
<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>
+<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="sig-name descname">CudaBufferReader</code> : <em class="property">public</em> arrow::io::BufferReader<a class="headerlink" href="#_CPPv4N5arrow4cuda16CudaBufferReaderE" title="Permalink to this definition">¶</a>< [...]
<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 [...]
+<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="sig-name descname">Read</c [...]
<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>
+<p><dl class="simple">
+<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">nbytes</span></code>: number of bytes to read </p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">[out]</span> <span class="pre">bytes_read</span></code>: actual number of bytes read </p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">[out]</span> <span class="pre">buffer</span></code>: pre-allocated memory to write into </p></li>
</ul>
</dd>
</dl>
@@ -548,15 +551,14 @@
<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> [...]
+<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>
+<p><dl class="simple">
+<dt><strong>Return</strong></dt><dd><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a> </p>
+</dd>
+<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">nbytes</span></code>: number of bytes to read </p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">[out]</span> <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 </p></li>
</ul>
</dd>
</dl>
@@ -568,33 +570,32 @@
<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>
+<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="sig-name descname">CudaBufferWriter</code> : <em class="property">public</em> arrow::io::WritableFile<a class="headerlink" href="#_CPPv4N5arrow4cuda16CudaBufferWriterE" title="Permalink to this definition">¶</a>< [...]
<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 [...]
+<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="sig-name descname">Close</code><span class="sig-paren">(</span><span class="sig-par [...]
<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 [...]
+<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="sig-name descname">Flush</code><span class="sig-paren">(</span><span class="sig-par [...]
<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>< [...]
+<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="sig-name descname">SetBufferSiz [...]
<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>
+<dl class="simple">
+<dt><strong>Return</strong></dt><dd><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a></p>
+</dd>
+<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">buffer_size</span></code>: the size of CPU buffer to allocate </p></li>
</ul>
</dd>
</dl>
@@ -603,13 +604,13 @@
<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 [...]
+<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="sig-name descname">buffer_size</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" hr [...]
<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 [...]
+<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="sig-name descname">num_bytes_buffered</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const< [...]
<dd><p>Returns number of bytes buffered on host. </p>
</dd></dl>
@@ -621,20 +622,19 @@
<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>
+<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="sig-name 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" [...]
+<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>
+<p><dl class="simple">
+<dt><strong>Return</strong></dt><dd><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a> </p>
+</dd>
+<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <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 </p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">[out]</span> <span class="pre">out</span></code>: the serialized buffer </p></li>
</ul>
</dd>
</dl>
@@ -646,15 +646,14 @@
<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" [...]
+<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>
+<p>from another process) <dl class="simple">
+<dt><strong>Return</strong></dt><dd><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a> </p>
+</dd>
+<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">opaque_handle</span></code>: a CUipcMemHandle as a const void* </p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">[out]</span> <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 </p></li>
</ul>
</dd>
</dl>
@@ -666,16 +665,15 @@
<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 [...]
+<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>
+<p><dl class="simple">
+<dt><strong>Return</strong></dt><dd><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a> </p>
+</dd>
+<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">batch</span></code>: record batch to write </p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <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 </p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">[out]</span> <span class="pre">out</span></code>: the returned device buffer which contains the record batch message </p></li>
</ul>
</dd>
</dl>
@@ -684,15 +682,14 @@
<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 [...]
+<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>
+<p><dl class="simple">
+<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <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 </p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <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 </p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <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 </p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">[out]</span> <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 </p></li>
</ul>
</dd>
</dl>
@@ -710,7 +707,7 @@
<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="flight.html" class="btn btn-neutral float-right" title="Arrow Flight RPC" 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>
diff --git a/docs/cpp/api/datatype.html b/docs/cpp/api/datatype.html
index 82379ea..2e57665 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.13.0</title>
+ <title>Data Types — Apache Arrow v0.14.2.dev0+g5f564424c.d20190805</title>
@@ -61,7 +61,7 @@
<div class="version">
- 0.13.0
+ 0.14.2.dev0+g5f564424c.d20190805
</div>
@@ -92,6 +92,7 @@
<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>
+<li class="toctree-l1"><a class="reference internal" href="../../format/Flight.html">Arrow Flight RPC</a></li>
</ul>
<p class="caption"><span class="caption-text">Arrow Libraries</span></p>
<ul class="current">
@@ -112,6 +113,7 @@
<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>
+<li class="toctree-l3"><a class="reference internal" href="flight.html">Arrow Flight RPC</a></li>
</ul>
</li>
</ul>
@@ -124,6 +126,7 @@
<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/benchmarks.html">Benchmarks</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../developers/documentation.html">Building the Documentation</a></li>
</ul>
@@ -195,192 +198,205 @@
<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">
+<dl class="enum">
<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>
+<span id="_CPPv3N5arrow4Type4typeE"></span><span id="_CPPv2N5arrow4Type4typeE"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44"></span><em class="property">enum </em><code class="sig-prename descclassname">arrow::Type<code class="sig-prename descclassname">::</code></code><code class="sig-name 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="_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>
+<span id="_CPPv3N5arrow4Type2NAE"></span><span id="_CPPv2N5arrow4Type2NAE"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44af46d8600b17dd993097e0875a46e0b15"></span><code class="sig-name 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="_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>
+<span id="_CPPv3N5arrow4Type4BOOLE"></span><span id="_CPPv2N5arrow4Type4BOOLE"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44ae4bb4146eedf3fb5a517780000001b30"></span><code class="sig-name 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="_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>
+<span id="_CPPv3N5arrow4Type5UINT8E"></span><span id="_CPPv2N5arrow4Type5UINT8E"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44ab8f52afb784526f800c91de101673b42"></span><code class="sig-name 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="_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>
+<span id="_CPPv3N5arrow4Type4INT8E"></span><span id="_CPPv2N5arrow4Type4INT8E"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44adf9f694eb598f6f8cac8bed3da547d65"></span><code class="sig-name 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="_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>
+<span id="_CPPv3N5arrow4Type6UINT16E"></span><span id="_CPPv2N5arrow4Type6UINT16E"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44a87c4272d67d3a84ed9ce6c6a9a4a6772"></span><code class="sig-name 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="_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>
+<span id="_CPPv3N5arrow4Type5INT16E"></span><span id="_CPPv2N5arrow4Type5INT16E"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44a36b3753b92501b60b2740b29d6e17696"></span><code class="sig-name 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="_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>
+<span id="_CPPv3N5arrow4Type6UINT32E"></span><span id="_CPPv2N5arrow4Type6UINT32E"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44a89620afd46abf8f99b057bd3587a78f0"></span><code class="sig-name 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="_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>
+<span id="_CPPv3N5arrow4Type5INT32E"></span><span id="_CPPv2N5arrow4Type5INT32E"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44af8005f162bc422abcee7f1197bf04cf8"></span><code class="sig-name 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="_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>
+<span id="_CPPv3N5arrow4Type6UINT64E"></span><span id="_CPPv2N5arrow4Type6UINT64E"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44af1096e3ebb2d7a678fc6ddac24bf7639"></span><code class="sig-name 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="_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>
+<span id="_CPPv3N5arrow4Type5INT64E"></span><span id="_CPPv2N5arrow4Type5INT64E"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44af38ec7ec303572a87b11fd48876bc1d0"></span><code class="sig-name 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="_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>
+<span id="_CPPv3N5arrow4Type10HALF_FLOATE"></span><span id="_CPPv2N5arrow4Type10HALF_FLOATE"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44af6ebd198668f2a6c2d79c549f599e896"></span><code class="sig-name 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="_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>
+<span id="_CPPv3N5arrow4Type5FLOATE"></span><span id="_CPPv2N5arrow4Type5FLOATE"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44a57c54c2b9d1630bc8c99b5fec4c93e58"></span><code class="sig-name 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="_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>
+<span id="_CPPv3N5arrow4Type6DOUBLEE"></span><span id="_CPPv2N5arrow4Type6DOUBLEE"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44a75397800ad025678ff7803b543d4a183"></span><code class="sig-name 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="_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>
+<span id="_CPPv3N5arrow4Type6STRINGE"></span><span id="_CPPv2N5arrow4Type6STRINGE"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44a864933bd7cdfa63ea75498c34db6545f"></span><code class="sig-name 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="_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>
+<span id="_CPPv3N5arrow4Type6BINARYE"></span><span id="_CPPv2N5arrow4Type6BINARYE"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44a442cc62761c7e5a83d26da4d3ed2fe01"></span><code class="sig-name 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="_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>
+<span id="_CPPv3N5arrow4Type17FIXED_SIZE_BINARYE"></span><span id="_CPPv2N5arrow4Type17FIXED_SIZE_BINARYE"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44a1b3f48148c5ff94c039d09ff689da179"></span><code class="sig-name 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="_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>
+<span id="_CPPv3N5arrow4Type6DATE32E"></span><span id="_CPPv2N5arrow4Type6DATE32E"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44a4351aedceb3d92f82cf7ae504476ef30"></span><code class="sig-name 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="_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>
+<span id="_CPPv3N5arrow4Type6DATE64E"></span><span id="_CPPv2N5arrow4Type6DATE64E"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44a17325202e90c23cd194b1698eea87a38"></span><code class="sig-name 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="_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>
+<span id="_CPPv3N5arrow4Type9TIMESTAMPE"></span><span id="_CPPv2N5arrow4Type9TIMESTAMPE"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44a1e41dddee4a6410c4d6fe164b36a230e"></span><code class="sig-name 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="_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>
+<span id="_CPPv3N5arrow4Type6TIME32E"></span><span id="_CPPv2N5arrow4Type6TIME32E"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44a73fb0fcd2b5d9a4c6071574c73cdf3c5"></span><code class="sig-name 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="_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>
+<span id="_CPPv3N5arrow4Type6TIME64E"></span><span id="_CPPv2N5arrow4Type6TIME64E"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44ab960cffd22f54b634d9f055f7568d321"></span><code class="sig-name 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="_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>
+<span id="_CPPv3N5arrow4Type8INTERVALE"></span><span id="_CPPv2N5arrow4Type8INTERVALE"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44aaa546143f5b445f6478b7e157546ec3f"></span><code class="sig-name 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="_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>
+<span id="_CPPv3N5arrow4Type7DECIMALE"></span><span id="_CPPv2N5arrow4Type7DECIMALE"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44a014fe7104b592dbd7c70e4e861774a63"></span><code class="sig-name 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="_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>
+<span id="_CPPv3N5arrow4Type4LISTE"></span><span id="_CPPv2N5arrow4Type4LISTE"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44ad074f9c02567b5945293b9114f84f210"></span><code class="sig-name 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="_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>
+<span id="_CPPv3N5arrow4Type6STRUCTE"></span><span id="_CPPv2N5arrow4Type6STRUCTE"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44aaa028b35c4e6a047c0e510ef1b0389ef"></span><code class="sig-name 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="_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>
+<span id="_CPPv3N5arrow4Type5UNIONE"></span><span id="_CPPv2N5arrow4Type5UNIONE"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44a2fa6d3a8e3947b7d0024304bfb8b5fad"></span><code class="sig-name 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="_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>
+<span id="_CPPv3N5arrow4Type10DICTIONARYE"></span><span id="_CPPv2N5arrow4Type10DICTIONARYE"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44a3c38b5820a3de12d71713473550c6280"></span><code class="sig-name descname">DICTIONARY</code><a class="headerlink" href="#_CPPv4N5arrow4Type10DICTIONARYE" title="Permalink to this definition">¶</a><br /></dt>
+<dd><p>Dictionary-encoded type, also called “categorical” or “factor” in other programming languages. </p>
+<p>Holds the dictionary value type but not the dictionary itself, which is part of the ArrayData struct </p>
</dd></dl>
<dl class="enumerator">
<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>
+<span id="_CPPv3N5arrow4Type3MAPE"></span><span id="_CPPv2N5arrow4Type3MAPE"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44a51838b04a2cdc2db91890e4c70f45e61"></span><code class="sig-name 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>
+<span id="_CPPv3N5arrow4Type9EXTENSIONE"></span><span id="_CPPv2N5arrow4Type9EXTENSIONE"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44af62348e1483c0b1a1536853e35588dad"></span><code class="sig-name 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>
+<dl class="enumerator">
+<dt id="_CPPv4N5arrow4Type15FIXED_SIZE_LISTE">
+<span id="_CPPv3N5arrow4Type15FIXED_SIZE_LISTE"></span><span id="_CPPv2N5arrow4Type15FIXED_SIZE_LISTE"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44a870656978bd9028566f88fe1c0afb127"></span><code class="sig-name descname">FIXED_SIZE_LIST</code><a class="headerlink" href="#_CPPv4N5arrow4Type15FIXED_SIZE_LISTE" title="Permalink to this definition">¶</a><br /></dt>
+<dd><p>Fixed size list of some logical type. </p>
+</dd></dl>
+
+<dl class="enumerator">
+<dt id="_CPPv4N5arrow4Type8DURATIONE">
+<span id="_CPPv3N5arrow4Type8DURATIONE"></span><span id="_CPPv2N5arrow4Type8DURATIONE"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44a5322b7f2fd54030f65ac36e9637ff45b"></span><code class="sig-name descname">DURATION</code><a class="headerlink" href="#_CPPv4N5arrow4Type8DURATIONE" title="Permalink to this definition">¶</a><br /></dt>
+<dd><p>Measure of elapsed time in either seconds, milliseconds, microseconds or nanoseconds. </p>
+</dd></dl>
+
</dd></dl>
<dl class="class">
<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>
+<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="sig-name 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>
@@ -389,39 +405,51 @@
<p class="breathe-sectiondef-title rubric">Public Functions</p>
<dl class="function">
<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 [...]
+<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="sig-name descname">Equals</code><span class="sig-paren">(</span><em class="property">const</em> <a class="reference internal" href="#_CPPv4N5arrow8DataTypeE" title="arrow::DataType">DataType</a> & [...]
<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="_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 [...]
+<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="sig-name descname">Equals</code><span class="sig-paren">(</span><em class="property">const</em> std::shared_ptr<<a class="reference internal" href=" [...]
<dd><p>Return whether the types are equal. </p>
</dd></dl>
<dl class="function">
<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" [...]
+<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="sig-name descname">ToString</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em> = 0<a class="headerlink" href="#_CPPv4NK5arrow8DataType8To [...]
<dd><p>A string representation of the type, including any children. </p>
</dd></dl>
<dl class="function">
<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 [...]
+<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="sig-name 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="Per [...]
<dd><p>A string name of the type, omitting any child fields. </p>
-<p><dl class="docutils">
-<dt><strong>Note</strong></dt>
-<dd>Experimental API </dd>
-<dt><strong>Since</strong></dt>
-<dd>0.7.0 </dd>
+<p><dl class="simple">
+<dt><strong>Note</strong></dt><dd><p>Experimental API </p>
+</dd>
+<dt><strong>Since</strong></dt><dd><p>0.7.0 </p>
+</dd>
+</dl>
+</p>
+</dd></dl>
+
+<dl class="function">
+<dt id="_CPPv4NK5arrow8DataType6layoutEv">
+<span id="_CPPv3NK5arrow8DataType6layoutEv"></span><span id="_CPPv2NK5arrow8DataType6layoutEv"></span><span id="arrow::DataType::layoutC"></span><span class="target" id="classarrow_1_1_data_type_1a4fe70f6a45eda029ea118c8470ff925e"></span><em class="property">virtual</em> DataTypeLayout <code class="sig-name descname">layout</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em> = 0<a class="headerlink" href="#_CPPv4NK5arrow8DataType6layoutE [...]
+<dd><p>Return the data type layout. </p>
+<p>Children are not included.</p>
+<p><dl class="simple">
+<dt><strong>Note</strong></dt><dd><p>Experimental API </p>
+</dd>
</dl>
</p>
</dd></dl>
<dl class="function">
<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 [...]
+<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="sig-name descname">id</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" hre [...]
<dd><p>Return the type category. </p>
</dd></dl>
@@ -434,177 +462,234 @@
new objects or existing singletons, depending on the type requested.</p>
<dl class="function">
<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 [...]
+<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="sig-prename descclassname">arrow<code class="sig-prename descclassname">::</code></code><code [...]
<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="_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>< [...]
+<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="sig-prename descclassname">arrow<code class="sig-prename descclassname">::</code></code><code class="s [...]
<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="_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 [...]
+<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="sig-prename descclassname">arrow<code class="sig-prename descclassname">::</code>< [...]
<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="_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 [...]
+<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="sig-prename descclassname">arrow<code class="sig-prename descclassname">: [...]
<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="_CPPv4N5arrow3mapERKNSt10shared_ptrI8DataTypeEERKNSt10shared_ptrI8DataTypeEEb">
+<span id="_CPPv3N5arrow3mapERKNSt10shared_ptrI8DataTypeEERKNSt10shared_ptrI8DataTypeEEb"></span><span id="_CPPv2N5arrow3mapERKNSt10shared_ptrI8DataTypeEERKNSt10shared_ptrI8DataTypeEEb"></span><span id="arrow::map__std::shared_ptr:DataType:CR.std::shared_ptr:DataType:CR.b"></span><span class="target" id="group__type-factories_1ga464d9a4f0c307d935593d4aa4ff44846"></span>std::shared_ptr<<a class="reference internal" href="#_CPPv4N5arrow8DataTypeE" title="arrow::DataType">DataType</a>> [...]
+<dd><p>Create a MapType instance from its key and value DataTypes. </p>
+</dd></dl>
+
+<dl class="function">
+<dt id="_CPPv4N5arrow15fixed_size_listERKNSt10shared_ptrI5FieldEE7int32_t">
+<span id="_CPPv3N5arrow15fixed_size_listERKNSt10shared_ptrI5FieldEE7int32_t"></span><span id="_CPPv2N5arrow15fixed_size_listERKNSt10shared_ptrI5FieldEE7int32_t"></span><span id="arrow::fixed_size_list__std::shared_ptr:Field:CR.int32_t"></span><span class="target" id="group__type-factories_1gad5bb35da3242368660a754a0d47e518b"></span>std::shared_ptr<<a class="reference internal" href="#_CPPv4N5arrow8DataTypeE" title="arrow::DataType">DataType</a>> <code class="sig-prename descclassna [...]
+<dd><p>Create a FixedSizeListType 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="_CPPv4N5arrow15fixed_size_listERKNSt10shared_ptrI8DataTypeEE7int32_t">
+<span id="_CPPv3N5arrow15fixed_size_listERKNSt10shared_ptrI8DataTypeEE7int32_t"></span><span id="_CPPv2N5arrow15fixed_size_listERKNSt10shared_ptrI8DataTypeEE7int32_t"></span><span id="arrow::fixed_size_list__std::shared_ptr:DataType:CR.int32_t"></span><span class="target" id="group__type-factories_1ga09fb55b2d07e324f1560a8eeb142e2ed"></span>std::shared_ptr<<a class="reference internal" href="#_CPPv4N5arrow8DataTypeE" title="arrow::DataType">DataType</a>> <code class="sig-prename de [...]
+<dd><p>Create a FixedSizeListType 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="_CPPv4N5arrow8durationEN8TimeUnit4typeE">
+<span id="_CPPv3N5arrow8durationEN8TimeUnit4typeE"></span><span id="_CPPv2N5arrow8durationEN8TimeUnit4typeE"></span><span id="arrow::duration__TimeUnit::type"></span><span class="target" id="group__type-factories_1ga4a09df951503764895e56db3fe5d053c"></span>std::shared_ptr<<a class="reference internal" href="#_CPPv4N5arrow8DataTypeE" title="arrow::DataType">DataType</a>> <code class="sig-prename descclassname">arrow<code class="sig-prename descclassname">::</code></code><code class= [...]
+<dd><p>Return an Duration instance (naming use _type to avoid namespace conflict with built in time clases). </p>
+</dd></dl>
+
+<dl class="function">
+<dt id="_CPPv4N5arrow17day_time_intervalEv">
+<span id="_CPPv3N5arrow17day_time_intervalEv"></span><span id="_CPPv2N5arrow17day_time_intervalEv"></span><span id="arrow::day_time_interval"></span><span class="target" id="group__type-factories_1ga81643b6c32e9c11375084c074567cba0"></span>std::shared_ptr<<a class="reference internal" href="#_CPPv4N5arrow8DataTypeE" title="arrow::DataType">DataType</a>> <code class="sig-prename descclassname">arrow<code class="sig-prename descclassname">::</code></code><code class="sig-name descnam [...]
+<dd><p>Return an DayTimeIntervalType instance. </p>
+</dd></dl>
+
+<dl class="function">
+<dt id="_CPPv4N5arrow14month_intervalEv">
+<span id="_CPPv3N5arrow14month_intervalEv"></span><span id="_CPPv2N5arrow14month_intervalEv"></span><span id="arrow::month_interval"></span><span class="target" id="group__type-factories_1gaf3c6cebcb8e66ada1ea7bbfe5d4c8978"></span>std::shared_ptr<<a class="reference internal" href="#_CPPv4N5arrow8DataTypeE" title="arrow::DataType">DataType</a>> <code class="sig-prename descclassname">arrow<code class="sig-prename descclassname">::</code></code><code class="sig-name descname">month_ [...]
+<dd><p>Return an MonthIntervalType instance. </p>
+</dd></dl>
+
+<dl class="function">
<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< [...]
+<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="sig-prename descclassname">arrow<code class="sig-prename descclassname">::</code></code><code cla [...]
<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="_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 [...]
+<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="sig-prename descclassname">arrow<code class="sig-prename descclass [...]
<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="_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 [...]
+<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="sig-prename descclassname">arrow<code class="sig-prename descclassname">::</code></code><code class="sig-n [...]
<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="_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 [...]
+<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="sig-prename descclassname">arrow<code class="sig-prename descclassname">::</code></code><code class="sig-n [...]
<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="_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 [...]
+<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="sig-prename descclassname">arrow<c [...]
<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="_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 [...]
+<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="_CPPv4N5arrow6union_ERKNSt6vectorINSt10shared_ptrI5ArrayEEEERKNSt6vectorINSt6stringEEERKNSt6vectorI7uint8_tEEN9UnionMode4typeE">
+<span id="_CPPv3N5arrow6union_ERKNSt6vectorINSt10shared_ptrI5ArrayEEEERKNSt6vectorINSt6stringEEERKNSt6vectorI7uint8_tEEN9UnionMode4typeE"></span><span id="_CPPv2N5arrow6union_ERKNSt6vectorINSt10shared_ptrI5ArrayEEEERKNSt6vectorINSt6stringEEERKNSt6vectorI7uint8_tEEN9UnionMode4typeE"></span><span id="arrow::union___std::vector:std::shared_ptr:Array::CR.std::vector:ss:CR.std::vector:uint8_t:CR.UnionMode::type"></span><span class="target" id="group__type-factories_1ga40357a84202d2b86e3f38222 [...]
+<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="_CPPv4N5arrow6union_ERKNSt6vectorINSt10shared_ptrI5ArrayEEEERKNSt6vectorINSt6stringEEEN9UnionMode4typeE">
+<span id="_CPPv3N5arrow6union_ERKNSt6vectorINSt10shared_ptrI5ArrayEEEERKNSt6vectorINSt6stringEEEN9UnionMode4typeE"></span><span id="_CPPv2N5arrow6union_ERKNSt6vectorINSt10shared_ptrI5ArrayEEEERKNSt6vectorINSt6stringEEEN9UnionMode4typeE"></span><span id="arrow::union___std::vector:std::shared_ptr:Array::CR.std::vector:ss:CR.UnionMode::type"></span><span class="target" id="group__type-factories_1ga009d36e7c16f62a9e192394da9a94c7c"></span>std::shared_ptr<<a class="reference internal" hre [...]
<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="_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>> [...]
+<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="_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 [...]
+<dt id="_CPPv4N5arrow10dictionaryERKNSt10shared_ptrI8DataTypeEERKNSt10shared_ptrI8DataTypeEEb">
+<span id="_CPPv3N5arrow10dictionaryERKNSt10shared_ptrI8DataTypeEERKNSt10shared_ptrI8DataTypeEEb"></span><span id="_CPPv2N5arrow10dictionaryERKNSt10shared_ptrI8DataTypeEERKNSt10shared_ptrI8DataTypeEEb"></span><span id="arrow::dictionary__std::shared_ptr:DataType:CR.std::shared_ptr:DataType:CR.b"></span><span class="target" id="group__type-factories_1ga36f61c68b2a04a9d179cb56ff1186c59"></span>std::shared_ptr<<a class="reference internal" href="#_CPPv4N5arrow8DataTypeE" title="arrow::Dat [...]
<dd><p>Create a <a class="reference internal" href="#classarrow_1_1_dictionary_type"><span class="std std-ref">DictionaryType</span></a> instance. </p>
+<p><dl class="simple">
+<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">index_type</span></code>: the type of the dictionary indices (must be a signed integer) </p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">dict_type</span></code>: the type of the values in the variable dictionary </p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">ordered</span></code>: true if the order of the dictionary values has semantic meaning and should be preserved where possible </p></li>
+</ul>
+</dd>
+</dl>
+</p>
</dd></dl>
<dl class="function">
<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 [...]
+<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="sig-prename descclassname">arrow<code class="sig-prename descclassname">::</code></code><code class="sig-name descname">null</code><span class="sig-paren">(</ [...]
<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="_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 [...]
+<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="sig-prename descclassname">arrow<code class="sig-prename descclassname">::</code></code><code class="sig-name descname">boolean</code><span class="si [...]
<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="_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 [...]
+<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="sig-prename descclassname">arrow<code class="sig-prename descclassname">::</code></code><code class="sig-name descname">int8</code><span class="sig-paren">(</ [...]
<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="_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"> [...]
+<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="sig-prename descclassname">arrow<code class="sig-prename descclassname">::</code></code><code class="sig-name descname">int16</code><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="_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"> [...]
+<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="sig-prename descclassname">arrow<code class="sig-prename descclassname">::</code></code><code class="sig-name descname">int32</code><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="_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"> [...]
+<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="sig-prename descclassname">arrow<code class="sig-prename descclassname">::</code></code><code class="sig-name descname">int64</code><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="_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"> [...]
+<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="sig-prename descclassname">arrow<code class="sig-prename descclassname">::</code></code><code class="sig-name descname">uint8</code><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="_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 [...]
+<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="sig-prename descclassname">arrow<code class="sig-prename descclassname">::</code></code><code class="sig-name descname">uint16</code><span class="sig-pa [...]
<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="_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 [...]
+<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="sig-prename descclassname">arrow<code class="sig-prename descclassname">::</code></code><code class="sig-name descname">uint32</code><span class="sig-pa [...]
<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="_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 [...]
+<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="sig-prename descclassname">arrow<code class="sig-prename descclassname">::</code></code><code class="sig-name descname">uint64</code><span class="sig-pa [...]
<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="_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 [...]
+<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="sig-prename descclassname">arrow<code class="sig-prename descclassname">::</code></code><code class="sig-name descname">float16</code><span class="si [...]
<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="_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 [...]
+<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="sig-prename descclassname">arrow<code class="sig-prename descclassname">::</code></code><code class="sig-name descname">float32</code><span class="si [...]
<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="_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 [...]
+<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="sig-prename descclassname">arrow<code class="sig-prename descclassname">::</code></code><code class="sig-name descname">float64</code><span class="si [...]
<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="_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 [...]
+<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="sig-prename descclassname">arrow<code class="sig-prename descclassname">::</code></code><code class="sig-name descname">utf8</code><span class="sig-paren">(</ [...]
<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="_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 [...]
+<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="sig-prename descclassname">arrow<code class="sig-prename descclassname">::</code></code><code class="sig-name descname">binary</code><span class="sig-pa [...]
<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="_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 [...]
+<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="sig-prename descclassname">arrow<code class="sig-prename descclassname">::</code></code><code class="sig-name descname">date32</code><span class="sig-pa [...]
<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="_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 [...]
+<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="sig-prename descclassname">arrow<code class="sig-prename descclassname">::</code></code><code class="sig-name descname">date64</code><span class="sig-pa [...]
<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>
@@ -615,25 +700,37 @@ new objects or existing singletons, depending on the type requested.</p>
... 68375 lines suppressed ...