copying.hpp
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2018-2024, NVIDIA CORPORATION.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 #pragma once
18 
19 #include <cudf/column/column_view.hpp>
20 #include <cudf/lists/lists_column_view.hpp>
21 #include <cudf/scalar/scalar.hpp>
22 #include <cudf/strings/strings_column_view.hpp>
23 #include <cudf/structs/structs_column_view.hpp>
24 #include <cudf/table/table.hpp>
25 #include <cudf/types.hpp>
26 
27 #include <rmm/mr/device/per_device_resource.hpp>
28 #include <rmm/resource_ref.hpp>
29 
30 #include <memory>
31 #include <vector>
32 
33 namespace cudf {
34 
49 enum class out_of_bounds_policy : bool {
50  NULLIFY,
51  DONT_CHECK
52 };
53 
85 std::unique_ptr<table> gather(
86  table_view const& source_table,
87  column_view const& gather_map,
88  out_of_bounds_policy bounds_policy = out_of_bounds_policy::DONT_CHECK,
89  rmm::cuda_stream_view stream = cudf::get_default_stream(),
90  rmm::device_async_resource_ref mr = rmm::mr::get_current_device_resource());
91 
107 std::unique_ptr<table> reverse(
108  table_view const& source_table,
109  rmm::cuda_stream_view stream = cudf::get_default_stream(),
110  rmm::device_async_resource_ref mr = rmm::mr::get_current_device_resource());
111 
127 std::unique_ptr<column> reverse(
128  column_view const& source_column,
129  rmm::cuda_stream_view stream = cudf::get_default_stream(),
130  rmm::device_async_resource_ref mr = rmm::mr::get_current_device_resource());
131 
174 std::unique_ptr<table> scatter(
175  table_view const& source,
176  column_view const& scatter_map,
177  table_view const& target,
178  rmm::cuda_stream_view stream = cudf::get_default_stream(),
179  rmm::device_async_resource_ref mr = rmm::mr::get_current_device_resource());
180 
217 std::unique_ptr<table> scatter(
218  std::vector<std::reference_wrapper<scalar const>> const& source,
219  column_view const& indices,
220  table_view const& target,
221  rmm::cuda_stream_view stream = cudf::get_default_stream(),
222  rmm::device_async_resource_ref mr = rmm::mr::get_current_device_resource());
223 
227 enum class mask_allocation_policy : int32_t {
228  NEVER,
229  RETAIN,
230  ALWAYS
231 };
232 
239 std::unique_ptr<column> empty_like(column_view const& input);
240 
247 std::unique_ptr<column> empty_like(scalar const& input);
248 
266 std::unique_ptr<column> allocate_like(
267  column_view const& input,
268  mask_allocation_policy mask_alloc = mask_allocation_policy::RETAIN,
269  rmm::cuda_stream_view stream = cudf::get_default_stream(),
270  rmm::device_async_resource_ref mr = rmm::mr::get_current_device_resource());
271 
288 std::unique_ptr<column> allocate_like(
289  column_view const& input,
290  size_type size,
291  mask_allocation_policy mask_alloc = mask_allocation_policy::RETAIN,
292  rmm::cuda_stream_view stream = cudf::get_default_stream(),
293  rmm::device_async_resource_ref mr = rmm::mr::get_current_device_resource());
294 
305 std::unique_ptr<table> empty_like(table_view const& input_table);
306 
339 void copy_range_in_place(column_view const& source,
340  mutable_column_view& target,
341  size_type source_begin,
342  size_type source_end,
343  size_type target_begin,
344  rmm::cuda_stream_view stream = cudf::get_default_stream());
345 
378 std::unique_ptr<column> copy_range(
379  column_view const& source,
380  column_view const& target,
381  size_type source_begin,
382  size_type source_end,
383  size_type target_begin,
384  rmm::cuda_stream_view stream = cudf::get_default_stream(),
385  rmm::device_async_resource_ref mr = rmm::mr::get_current_device_resource());
386 
424 std::unique_ptr<column> shift(
425  column_view const& input,
426  size_type offset,
427  scalar const& fill_value,
428  rmm::cuda_stream_view stream = cudf::get_default_stream(),
429  rmm::device_async_resource_ref mr = rmm::mr::get_current_device_resource());
430 
462 std::vector<column_view> slice(column_view const& input,
463  host_span<size_type const> indices,
464  rmm::cuda_stream_view stream = cudf::get_default_stream());
469 std::vector<column_view> slice(column_view const& input,
470  std::initializer_list<size_type> indices,
471  rmm::cuda_stream_view stream = cudf::get_default_stream());
472 
506 std::vector<table_view> slice(table_view const& input,
507  host_span<size_type const> indices,
508  rmm::cuda_stream_view stream = cudf::get_default_stream());
513 std::vector<table_view> slice(table_view const& input,
514  std::initializer_list<size_type> indices,
515  rmm::cuda_stream_view stream = cudf::get_default_stream());
516 
550 std::vector<column_view> split(column_view const& input,
551  host_span<size_type const> splits,
552  rmm::cuda_stream_view stream = cudf::get_default_stream());
557 std::vector<column_view> split(column_view const& input,
558  std::initializer_list<size_type> splits,
559  rmm::cuda_stream_view stream = cudf::get_default_stream());
560 
596 std::vector<table_view> split(table_view const& input,
597  host_span<size_type const> splits,
598  rmm::cuda_stream_view stream = cudf::get_default_stream());
603 std::vector<table_view> split(table_view const& input,
604  std::initializer_list<size_type> splits,
605  rmm::cuda_stream_view stream = cudf::get_default_stream());
606 
627 std::unique_ptr<column> copy_if_else(
628  column_view const& lhs,
629  column_view const& rhs,
630  column_view const& boolean_mask,
631  rmm::cuda_stream_view stream = cudf::get_default_stream(),
632  rmm::device_async_resource_ref mr = rmm::mr::get_current_device_resource());
633 
653 std::unique_ptr<column> copy_if_else(
654  scalar const& lhs,
655  column_view const& rhs,
656  column_view const& boolean_mask,
657  rmm::cuda_stream_view stream = cudf::get_default_stream(),
658  rmm::device_async_resource_ref mr = rmm::mr::get_current_device_resource());
659 
679 std::unique_ptr<column> copy_if_else(
680  column_view const& lhs,
681  scalar const& rhs,
682  column_view const& boolean_mask,
683  rmm::cuda_stream_view stream = cudf::get_default_stream(),
684  rmm::device_async_resource_ref mr = rmm::mr::get_current_device_resource());
685 
703 std::unique_ptr<column> copy_if_else(
704  scalar const& lhs,
705  scalar const& rhs,
706  column_view const& boolean_mask,
707  rmm::cuda_stream_view stream = cudf::get_default_stream(),
708  rmm::device_async_resource_ref mr = rmm::mr::get_current_device_resource());
709 
747 std::unique_ptr<table> boolean_mask_scatter(
748  table_view const& input,
749  table_view const& target,
750  column_view const& boolean_mask,
751  rmm::cuda_stream_view stream = cudf::get_default_stream(),
752  rmm::device_async_resource_ref mr = rmm::mr::get_current_device_resource());
753 
786 std::unique_ptr<table> boolean_mask_scatter(
787  std::vector<std::reference_wrapper<scalar const>> const& input,
788  table_view const& target,
789  column_view const& boolean_mask,
790  rmm::cuda_stream_view stream = cudf::get_default_stream(),
791  rmm::device_async_resource_ref mr = rmm::mr::get_current_device_resource());
792 
807 std::unique_ptr<scalar> get_element(
808  column_view const& input,
809  size_type index,
810  rmm::cuda_stream_view stream = cudf::get_default_stream(),
811  rmm::device_async_resource_ref mr = rmm::mr::get_current_device_resource());
812 
816 enum class sample_with_replacement : bool {
817  FALSE,
818  TRUE
819 };
820 
849 std::unique_ptr<table> sample(
850  table_view const& input,
851  size_type const n,
852  sample_with_replacement replacement = sample_with_replacement::FALSE,
853  int64_t const seed = 0,
854  rmm::cuda_stream_view stream = cudf::get_default_stream(),
855  rmm::device_async_resource_ref mr = rmm::mr::get_current_device_resource());
856 
874 bool has_nonempty_nulls(column_view const& input,
875  rmm::cuda_stream_view stream = cudf::get_default_stream());
876 
899 bool may_have_nonempty_nulls(column_view const& input);
900 
969 std::unique_ptr<column> purge_nonempty_nulls(
970  column_view const& input,
971  rmm::cuda_stream_view stream = cudf::get_default_stream(),
972  rmm::device_async_resource_ref mr = rmm::mr::get_current_device_resource());
973 
975 } // namespace 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:313
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:477
cudf::scalar
An owning class to represent a singular value.
Definition: scalar.hpp:49
cudf::table_view
A set of cudf::column_view's of the same size.
Definition: table_view.hpp:187
column_view.hpp
column view class definitions
cudf::reverse
std::unique_ptr< table > reverse(table_view const &source_table, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=rmm::mr::get_current_device_resource())
Reverses the rows within a table.
cudf::empty_like
std::unique_ptr< column > empty_like(column_view const &input)
Initializes and returns an empty column of the same type as the input.
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=rmm::mr::get_current_device_resource())
Gather n samples from given input randomly.
cudf::mask_allocation_policy
mask_allocation_policy
Indicates when to allocate a mask, based on an existing mask.
Definition: copying.hpp:227
cudf::allocate_like
std::unique_ptr< column > allocate_like(column_view const &input, mask_allocation_policy mask_alloc=mask_allocation_policy::RETAIN, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=rmm::mr::get_current_device_resource())
Creates an uninitialized new column of the same size and type as the input.
cudf::copy_if_else
std::unique_ptr< column > copy_if_else(column_view const &lhs, column_view const &rhs, column_view const &boolean_mask, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=rmm::mr::get_current_device_resource())
Returns a new column, where each element is selected from either lhs or rhs based on the value of the...
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=rmm::mr::get_current_device_resource())
Copies a range of elements out-of-place from one column to another.
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=rmm::mr::get_current_device_resource())
Copy input into output while purging any non-empty null rows in the column or its descendants.
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::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=rmm::mr::get_current_device_resource())
Get the element at specified index from a column.
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::out_of_bounds_policy
out_of_bounds_policy
Policy to account for possible out-of-bounds indices.
Definition: copying.hpp:49
cudf::sample_with_replacement
sample_with_replacement
Indicates whether a row can be sampled more than once.
Definition: copying.hpp:816
cudf::mask_allocation_policy::NEVER
@ NEVER
Do not allocate a null mask, regardless of input.
cudf::mask_allocation_policy::RETAIN
@ RETAIN
Allocate a null mask if the input contains one.
cudf::mask_allocation_policy::ALWAYS
@ ALWAYS
Allocate a null mask, regardless of input.
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=rmm::mr::get_current_device_resource())
Gathers the specified rows (including null values) of a set of columns.
cudf::scatter
std::unique_ptr< table > scatter(table_view const &source, column_view const &scatter_map, table_view const &target, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=rmm::mr::get_current_device_resource())
Scatters the rows of the source table into a copy of the target table according to a scatter map.
cudf::boolean_mask_scatter
std::unique_ptr< table > boolean_mask_scatter(table_view 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=rmm::mr::get_current_device_resource())
Scatters rows from the input table to rows of the output corresponding to true values in a boolean ma...
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=rmm::mr::get_current_device_resource())
Creates a new column by shifting all values by an offset.
cudf::slice
std::vector< column_view > slice(column_view const &input, host_span< size_type const > indices, rmm::cuda_stream_view stream=cudf::get_default_stream())
Slices a column_view into a set of column_views according to a set of indices.
cudf::split
std::vector< column_view > split(column_view const &input, host_span< size_type const > splits, rmm::cuda_stream_view stream=cudf::get_default_stream())
Splits a column_view into a set of column_views according to a set of indices derived from expected s...
cudf::get_default_stream
rmm::cuda_stream_view const get_default_stream()
Get the current default stream.
cudf::size_type
int32_t size_type
Row index type for columns and tables.
Definition: types.hpp:93
lists_column_view.hpp
Class definition for cudf::lists_column_view.
cudf
cuDF interfaces
Definition: aggregation.hpp:34
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:224
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