lists_column_view.hpp

Go to the documentation of this file.

/*
 * Copyright (c) 2020-2023, NVIDIA CORPORATION.
 *
 * Licensed 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.
 */
#pragma once
 
#include <cudf/column/column.hpp>
#include <cudf/column/column_view.hpp>
 
#include <rmm/cuda_stream_view.hpp>
 
namespace cudf {
 
class lists_column_view : private column_view {
 public:
  lists_column_view(column_view const& lists_column);
  lists_column_view(lists_column_view&&)      = default;  
  lists_column_view(lists_column_view const&) = default;  
  ~lists_column_view()                        = default;
  lists_column_view& operator=(lists_column_view const&) = default;
  lists_column_view& operator=(lists_column_view&&) = default;
 
  static constexpr size_type offsets_column_index{0};  
  static constexpr size_type child_column_index{1};    
 
  using column_view::child_begin;
  using column_view::child_end;
  using column_view::has_nulls;
  using column_view::is_empty;
  using column_view::null_count;
  using column_view::null_mask;
  using column_view::offset;
  using column_view::size;
  static_assert(std::is_same_v<offset_type, size_type>,
                "offset_type is expected to be the same as size_type.");
  using offset_iterator = offset_type const*;  
 
  [[nodiscard]] column_view parent() const;
 
  [[nodiscard]] column_view offsets() const;
 
  [[nodiscard]] column_view child() const;
 
  [[nodiscard]] column_view get_sliced_child(rmm::cuda_stream_view stream) const;
 
  [[nodiscard]] offset_iterator offsets_begin() const noexcept
  {
    return offsets().begin<offset_type>() + offset();
  }
 
  [[nodiscard]] offset_iterator offsets_end() const noexcept
  {
    return offsets_begin() + size() + 1;
  }
};  // end of group
}  // namespace cudf