scalar_factories.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 #pragma once
6 
7 #include <cudf/scalar/scalar.hpp>
8 #include <cudf/utilities/default_stream.hpp>
9 #include <cudf/utilities/memory_resource.hpp>
10 
11 #include <rmm/cuda_stream_view.hpp>
12 
13 #include <span>
14 
20 namespace CUDF_EXPORT cudf {
38 std::unique_ptr<scalar> make_numeric_scalar(
39  data_type type,
40  rmm::cuda_stream_view stream = cudf::get_default_stream(),
41  rmm::device_async_resource_ref mr = cudf::get_current_device_resource_ref());
42 
55 std::unique_ptr<scalar> make_timestamp_scalar(
56  data_type type,
57  rmm::cuda_stream_view stream = cudf::get_default_stream(),
58  rmm::device_async_resource_ref mr = cudf::get_current_device_resource_ref());
59 
72 std::unique_ptr<scalar> make_duration_scalar(
73  data_type type,
74  rmm::cuda_stream_view stream = cudf::get_default_stream(),
75  rmm::device_async_resource_ref mr = cudf::get_current_device_resource_ref());
76 
89 std::unique_ptr<scalar> make_fixed_width_scalar(
90  data_type type,
91  rmm::cuda_stream_view stream = cudf::get_default_stream(),
92  rmm::device_async_resource_ref mr = cudf::get_current_device_resource_ref());
93 
106 std::unique_ptr<scalar> make_string_scalar(
107  std::string const& string,
108  rmm::cuda_stream_view stream = cudf::get_default_stream(),
109  rmm::device_async_resource_ref mr = cudf::get_current_device_resource_ref());
110 
121 std::unique_ptr<scalar> make_default_constructed_scalar(
122  data_type type,
123  rmm::cuda_stream_view stream = cudf::get_default_stream(),
124  rmm::device_async_resource_ref mr = cudf::get_current_device_resource_ref());
125 
136 std::unique_ptr<scalar> make_empty_scalar_like(
137  column_view const& input,
138  rmm::cuda_stream_view stream = cudf::get_default_stream(),
139  rmm::device_async_resource_ref mr = cudf::get_current_device_resource_ref());
140 
150 template <typename T>
151 std::unique_ptr<scalar> make_fixed_width_scalar(
152  T value,
153  rmm::cuda_stream_view stream = cudf::get_default_stream(),
154  rmm::device_async_resource_ref mr = cudf::get_current_device_resource_ref())
155 {
156  return std::make_unique<scalar_type_t<T>>(value, true, stream, mr);
157 }
158 
169 template <typename T>
170 std::unique_ptr<scalar> make_fixed_point_scalar(
171  typename T::rep value,
172  numeric::scale_type scale,
173  rmm::cuda_stream_view stream = cudf::get_default_stream(),
174  rmm::device_async_resource_ref mr = cudf::get_current_device_resource_ref())
175 {
176  return std::make_unique<scalar_type_t<T>>(value, scale, true, stream, mr);
177 }
178 
187 std::unique_ptr<scalar> make_list_scalar(
188  column_view elements,
189  rmm::cuda_stream_view stream = cudf::get_default_stream(),
190  rmm::device_async_resource_ref mr = cudf::get_current_device_resource_ref());
191 
202 std::unique_ptr<scalar> make_struct_scalar(
203  table_view const& data,
204  rmm::cuda_stream_view stream = cudf::get_default_stream(),
205  rmm::device_async_resource_ref mr = cudf::get_current_device_resource_ref());
206 
217 std::unique_ptr<scalar> make_struct_scalar(
218  std::span<column_view const> data,
219  rmm::cuda_stream_view stream = cudf::get_default_stream(),
220  rmm::device_async_resource_ref mr = cudf::get_current_device_resource_ref());
221  // end of group
223 } // namespace CUDF_EXPORT 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:318
cudf::data_type
Indicator for the logical data type of an element in a column.
Definition: types.hpp:286
cudf::table_view
A set of cudf::column_view's of the same size.
Definition: table_view.hpp:206
rmm::cuda_stream_view
cuda_stream_view.hpp
default_stream.hpp
APIs for querying the default CUDA stream and per-thread default stream status.
cudf::get_default_stream
rmm::cuda_stream_view const get_default_stream()
Get the current default stream.
numeric::scale_type
scale_type
The scale type for fixed_point.
Definition: fixed_point.hpp:38
cudf::get_current_device_resource_ref
rmm::device_async_resource_ref get_current_device_resource_ref()
Get the current device memory resource reference.
Definition: memory_resource.hpp:34
rmm::device_async_resource_ref
cuda::mr::resource_ref< cuda::mr::device_accessible > device_async_resource_ref
cudf::make_duration_scalar
std::unique_ptr< scalar > make_duration_scalar(data_type type, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=cudf::get_current_device_resource_ref())
Construct scalar with uninitialized storage to hold a value of the specified duration data_type.
cudf::make_fixed_point_scalar
std::unique_ptr< scalar > make_fixed_point_scalar(typename T::rep value, numeric::scale_type scale, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=cudf::get_current_device_resource_ref())
Construct scalar using the given value of fixed_point type.
Definition: scalar_factories.hpp:170
cudf::make_list_scalar
std::unique_ptr< scalar > make_list_scalar(column_view elements, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=cudf::get_current_device_resource_ref())
Construct scalar using the given column of elements.
cudf::make_empty_scalar_like
std::unique_ptr< scalar > make_empty_scalar_like(column_view const &input, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=cudf::get_current_device_resource_ref())
Creates an empty (invalid) scalar of the same type as the input column_view.
cudf::make_struct_scalar
std::unique_ptr< scalar > make_struct_scalar(std::span< column_view const > data, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=cudf::get_current_device_resource_ref())
Construct a struct scalar using the given span of column views.
cudf::make_numeric_scalar
std::unique_ptr< scalar > make_numeric_scalar(data_type type, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=cudf::get_current_device_resource_ref())
Construct scalar with uninitialized storage to hold a value of the specified numeric data_type.
cudf::make_fixed_width_scalar
std::unique_ptr< scalar > make_fixed_width_scalar(T value, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=cudf::get_current_device_resource_ref())
Construct scalar using the given value of fixed width type.
Definition: scalar_factories.hpp:151
cudf::make_default_constructed_scalar
std::unique_ptr< scalar > make_default_constructed_scalar(data_type type, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=cudf::get_current_device_resource_ref())
Constructs default constructed scalar of type type
cudf::make_string_scalar
std::unique_ptr< scalar > make_string_scalar(std::string const &string, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=cudf::get_current_device_resource_ref())
Construct STRING type scalar given a std::string. The size of the std::string must not exceed the max...
cudf::make_timestamp_scalar
std::unique_ptr< scalar > make_timestamp_scalar(data_type type, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=cudf::get_current_device_resource_ref())
Construct scalar with uninitialized storage to hold a value of the specified timestamp data_type.
memory_resource.hpp
APIs for getting and setting the current device memory resource.
cudf
cuDF interfaces
Definition: host_udf.hpp:26
scalar.hpp
Class definitions for cudf::scalar.
Generated by doxygen 1.9.1