copying.hpp
Go to the documentation of this file.
1 /*
2  * SPDX-FileCopyrightText: Copyright (c) 2018-2024, NVIDIA CORPORATION.
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 <vector>
20 
21 namespace CUDF_EXPORT cudf {
22 
37 enum class out_of_bounds_policy : bool {
38  NULLIFY,
39  DONT_CHECK
40 };
41 
73 std::unique_ptr<table> gather(
74  table_view const& source_table,
75  column_view const& gather_map,
76  out_of_bounds_policy bounds_policy = out_of_bounds_policy::DONT_CHECK,
77  rmm::cuda_stream_view stream = cudf::get_default_stream(),
78  rmm::device_async_resource_ref mr = cudf::get_current_device_resource_ref());
79 
95 std::unique_ptr<table> reverse(
96  table_view const& source_table,
97  rmm::cuda_stream_view stream = cudf::get_default_stream(),
98  rmm::device_async_resource_ref mr = cudf::get_current_device_resource_ref());
99 
115 std::unique_ptr<column> reverse(
116  column_view const& source_column,
117  rmm::cuda_stream_view stream = cudf::get_default_stream(),
118  rmm::device_async_resource_ref mr = cudf::get_current_device_resource_ref());
119 
162 std::unique_ptr<table> scatter(
163  table_view const& source,
164  column_view const& scatter_map,
165  table_view const& target,
166  rmm::cuda_stream_view stream = cudf::get_default_stream(),
167  rmm::device_async_resource_ref mr = cudf::get_current_device_resource_ref());
168 
205 std::unique_ptr<table> scatter(
206  std::vector<std::reference_wrapper<scalar const>> const& source,
207  column_view const& indices,
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 
215 enum class mask_allocation_policy : int32_t {
216  NEVER,
217  RETAIN,
218  ALWAYS
219 };
220 
227 std::unique_ptr<column> empty_like(column_view const& input);
228 
235 std::unique_ptr<column> empty_like(scalar const& input);
236 
254 std::unique_ptr<column> allocate_like(
255  column_view const& input,
256  mask_allocation_policy mask_alloc = mask_allocation_policy::RETAIN,
257  rmm::cuda_stream_view stream = cudf::get_default_stream(),
258  rmm::device_async_resource_ref mr = cudf::get_current_device_resource_ref());
259 
276 std::unique_ptr<column> allocate_like(
277  column_view const& input,
278  size_type size,
279  mask_allocation_policy mask_alloc = mask_allocation_policy::RETAIN,
280  rmm::cuda_stream_view stream = cudf::get_default_stream(),
281  rmm::device_async_resource_ref mr = cudf::get_current_device_resource_ref());
282 
293 std::unique_ptr<table> empty_like(table_view const& input_table);
294 
327 void copy_range_in_place(column_view const& source,
328  mutable_column_view& target,
329  size_type source_begin,
330  size_type source_end,
331  size_type target_begin,
332  rmm::cuda_stream_view stream = cudf::get_default_stream());
333 
366 std::unique_ptr<column> copy_range(
367  column_view const& source,
368  column_view const& target,
369  size_type source_begin,
370  size_type source_end,
371  size_type target_begin,
372  rmm::cuda_stream_view stream = cudf::get_default_stream(),
373  rmm::device_async_resource_ref mr = cudf::get_current_device_resource_ref());
374 
412 std::unique_ptr<column> shift(
413  column_view const& input,
414  size_type offset,
415  scalar const& fill_value,
416  rmm::cuda_stream_view stream = cudf::get_default_stream(),
417  rmm::device_async_resource_ref mr = cudf::get_current_device_resource_ref());
418 
450 std::vector<column_view> slice(column_view const& input,
451  host_span<size_type const> indices,
452  rmm::cuda_stream_view stream = cudf::get_default_stream());
457 std::vector<column_view> slice(column_view const& input,
458  std::initializer_list<size_type> indices,
459  rmm::cuda_stream_view stream = cudf::get_default_stream());
460 
494 std::vector<table_view> slice(table_view const& input,
495  host_span<size_type const> indices,
496  rmm::cuda_stream_view stream = cudf::get_default_stream());
501 std::vector<table_view> slice(table_view const& input,
502  std::initializer_list<size_type> indices,
503  rmm::cuda_stream_view stream = cudf::get_default_stream());
504 
538 std::vector<column_view> split(column_view const& input,
539  host_span<size_type const> splits,
540  rmm::cuda_stream_view stream = cudf::get_default_stream());
545 std::vector<column_view> split(column_view const& input,
546  std::initializer_list<size_type> splits,
547  rmm::cuda_stream_view stream = cudf::get_default_stream());
548 
584 std::vector<table_view> split(table_view const& input,
585  host_span<size_type const> splits,
586  rmm::cuda_stream_view stream = cudf::get_default_stream());
591 std::vector<table_view> split(table_view const& input,
592  std::initializer_list<size_type> splits,
593  rmm::cuda_stream_view stream = cudf::get_default_stream());
594 
615 std::unique_ptr<column> copy_if_else(
616  column_view const& lhs,
617  column_view const& rhs,
618  column_view const& boolean_mask,
619  rmm::cuda_stream_view stream = cudf::get_default_stream(),
620  rmm::device_async_resource_ref mr = cudf::get_current_device_resource_ref());
621 
641 std::unique_ptr<column> copy_if_else(
642  scalar const& lhs,
643  column_view const& rhs,
644  column_view const& boolean_mask,
645  rmm::cuda_stream_view stream = cudf::get_default_stream(),
646  rmm::device_async_resource_ref mr = cudf::get_current_device_resource_ref());
647 
667 std::unique_ptr<column> copy_if_else(
668  column_view const& lhs,
669  scalar const& rhs,
670  column_view const& boolean_mask,
671  rmm::cuda_stream_view stream = cudf::get_default_stream(),
672  rmm::device_async_resource_ref mr = cudf::get_current_device_resource_ref());
673 
691 std::unique_ptr<column> copy_if_else(
692  scalar const& lhs,
693  scalar const& rhs,
694  column_view const& boolean_mask,
695  rmm::cuda_stream_view stream = cudf::get_default_stream(),
696  rmm::device_async_resource_ref mr = cudf::get_current_device_resource_ref());
697 
735 std::unique_ptr<table> boolean_mask_scatter(
736  table_view const& input,
737  table_view const& target,
738  column_view const& boolean_mask,
739  rmm::cuda_stream_view stream = cudf::get_default_stream(),
740  rmm::device_async_resource_ref mr = cudf::get_current_device_resource_ref());
741 
774 std::unique_ptr<table> boolean_mask_scatter(
775  std::vector<std::reference_wrapper<scalar const>> const& input,
776  table_view const& target,
777  column_view const& boolean_mask,
778  rmm::cuda_stream_view stream = cudf::get_default_stream(),
779  rmm::device_async_resource_ref mr = cudf::get_current_device_resource_ref());
780 
795 std::unique_ptr<scalar> get_element(
796  column_view const& input,
797  size_type index,
798  rmm::cuda_stream_view stream = cudf::get_default_stream(),
799  rmm::device_async_resource_ref mr = cudf::get_current_device_resource_ref());
800 
804 enum class sample_with_replacement : bool {
805  FALSE,
806  TRUE
807 };
808 
837 std::unique_ptr<table> sample(
838  table_view const& input,
839  size_type const n,
840  sample_with_replacement replacement = sample_with_replacement::FALSE,
841  int64_t const seed = 0,
842  rmm::cuda_stream_view stream = cudf::get_default_stream(),
843  rmm::device_async_resource_ref mr = cudf::get_current_device_resource_ref());
844 
862 bool has_nonempty_nulls(column_view const& input,
863  rmm::cuda_stream_view stream = cudf::get_default_stream());
864 
887 bool may_have_nonempty_nulls(column_view const& input);
888 
957 std::unique_ptr<column> purge_nonempty_nulls(
958  column_view const& input,
959  rmm::cuda_stream_view stream = cudf::get_default_stream(),
960  rmm::device_async_resource_ref mr = cudf::get_current_device_resource_ref());
961 
963 } // 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:316
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:492
cudf::scalar
An owning class to represent a singular value.
Definition: scalar.hpp:40
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:215
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::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:804
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::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=out_of_bounds_policy::DONT_CHECK, 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 (including null values) of a set of columns.
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: io/types.hpp:217
cudf::io::NEVER
@ NEVER
Never use dictionary encoding.
Definition: io/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:40
device_async_resource_ref
detail::cccl_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:84
lists_column_view.hpp
Class definition for cudf::lists_column_view.
memory_resource.hpp
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.
cudf::host_span
C++20 std::span with reduced feature set.
Definition: span.hpp:182
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