label_bins.hpp
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2021-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.hpp>
21 #include <cudf/types.hpp>
22 
23 #include <rmm/mr/device/device_memory_resource.hpp>
24 #include <rmm/mr/device/per_device_resource.hpp>
25 #include <rmm/resource_ref.hpp>
26 
27 namespace cudf {
28 
39 enum class inclusive { YES, NO };
40 
72 std::unique_ptr<column> label_bins(
73  column_view const& input,
74  column_view const& left_edges,
75  inclusive left_inclusive,
76  column_view const& right_edges,
77  inclusive right_inclusive,
78  rmm::cuda_stream_view stream = cudf::get_default_stream(),
79  rmm::device_async_resource_ref mr = rmm::mr::get_current_device_resource());
80  // end of group
82 } // namespace cudf
A non-owning, immutable view of device data as a column of elements, some of which may be null as ind...
Class definition for cudf::column.
column view class definitions
rmm::cuda_stream_view const get_default_stream()
Get the current default stream.
std::unique_ptr< column > label_bins(column_view const &input, column_view const &left_edges, inclusive left_inclusive, column_view const &right_edges, inclusive right_inclusive, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=rmm::mr::get_current_device_resource())
Labels elements based on membership in the specified bins.
inclusive
Enum used to define whether or not bins include their boundary points.
Definition: label_bins.hpp:39
cuDF interfaces
Definition: aggregation.hpp:34
Type declarations for libcudf.