Morph MORPH
SIGN IN SIGN UP
apache / arrow UNCLAIMED

Apache Arrow is the universal columnar format and multi-language toolbox for fast data interchange and in-memory analytics

0 0 2 C++
Normal View History Raw
ARROW-3834: [Doc] Merge C++ and Python documentation Author: Uwe L. Korn <uwelk@xhochy.com> Author: Korn, Uwe <Uwe.Korn@blue-yonder.com> Author: Wes McKinney <wesm+git@apache.org> Closes #2856 from xhochy/doc-merge and squashes the following commits: 5b687ffa7 <Wes McKinney> Add simple README for the format/ directory 071d16ad7 <Uwe L. Korn> Move format specifications back to /format/ 337088bfd <Uwe L. Korn> Review comments fbe99c96c <Uwe L. Korn> Add more C++ docs 78a5eaf4b <Uwe L. Korn> Fix Python docs build 0b4dd3341 <Uwe L. Korn> Rename doc to docs 918e76244 <Uwe L. Korn> Convert format docs to reST 7aeff65ef <Uwe L. Korn> Add doc generation to docker-compose 185cba8fb <Uwe L. Korn> Add pre-commit check for RAT 671d24466 <Uwe L. Korn> Fix references to format documents bdd824c87 <Uwe L. Korn> Move doc to top-level 985d42806 <Uwe L. Korn> Move Sphinx doc to top-level directory f7d5e92d9 <Uwe L. Korn> Build C++ API docs 7850db8a6 <Uwe L. Korn> Add breathe as a requirement d4cf54259 <Uwe L. Korn> Fix linter issues fd75660e6 <Korn, Uwe> Fix Sphinx build for sphinx>=1.8 9be6fbe6f <Korn, Uwe> Merge C++ and Python documentation
2018-12-05 19:54:57 -06:00
.. 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-3986: [C++] Write prose documentation Author: Antoine Pitrou <antoine@python.org> Closes #3149 from pitrou/ARROW-3986-cpp-prose-doc and squashes the following commits: 77e37940 <Antoine Pitrou> ARROW-3986: Write prose documentation
2018-12-11 15:16:06 +01:00
======
Arrays
======
ARROW-3834: [Doc] Merge C++ and Python documentation Author: Uwe L. Korn <uwelk@xhochy.com> Author: Korn, Uwe <Uwe.Korn@blue-yonder.com> Author: Wes McKinney <wesm+git@apache.org> Closes #2856 from xhochy/doc-merge and squashes the following commits: 5b687ffa7 <Wes McKinney> Add simple README for the format/ directory 071d16ad7 <Uwe L. Korn> Move format specifications back to /format/ 337088bfd <Uwe L. Korn> Review comments fbe99c96c <Uwe L. Korn> Add more C++ docs 78a5eaf4b <Uwe L. Korn> Fix Python docs build 0b4dd3341 <Uwe L. Korn> Rename doc to docs 918e76244 <Uwe L. Korn> Convert format docs to reST 7aeff65ef <Uwe L. Korn> Add doc generation to docker-compose 185cba8fb <Uwe L. Korn> Add pre-commit check for RAT 671d24466 <Uwe L. Korn> Fix references to format documents bdd824c87 <Uwe L. Korn> Move doc to top-level 985d42806 <Uwe L. Korn> Move Sphinx doc to top-level directory f7d5e92d9 <Uwe L. Korn> Build C++ API docs 7850db8a6 <Uwe L. Korn> Add breathe as a requirement d4cf54259 <Uwe L. Korn> Fix linter issues fd75660e6 <Korn, Uwe> Fix Sphinx build for sphinx>=1.8 9be6fbe6f <Korn, Uwe> Merge C++ and Python documentation
2018-12-05 19:54:57 -06:00
GH-34535: [C++] Move ChunkResolver to the public API (#44357) ### Rationale for this change Adopting https://github.com/apache/arrow/pull/40226. The creation and return of a shared_ptr does result in some performance overhead, that makes a difference for a performance-sensitive application. If someone could use ChunkResolver to learn the indices, they could then instead access the data directly. ### What changes are included in this PR? - [X] Updates to documentation (thanks to @ SChakravorti21 ) - [X] Moving `ChunkResolver` to public API, and updating all references to it in the code ### Are these changes tested? There seemed to be comprehensive tests already: https://github.com/apache/arrow/blob/main/cpp/src/arrow/chunked_array_test.cc#L324 If an edgecase is missing, I'd be happy to add it. ### Are there any user-facing changes? `ChunkResolver` and `TypedChunkLocation` are now in the public API. * GitHub Issue: #34535 Lead-authored-by: Anja Kefala <anja.kefala@gmail.com> Co-authored-by: anjakefala <anja.kefala@gmail.com> Co-authored-by: Bryce Mecum <petridish@gmail.com> Co-authored-by: SChakravorti21 <schakravorti@bloomberg.net> Co-authored-by: SChakravorti21<schakravorti@bloomberg.net> Co-authored-by: Jacob Wujciak-Jens <jacob@wujciak.de> Signed-off-by: Felipe Oliveira Carvalho <felipekde@gmail.com>
2024-10-21 15:46:48 -07:00
Base classes
============
GH-44710: [Docs][C++] Add `arrow::ArrayStatistics` to API doc (#44764) ### Rationale for this change https://arrow.apache.org/docs/cpp/api/array.html should have `arrow::ArrayStatistics`. ### What changes are included in this PR? Add missing `\class` and `doxygenclass`. ### Are these changes tested? Yes. ### Are there any user-facing changes? Yes. * GitHub Issue: #44710 Authored-by: Sutou Kouhei <kou@clear-code.com> Signed-off-by: Sutou Kouhei <kou@clear-code.com>
2024-11-19 10:07:26 +09:00
.. doxygenclass:: arrow::ArrayStatistics
:project: arrow_cpp
:members:
ARROW-14056: [Doc][C++] Document ArrayData Also ensure that all concrete datatype and array classes are documented. Closes #11201 from pitrou/ARROW-14056-doc-array-data Authored-by: Antoine Pitrou <antoine@python.org> Signed-off-by: Antoine Pitrou <antoine@python.org>
2021-09-22 17:22:02 +02:00
.. doxygenclass:: arrow::ArrayData
:project: arrow_cpp
:members:
ARROW-3834: [Doc] Merge C++ and Python documentation Author: Uwe L. Korn <uwelk@xhochy.com> Author: Korn, Uwe <Uwe.Korn@blue-yonder.com> Author: Wes McKinney <wesm+git@apache.org> Closes #2856 from xhochy/doc-merge and squashes the following commits: 5b687ffa7 <Wes McKinney> Add simple README for the format/ directory 071d16ad7 <Uwe L. Korn> Move format specifications back to /format/ 337088bfd <Uwe L. Korn> Review comments fbe99c96c <Uwe L. Korn> Add more C++ docs 78a5eaf4b <Uwe L. Korn> Fix Python docs build 0b4dd3341 <Uwe L. Korn> Rename doc to docs 918e76244 <Uwe L. Korn> Convert format docs to reST 7aeff65ef <Uwe L. Korn> Add doc generation to docker-compose 185cba8fb <Uwe L. Korn> Add pre-commit check for RAT 671d24466 <Uwe L. Korn> Fix references to format documents bdd824c87 <Uwe L. Korn> Move doc to top-level 985d42806 <Uwe L. Korn> Move Sphinx doc to top-level directory f7d5e92d9 <Uwe L. Korn> Build C++ API docs 7850db8a6 <Uwe L. Korn> Add breathe as a requirement d4cf54259 <Uwe L. Korn> Fix linter issues fd75660e6 <Korn, Uwe> Fix Sphinx build for sphinx>=1.8 9be6fbe6f <Korn, Uwe> Merge C++ and Python documentation
2018-12-05 19:54:57 -06:00
.. doxygenclass:: arrow::Array
:project: arrow_cpp
:members:
GH-46537: [Docs][C++] Add RunEndEncodedArray, FlatArray, and PrimitiveArray API Docs (#46540) ### Rationale for this change The [Array](https://arrow.apache.org/docs/cpp/api/array.html) section of the API Doc does not explain `FlatArray`, `PrimitiveArray`, and `RunEndEncodedArray` . ### What changes are included in this PR? Add `FlatArray`, `PrimitiveArray`, and `RunEndEncodedArray` API docs ### Are these changes tested? No. (Document only) ### Are there any user-facing changes? No. * GitHub Issue: #46537 Authored-by: Hiroyuki Sato <hiroysato@gmail.com> Signed-off-by: Antoine Pitrou <antoine@python.org>
2025-05-22 20:29:13 +09:00
.. doxygenclass:: arrow::FlatArray
:project: arrow_cpp
:members:
.. doxygenclass:: arrow::PrimitiveArray
:project: arrow_cpp
:members:
GH-40318: [C++][Docs] Add documentation of array factories (#40373) ### Rationale for this change These factory functions are generally useful and available, so documenting them helps external users find them without having to search the source code. ### What changes are included in this PR? This PR adds the array factories in arrow/array/util.h into a doxygen group for array factories and adds that group to the Sphinx C++ API documentation. ### Are these changes tested? I built the docs locally to verify. ### Are there any user-facing changes? Nothing to the API, only docs. * GitHub Issue: #40318 Authored-by: Vyas Ramasubramani <vyasr@nvidia.com> Signed-off-by: Antoine Pitrou <antoine@python.org>
2024-03-07 05:24:15 -08:00
Factory functions
=================
.. doxygengroup:: array-factories
:content-only:
ARROW-3986: [C++] Write prose documentation Author: Antoine Pitrou <antoine@python.org> Closes #3149 from pitrou/ARROW-3986-cpp-prose-doc and squashes the following commits: 77e37940 <Antoine Pitrou> ARROW-3986: Write prose documentation
2018-12-11 15:16:06 +01:00
Concrete array subclasses
=========================
ARROW-14056: [Doc][C++] Document ArrayData Also ensure that all concrete datatype and array classes are documented. Closes #11201 from pitrou/ARROW-14056-doc-array-data Authored-by: Antoine Pitrou <antoine@python.org> Signed-off-by: Antoine Pitrou <antoine@python.org>
2021-09-22 17:22:02 +02:00
Primitive and temporal
----------------------
ARROW-3834: [Doc] Merge C++ and Python documentation Author: Uwe L. Korn <uwelk@xhochy.com> Author: Korn, Uwe <Uwe.Korn@blue-yonder.com> Author: Wes McKinney <wesm+git@apache.org> Closes #2856 from xhochy/doc-merge and squashes the following commits: 5b687ffa7 <Wes McKinney> Add simple README for the format/ directory 071d16ad7 <Uwe L. Korn> Move format specifications back to /format/ 337088bfd <Uwe L. Korn> Review comments fbe99c96c <Uwe L. Korn> Add more C++ docs 78a5eaf4b <Uwe L. Korn> Fix Python docs build 0b4dd3341 <Uwe L. Korn> Rename doc to docs 918e76244 <Uwe L. Korn> Convert format docs to reST 7aeff65ef <Uwe L. Korn> Add doc generation to docker-compose 185cba8fb <Uwe L. Korn> Add pre-commit check for RAT 671d24466 <Uwe L. Korn> Fix references to format documents bdd824c87 <Uwe L. Korn> Move doc to top-level 985d42806 <Uwe L. Korn> Move Sphinx doc to top-level directory f7d5e92d9 <Uwe L. Korn> Build C++ API docs 7850db8a6 <Uwe L. Korn> Add breathe as a requirement d4cf54259 <Uwe L. Korn> Fix linter issues fd75660e6 <Korn, Uwe> Fix Sphinx build for sphinx>=1.8 9be6fbe6f <Korn, Uwe> Merge C++ and Python documentation
2018-12-05 19:54:57 -06:00
.. doxygenclass:: arrow::NullArray
:project: arrow_cpp
:members:
.. doxygenclass:: arrow::BooleanArray
:project: arrow_cpp
:members:
ARROW-14056: [Doc][C++] Document ArrayData Also ensure that all concrete datatype and array classes are documented. Closes #11201 from pitrou/ARROW-14056-doc-array-data Authored-by: Antoine Pitrou <antoine@python.org> Signed-off-by: Antoine Pitrou <antoine@python.org>
2021-09-22 17:22:02 +02:00
.. doxygengroup:: numeric-arrays
:content-only:
ARROW-3834: [Doc] Merge C++ and Python documentation Author: Uwe L. Korn <uwelk@xhochy.com> Author: Korn, Uwe <Uwe.Korn@blue-yonder.com> Author: Wes McKinney <wesm+git@apache.org> Closes #2856 from xhochy/doc-merge and squashes the following commits: 5b687ffa7 <Wes McKinney> Add simple README for the format/ directory 071d16ad7 <Uwe L. Korn> Move format specifications back to /format/ 337088bfd <Uwe L. Korn> Review comments fbe99c96c <Uwe L. Korn> Add more C++ docs 78a5eaf4b <Uwe L. Korn> Fix Python docs build 0b4dd3341 <Uwe L. Korn> Rename doc to docs 918e76244 <Uwe L. Korn> Convert format docs to reST 7aeff65ef <Uwe L. Korn> Add doc generation to docker-compose 185cba8fb <Uwe L. Korn> Add pre-commit check for RAT 671d24466 <Uwe L. Korn> Fix references to format documents bdd824c87 <Uwe L. Korn> Move doc to top-level 985d42806 <Uwe L. Korn> Move Sphinx doc to top-level directory f7d5e92d9 <Uwe L. Korn> Build C++ API docs 7850db8a6 <Uwe L. Korn> Add breathe as a requirement d4cf54259 <Uwe L. Korn> Fix linter issues fd75660e6 <Korn, Uwe> Fix Sphinx build for sphinx>=1.8 9be6fbe6f <Korn, Uwe> Merge C++ and Python documentation
2018-12-05 19:54:57 -06:00
:members:
ARROW-14056: [Doc][C++] Document ArrayData Also ensure that all concrete datatype and array classes are documented. Closes #11201 from pitrou/ARROW-14056-doc-array-data Authored-by: Antoine Pitrou <antoine@python.org> Signed-off-by: Antoine Pitrou <antoine@python.org>
2021-09-22 17:22:02 +02:00
Binary-like
-----------
ARROW-3834: [Doc] Merge C++ and Python documentation Author: Uwe L. Korn <uwelk@xhochy.com> Author: Korn, Uwe <Uwe.Korn@blue-yonder.com> Author: Wes McKinney <wesm+git@apache.org> Closes #2856 from xhochy/doc-merge and squashes the following commits: 5b687ffa7 <Wes McKinney> Add simple README for the format/ directory 071d16ad7 <Uwe L. Korn> Move format specifications back to /format/ 337088bfd <Uwe L. Korn> Review comments fbe99c96c <Uwe L. Korn> Add more C++ docs 78a5eaf4b <Uwe L. Korn> Fix Python docs build 0b4dd3341 <Uwe L. Korn> Rename doc to docs 918e76244 <Uwe L. Korn> Convert format docs to reST 7aeff65ef <Uwe L. Korn> Add doc generation to docker-compose 185cba8fb <Uwe L. Korn> Add pre-commit check for RAT 671d24466 <Uwe L. Korn> Fix references to format documents bdd824c87 <Uwe L. Korn> Move doc to top-level 985d42806 <Uwe L. Korn> Move Sphinx doc to top-level directory f7d5e92d9 <Uwe L. Korn> Build C++ API docs 7850db8a6 <Uwe L. Korn> Add breathe as a requirement d4cf54259 <Uwe L. Korn> Fix linter issues fd75660e6 <Korn, Uwe> Fix Sphinx build for sphinx>=1.8 9be6fbe6f <Korn, Uwe> Merge C++ and Python documentation
2018-12-05 19:54:57 -06:00
ARROW-14056: [Doc][C++] Document ArrayData Also ensure that all concrete datatype and array classes are documented. Closes #11201 from pitrou/ARROW-14056-doc-array-data Authored-by: Antoine Pitrou <antoine@python.org> Signed-off-by: Antoine Pitrou <antoine@python.org>
2021-09-22 17:22:02 +02:00
.. doxygengroup:: binary-arrays
:content-only:
ARROW-3834: [Doc] Merge C++ and Python documentation Author: Uwe L. Korn <uwelk@xhochy.com> Author: Korn, Uwe <Uwe.Korn@blue-yonder.com> Author: Wes McKinney <wesm+git@apache.org> Closes #2856 from xhochy/doc-merge and squashes the following commits: 5b687ffa7 <Wes McKinney> Add simple README for the format/ directory 071d16ad7 <Uwe L. Korn> Move format specifications back to /format/ 337088bfd <Uwe L. Korn> Review comments fbe99c96c <Uwe L. Korn> Add more C++ docs 78a5eaf4b <Uwe L. Korn> Fix Python docs build 0b4dd3341 <Uwe L. Korn> Rename doc to docs 918e76244 <Uwe L. Korn> Convert format docs to reST 7aeff65ef <Uwe L. Korn> Add doc generation to docker-compose 185cba8fb <Uwe L. Korn> Add pre-commit check for RAT 671d24466 <Uwe L. Korn> Fix references to format documents bdd824c87 <Uwe L. Korn> Move doc to top-level 985d42806 <Uwe L. Korn> Move Sphinx doc to top-level directory f7d5e92d9 <Uwe L. Korn> Build C++ API docs 7850db8a6 <Uwe L. Korn> Add breathe as a requirement d4cf54259 <Uwe L. Korn> Fix linter issues fd75660e6 <Korn, Uwe> Fix Sphinx build for sphinx>=1.8 9be6fbe6f <Korn, Uwe> Merge C++ and Python documentation
2018-12-05 19:54:57 -06:00
:members:
ARROW-3986: [C++] Write prose documentation Author: Antoine Pitrou <antoine@python.org> Closes #3149 from pitrou/ARROW-3986-cpp-prose-doc and squashes the following commits: 77e37940 <Antoine Pitrou> ARROW-3986: Write prose documentation
2018-12-11 15:16:06 +01:00
Nested
------
ARROW-3834: [Doc] Merge C++ and Python documentation Author: Uwe L. Korn <uwelk@xhochy.com> Author: Korn, Uwe <Uwe.Korn@blue-yonder.com> Author: Wes McKinney <wesm+git@apache.org> Closes #2856 from xhochy/doc-merge and squashes the following commits: 5b687ffa7 <Wes McKinney> Add simple README for the format/ directory 071d16ad7 <Uwe L. Korn> Move format specifications back to /format/ 337088bfd <Uwe L. Korn> Review comments fbe99c96c <Uwe L. Korn> Add more C++ docs 78a5eaf4b <Uwe L. Korn> Fix Python docs build 0b4dd3341 <Uwe L. Korn> Rename doc to docs 918e76244 <Uwe L. Korn> Convert format docs to reST 7aeff65ef <Uwe L. Korn> Add doc generation to docker-compose 185cba8fb <Uwe L. Korn> Add pre-commit check for RAT 671d24466 <Uwe L. Korn> Fix references to format documents bdd824c87 <Uwe L. Korn> Move doc to top-level 985d42806 <Uwe L. Korn> Move Sphinx doc to top-level directory f7d5e92d9 <Uwe L. Korn> Build C++ API docs 7850db8a6 <Uwe L. Korn> Add breathe as a requirement d4cf54259 <Uwe L. Korn> Fix linter issues fd75660e6 <Korn, Uwe> Fix Sphinx build for sphinx>=1.8 9be6fbe6f <Korn, Uwe> Merge C++ and Python documentation
2018-12-05 19:54:57 -06:00
ARROW-14056: [Doc][C++] Document ArrayData Also ensure that all concrete datatype and array classes are documented. Closes #11201 from pitrou/ARROW-14056-doc-array-data Authored-by: Antoine Pitrou <antoine@python.org> Signed-off-by: Antoine Pitrou <antoine@python.org>
2021-09-22 17:22:02 +02:00
.. doxygengroup:: nested-arrays
:content-only:
ARROW-3834: [Doc] Merge C++ and Python documentation Author: Uwe L. Korn <uwelk@xhochy.com> Author: Korn, Uwe <Uwe.Korn@blue-yonder.com> Author: Wes McKinney <wesm+git@apache.org> Closes #2856 from xhochy/doc-merge and squashes the following commits: 5b687ffa7 <Wes McKinney> Add simple README for the format/ directory 071d16ad7 <Uwe L. Korn> Move format specifications back to /format/ 337088bfd <Uwe L. Korn> Review comments fbe99c96c <Uwe L. Korn> Add more C++ docs 78a5eaf4b <Uwe L. Korn> Fix Python docs build 0b4dd3341 <Uwe L. Korn> Rename doc to docs 918e76244 <Uwe L. Korn> Convert format docs to reST 7aeff65ef <Uwe L. Korn> Add doc generation to docker-compose 185cba8fb <Uwe L. Korn> Add pre-commit check for RAT 671d24466 <Uwe L. Korn> Fix references to format documents bdd824c87 <Uwe L. Korn> Move doc to top-level 985d42806 <Uwe L. Korn> Move Sphinx doc to top-level directory f7d5e92d9 <Uwe L. Korn> Build C++ API docs 7850db8a6 <Uwe L. Korn> Add breathe as a requirement d4cf54259 <Uwe L. Korn> Fix linter issues fd75660e6 <Korn, Uwe> Fix Sphinx build for sphinx>=1.8 9be6fbe6f <Korn, Uwe> Merge C++ and Python documentation
2018-12-05 19:54:57 -06:00
:members:
ARROW-14056: [Doc][C++] Document ArrayData Also ensure that all concrete datatype and array classes are documented. Closes #11201 from pitrou/ARROW-14056-doc-array-data Authored-by: Antoine Pitrou <antoine@python.org> Signed-off-by: Antoine Pitrou <antoine@python.org>
2021-09-22 17:22:02 +02:00
Dictionary-encoded
------------------
.. doxygenclass:: arrow::DictionaryArray
ARROW-3834: [Doc] Merge C++ and Python documentation Author: Uwe L. Korn <uwelk@xhochy.com> Author: Korn, Uwe <Uwe.Korn@blue-yonder.com> Author: Wes McKinney <wesm+git@apache.org> Closes #2856 from xhochy/doc-merge and squashes the following commits: 5b687ffa7 <Wes McKinney> Add simple README for the format/ directory 071d16ad7 <Uwe L. Korn> Move format specifications back to /format/ 337088bfd <Uwe L. Korn> Review comments fbe99c96c <Uwe L. Korn> Add more C++ docs 78a5eaf4b <Uwe L. Korn> Fix Python docs build 0b4dd3341 <Uwe L. Korn> Rename doc to docs 918e76244 <Uwe L. Korn> Convert format docs to reST 7aeff65ef <Uwe L. Korn> Add doc generation to docker-compose 185cba8fb <Uwe L. Korn> Add pre-commit check for RAT 671d24466 <Uwe L. Korn> Fix references to format documents bdd824c87 <Uwe L. Korn> Move doc to top-level 985d42806 <Uwe L. Korn> Move Sphinx doc to top-level directory f7d5e92d9 <Uwe L. Korn> Build C++ API docs 7850db8a6 <Uwe L. Korn> Add breathe as a requirement d4cf54259 <Uwe L. Korn> Fix linter issues fd75660e6 <Korn, Uwe> Fix Sphinx build for sphinx>=1.8 9be6fbe6f <Korn, Uwe> Merge C++ and Python documentation
2018-12-05 19:54:57 -06:00
:members:
ARROW-14056: [Doc][C++] Document ArrayData Also ensure that all concrete datatype and array classes are documented. Closes #11201 from pitrou/ARROW-14056-doc-array-data Authored-by: Antoine Pitrou <antoine@python.org> Signed-off-by: Antoine Pitrou <antoine@python.org>
2021-09-22 17:22:02 +02:00
Extension arrays
----------------
.. doxygenclass:: arrow::ExtensionArray
ARROW-3834: [Doc] Merge C++ and Python documentation Author: Uwe L. Korn <uwelk@xhochy.com> Author: Korn, Uwe <Uwe.Korn@blue-yonder.com> Author: Wes McKinney <wesm+git@apache.org> Closes #2856 from xhochy/doc-merge and squashes the following commits: 5b687ffa7 <Wes McKinney> Add simple README for the format/ directory 071d16ad7 <Uwe L. Korn> Move format specifications back to /format/ 337088bfd <Uwe L. Korn> Review comments fbe99c96c <Uwe L. Korn> Add more C++ docs 78a5eaf4b <Uwe L. Korn> Fix Python docs build 0b4dd3341 <Uwe L. Korn> Rename doc to docs 918e76244 <Uwe L. Korn> Convert format docs to reST 7aeff65ef <Uwe L. Korn> Add doc generation to docker-compose 185cba8fb <Uwe L. Korn> Add pre-commit check for RAT 671d24466 <Uwe L. Korn> Fix references to format documents bdd824c87 <Uwe L. Korn> Move doc to top-level 985d42806 <Uwe L. Korn> Move Sphinx doc to top-level directory f7d5e92d9 <Uwe L. Korn> Build C++ API docs 7850db8a6 <Uwe L. Korn> Add breathe as a requirement d4cf54259 <Uwe L. Korn> Fix linter issues fd75660e6 <Korn, Uwe> Fix Sphinx build for sphinx>=1.8 9be6fbe6f <Korn, Uwe> Merge C++ and Python documentation
2018-12-05 19:54:57 -06:00
:members:
ARROW-3986: [C++] Write prose documentation Author: Antoine Pitrou <antoine@python.org> Closes #3149 from pitrou/ARROW-3986-cpp-prose-doc and squashes the following commits: 77e37940 <Antoine Pitrou> ARROW-3986: Write prose documentation
2018-12-11 15:16:06 +01:00
GH-49274: [Doc][C++] Document security model for Arrow C++ (#49489) ### Rationale for this change Now that we have a general security model for the Arrow specs, add a security model for Arrow C++ specifically, meant to describe appropriate API usage. ### Are these changes tested? N/A. ### Are there any user-facing changes? No. * GitHub Issue: #49274 Authored-by: Antoine Pitrou <antoine@python.org> Signed-off-by: Antoine Pitrou <antoine@python.org>
2026-03-30 11:38:54 +02:00
Run-end encoded
---------------
GH-46537: [Docs][C++] Add RunEndEncodedArray, FlatArray, and PrimitiveArray API Docs (#46540) ### Rationale for this change The [Array](https://arrow.apache.org/docs/cpp/api/array.html) section of the API Doc does not explain `FlatArray`, `PrimitiveArray`, and `RunEndEncodedArray` . ### What changes are included in this PR? Add `FlatArray`, `PrimitiveArray`, and `RunEndEncodedArray` API docs ### Are these changes tested? No. (Document only) ### Are there any user-facing changes? No. * GitHub Issue: #46537 Authored-by: Hiroyuki Sato <hiroysato@gmail.com> Signed-off-by: Antoine Pitrou <antoine@python.org>
2025-05-22 20:29:13 +09:00
.. doxygenclass:: arrow::RunEndEncodedArray
:members:
ARROW-14056: [Doc][C++] Document ArrayData Also ensure that all concrete datatype and array classes are documented. Closes #11201 from pitrou/ARROW-14056-doc-array-data Authored-by: Antoine Pitrou <antoine@python.org> Signed-off-by: Antoine Pitrou <antoine@python.org>
2021-09-22 17:22:02 +02:00
ARROW-3986: [C++] Write prose documentation Author: Antoine Pitrou <antoine@python.org> Closes #3149 from pitrou/ARROW-3986-cpp-prose-doc and squashes the following commits: 77e37940 <Antoine Pitrou> ARROW-3986: Write prose documentation
2018-12-11 15:16:06 +01:00
Chunked Arrays
==============
.. doxygenclass:: arrow::ChunkedArray
:project: arrow_cpp
:members:
ARROW-15952: [C++] Document Visitors and finish Scalar::Accept Closes #12651 from wjones127/ARROW-15952-document-visitor Authored-by: Will Jones <willjones127@gmail.com> Signed-off-by: Antoine Pitrou <antoine@python.org>
2022-03-17 10:45:32 +01:00
GH-44506: [Docs][C++] Fix documentation directive for ChunkLocation (#44505) ### Rationale for this change Since ChunkLocation is a typedef/alias, it needs to use the `doxygentypedef` Sphinx directive rather than `doxygenstruct` in order for it to show up in the generated HTML. Otherwise we get an error. ### What changes are included in this PR? Just docs: - Replace `doxygenstruct` directive with `doxygentypedef` - Remove `:members:` directive as it's not needed ### Are these changes tested? Yes. ### Are there any user-facing changes? Yes, though just docs. * GitHub Issue: #44506 Authored-by: Bryce Mecum <petridish@gmail.com> Signed-off-by: Bryce Mecum <petridish@gmail.com>
2024-10-22 18:36:01 -07:00
.. doxygentypedef:: arrow::ChunkLocation
GH-34535: [C++] Move ChunkResolver to the public API (#44357) ### Rationale for this change Adopting https://github.com/apache/arrow/pull/40226. The creation and return of a shared_ptr does result in some performance overhead, that makes a difference for a performance-sensitive application. If someone could use ChunkResolver to learn the indices, they could then instead access the data directly. ### What changes are included in this PR? - [X] Updates to documentation (thanks to @ SChakravorti21 ) - [X] Moving `ChunkResolver` to public API, and updating all references to it in the code ### Are these changes tested? There seemed to be comprehensive tests already: https://github.com/apache/arrow/blob/main/cpp/src/arrow/chunked_array_test.cc#L324 If an edgecase is missing, I'd be happy to add it. ### Are there any user-facing changes? `ChunkResolver` and `TypedChunkLocation` are now in the public API. * GitHub Issue: #34535 Lead-authored-by: Anja Kefala <anja.kefala@gmail.com> Co-authored-by: anjakefala <anja.kefala@gmail.com> Co-authored-by: Bryce Mecum <petridish@gmail.com> Co-authored-by: SChakravorti21 <schakravorti@bloomberg.net> Co-authored-by: SChakravorti21<schakravorti@bloomberg.net> Co-authored-by: Jacob Wujciak-Jens <jacob@wujciak.de> Signed-off-by: Felipe Oliveira Carvalho <felipekde@gmail.com>
2024-10-21 15:46:48 -07:00
:project: arrow_cpp
.. doxygenstruct:: arrow::TypedChunkLocation
:project: arrow_cpp
:members:
.. doxygenclass:: arrow::ChunkResolver
:project: arrow_cpp
:members:
ARROW-15952: [C++] Document Visitors and finish Scalar::Accept Closes #12651 from wjones127/ARROW-15952-document-visitor Authored-by: Will Jones <willjones127@gmail.com> Signed-off-by: Antoine Pitrou <antoine@python.org>
2022-03-17 10:45:32 +01:00
GH-49274: [Doc][C++] Document security model for Arrow C++ (#49489) ### Rationale for this change Now that we have a general security model for the Arrow specs, add a security model for Arrow C++ specifically, meant to describe appropriate API usage. ### Are these changes tested? N/A. ### Are there any user-facing changes? No. * GitHub Issue: #49274 Authored-by: Antoine Pitrou <antoine@python.org> Signed-off-by: Antoine Pitrou <antoine@python.org>
2026-03-30 11:38:54 +02:00
Non-owning data class
=====================
.. warning::
As this class doesn't keep alive the objects and data it points to, their
lifetime must be ensured separately. We recommend using :class:`arrow::ArrayData`
instead.
.. doxygenclass:: arrow::ArraySpan
:members:
ARROW-15952: [C++] Document Visitors and finish Scalar::Accept Closes #12651 from wjones127/ARROW-15952-document-visitor Authored-by: Will Jones <willjones127@gmail.com> Signed-off-by: Antoine Pitrou <antoine@python.org>
2022-03-17 10:45:32 +01:00
Utilities
=========
.. doxygenclass:: arrow::ArrayVisitor
:project: arrow_cpp
:members:
GH-40318: [C++][Docs] Add documentation of array factories (#40373) ### Rationale for this change These factory functions are generally useful and available, so documenting them helps external users find them without having to search the source code. ### What changes are included in this PR? This PR adds the array factories in arrow/array/util.h into a doxygen group for array factories and adds that group to the Sphinx C++ API documentation. ### Are these changes tested? I built the docs locally to verify. ### Are there any user-facing changes? Nothing to the API, only docs. * GitHub Issue: #40318 Authored-by: Vyas Ramasubramani <vyasr@nvidia.com> Signed-off-by: Antoine Pitrou <antoine@python.org>
2024-03-07 05:24:15 -08:00
:undoc-members:
GH-45908: [C++][Docs] Rename and expose basic {Array,...}FromJSON helpers as public APIs (#46180) ### Rationale for this change These functions are generally useful and stable so it would be a good idea to clearly include them in the public API. I'm starting here with just the basic ones in order to make the PR small. See https://github.com/apache/arrow/issues/45908 for more information. ### What changes are included in this PR? - Moves `ArrayFromJSON`, `ChunkedArrayFromJSON`, `DictArrayFromJSON`, `ScalarFromJSON`, `DictScalarFromJSON` from `arrow::ipc::internal` namespace to `arrow::json` so it's clearer they're part of the public API and that they're more useful than just for IPC - Renames each of the above from `{Array,...}FromJSON` to `{Array,...}FromJSONString` to avoid confusion between these helpers and the main JSON(L) reader - Renames `arrow/util/json_simple.{h,cc}` to `arrow/json/from_string.{h,cc}` both because of the namespace jump but also because the filename is more clear. - Adds User Guide and adds a listing in the API docs for moved functions ### Are these changes tested? Yes. ### Are there any user-facing changes? This expands the scope of our public API but does not break any existing public APIs though it's possible users * GitHub Issue: #45908 Lead-authored-by: Bryce Mecum <petridish@gmail.com> Co-authored-by: Benjamin Kietzman <bengilgit@gmail.com> Co-authored-by: Enrico Minack <github@enrico.minack.dev> Signed-off-by: Bryce Mecum <petridish@gmail.com>
2025-05-14 07:22:02 -07:00
.. _api-array-from-json-string:
FromJSONString Helpers
----------------------
.. doxygengroup:: array-from-json-string
:members:
Reference in New Issue Copy Permalink