arrow/util/bitmap_builders.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 <cstdint>
0021 #include <memory>
0022 #include <vector>
0023
0024 #include "arrow/result.h"
0025 #include "arrow/type_fwd.h"
0026 #include "arrow/util/span.h"
0027 #include "arrow/util/visibility.h"
0028
0029 namespace arrow {
0030 namespace internal {
0031
0032 /// \brief Generate Bitmap with all position to `value` except for one found
0033 /// at `straggler_pos`.
0034 ARROW_EXPORT
0035 Result<std::shared_ptr<Buffer>> BitmapAllButOne(MemoryPool* pool, int64_t length,
0036                                                 int64_t straggler_pos, bool value = true);
0037
0038 /// \brief Convert vector of bytes to bitmap buffer
0039 ARROW_EXPORT
0040 Result<std::shared_ptr<Buffer>> BytesToBits(util::span<const uint8_t> bytes,
0041                                             MemoryPool* pool = default_memory_pool());
0042
0043 }  // namespace internal
0044 }  // namespace arrow