copying.hpp
Go to the documentation of this file.
1 /*
2  * SPDX-FileCopyrightText: Copyright (c) 2018-2026, NVIDIA CORPORATION & AFFILIATES. All rights reserved.
3  * SPDX-License-Identifier: Apache-2.0
4  */
5 
6 #pragma once
7 
8 #include <cudf/column/column_view.hpp>
9 #include <cudf/lists/lists_column_view.hpp>
10 #include <cudf/scalar/scalar.hpp>
11 #include <cudf/strings/strings_column_view.hpp>
12 #include <cudf/structs/structs_column_view.hpp>
13 #include <cudf/table/table.hpp>
14 #include <cudf/types.hpp>
15 #include <cudf/utilities/export.hpp>
16 #include <cudf/utilities/memory_resource.hpp>
17 
18 #include <memory>
19 #include <span>
20 #include <vector>
21 
27 namespace CUDF_EXPORT cudf {
28 
37 enum class out_of_bounds_policy : bool {
38  NULLIFY,
39  DONT_CHECK
40 };
41 
45 enum class negative_index_policy : bool {
46  ALLOWED,
47  NOT_ALLOWED
48 };
49 
81 std::unique_ptr<table> gather(
82  table_view const& source_table,
83  column_view const& gather_map,
84  out_of_bounds_policy bounds_policy = out_of_bounds_policy::DONT_CHECK,
85  rmm::cuda_stream_view stream = cudf::get_default_stream(),
86  rmm::device_async_resource_ref mr = cudf::get_current_device_resource_ref());
87 
118 std::unique_ptr<table> gather(
119  table_view const& source_table,
120  column_view const& gather_map,
121  out_of_bounds_policy bounds_policy,
122  negative_index_policy neg_indices,
123  rmm::cuda_stream_view stream = cudf::get_default_stream(),
124  rmm::device_async_resource_ref mr = cudf::get_current_device_resource_ref());
125 
141 std::unique_ptr<table> reverse(
142  table_view const& source_table,
143  rmm::cuda_stream_view stream = cudf::get_default_stream(),
144  rmm::device_async_resource_ref mr = cudf::get_current_device_resource_ref());
145 
161 std::unique_ptr<column> reverse(
162  column_view const& source_column,
163  rmm::cuda_stream_view stream = cudf::get_default_stream(),
164  rmm::device_async_resource_ref mr = cudf::get_current_device_resource_ref());
165 
208 std::unique_ptr<table> scatter(
209  table_view const& source,
210  column_view const& scatter_map,
211  table_view const& target,
212  rmm::cuda_stream_view stream = cudf::get_default_stream(),
213  rmm::device_async_resource_ref mr = cudf::get_current_device_resource_ref());
214 
251 std::unique_ptr<table> scatter(
252  std::vector<std::reference_wrapper<scalar const>> const& source,
253  column_view const& indices,
254  table_view const& target,
255  rmm::cuda_stream_view stream = cudf::get_default_stream(),
256  rmm::device_async_resource_ref mr = cudf::get_current_device_resource_ref());
257 
261 enum class mask_allocation_policy : int32_t {
262  NEVER,
263  RETAIN,
264  ALWAYS
265 };
266 
273 std::unique_ptr<column> empty_like(column_view const& input);
274 
281 std::unique_ptr<column> empty_like(scalar const& input);
282 
300 std::unique_ptr<column> allocate_like(
301  column_view const& input,
302  mask_allocation_policy mask_alloc = mask_allocation_policy::RETAIN,
303  rmm::cuda_stream_view stream = cudf::get_default_stream(),
304  rmm::device_async_resource_ref mr = cudf::get_current_device_resource_ref());
305 
322 std::unique_ptr<column> allocate_like(
323  column_view const& input,
324  size_type size,
325  mask_allocation_policy mask_alloc = mask_allocation_policy::RETAIN,
326  rmm::cuda_stream_view stream = cudf::get_default_stream(),
327  rmm::device_async_resource_ref mr = cudf::get_current_device_resource_ref());
328 
339 std::unique_ptr<table> empty_like(table_view const& input_table);
340 
373 void copy_range_in_place(column_view const& source,
374  mutable_column_view& target,
375  size_type source_begin,
376  size_type source_end,
377  size_type target_begin,
378  rmm::cuda_stream_view stream = cudf::get_default_stream());
379 
412 std::unique_ptr<column> copy_range(
413  column_view const& source,
414  column_view const& target,
415  size_type source_begin,
416  size_type source_end,
417  size_type target_begin,
418  rmm::cuda_stream_view stream = cudf::get_default_stream(),
419  rmm::device_async_resource_ref mr = cudf::get_current_device_resource_ref());
420 
458 std::unique_ptr<column> shift(
459  column_view const& input,
460  size_type offset,
461  scalar const& fill_value,
462  rmm::cuda_stream_view stream = cudf::get_default_stream(),
463  rmm::device_async_resource_ref mr = cudf::get_current_device_resource_ref());
464 
496 std::vector<column_view> slice(column_view const& input,
497  std::span<size_type const> indices,
498  rmm::cuda_stream_view stream = cudf::get_default_stream());
503 std::vector<column_view> slice(column_view const& input,
504  std::initializer_list<size_type> indices,
505  rmm::cuda_stream_view stream = cudf::get_default_stream());
506 
540 std::vector<table_view> slice(table_view const& input,
541  std::span<size_type const> indices,
542  rmm::cuda_stream_view stream = cudf::get_default_stream());
547 std::vector<table_view> slice(table_view const& input,
548  std::initializer_list<size_type> indices,
549  rmm::cuda_stream_view stream = cudf::get_default_stream());
550 
584 std::vector<column_view> split(column_view const& input,
585  std::span<size_type const> splits,
586  rmm::cuda_stream_view stream = cudf::get_default_stream());
591 std::vector<column_view> split(column_view const& input,
592  std::initializer_list<size_type> splits,
593  rmm::cuda_stream_view stream = cudf::get_default_stream());
594 
630 std::vector<table_view> split(table_view const& input,
631  std::span<size_type const> splits,
632  rmm::cuda_stream_view stream = cudf::get_default_stream());
637 std::vector<table_view> split(table_view const& input,
638  std::initializer_list<size_type> splits,
639  rmm::cuda_stream_view stream = cudf::get_default_stream());
640 
661 std::unique_ptr<column> copy_if_else(
662  column_view const& lhs,
663  column_view const& rhs,
664  column_view const& boolean_mask,
665  rmm::cuda_stream_view stream = cudf::get_default_stream(),
666  rmm::device_async_resource_ref mr = cudf::get_current_device_resource_ref());
667 
687 std::unique_ptr<column> copy_if_else(
688  scalar const& lhs,
689  column_view const& rhs,
690  column_view const& boolean_mask,
691  rmm::cuda_stream_view stream = cudf::get_default_stream(),
692  rmm::device_async_resource_ref mr = cudf::get_current_device_resource_ref());
693 
713 std::unique_ptr<column> copy_if_else(
714  column_view const& lhs,
715  scalar const& rhs,
716  column_view const& boolean_mask,
717  rmm::cuda_stream_view stream = cudf::get_default_stream(),
718  rmm::device_async_resource_ref mr = cudf::get_current_device_resource_ref());
719 
737 std::unique_ptr<column> copy_if_else(
738  scalar const& lhs,
739  scalar const& rhs,
740  column_view const& boolean_mask,
741  rmm::cuda_stream_view stream = cudf::get_default_stream(),
742  rmm::device_async_resource_ref mr = cudf::get_current_device_resource_ref());
743 
781 std::unique_ptr<table> boolean_mask_scatter(
782  table_view const& input,
783  table_view const& target,
784  column_view const& boolean_mask,
785  rmm::cuda_stream_view stream = cudf::get_default_stream(),
786  rmm::device_async_resource_ref mr = cudf::get_current_device_resource_ref());
787 
820 std::unique_ptr<table> boolean_mask_scatter(
821  std::vector<std::reference_wrapper<scalar const>> const& input,
822  table_view const& target,
823  column_view const& boolean_mask,
824  rmm::cuda_stream_view stream = cudf::get_default_stream(),
825  rmm::device_async_resource_ref mr = cudf::get_current_device_resource_ref());
826 
841 std::unique_ptr<scalar> get_element(
842  column_view const& input,
843  size_type index,
844  rmm::cuda_stream_view stream = cudf::get_default_stream(),
845  rmm::device_async_resource_ref mr = cudf::get_current_device_resource_ref());
846 
850 enum class sample_with_replacement : bool {
851  FALSE,
852  TRUE
853 };
854 
883 std::unique_ptr<table> sample(
884  table_view const& input,
885  size_type const n,
886  sample_with_replacement replacement = sample_with_replacement::FALSE,
887  int64_t const seed = 0,
888  rmm::cuda_stream_view stream = cudf::get_default_stream(),
889  rmm::device_async_resource_ref mr = cudf::get_current_device_resource_ref());
890 
908 bool has_nonempty_nulls(column_view const& input,
909  rmm::cuda_stream_view stream = cudf::get_default_stream());
910 
933 bool may_have_nonempty_nulls(column_view const& input);
934 
1003 std::unique_ptr<column> purge_nonempty_nulls(
1004  column_view const& input,
1005  rmm::cuda_stream_view stream = cudf::get_default_stream(),
1006  rmm::device_async_resource_ref mr = cudf::get_current_device_resource_ref());
1007 
1009 } // namespace CUDF_EXPORT cudf
cudf::column_view
A non-owning, immutable view of device data as a column of elements, some of which may be null as ind...
Definition: column_view.hpp:318
cudf::mutable_column_view
A non-owning, mutable view of device data as a column of elements, some of which may be null as indic...
Definition: column_view.hpp:494
cudf::scalar
An owning class to represent a singular value.
Definition: scalar.hpp:41
cudf::table_view
A set of cudf::column_view's of the same size.
Definition: table_view.hpp:206
rmm::cuda_stream_view
column_view.hpp
column view class definitions
cudf::mask_allocation_policy
mask_allocation_policy
Indicates when to allocate a mask, based on an existing mask.
Definition: copying.hpp:261
cudf::reverse
std::unique_ptr< column > reverse(column_view const &source_column, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=cudf::get_current_device_resource_ref())
Reverses the elements of a column.
cudf::copy_if_else
std::unique_ptr< column > copy_if_else(scalar const &lhs, scalar const &rhs, column_view const &boolean_mask, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=cudf::get_current_device_resource_ref())
Returns a new column, where each element is selected from either lhs or rhs based on the value of the...
cudf::allocate_like
std::unique_ptr< column > allocate_like(column_view const &input, size_type size, mask_allocation_policy mask_alloc=mask_allocation_policy::RETAIN, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=cudf::get_current_device_resource_ref())
Creates an uninitialized new column of the specified size and same type as the input.
cudf::may_have_nonempty_nulls
bool may_have_nonempty_nulls(column_view const &input)
Approximates if a column or its descendants may have non-empty null elements.
cudf::copy_range_in_place
void copy_range_in_place(column_view const &source, mutable_column_view &target, size_type source_begin, size_type source_end, size_type target_begin, rmm::cuda_stream_view stream=cudf::get_default_stream())
Copies a range of elements in-place from one column to another.
cudf::negative_index_policy
negative_index_policy
Policy to recognize negative indices as relative to the end of the source.
Definition: copying.hpp:45
cudf::sample
std::unique_ptr< table > sample(table_view const &input, size_type const n, sample_with_replacement replacement=sample_with_replacement::FALSE, int64_t const seed=0, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=cudf::get_current_device_resource_ref())
Gather n samples from given input randomly.
cudf::has_nonempty_nulls
bool has_nonempty_nulls(column_view const &input, rmm::cuda_stream_view stream=cudf::get_default_stream())
Checks if a column or its descendants have non-empty null rows.
cudf::purge_nonempty_nulls
std::unique_ptr< column > purge_nonempty_nulls(column_view const &input, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=cudf::get_current_device_resource_ref())
Copy input into output while purging any non-empty null rows in the column or its descendants.
cudf::copy_range
std::unique_ptr< column > copy_range(column_view const &source, column_view const &target, size_type source_begin, size_type source_end, size_type target_begin, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=cudf::get_current_device_resource_ref())
Copies a range of elements out-of-place from one column to another.
cudf::out_of_bounds_policy
out_of_bounds_policy
Policy to account for possible out-of-bounds indices.
Definition: copying.hpp:37
cudf::sample_with_replacement
sample_with_replacement
Indicates whether a row can be sampled more than once.
Definition: copying.hpp:850
cudf::get_element
std::unique_ptr< scalar > get_element(column_view const &input, size_type index, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=cudf::get_current_device_resource_ref())
Get the element at specified index from a column.
cudf::empty_like
std::unique_ptr< table > empty_like(table_view const &input_table)
Creates a table of empty columns with the same types as the input_table
cudf::mask_allocation_policy::RETAIN
@ RETAIN
Allocate a null mask if the input contains one.
cudf::negative_index_policy::NOT_ALLOWED
@ NOT_ALLOWED
Negative indices are not allowed and result in undefined behavior.
cudf::negative_index_policy::ALLOWED
@ ALLOWED
Negative indices are allowed and result in wrapping behavior.
cudf::out_of_bounds_policy::DONT_CHECK
@ DONT_CHECK
No bounds checking is performed, better performance.
cudf::out_of_bounds_policy::NULLIFY
@ NULLIFY
Output values corresponding to out-of-bounds indices are null.
cudf::sample_with_replacement::FALSE
@ FALSE
A row can be sampled only once.
cudf::sample_with_replacement::TRUE
@ TRUE
A row can be sampled more than once.
cudf::gather
std::unique_ptr< table > gather(table_view const &source_table, column_view const &gather_map, out_of_bounds_policy bounds_policy, negative_index_policy neg_indices, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=cudf::get_current_device_resource_ref())
Gathers the specified rows of a set of columns according to a gather map.
cudf::scatter
std::unique_ptr< table > scatter(std::vector< std::reference_wrapper< scalar const >> const &source, column_view const &indices, table_view const &target, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=cudf::get_current_device_resource_ref())
Scatters a row of scalar values into a copy of the target table according to a scatter map.
cudf::boolean_mask_scatter
std::unique_ptr< table > boolean_mask_scatter(std::vector< std::reference_wrapper< scalar const >> const &input, table_view const &target, column_view const &boolean_mask, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=cudf::get_current_device_resource_ref())
Scatters scalar values to rows of the output corresponding to true values in a boolean mask.
cudf::shift
std::unique_ptr< column > shift(column_view const &input, size_type offset, scalar const &fill_value, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=cudf::get_current_device_resource_ref())
Creates a new column by shifting all values by an offset.
cudf::slice
std::vector< table_view > slice(table_view const &input, std::initializer_list< size_type > indices, rmm::cuda_stream_view stream=cudf::get_default_stream())
Slices a table_view into a set of table_views according to a set of indices.
cudf::split
std::vector< table_view > split(table_view const &input, std::initializer_list< size_type > splits, rmm::cuda_stream_view stream=cudf::get_default_stream())
Splits a table_view into a set of table_views according to a set of indices derived from expected spl...
cudf::get_default_stream
rmm::cuda_stream_view const get_default_stream()
Get the current default stream.
cudf::io::ALWAYS
@ ALWAYS
Use dictionary regardless of impact on compression.
Definition: types.hpp:217
cudf::io::NEVER
@ NEVER
Never use dictionary encoding.
Definition: types.hpp:215
cudf::get_current_device_resource_ref
rmm::device_async_resource_ref get_current_device_resource_ref()
Get the current device memory resource reference.
Definition: memory_resource.hpp:34
rmm::device_async_resource_ref
cuda::mr::resource_ref< cuda::mr::device_accessible > device_async_resource_ref
cudf::size_type
int32_t size_type
Row index type for columns and tables.
Definition: types.hpp:76
lists_column_view.hpp
Class definition for cudf::lists_column_view.
memory_resource.hpp
APIs for getting and setting the current device memory resource.
cudf
cuDF interfaces
Definition: host_udf.hpp:26
scalar.hpp
Class definitions for cudf::scalar.
strings_column_view.hpp
Class definition for cudf::strings_column_view.
structs_column_view.hpp
Class definition for cudf::structs_column_view.
table.hpp
Class definition for cudf::table.
types.hpp
Type declarations for libcudf.
Generated by doxygen 1.9.1