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 
22 namespace CUDF_EXPORT cudf {
23 
34 enum class out_of_bounds_policy : bool {
35  NULLIFY,
36  DONT_CHECK
37 };
38 
42 enum class negative_index_policy : bool {
43  ALLOWED,
44  NOT_ALLOWED
45 };
46 
78 std::unique_ptr<table> gather(
79  table_view const& source_table,
80  column_view const& gather_map,
81  out_of_bounds_policy bounds_policy = out_of_bounds_policy::DONT_CHECK,
82  rmm::cuda_stream_view stream = cudf::get_default_stream(),
83  rmm::device_async_resource_ref mr = cudf::get_current_device_resource_ref());
84 
115 std::unique_ptr<table> gather(
116  table_view const& source_table,
117  column_view const& gather_map,
118  out_of_bounds_policy bounds_policy,
119  negative_index_policy neg_indices,
120  rmm::cuda_stream_view stream = cudf::get_default_stream(),
121  rmm::device_async_resource_ref mr = cudf::get_current_device_resource_ref());
122 
138 std::unique_ptr<table> reverse(
139  table_view const& source_table,
140  rmm::cuda_stream_view stream = cudf::get_default_stream(),
141  rmm::device_async_resource_ref mr = cudf::get_current_device_resource_ref());
142 
158 std::unique_ptr<column> reverse(
159  column_view const& source_column,
160  rmm::cuda_stream_view stream = cudf::get_default_stream(),
161  rmm::device_async_resource_ref mr = cudf::get_current_device_resource_ref());
162 
205 std::unique_ptr<table> scatter(
206  table_view const& source,
207  column_view const& scatter_map,
208  table_view const& target,
209  rmm::cuda_stream_view stream = cudf::get_default_stream(),
210  rmm::device_async_resource_ref mr = cudf::get_current_device_resource_ref());
211 
248 std::unique_ptr<table> scatter(
249  std::vector<std::reference_wrapper<scalar const>> const& source,
250  column_view const& indices,
251  table_view const& target,
252  rmm::cuda_stream_view stream = cudf::get_default_stream(),
253  rmm::device_async_resource_ref mr = cudf::get_current_device_resource_ref());
254 
258 enum class mask_allocation_policy : int32_t {
259  NEVER,
260  RETAIN,
261  ALWAYS
262 };
263 
270 std::unique_ptr<column> empty_like(column_view const& input);
271 
278 std::unique_ptr<column> empty_like(scalar const& input);
279 
297 std::unique_ptr<column> allocate_like(
298  column_view const& input,
299  mask_allocation_policy mask_alloc = mask_allocation_policy::RETAIN,
300  rmm::cuda_stream_view stream = cudf::get_default_stream(),
301  rmm::device_async_resource_ref mr = cudf::get_current_device_resource_ref());
302 
319 std::unique_ptr<column> allocate_like(
320  column_view const& input,
321  size_type size,
322  mask_allocation_policy mask_alloc = mask_allocation_policy::RETAIN,
323  rmm::cuda_stream_view stream = cudf::get_default_stream(),
324  rmm::device_async_resource_ref mr = cudf::get_current_device_resource_ref());
325 
336 std::unique_ptr<table> empty_like(table_view const& input_table);
337 
370 void copy_range_in_place(column_view const& source,
371  mutable_column_view& target,
372  size_type source_begin,
373  size_type source_end,
374  size_type target_begin,
375  rmm::cuda_stream_view stream = cudf::get_default_stream());
376 
409 std::unique_ptr<column> copy_range(
410  column_view const& source,
411  column_view const& target,
412  size_type source_begin,
413  size_type source_end,
414  size_type target_begin,
415  rmm::cuda_stream_view stream = cudf::get_default_stream(),
416  rmm::device_async_resource_ref mr = cudf::get_current_device_resource_ref());
417 
455 std::unique_ptr<column> shift(
456  column_view const& input,
457  size_type offset,
458  scalar const& fill_value,
459  rmm::cuda_stream_view stream = cudf::get_default_stream(),
460  rmm::device_async_resource_ref mr = cudf::get_current_device_resource_ref());
461 
493 std::vector<column_view> slice(column_view const& input,
494  std::span<size_type const> indices,
495  rmm::cuda_stream_view stream = cudf::get_default_stream());
500 std::vector<column_view> slice(column_view const& input,
501  std::initializer_list<size_type> indices,
502  rmm::cuda_stream_view stream = cudf::get_default_stream());
503 
537 std::vector<table_view> slice(table_view const& input,
538  std::span<size_type const> indices,
539  rmm::cuda_stream_view stream = cudf::get_default_stream());
544 std::vector<table_view> slice(table_view const& input,
545  std::initializer_list<size_type> indices,
546  rmm::cuda_stream_view stream = cudf::get_default_stream());
547 
581 std::vector<column_view> split(column_view const& input,
582  std::span<size_type const> splits,
583  rmm::cuda_stream_view stream = cudf::get_default_stream());
588 std::vector<column_view> split(column_view const& input,
589  std::initializer_list<size_type> splits,
590  rmm::cuda_stream_view stream = cudf::get_default_stream());
591 
627 std::vector<table_view> split(table_view const& input,
628  std::span<size_type const> splits,
629  rmm::cuda_stream_view stream = cudf::get_default_stream());
634 std::vector<table_view> split(table_view const& input,
635  std::initializer_list<size_type> splits,
636  rmm::cuda_stream_view stream = cudf::get_default_stream());
637 
658 std::unique_ptr<column> copy_if_else(
659  column_view const& lhs,
660  column_view const& rhs,
661  column_view const& boolean_mask,
662  rmm::cuda_stream_view stream = cudf::get_default_stream(),
663  rmm::device_async_resource_ref mr = cudf::get_current_device_resource_ref());
664 
684 std::unique_ptr<column> copy_if_else(
685  scalar const& lhs,
686  column_view const& rhs,
687  column_view const& boolean_mask,
688  rmm::cuda_stream_view stream = cudf::get_default_stream(),
689  rmm::device_async_resource_ref mr = cudf::get_current_device_resource_ref());
690 
710 std::unique_ptr<column> copy_if_else(
711  column_view const& lhs,
712  scalar const& rhs,
713  column_view const& boolean_mask,
714  rmm::cuda_stream_view stream = cudf::get_default_stream(),
715  rmm::device_async_resource_ref mr = cudf::get_current_device_resource_ref());
716 
734 std::unique_ptr<column> copy_if_else(
735  scalar const& lhs,
736  scalar const& rhs,
737  column_view const& boolean_mask,
738  rmm::cuda_stream_view stream = cudf::get_default_stream(),
739  rmm::device_async_resource_ref mr = cudf::get_current_device_resource_ref());
740 
778 std::unique_ptr<table> boolean_mask_scatter(
779  table_view const& input,
780  table_view const& target,
781  column_view const& boolean_mask,
782  rmm::cuda_stream_view stream = cudf::get_default_stream(),
783  rmm::device_async_resource_ref mr = cudf::get_current_device_resource_ref());
784 
817 std::unique_ptr<table> boolean_mask_scatter(
818  std::vector<std::reference_wrapper<scalar const>> const& input,
819  table_view const& target,
820  column_view const& boolean_mask,
821  rmm::cuda_stream_view stream = cudf::get_default_stream(),
822  rmm::device_async_resource_ref mr = cudf::get_current_device_resource_ref());
823 
838 std::unique_ptr<scalar> get_element(
839  column_view const& input,
840  size_type index,
841  rmm::cuda_stream_view stream = cudf::get_default_stream(),
842  rmm::device_async_resource_ref mr = cudf::get_current_device_resource_ref());
843 
847 enum class sample_with_replacement : bool {
848  FALSE,
849  TRUE
850 };
851 
880 std::unique_ptr<table> sample(
881  table_view const& input,
882  size_type const n,
883  sample_with_replacement replacement = sample_with_replacement::FALSE,
884  int64_t const seed = 0,
885  rmm::cuda_stream_view stream = cudf::get_default_stream(),
886  rmm::device_async_resource_ref mr = cudf::get_current_device_resource_ref());
887 
905 bool has_nonempty_nulls(column_view const& input,
906  rmm::cuda_stream_view stream = cudf::get_default_stream());
907 
930 bool may_have_nonempty_nulls(column_view const& input);
931 
1000 std::unique_ptr<column> purge_nonempty_nulls(
1001  column_view const& input,
1002  rmm::cuda_stream_view stream = cudf::get_default_stream(),
1003  rmm::device_async_resource_ref mr = cudf::get_current_device_resource_ref());
1004 
1006 } // 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:189
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:258
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:42
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:34
cudf::sample_with_replacement
sample_with_replacement
Indicates whether a row can be sampled more than once.
Definition: copying.hpp:847
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:218
cudf::io::NEVER
@ NEVER
Never use dictionary encoding.
Definition: types.hpp:216
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:28
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:85
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