raulcd commented on code in PR #46210: URL: https://github.com/apache/arrow/pull/46210#discussion_r2079382014
########## docs/source/developers/cpp/compute.rst: ########## @@ -0,0 +1,178 @@ +.. 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. + +.. highlight:: console +.. _development-cpp-compute: + +============================ +Developing Arrow C++ Compute +============================ + +This section provides information for developers of the Arrow C++ Compute module. + +Row Table +========= + +The row table in Arrow represents data stored in row-major format. This format +is particularly useful for scenarios involving random access to individual rows +and where all columns are frequently accessed together. It is especially +advantageous for hash-table keys and facilitates efficient operations such as +grouping and hash joins by optimizing memory access patterns and data locality. + +Metadata +-------- + +A row table is defined by its metadata, ``RowTableMetadata``, which includes +information about its schema, alignment, and derived properties. + +The schema specifies the types and order of columns. Each row in the row table +contains the data for each column in that logical order (the physical order may +vary; see :ref:`row-encoding` for details). + +One important property derived from the schema is wether the row table is Review Comment: ```suggestion One important property derived from the schema is whether the row table is ``` ########## docs/source/developers/cpp/compute.rst: ########## @@ -0,0 +1,178 @@ +.. 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. + +.. highlight:: console +.. _development-cpp-compute: + +============================ +Developing Arrow C++ Compute +============================ + +This section provides information for developers of the Arrow C++ Compute module. + +Row Table +========= + +The row table in Arrow represents data stored in row-major format. This format +is particularly useful for scenarios involving random access to individual rows +and where all columns are frequently accessed together. It is especially +advantageous for hash-table keys and facilitates efficient operations such as +grouping and hash joins by optimizing memory access patterns and data locality. + +Metadata +-------- + +A row table is defined by its metadata, ``RowTableMetadata``, which includes +information about its schema, alignment, and derived properties. + +The schema specifies the types and order of columns. Each row in the row table +contains the data for each column in that logical order (the physical order may +vary; see :ref:`row-encoding` for details). + +One important property derived from the schema is wether the row table is +fixed-length or varying-length. A fixed-length row table contains only +fixed-length columns, while a varying-length row table includes at least one +varying-length column. This distinction determines how data is stored and +accessed in the row table. + +Each row in the row table is aligned to ``RowTableMetadata::row_alignment`` +bytes. Fixed-length columns with non-power-of-2 lengths are also aligned to +``RowTableMetadata::row_alignment`` bytes. Varying-length columns are aligned to +``RowTableMetadata::string_alignment`` bytes. + +Buffer Layout +------------- + +Similar to most Arrow ``Array``\s, the row table consists of three buffers: Review Comment: I personally would remove the `Similar to most Arrow Arrays` part as when I read it the first time my brain wrongly assume that the varying-length buffer could have some similarity to the offsets buffer and the memory layout is quite different when we have varying length columns. ```suggestion The row table layout consists of three buffers: ``` -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: github-unsubscr...@arrow.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
