datetime.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 
17 #pragma once
18 
19 #include <cudf/types.hpp>
20 #include <cudf/utilities/default_stream.hpp>
21 #include <cudf/utilities/export.hpp>
22 #include <cudf/utilities/memory_resource.hpp>
23 
24 #include <rmm/cuda_stream_view.hpp>
25 
26 #include <memory>
27 
33 namespace CUDF_EXPORT cudf {
34 namespace datetime {
52 std::unique_ptr<cudf::column> extract_year(
53  cudf::column_view const& column,
54  rmm::cuda_stream_view stream = cudf::get_default_stream(),
55  rmm::device_async_resource_ref mr = cudf::get_current_device_resource_ref());
56 
68 std::unique_ptr<cudf::column> extract_month(
69  cudf::column_view const& column,
70  rmm::cuda_stream_view stream = cudf::get_default_stream(),
71  rmm::device_async_resource_ref mr = cudf::get_current_device_resource_ref());
72 
84 std::unique_ptr<cudf::column> extract_day(
85  cudf::column_view const& column,
86  rmm::cuda_stream_view stream = cudf::get_default_stream(),
87  rmm::device_async_resource_ref mr = cudf::get_current_device_resource_ref());
88 
100 std::unique_ptr<cudf::column> extract_weekday(
101  cudf::column_view const& column,
102  rmm::cuda_stream_view stream = cudf::get_default_stream(),
103  rmm::device_async_resource_ref mr = cudf::get_current_device_resource_ref());
104 
116 std::unique_ptr<cudf::column> extract_hour(
117  cudf::column_view const& column,
118  rmm::cuda_stream_view stream = cudf::get_default_stream(),
119  rmm::device_async_resource_ref mr = cudf::get_current_device_resource_ref());
120 
132 std::unique_ptr<cudf::column> extract_minute(
133  cudf::column_view const& column,
134  rmm::cuda_stream_view stream = cudf::get_default_stream(),
135  rmm::device_async_resource_ref mr = cudf::get_current_device_resource_ref());
136 
148 std::unique_ptr<cudf::column> extract_second(
149  cudf::column_view const& column,
150  rmm::cuda_stream_view stream = cudf::get_default_stream(),
151  rmm::device_async_resource_ref mr = cudf::get_current_device_resource_ref());
152 
167 std::unique_ptr<cudf::column> extract_millisecond_fraction(
168  cudf::column_view const& column,
169  rmm::cuda_stream_view stream = cudf::get_default_stream(),
170  rmm::device_async_resource_ref mr = cudf::get_current_device_resource_ref());
171 
186 std::unique_ptr<cudf::column> extract_microsecond_fraction(
187  cudf::column_view const& column,
188  rmm::cuda_stream_view stream = cudf::get_default_stream(),
189  rmm::device_async_resource_ref mr = cudf::get_current_device_resource_ref());
190 
205 std::unique_ptr<cudf::column> extract_nanosecond_fraction(
206  cudf::column_view const& column,
207  rmm::cuda_stream_view stream = cudf::get_default_stream(),
208  rmm::device_async_resource_ref mr = cudf::get_current_device_resource_ref());
209  // end of group
228 std::unique_ptr<cudf::column> last_day_of_month(
229  cudf::column_view const& column,
230  rmm::cuda_stream_view stream = cudf::get_default_stream(),
231  rmm::device_async_resource_ref mr = cudf::get_current_device_resource_ref());
232 
244 std::unique_ptr<cudf::column> day_of_year(
245  cudf::column_view const& column,
246  rmm::cuda_stream_view stream = cudf::get_default_stream(),
247  rmm::device_async_resource_ref mr = cudf::get_current_device_resource_ref());
248 
280 std::unique_ptr<cudf::column> add_calendrical_months(
281  cudf::column_view const& timestamps,
282  cudf::column_view const& months,
283  rmm::cuda_stream_view stream = cudf::get_default_stream(),
284  rmm::device_async_resource_ref mr = cudf::get_current_device_resource_ref());
285 
317 std::unique_ptr<cudf::column> add_calendrical_months(
318  cudf::column_view const& timestamps,
319  cudf::scalar const& months,
320  rmm::cuda_stream_view stream = cudf::get_default_stream(),
321  rmm::device_async_resource_ref mr = cudf::get_current_device_resource_ref());
322 
337 std::unique_ptr<cudf::column> is_leap_year(
338  cudf::column_view const& column,
339  rmm::cuda_stream_view stream = cudf::get_default_stream(),
340  rmm::device_async_resource_ref mr = cudf::get_current_device_resource_ref());
341 
355 std::unique_ptr<cudf::column> days_in_month(
356  cudf::column_view const& column,
357  rmm::cuda_stream_view stream = cudf::get_default_stream(),
358  rmm::device_async_resource_ref mr = cudf::get_current_device_resource_ref());
359 
373 std::unique_ptr<cudf::column> extract_quarter(
374  cudf::column_view const& column,
375  rmm::cuda_stream_view stream = cudf::get_default_stream(),
376  rmm::device_async_resource_ref mr = cudf::get_current_device_resource_ref());
377 
382 enum class rounding_frequency : int32_t {
383  DAY,
384  HOUR,
385  MINUTE,
386  SECOND,
387  MILLISECOND,
388  MICROSECOND,
389  NANOSECOND
390 };
391 
403 std::unique_ptr<cudf::column> ceil_datetimes(
404  cudf::column_view const& column,
405  rounding_frequency freq,
406  rmm::cuda_stream_view stream = cudf::get_default_stream(),
407  rmm::device_async_resource_ref mr = cudf::get_current_device_resource_ref());
408 
420 std::unique_ptr<cudf::column> floor_datetimes(
421  cudf::column_view const& column,
422  rounding_frequency freq,
423  rmm::cuda_stream_view stream = cudf::get_default_stream(),
424  rmm::device_async_resource_ref mr = cudf::get_current_device_resource_ref());
425 
437 std::unique_ptr<cudf::column> round_datetimes(
438  cudf::column_view const& column,
439  rounding_frequency freq,
440  rmm::cuda_stream_view stream = cudf::get_default_stream(),
441  rmm::device_async_resource_ref mr = cudf::get_current_device_resource_ref());
442  // end of group
444 
445 } // namespace datetime
446 } // 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:321
cudf::column
A container of nullable device data as a column of elements.
Definition: column.hpp:47
cudf::scalar
An owning class to represent a singular value.
Definition: scalar.hpp:48
rmm::cuda_stream_view
cuda_stream_view.hpp
default_stream.hpp
cudf::datetime::add_calendrical_months
std::unique_ptr< cudf::column > add_calendrical_months(cudf::column_view const &timestamps, cudf::scalar const &months, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=cudf::get_current_device_resource_ref())
Adds or subtracts a number of months from the datetime type and returns a timestamp column that is of...
cudf::datetime::floor_datetimes
std::unique_ptr< cudf::column > floor_datetimes(cudf::column_view const &column, rounding_frequency freq, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=cudf::get_current_device_resource_ref())
Round datetimes down to the nearest multiple of the given frequency.
cudf::datetime::last_day_of_month
std::unique_ptr< cudf::column > last_day_of_month(cudf::column_view const &column, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=cudf::get_current_device_resource_ref())
Computes the last day of the month in datetime type and returns a TIMESTAMP_DAYS cudf::column.
cudf::datetime::days_in_month
std::unique_ptr< cudf::column > days_in_month(cudf::column_view const &column, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=cudf::get_current_device_resource_ref())
Extract the number of days in the month.
cudf::datetime::round_datetimes
std::unique_ptr< cudf::column > round_datetimes(cudf::column_view const &column, rounding_frequency freq, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=cudf::get_current_device_resource_ref())
Round datetimes to the nearest multiple of the given frequency.
cudf::datetime::is_leap_year
std::unique_ptr< cudf::column > is_leap_year(cudf::column_view const &column, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=cudf::get_current_device_resource_ref())
Check if the year of the given date is a leap year.
cudf::datetime::day_of_year
std::unique_ptr< cudf::column > day_of_year(cudf::column_view const &column, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=cudf::get_current_device_resource_ref())
Computes the day number since the start of the year from the datetime and returns an int16_t cudf::co...
cudf::datetime::extract_quarter
std::unique_ptr< cudf::column > extract_quarter(cudf::column_view const &column, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=cudf::get_current_device_resource_ref())
Returns the quarter of the date.
cudf::datetime::rounding_frequency
rounding_frequency
Fixed frequencies supported by datetime rounding functions ceil, floor, round.
Definition: datetime.hpp:382
cudf::datetime::ceil_datetimes
std::unique_ptr< cudf::column > ceil_datetimes(cudf::column_view const &column, rounding_frequency freq, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=cudf::get_current_device_resource_ref())
Round datetimes up to the nearest multiple of the given frequency.
cudf::datetime::extract_year
std::unique_ptr< cudf::column > extract_year(cudf::column_view const &column, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=cudf::get_current_device_resource_ref())
Extracts year from any datetime type and returns an int16_t cudf::column.
cudf::datetime::extract_nanosecond_fraction
std::unique_ptr< cudf::column > extract_nanosecond_fraction(cudf::column_view const &column, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=cudf::get_current_device_resource_ref())
Extracts nanosecond fraction from any datetime type and returns an int16_t cudf::column.
cudf::datetime::extract_day
std::unique_ptr< cudf::column > extract_day(cudf::column_view const &column, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=cudf::get_current_device_resource_ref())
Extracts day from any datetime type and returns an int16_t cudf::column.
cudf::datetime::extract_millisecond_fraction
std::unique_ptr< cudf::column > extract_millisecond_fraction(cudf::column_view const &column, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=cudf::get_current_device_resource_ref())
Extracts millisecond fraction from any datetime type and returns an int16_t cudf::column.
cudf::datetime::extract_hour
std::unique_ptr< cudf::column > extract_hour(cudf::column_view const &column, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=cudf::get_current_device_resource_ref())
Extracts hour from any datetime type and returns an int16_t cudf::column.
cudf::datetime::extract_weekday
std::unique_ptr< cudf::column > extract_weekday(cudf::column_view const &column, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=cudf::get_current_device_resource_ref())
Extracts a weekday from any datetime type and returns an int16_t cudf::column.
cudf::datetime::extract_minute
std::unique_ptr< cudf::column > extract_minute(cudf::column_view const &column, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=cudf::get_current_device_resource_ref())
Extracts minute from any datetime type and returns an int16_t cudf::column.
cudf::datetime::extract_second
std::unique_ptr< cudf::column > extract_second(cudf::column_view const &column, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=cudf::get_current_device_resource_ref())
Extracts second from any datetime type and returns an int16_t cudf::column.
cudf::datetime::extract_month
std::unique_ptr< cudf::column > extract_month(cudf::column_view const &column, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=cudf::get_current_device_resource_ref())
Extracts month from any datetime type and returns an int16_t cudf::column.
cudf::datetime::extract_microsecond_fraction
std::unique_ptr< cudf::column > extract_microsecond_fraction(cudf::column_view const &column, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=cudf::get_current_device_resource_ref())
Extracts microsecond fraction from any datetime type and returns an int16_t cudf::column.
cudf::get_default_stream
rmm::cuda_stream_view const get_default_stream()
Get the current default stream.
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:49
device_async_resource_ref
cuda::mr::async_resource_ref< cuda::mr::device_accessible > device_async_resource_ref
memory_resource.hpp
cudf
cuDF interfaces
Definition: aggregation.hpp:35
types.hpp
Type declarations for libcudf.
Generated by doxygen 1.9.1