arrow/array/concatenate.h

0001 // Licensed to the Apache Software Foundation (ASF) under one
0002 // or more contributor license agreements.  See the NOTICE file
0003 // distributed with this work for additional information
0004 // regarding copyright ownership.  The ASF licenses this file
0005 // to you under the Apache License, Version 2.0 (the
0006 // "License"); you may not use this file except in compliance
0007 // with the License.  You may obtain a copy of the License at
0008 //
0009 //   http://www.apache.org/licenses/LICENSE-2.0
0010 //
0011 // Unless required by applicable law or agreed to in writing,
0012 // software distributed under the License is distributed on an
0013 // "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
0014 // KIND, either express or implied.  See the License for the
0015 // specific language governing permissions and limitations
0016 // under the License.
0017
0018 #pragma once
0019
0020 #include <memory>
0021
0022 #include "arrow/type_fwd.h"
0023 #include "arrow/util/macros.h"
0024 #include "arrow/util/visibility.h"
0025
0026 namespace arrow {
0027 namespace internal {
0028
0029 /// \brief Concatenate arrays
0030 ///
0031 /// \param[in] arrays a vector of arrays to be concatenated
0032 /// \param[in] pool memory to store the result will be allocated from this memory pool
0033 /// \param[out] out_suggested_cast if a non-OK Result is returned, the function might set
0034 ///   out_suggested_cast to a cast suggestion that would allow concatenating the arrays
0035 ///   without overflow of offsets (e.g. string to large_string)
0036 ///
0037 /// \return the concatenated array
0038 ARROW_EXPORT
0039 Result<std::shared_ptr<Array>> Concatenate(const ArrayVector& arrays, MemoryPool* pool,
0040                                            std::shared_ptr<DataType>* out_suggested_cast);
0041
0042 }  // namespace internal
0043
0044 /// \brief Concatenate arrays
0045 ///
0046 /// \param[in] arrays a vector of arrays to be concatenated
0047 /// \param[in] pool memory to store the result will be allocated from this memory pool
0048 /// \return the concatenated array
0049 ARROW_EXPORT
0050 Result<std::shared_ptr<Array>> Concatenate(const ArrayVector& arrays,
0051                                            MemoryPool* pool = default_memory_pool());
0052
0053 }  // namespace arrow