reduction.hpp
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2019-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/aggregation.hpp>
20 #include <cudf/scalar/scalar.hpp>
21 #include <cudf/utilities/export.hpp>
23 
24 #include <optional>
25 
26 namespace CUDF_EXPORT cudf {
36 enum class scan_type : bool { INCLUSIVE, EXCLUSIVE };
37 
81 std::unique_ptr<scalar> reduce(
82  column_view const& col,
83  reduce_aggregation const& agg,
84  data_type output_dtype,
87 
104 std::unique_ptr<scalar> reduce(
105  column_view const& col,
106  reduce_aggregation const& agg,
107  data_type output_dtype,
108  std::optional<std::reference_wrapper<scalar const>> init,
111 
155 std::unique_ptr<column> segmented_reduce(
156  column_view const& segmented_values,
158  segmented_reduce_aggregation const& agg,
159  data_type output_dtype,
160  null_policy null_handling,
163 
181 std::unique_ptr<column> segmented_reduce(
182  column_view const& segmented_values,
184  segmented_reduce_aggregation const& agg,
185  data_type output_dtype,
186  null_policy null_handling,
187  std::optional<std::reference_wrapper<scalar const>> init,
190 
209 std::unique_ptr<column> scan(
210  column_view const& input,
211  scan_aggregation const& agg,
213  null_policy null_handling = null_policy::EXCLUDE,
216 
227 std::pair<std::unique_ptr<scalar>, std::unique_ptr<scalar>> minmax(
228  column_view const& col,
231  // end of group
233 
234 } // namespace CUDF_EXPORT cudf
Representation for specifying desired aggregations from aggregation-based APIs, e....
A non-owning, immutable view of device data as a column of elements, some of which may be null as ind...
Indicator for the logical data type of an element in a column.
Definition: types.hpp:243
Derived class intended for reduction usage.
Derived class intended for scan usage.
Derived class intended for segmented reduction usage.
scan_type
Enum to describe scan operation type.
Definition: reduction.hpp:36
std::unique_ptr< column > scan(column_view const &input, scan_aggregation const &agg, scan_type inclusive, null_policy null_handling=null_policy::EXCLUDE, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=cudf::get_current_device_resource_ref())
Computes the scan of a column.
std::unique_ptr< scalar > reduce(column_view const &col, reduce_aggregation const &agg, data_type output_dtype, std::optional< std::reference_wrapper< scalar const >> init, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=cudf::get_current_device_resource_ref())
Computes the reduction of the values in all rows of a column with an initial value.
std::unique_ptr< column > segmented_reduce(column_view const &segmented_values, device_span< size_type const > offsets, segmented_reduce_aggregation const &agg, data_type output_dtype, null_policy null_handling, std::optional< std::reference_wrapper< scalar const >> init, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=cudf::get_current_device_resource_ref())
Compute reduction of each segment in the input column with an initial value. Only SUM,...
std::pair< std::unique_ptr< scalar >, std::unique_ptr< scalar > > minmax(column_view const &col, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=cudf::get_current_device_resource_ref())
Determines the minimum and maximum values of a column.
rmm::cuda_stream_view const get_default_stream()
Get the current default stream.
inclusive
Enum used to define whether or not bins include their boundary points.
Definition: label_bins.hpp:38
rmm::device_async_resource_ref get_current_device_resource_ref()
Get the current device memory resource reference.
cuda::mr::async_resource_ref< cuda::mr::device_accessible > device_async_resource_ref
null_policy
Enum to specify whether to include nulls or exclude nulls.
Definition: types.hpp:126
cuDF interfaces
Definition: aggregation.hpp:35
Class definitions for cudf::scalar.
Device version of C++20 std::span with reduced feature set.
Definition: span.hpp:338