scalar_factories.hpp
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2019-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 #pragma once
17 
18 #include <cudf/scalar/scalar.hpp>
20 
21 #include <rmm/cuda_stream_view.hpp>
22 #include <rmm/mr/device/per_device_resource.hpp>
23 #include <rmm/resource_ref.hpp>
24 
25 namespace cudf {
45 std::unique_ptr<scalar> make_numeric_scalar(
46  data_type type,
47  rmm::cuda_stream_view stream = cudf::get_default_stream(),
48  rmm::device_async_resource_ref mr = rmm::mr::get_current_device_resource());
49 
62 std::unique_ptr<scalar> make_timestamp_scalar(
63  data_type type,
64  rmm::cuda_stream_view stream = cudf::get_default_stream(),
65  rmm::device_async_resource_ref mr = rmm::mr::get_current_device_resource());
66 
79 std::unique_ptr<scalar> make_duration_scalar(
80  data_type type,
81  rmm::cuda_stream_view stream = cudf::get_default_stream(),
82  rmm::device_async_resource_ref mr = rmm::mr::get_current_device_resource());
83 
96 std::unique_ptr<scalar> make_fixed_width_scalar(
97  data_type type,
98  rmm::cuda_stream_view stream = cudf::get_default_stream(),
99  rmm::device_async_resource_ref mr = rmm::mr::get_current_device_resource());
100 
113 std::unique_ptr<scalar> make_string_scalar(
114  std::string const& string,
115  rmm::cuda_stream_view stream = cudf::get_default_stream(),
116  rmm::device_async_resource_ref mr = rmm::mr::get_current_device_resource());
117 
128 std::unique_ptr<scalar> make_default_constructed_scalar(
129  data_type type,
130  rmm::cuda_stream_view stream = cudf::get_default_stream(),
131  rmm::device_async_resource_ref mr = rmm::mr::get_current_device_resource());
132 
143 std::unique_ptr<scalar> make_empty_scalar_like(
144  column_view const& input,
145  rmm::cuda_stream_view stream = cudf::get_default_stream(),
146  rmm::device_async_resource_ref mr = rmm::mr::get_current_device_resource());
147 
157 template <typename T>
158 std::unique_ptr<scalar> make_fixed_width_scalar(
159  T value,
160  rmm::cuda_stream_view stream = cudf::get_default_stream(),
161  rmm::device_async_resource_ref mr = rmm::mr::get_current_device_resource())
162 {
163  return std::make_unique<scalar_type_t<T>>(value, true, stream, mr);
164 }
165 
176 template <typename T>
177 std::unique_ptr<scalar> make_fixed_point_scalar(
178  typename T::rep value,
179  numeric::scale_type scale,
180  rmm::cuda_stream_view stream = cudf::get_default_stream(),
181  rmm::device_async_resource_ref mr = rmm::mr::get_current_device_resource())
182 {
183  return std::make_unique<scalar_type_t<T>>(value, scale, true, stream, mr);
184 }
185 
194 std::unique_ptr<scalar> make_list_scalar(
195  column_view elements,
196  rmm::cuda_stream_view stream = cudf::get_default_stream(),
197  rmm::device_async_resource_ref mr = rmm::mr::get_current_device_resource());
198 
209 std::unique_ptr<scalar> make_struct_scalar(
210  table_view const& data,
211  rmm::cuda_stream_view stream = cudf::get_default_stream(),
212  rmm::device_async_resource_ref mr = rmm::mr::get_current_device_resource());
213 
224 std::unique_ptr<scalar> make_struct_scalar(
226  rmm::cuda_stream_view stream = cudf::get_default_stream(),
227  rmm::device_async_resource_ref mr = rmm::mr::get_current_device_resource());
228  // end of group
230 } // namespace cudf
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
A set of cudf::column_view's of the same size.
Definition: table_view.hpp:187
rmm::cuda_stream_view const get_default_stream()
Get the current default stream.
scale_type
The scale type for fixed_point.
Definition: fixed_point.hpp:43
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=rmm::mr::get_current_device_resource())
Construct scalar using the given value of fixed_point type.
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=rmm::mr::get_current_device_resource())
Constructs default constructed scalar of type type
std::unique_ptr< scalar > make_struct_scalar(table_view const &data, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=rmm::mr::get_current_device_resource())
Construct a struct scalar using the given table_view.
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=rmm::mr::get_current_device_resource())
Construct scalar with uninitialized storage to hold a value of the specified duration data_type.
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=rmm::mr::get_current_device_resource())
Construct scalar using the given column of elements.
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=rmm::mr::get_current_device_resource())
Creates an empty (invalid) scalar of the same type as the input column_view.
std::unique_ptr< scalar > make_fixed_width_scalar(data_type type, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=rmm::mr::get_current_device_resource())
Construct scalar with uninitialized storage to hold a value of the specified fixed-width data_type.
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=rmm::mr::get_current_device_resource())
Construct scalar with uninitialized storage to hold a value of the specified numeric data_type.
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=rmm::mr::get_current_device_resource())
Construct scalar with uninitialized storage to hold a value of the specified timestamp data_type.
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=rmm::mr::get_current_device_resource())
Construct STRING type scalar given a std::string. The size of the std::string must not exceed the max...
cuDF interfaces
Definition: aggregation.hpp:34
Class definitions for cudf::scalar.
C++20 std::span with reduced feature set.
Definition: span.hpp:228