Files | Enumerations | Functions
Extracting

Files

file  datetime.hpp
 DateTime column APIs.
 

Enumerations

enum class  cudf::datetime::datetime_component : uint8_t {
  YEAR , MONTH , DAY , WEEKDAY ,
  HOUR , MINUTE , SECOND , MILLISECOND ,
  MICROSECOND , NANOSECOND
}
 Types of datetime components that may be extracted.
 

Functions

std::unique_ptr< cudf::columncudf::datetime::extract_datetime_component (cudf::column_view const &column, datetime_component component, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=cudf::get_current_device_resource_ref())
 Extracts the specified datetime component from any datetime type and returns an int16_t cudf::column. More...
 

Detailed Description

Function Documentation

◆ extract_datetime_component()

std::unique_ptr<cudf::column> cudf::datetime::extract_datetime_component ( cudf::column_view const &  column,
datetime_component  component,
rmm::cuda_stream_view  stream = cudf::get_default_stream(),
rmm::device_async_resource_ref  mr = cudf::get_current_device_resource_ref() 
)

Extracts the specified datetime component from any datetime type and returns an int16_t cudf::column.

Parameters
columncudf::column_view of the input datetime values
componentThe datetime component to extract
streamCUDA stream used for device memory operations and kernel launches
mrDevice memory resource used to allocate device memory of the returned column
Returns
cudf::column of the extracted int16_t datetime component
Exceptions
cudf::logic_errorif input column datatype is not TIMESTAMP