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 
15 namespace CUDF_EXPORT cudf {
35 std::unique_ptr<scalar> make_numeric_scalar(
36  data_type type,
37  rmm::cuda_stream_view stream = cudf::get_default_stream(),
38  rmm::device_async_resource_ref mr = cudf::get_current_device_resource_ref());
39 
52 std::unique_ptr<scalar> make_timestamp_scalar(
53  data_type type,
54  rmm::cuda_stream_view stream = cudf::get_default_stream(),
55  rmm::device_async_resource_ref mr = cudf::get_current_device_resource_ref());
56 
69 std::unique_ptr<scalar> make_duration_scalar(
70  data_type type,
71  rmm::cuda_stream_view stream = cudf::get_default_stream(),
72  rmm::device_async_resource_ref mr = cudf::get_current_device_resource_ref());
73 
86 std::unique_ptr<scalar> make_fixed_width_scalar(
87  data_type type,
88  rmm::cuda_stream_view stream = cudf::get_default_stream(),
89  rmm::device_async_resource_ref mr = cudf::get_current_device_resource_ref());
90 
103 std::unique_ptr<scalar> make_string_scalar(
104  std::string const& string,
105  rmm::cuda_stream_view stream = cudf::get_default_stream(),
106  rmm::device_async_resource_ref mr = cudf::get_current_device_resource_ref());
107 
118 std::unique_ptr<scalar> make_default_constructed_scalar(
119  data_type type,
120  rmm::cuda_stream_view stream = cudf::get_default_stream(),
121  rmm::device_async_resource_ref mr = cudf::get_current_device_resource_ref());
122 
133 std::unique_ptr<scalar> make_empty_scalar_like(
134  column_view const& input,
135  rmm::cuda_stream_view stream = cudf::get_default_stream(),
136  rmm::device_async_resource_ref mr = cudf::get_current_device_resource_ref());
137 
147 template <typename T>
148 std::unique_ptr<scalar> make_fixed_width_scalar(
149  T value,
150  rmm::cuda_stream_view stream = cudf::get_default_stream(),
151  rmm::device_async_resource_ref mr = cudf::get_current_device_resource_ref())
152 {
153  return std::make_unique<scalar_type_t<T>>(value, true, stream, mr);
154 }
155 
166 template <typename T>
167 std::unique_ptr<scalar> make_fixed_point_scalar(
168  typename T::rep value,
169  numeric::scale_type scale,
170  rmm::cuda_stream_view stream = cudf::get_default_stream(),
171  rmm::device_async_resource_ref mr = cudf::get_current_device_resource_ref())
172 {
173  return std::make_unique<scalar_type_t<T>>(value, scale, true, stream, mr);
174 }
175 
184 std::unique_ptr<scalar> make_list_scalar(
185  column_view elements,
186  rmm::cuda_stream_view stream = cudf::get_default_stream(),
187  rmm::device_async_resource_ref mr = cudf::get_current_device_resource_ref());
188 
199 std::unique_ptr<scalar> make_struct_scalar(
200  table_view const& data,
201  rmm::cuda_stream_view stream = cudf::get_default_stream(),
202  rmm::device_async_resource_ref mr = cudf::get_current_device_resource_ref());
203 
214 std::unique_ptr<scalar> make_struct_scalar(
215  std::span<column_view const> data,
216  rmm::cuda_stream_view stream = cudf::get_default_stream(),
217  rmm::device_async_resource_ref mr = cudf::get_current_device_resource_ref());
218  // end of group
220 } // 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:278
cudf::table_view
A set of cudf::column_view's of the same size.
Definition: table_view.hpp:189
rmm::cuda_stream_view
cuda_stream_view.hpp
default_stream.hpp
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:35
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:27
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:167
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:148
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
cudf
cuDF interfaces
Definition: host_udf.hpp:26
scalar.hpp
Class definitions for cudf::scalar.
Generated by doxygen 1.9.1