reduction.hpp
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2019-2023, 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 
22 #include <rmm/mr/device/per_device_resource.hpp>
23 
24 #include <optional>
25 
26 namespace cudf {
36 enum class scan_type : bool { INCLUSIVE, EXCLUSIVE };
37 
80 std::unique_ptr<scalar> reduce(
81  column_view const& col,
82  reduce_aggregation const& agg,
83  data_type output_dtype,
84  rmm::mr::device_memory_resource* mr = rmm::mr::get_current_device_resource());
85 
101 std::unique_ptr<scalar> reduce(
102  column_view const& col,
103  reduce_aggregation const& agg,
104  data_type output_dtype,
105  std::optional<std::reference_wrapper<scalar const>> init,
106  rmm::mr::device_memory_resource* mr = rmm::mr::get_current_device_resource());
107 
150 std::unique_ptr<column> segmented_reduce(
151  column_view const& segmented_values,
153  segmented_reduce_aggregation const& agg,
154  data_type output_dtype,
155  null_policy null_handling,
156  rmm::mr::device_memory_resource* mr = rmm::mr::get_current_device_resource());
157 
174 std::unique_ptr<column> segmented_reduce(
175  column_view const& segmented_values,
177  segmented_reduce_aggregation const& agg,
178  data_type output_dtype,
179  null_policy null_handling,
180  std::optional<std::reference_wrapper<scalar const>> init,
181  rmm::mr::device_memory_resource* mr = rmm::mr::get_current_device_resource());
182 
200 std::unique_ptr<column> scan(
201  column_view const& input,
202  scan_aggregation const& agg,
204  null_policy null_handling = null_policy::EXCLUDE,
205  rmm::mr::device_memory_resource* mr = rmm::mr::get_current_device_resource());
206 
216 std::pair<std::unique_ptr<scalar>, std::unique_ptr<scalar>> minmax(
217  column_view const& col,
218  rmm::mr::device_memory_resource* mr = rmm::mr::get_current_device_resource());
219  // end of group
221 
222 } // namespace 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:241
Derived class intended for reduction usage.
Derived class intended for scan usage.
Derived class intended for segmented reduction usage.
std::pair< std::unique_ptr< scalar >, std::unique_ptr< scalar > > minmax(column_view const &col, rmm::mr::device_memory_resource *mr=rmm::mr::get_current_device_resource())
Determines the minimum and maximum values of a column.
scan_type
Enum to describe scan operation type.
Definition: reduction.hpp:36
std::unique_ptr< scalar > reduce(column_view const &col, reduce_aggregation const &agg, data_type output_dtype, rmm::mr::device_memory_resource *mr=rmm::mr::get_current_device_resource())
Computes the reduction of the values in all rows of a column.
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, rmm::mr::device_memory_resource *mr=rmm::mr::get_current_device_resource())
Compute reduction of each segment in the input column.
std::unique_ptr< column > scan(column_view const &input, scan_aggregation const &agg, scan_type inclusive, null_policy null_handling=null_policy::EXCLUDE, rmm::mr::device_memory_resource *mr=rmm::mr::get_current_device_resource())
Computes the scan of a column.
inclusive
Enum used to define whether or not bins include their boundary points.
Definition: label_bins.hpp:38
null_policy
Enum to specify whether to include nulls or exclude nulls.
Definition: types.hpp:124
@ EXCLUDE
exclude null elements
cuDF interfaces
Definition: aggregation.hpp:34
Class definitions for cudf::scalar.
Device version of C++20 std::span with reduced feature set.
Definition: span.hpp:291