quantiles.hpp
Go to the documentation of this file.
1 /*
2  * SPDX-FileCopyrightText: Copyright (c) 2019-2026, NVIDIA CORPORATION & AFFILIATES. All rights reserved.
3  * SPDX-License-Identifier: Apache-2.0
4  */
5 
6 #pragma once
7 
8 #include <cudf/scalar/scalar.hpp>
11 #include <cudf/types.hpp>
12 #include <cudf/utilities/export.hpp>
14 
20 namespace CUDF_EXPORT cudf {
50 std::unique_ptr<column> quantile(
51  column_view const& input,
52  std::vector<double> const& q,
53  interpolation interp = interpolation::LINEAR,
54  column_view const& ordered_indices = {},
55  bool exact = true,
58 
90 std::unique_ptr<table> quantiles(
91  table_view const& input,
92  std::vector<double> const& q,
93  interpolation interp = interpolation::NEAREST,
94  cudf::sorted is_input_sorted = sorted::NO,
95  std::vector<order> const& column_order = {},
96  std::vector<null_order> const& null_precedence = {},
99 
123 std::unique_ptr<column> percentile_approx(
124  tdigest::tdigest_column_view const& input,
125  column_view const& percentiles,
128  // end of group
130 } // namespace CUDF_EXPORT cudf
A non-owning, immutable view of device data as a column of elements, some of which may be null as ind...
A set of cudf::column_view's of the same size.
Definition: table_view.hpp:206
Given a column_view containing tdigest data, an instance of this class provides a wrapper on the comp...
std::unique_ptr< column > percentile_approx(tdigest::tdigest_column_view const &input, column_view const &percentiles, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=cudf::get_current_device_resource_ref())
Calculate approximate percentiles on an input tdigest column.
std::unique_ptr< column > quantile(column_view const &input, std::vector< double > const &q, interpolation interp=interpolation::LINEAR, column_view const &ordered_indices={}, bool exact=true, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=cudf::get_current_device_resource_ref())
Computes quantiles with interpolation.
std::unique_ptr< table > quantiles(table_view const &input, std::vector< double > const &q, interpolation interp=interpolation::NEAREST, cudf::sorted is_input_sorted=sorted::NO, std::vector< order > const &column_order={}, std::vector< null_order > const &null_precedence={}, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=cudf::get_current_device_resource_ref())
Returns the rows of the input corresponding to the requested quantiles.
rmm::cuda_stream_view const get_default_stream()
Get the current default stream.
rmm::device_async_resource_ref get_current_device_resource_ref()
Get the current device memory resource reference.
cuda::mr::resource_ref< cuda::mr::device_accessible > device_async_resource_ref
interpolation
Interpolation method to use when the desired quantile lies between two data points i and j.
Definition: types.hpp:173
sorted
Indicates whether a collection of values is known to be sorted.
Definition: types.hpp:148
APIs for getting and setting the current device memory resource.
cuDF interfaces
Definition: host_udf.hpp:26
Class definitions for cudf::scalar.
Class definitions for (mutable)_table_view
tdigest data APIs
Type declarations for libcudf.